diff options
Diffstat (limited to 'doc/html/quickbook/versions.html')
| -rw-r--r--[-rwxr-xr-x] | doc/html/quickbook/versions.html | 110 |
1 files changed, 109 insertions, 1 deletions
diff --git a/doc/html/quickbook/versions.html b/doc/html/quickbook/versions.html index e32a00bbdc..24aaf662e7 100755..100644 --- a/doc/html/quickbook/versions.html +++ b/doc/html/quickbook/versions.html @@ -28,6 +28,7 @@ <div class="toc"><dl> <dt><span class="section"><a href="versions.html#quickbook.versions.stable">Stable Versions</a></span></dt> <dt><span class="section"><a href="versions.html#quickbook.versions.1_6">Quickbook 1.6</a></span></dt> +<dt><span class="section"><a href="versions.html#quickbook.versions.1_7">Quickbook 1.7</a></span></dt> </dl></div> <div class="section"> <div class="titlepage"><div><div><h3 class="title"> @@ -395,9 +396,9 @@ <p> Nested Para 2 </p> - </li></ul></div> <pre class="programlisting">Code block </pre> + </li></ul></div> <p> Para 3 </p> @@ -408,6 +409,113 @@ </p> </div> </div> +<div class="section"> +<div class="titlepage"><div><div><h3 class="title"> +<a name="quickbook.versions.1_7"></a><a class="link" href="versions.html#quickbook.versions.1_7" title="Quickbook 1.7">Quickbook 1.7</a> +</h3></div></div></div> +<div class="toc"><dl> +<dt><span class="section"><a href="versions.html#quickbook.versions.1_7.source_mode">Source mode for + single entities</a></span></dt> +<dt><span class="section"><a href="versions.html#quickbook.versions.1_7.callouts">Callouts in code block</a></span></dt> +<dt><span class="section"><a href="versions.html#quickbook.versions.1_7.escaped_docinfo_attributes">Escaped + docbook in docinfo blocks</a></span></dt> +<dt><span class="section"><a href="versions.html#quickbook.versions.1_7.templates_in_link_values">Templates + in link values</a></span></dt> +</dl></div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="quickbook.versions.1_7.source_mode"></a><a class="link" href="versions.html#quickbook.versions.1_7.source_mode" title="Source mode for single entities">Source mode for + single entities</a> +</h4></div></div></div> +<p> + 1.7 introduces a new <code class="computeroutput">!</code> element type for setting the source + mode of a single entity without changing the source mode otherwise. This + can be used for code blocks and other elements. For example: + </p> +<pre class="programlisting">[!c++] + void foo() {}; + +[!python]```def foo():``` +</pre> +<p> + It can also be used to set the source mode for elements: + </p> +<pre class="programlisting">[!teletype][table + [[code][meaning]] + [[`+`][addition]] +] +</pre> +<p> + When used a section, it's only set for the section element, not the whole + section. + </p> +<p> + Currently it does support other syntactic entities such as paragraphs and + lists. I'm not sure if it would be a good idea. + </p> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="quickbook.versions.1_7.callouts"></a><a class="link" href="versions.html#quickbook.versions.1_7.callouts" title="Callouts in code block">Callouts in code block</a> +</h4></div></div></div> +<p> + Currently callouts can only be used in code snippets. 1.7 add support in + normal code blocks. The same syntax is used as in code snippets, the callout + descriptions appear immediately after the code block. + </p> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="quickbook.versions.1_7.escaped_docinfo_attributes"></a><a class="link" href="versions.html#quickbook.versions.1_7.escaped_docinfo_attributes" title="Escaped docbook in docinfo blocks">Escaped + docbook in docinfo blocks</a> +</h4></div></div></div> +<p> + Quickbook docinfo attributes will probably never be as rich as docbook + attributes so to allow more flexible markup, not supported by quickbook + escaped docbook can be included in the docinfo block: + </p> +<pre class="programlisting">[article Some article +[quickbook 1.7] +'''<author> + <firstname>John</firstname> + <surname>Doe</surname> + <email>john.doe@example.com</email> +</author>''' +] +</pre> +<p> + The escaped docbook is always placed at the end of the docinfo block, so + it shouldn't be assumed that it will interleave the markup. A mixture of + quickbook and docbook attributes for the same information will not work + well. + </p> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="quickbook.versions.1_7.templates_in_link_values"></a><a class="link" href="versions.html#quickbook.versions.1_7.templates_in_link_values" title="Templates in link values">Templates + in link values</a> +</h4></div></div></div> +<p> + There's very premilinary support for calling templates in link values. + A lot more work needs to be done, including: + </p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + Considering other places where templates could be called (e.g. images + are quite tricky, as templates could get confused with attributes, + should templates be callable from something like an element's id?). + </li> +<li class="listitem"> + Trimming spaces from the body of the template (which can cause surprising + results). + </li> +<li class="listitem"> + Checking that the contents of the template are appropriate for the + context. Possibly even using a different grammar. + </li> +</ul></div> +</div> +</div> </div> <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> <td align="left"></td> |