| <html> |
| <head> |
| <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> |
| <title>Change Log</title> |
| <link rel="stylesheet" href="../../../doc/src/boostbook.css" type="text/css"> |
| <meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> |
| <link rel="home" href="../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> |
| <link rel="up" href="../quickbook.html" title="Chapter 31. Quickbook 1.5"> |
| <link rel="prev" href="../quickbook.html" title="Chapter 31. Quickbook 1.5"> |
| <link rel="next" href="syntax.html" title="Syntax Summary"> |
| </head> |
| <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> |
| <table cellpadding="2" width="100%"><tr> |
| <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../boost.png"></td> |
| <td align="center"><a href="../../../index.html">Home</a></td> |
| <td align="center"><a href="../../../libs/libraries.htm">Libraries</a></td> |
| <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> |
| <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> |
| <td align="center"><a href="../../../more/index.htm">More</a></td> |
| </tr></table> |
| <hr> |
| <div class="spirit-nav"> |
| <a accesskey="p" href="../quickbook.html"><img src="../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../quickbook.html"><img src="../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="syntax.html"><img src="../../../doc/src/images/next.png" alt="Next"></a> |
| </div> |
| <div class="section"> |
| <div class="titlepage"><div><div><h2 class="title" style="clear: both"> |
| <a name="quickbook.change_log"></a><a class="link" href="change_log.html" title="Change Log">Change Log</a> |
| </h2></div></div></div> |
| <a name="quickbook.change_log.version_1_3"></a><h4> |
| <a name="id3237264"></a> |
| <a class="link" href="change_log.html#quickbook.change_log.version_1_3">Version 1.3</a> |
| </h4> |
| <div class="itemizedlist"><ul class="itemizedlist" type="disc"> |
| <li class="listitem"> |
| Quickbook file inclusion [include]. |
| </li> |
| <li class="listitem"> |
| Better xml output (pretty layout). Check out the generated XML. |
| </li> |
| <li class="listitem"> |
| Regression testing facility: to make sure your document will always be |
| compatible (full backward compatibility) regardless of changes to QuickBook. |
| </li> |
| <li class="listitem"> |
| Code cleanup and refactoring. |
| </li> |
| <li class="listitem"> |
| Allow phrase markup in the doc-info. |
| </li> |
| <li class="listitem"> |
| Preformatted code blocks via ``code`` (double ticks) allows code in tables |
| and lists, for example. |
| </li> |
| <li class="listitem"> |
| Quickbook versioning; allows full backward compatibility. You have to add |
| [quickbook 1.3] to the doc-info header to enable the new features. Without |
| this, QuickBook will assume that the document is a pre-1.3 document. |
| </li> |
| <li class="listitem"> |
| Better (intuitive) paragraph termination. Some markups may terminate a |
| paragraph. Example: |
| <pre class="programlisting"><span class="special">[</span><span class="identifier">section</span> <span class="identifier">x</span><span class="special">]</span> |
| <span class="identifier">blah</span><span class="special">...</span> |
| <span class="special">[</span><span class="identifier">endsect</span><span class="special">]</span></pre> |
| </li> |
| <li class="listitem"> |
| Fully qualified section and headers. Subsection names are concatenated |
| to the ID to avoid clashing. Example: <code class="computeroutput"><span class="identifier">doc_name</span><span class="special">.</span><span class="identifier">sect_name</span><span class="special">.</span><span class="identifier">sub_sect_name</span><span class="special">.</span><span class="identifier">sub_sub_sect_name</span></code> |
| </li> |
| <li class="listitem"> |
| Better &nbsp; and whitespace handling in code snippets. |
| </li> |
| <li class="listitem"> |
| [xinclude] fixes up the relative path to the target XML file when input_directory |
| is not the same as the output_directory. |
| </li> |
| <li class="listitem"> |
| Allow untitled tables. |
| </li> |
| <li class="listitem"> |
| Allow phrase markups in section titles. |
| </li> |
| <li class="listitem"> |
| Allow escaping back to QuickBook from code, code blocks and inline code. |
| </li> |
| <li class="listitem"> |
| Footnotes, with the [footnote This is the footnote] syntax. |
| </li> |
| <li class="listitem"> |
| Post-processor bug fix for escaped XML code that it does not recognize. |
| </li> |
| <li class="listitem"> |
| Replaceable, with the [~replacement] syntax. |
| </li> |
| </ul></div> |
| <a name="quickbook.change_log.version_1_4"></a><h4> |
| <a name="id3237512"></a> |
| <a class="link" href="change_log.html#quickbook.change_log.version_1_4">Version 1.4</a> |
| </h4> |
| <div class="itemizedlist"><ul class="itemizedlist" type="disc"> |
| <li class="listitem"> |
| Generic Headers |
| </li> |
| <li class="listitem"> |
| Code changes to allow full recursion (i.e. Collectors and push/pop functions) |
| </li> |
| <li class="listitem"> |
| Various code cleanup/maintenance |
| </li> |
| <li class="listitem"> |
| Templates! |
| </li> |
| <li class="listitem"> |
| [conceptref] for referencing BoostBook <concept> entities. |
| </li> |
| <li class="listitem"> |
| Allow escape of spaces. The escaped space is removed from the output. Syntax: |
| <code class="computeroutput"><span class="special">\</span> </code>. |
| </li> |
| <li class="listitem"> |
| Nested comments are now allowed. |
| </li> |
| <li class="listitem"> |
| Quickbook blocks can nest inside comments. |
| </li> |
| <li class="listitem"> |
| <a class="link" href="syntax.html#quickbook.syntax.block.import" title="Import">Import</a> facility. |
| </li> |
| <li class="listitem"> |
| Callouts on imported code |
| </li> |
| <li class="listitem"> |
| Simple markups can now span a whole block. |
| </li> |
| <li class="listitem"> |
| <a class="link" href="syntax.html#quickbook.syntax.block.blurbs" title="Blurbs">Blurbs</a>, <a class="link" href="syntax.html#quickbook.syntax.block.admonitions" title="Admonitions">Admonitions</a> |
| and table cells (see <a class="link" href="syntax.html#quickbook.syntax.block.tables" title="Tables">Tables</a>) |
| may now contain paragraphs. |
| </li> |
| <li class="listitem"> |
| <code class="computeroutput"><span class="special">\</span><span class="identifier">n</span></code> |
| and <code class="computeroutput"><span class="special">[</span><span class="identifier">br</span><span class="special">]</span></code> are now deprecated. |
| </li> |
| <li class="listitem"> |
| <a class="link" href="syntax.html#quickbook.syntax.phrase.cond" title="Conditional Generation">Conditional Generation</a>. |
| Ala C++ #ifdef. |
| </li> |
| <li class="listitem"> |
| Searching of included and imported files in an extensible search path with |
| <code class="computeroutput"><span class="special">--</span><span class="identifier">include</span><span class="special">-</span><span class="identifier">path</span></code> |
| (<code class="computeroutput"><span class="special">-</span><span class="identifier">I</span></code>) |
| option. |
| </li> |
| </ul></div> |
| <a name="quickbook.change_log.version_1_5"></a><h4> |
| <a name="id3237770"></a> |
| <a class="link" href="change_log.html#quickbook.change_log.version_1_5">Version 1.5</a> |
| </h4> |
| <div class="itemizedlist"><ul class="itemizedlist" type="disc"> |
| <li class="listitem"> |
| Support multiple copyright entrys in document info. |
| </li> |
| <li class="listitem"> |
| Improved SVG support. |
| </li> |
| <li class="listitem"> |
| [globalref] for referencing BoostBook <global> entities. |
| </li> |
| <li class="listitem"> |
| Fail on error. |
| </li> |
| <li class="listitem"> |
| Fix crash for templates with too many arguments or trailing space. |
| </li> |
| <li class="listitem"> |
| Improved handling of unexpected characters in code blocks. |
| </li> |
| <li class="listitem"> |
| Improved handling of unmatched escape in code blocks. |
| </li> |
| <li class="listitem"> |
| Support for python snippets. |
| </li> |
| <li class="listitem"> |
| <code class="computeroutput"><span class="identifier">teletype</span></code> source mode. |
| </li> |
| <li class="listitem"> |
| Use static scoping in templates, should be a lot more intuitive. |
| </li> |
| <li class="listitem"> |
| Accept a space between <code class="computeroutput"><span class="identifier">section</span><span class="special">:</span></code> and the section id. |
| </li> |
| <li class="listitem"> |
| Support table ids. |
| </li> |
| </ul></div> |
| <a name="quickbook.change_log.version_1_5_1___boost_1_43_0"></a><h4> |
| <a name="id3237906"></a> |
| <a class="link" href="change_log.html#quickbook.change_log.version_1_5_1___boost_1_43_0">Version 1.5.1 |
| - Boost 1.43.0</a> |
| </h4> |
| <div class="itemizedlist"><ul class="itemizedlist" type="disc"> |
| <li class="listitem"> |
| Improve the post processor's list of block elements. <code class="computeroutput"><span class="identifier">table</span></code>, |
| <code class="computeroutput"><span class="identifier">entry</span></code> and <code class="computeroutput"><span class="identifier">varlistentry</span></code> are treated as blocks. |
| <code class="computeroutput"><span class="identifier">replaceable</span></code> is treated |
| as an inline element. |
| </li> |
| <li class="listitem"> |
| Check that <code class="computeroutput"><span class="special">[</span><span class="identifier">section</span><span class="special">]</span></code> and <code class="computeroutput"><span class="special">[</span><span class="identifier">endsect</span><span class="special">]</span></code> |
| tags are balanced in templates. |
| </li> |
| <li class="listitem"> |
| Add unicode escape characters, eg. <code class="computeroutput"><span class="special">\</span><span class="identifier">u03B1</span></code> for α. |
| </li> |
| <li class="listitem"> |
| Support UTF-8 files with a unicode byte order mark. |
| </li> |
| <li class="listitem"> |
| Disallow <code class="computeroutput"><span class="special">[</span></code> in simple markup. |
| Fixes some errors with mismatched punctuation. |
| </li> |
| <li class="listitem"> |
| Add command line flag to define macros at the command line, e.g. <code class="computeroutput"><span class="identifier">quickbook</span> <span class="string">"-D__italic_foo__=/foo/"</span></code>. |
| </li> |
| </ul></div> |
| <a name="quickbook.change_log.version_1_5_2___boost_1_44_0"></a><h4> |
| <a name="id3238088"></a> |
| <a class="link" href="change_log.html#quickbook.change_log.version_1_5_2___boost_1_44_0">Version 1.5.2 |
| - Boost 1.44.0</a> |
| </h4> |
| <div class="itemizedlist"><ul class="itemizedlist" type="disc"> |
| <li class="listitem"> |
| Use the cygwin 1.7 API for better path handling. |
| </li> |
| <li class="listitem"> |
| <p class="simpara"> |
| Improved boostbook generation: |
| </p> |
| <div class="itemizedlist"><ul class="itemizedlist" type="circle"> |
| <li class="listitem"> |
| XML encode the documentation info correctly. |
| </li> |
| <li class="listitem"> |
| Avoid generating empty paragraphs. |
| </li> |
| <li class="listitem"> |
| No longer wraps block templates in paragraphs. |
| </li> |
| <li class="listitem"> |
| Warns if you use invalid doc_info members for docbook document types. |
| </li> |
| <li class="listitem"> |
| Fixes some other causes of invalid boostbook, although it still generates |
| invalid boostbook in places. |
| </li> |
| </ul></div> |
| </li> |
| <li class="listitem"> |
| <p class="simpara"> |
| Improved grammar: |
| </p> |
| <div class="itemizedlist"><ul class="itemizedlist" type="circle"> |
| <li class="listitem"> |
| Supports multiple categories in library doc_info. |
| </li> |
| <li class="listitem"> |
| No longer requires commas between authors in docinfo. |
| </li> |
| <li class="listitem"> |
| Allows empty document bodies. |
| </li> |
| <li class="listitem"> |
| A line containing only a comment is no longer interpreted as a paragraph |
| break. |
| </li> |
| <li class="listitem"> |
| If a line starts with a comment, interpret it as a paragraph even if |
| it's followed by whitespace or a list character. |
| </li> |
| <li class="listitem"> |
| Doesn't treat several consecutive blank lines as multiple paragraph |
| breaks. |
| </li> |
| </ul></div> |
| </li> |
| <li class="listitem"> |
| Fixes duplicate image attribute detection. |
| </li> |
| <li class="listitem"> |
| Fixes using code snippets more than once. |
| </li> |
| <li class="listitem"> |
| <p class="simpara"> |
| Early work on quickbook 1.6, available using the <code class="computeroutput"><span class="special">[</span><span class="identifier">quickbook</span> <span class="number">1.6</span><span class="special">]</span></code> version switch, but liable to change in |
| future versions. |
| </p> |
| <div class="itemizedlist"><ul class="itemizedlist" type="circle"> |
| <li class="listitem"> |
| When automatically generating ids for headers, use the quickbook source, |
| rather than the generated docbook. |
| </li> |
| <li class="listitem"> |
| Fix id generation in included files. It wasn't correctly using the |
| main document's documentation id. |
| </li> |
| <li class="listitem"> |
| Correctly restore the quickbook version switch after including a file |
| with a different version. |
| </li> |
| </ul></div> |
| </li> |
| </ul></div> |
| <a name="quickbook.change_log.version_1_5_3___boost_1_45_0"></a><h4> |
| <a name="id3238309"></a> |
| <a class="link" href="change_log.html#quickbook.change_log.version_1_5_3___boost_1_45_0">Version 1.5.3 |
| - Boost 1.45.0</a> |
| </h4> |
| <div class="itemizedlist"><ul class="itemizedlist" type="disc"> |
| <li class="listitem"> |
| Fix command line flag for defining macros. |
| </li> |
| <li class="listitem"> |
| <p class="simpara"> |
| Fix a couple of issues with the code block parser: |
| </p> |
| <div class="itemizedlist"><ul class="itemizedlist" type="circle"> |
| <li class="listitem"> |
| A comment with no indentation will now end a code block. |
| </li> |
| <li class="listitem"> |
| Code blocks no longer have to be followed by a blank line. |
| </li> |
| </ul></div> |
| </li> |
| <li class="listitem"> |
| Improved tracking of file position in templates and imported code blocks. |
| </li> |
| <li class="listitem"> |
| Better generated markup for callout lists. |
| </li> |
| <li class="listitem"> |
| In docbook, variable list entries can only have one <code class="computeroutput"><span class="identifier">listitem</span></code>, |
| so if an entry has multiple values, merge them into one <code class="computeroutput"><span class="identifier">listitem</span></code>. |
| </li> |
| <li class="listitem"> |
| Support nested code snippets. |
| </li> |
| <li class="listitem"> |
| Support nested blocks in document info comments. |
| </li> |
| <li class="listitem"> |
| Revert xml escaping document info, it broke some documentation files (now |
| a 1.6 feature). |
| </li> |
| <li class="listitem"> |
| <p class="simpara"> |
| Further work on quickbook 1.6, still not stable. |
| </p> |
| <div class="itemizedlist"><ul class="itemizedlist" type="circle"> |
| <li class="listitem"> |
| Allow heading to have ids, using the syntax: <code class="computeroutput"><span class="special">[</span><span class="identifier">heading</span><span class="special">:</span><span class="identifier">id</span> <span class="identifier">title</span><span class="special">]</span></code>. |
| </li> |
| <li class="listitem"> |
| XML escape documentation fields, with escapes to allow encoding unicode |
| in ASCII. |
| </li> |
| </ul></div> |
| </li> |
| </ul></div> |
| </div> |
| <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> |
| <td align="left"></td> |
| <td align="right"><div class="copyright-footer">Copyright © 2002, 2004, 2006 Joel de Guzman, |
| Eric Niebler<p> |
| Distributed under the Boost Software License, Version 1.0. (See accompanying |
| file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) |
| </p> |
| </div></td> |
| </tr></table> |
| <hr> |
| <div class="spirit-nav"> |
| <a accesskey="p" href="../quickbook.html"><img src="../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../quickbook.html"><img src="../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="syntax.html"><img src="../../../doc/src/images/next.png" alt="Next"></a> |
| </div> |
| </body> |
| </html> |
