diff options
Diffstat (limited to 'doc/html/quickbook/syntax/block.html')
| -rw-r--r--[-rwxr-xr-x] | doc/html/quickbook/syntax/block.html | 91 |
1 files changed, 48 insertions, 43 deletions
diff --git a/doc/html/quickbook/syntax/block.html b/doc/html/quickbook/syntax/block.html index 50ba4496ca..6264078783 100755..100644 --- a/doc/html/quickbook/syntax/block.html +++ b/doc/html/quickbook/syntax/block.html @@ -30,26 +30,28 @@ <dt><span class="section"><a href="block.html#quickbook.syntax.block.paragraphs">Paragraphs</a></span></dt> <dt><span class="section"><a href="block.html#quickbook.syntax.block.lists">Lists</a></span></dt> <dt><span class="section"><a href="block.html#quickbook.syntax.block.code">Code</a></span></dt> -<dt><span class="section"><a href="block.html#quickbook.syntax.block.escape_back">Escaping Back To - QuickBook</a></span></dt> +<dt><span class="section"><a href="block.html#quickbook.syntax.block.escape_back">Escaping + Back To QuickBook</a></span></dt> <dt><span class="section"><a href="block.html#quickbook.syntax.block.preformatted">Preformatted</a></span></dt> <dt><span class="section"><a href="block.html#quickbook.syntax.block.blockquote">Blockquote</a></span></dt> <dt><span class="section"><a href="block.html#quickbook.syntax.block.admonitions">Admonitions</a></span></dt> <dt><span class="section"><a href="block.html#quickbook.syntax.block.headings">Headings</a></span></dt> -<dt><span class="section"><a href="block.html#quickbook.syntax.block.generic_heading">Generic Heading</a></span></dt> +<dt><span class="section"><a href="block.html#quickbook.syntax.block.generic_heading">Generic + Heading</a></span></dt> <dt><span class="section"><a href="block.html#quickbook.syntax.block.macros">Macros</a></span></dt> <dt><span class="section"><a href="block.html#quickbook.syntax.block.predefined_macros">Predefined Macros</a></span></dt> <dt><span class="section"><a href="block.html#quickbook.syntax.block.templates">Templates</a></span></dt> <dt><span class="section"><a href="block.html#quickbook.syntax.block.blurbs">Blurbs</a></span></dt> <dt><span class="section"><a href="block.html#quickbook.syntax.block.tables">Tables</a></span></dt> -<dt><span class="section"><a href="block.html#quickbook.syntax.block.variable_lists">Variable Lists</a></span></dt> +<dt><span class="section"><a href="block.html#quickbook.syntax.block.variable_lists">Variable + Lists</a></span></dt> <dt><span class="section"><a href="block.html#quickbook.syntax.block.include">Include</a></span></dt> <dt><span class="section"><a href="block.html#quickbook.syntax.block.import">Import</a></span></dt> </dl></div> <div class="section"> <div class="titlepage"><div><div><h3 class="title"> -<a name="quickbook.syntax.block.xinclude"></a><a class="link" href="block.html#quickbook.syntax.block.xinclude" title="xinclude">xinclude</a> +<a name="quickbook.syntax.block.xinclude"></a><a name="quickbook.ref.xinclude"></a><a class="link" href="block.html#quickbook.syntax.block.xinclude" title="xinclude">xinclude</a> </h3></div></div></div> <p> You can include another XML file with: @@ -63,7 +65,7 @@ </div> <div class="section"> <div class="titlepage"><div><div><h3 class="title"> -<a name="quickbook.syntax.block.paragraphs"></a><a class="link" href="block.html#quickbook.syntax.block.paragraphs" title="Paragraphs">Paragraphs</a> +<a name="quickbook.syntax.block.paragraphs"></a><a name="quickbook.ref.paragraphs"></a><a class="link" href="block.html#quickbook.syntax.block.paragraphs" title="Paragraphs">Paragraphs</a> </h3></div></div></div> <p> Paragraphs start left-flushed and are terminated by two or more newlines. @@ -75,7 +77,7 @@ </div> <div class="section"> <div class="titlepage"><div><div><h3 class="title"> -<a name="quickbook.syntax.block.lists"></a><a class="link" href="block.html#quickbook.syntax.block.lists" title="Lists">Lists</a> +<a name="quickbook.syntax.block.lists"></a><a name="quickbook.ref.lists"></a><a class="link" href="block.html#quickbook.syntax.block.lists" title="Lists">Lists</a> </h3></div></div></div> <div class="toc"><dl> <dt><span class="section"><a href="block.html#quickbook.syntax.block.lists.ordered_lists">Ordered @@ -86,11 +88,12 @@ List Lines</a></span></dt> <dt><span class="section"><a href="block.html#quickbook.syntax.block.lists.unordered_lists">Unordered lists</a></span></dt> -<dt><span class="section"><a href="block.html#quickbook.syntax.block.lists.mixed_lists">Mixed lists</a></span></dt> +<dt><span class="section"><a href="block.html#quickbook.syntax.block.lists.mixed_lists">Mixed + lists</a></span></dt> </dl></div> <div class="section"> <div class="titlepage"><div><div><h4 class="title"> -<a name="quickbook.syntax.block.lists.ordered_lists"></a><a class="link" href="block.html#quickbook.syntax.block.lists.ordered_lists" title="Ordered lists">Ordered +<a name="quickbook.syntax.block.lists.ordered_lists"></a><a name="quickbook.ref.ordered_lists"></a><a class="link" href="block.html#quickbook.syntax.block.lists.ordered_lists" title="Ordered lists">Ordered lists</a> </h4></div></div></div> <pre class="programlisting"># One @@ -114,7 +117,7 @@ </div> <div class="section"> <div class="titlepage"><div><div><h4 class="title"> -<a name="quickbook.syntax.block.lists.list_hierarchies"></a><a class="link" href="block.html#quickbook.syntax.block.lists.list_hierarchies" title="List Hierarchies">List +<a name="quickbook.syntax.block.lists.list_hierarchies"></a><a name="quickbook.ref.list_hierarchies"></a><a class="link" href="block.html#quickbook.syntax.block.lists.list_hierarchies" title="List Hierarchies">List Hierarchies</a> </h4></div></div></div> <p> @@ -177,7 +180,7 @@ </div> <div class="section"> <div class="titlepage"><div><div><h4 class="title"> -<a name="quickbook.syntax.block.lists.long_list_lines"></a><a class="link" href="block.html#quickbook.syntax.block.lists.long_list_lines" title="Long List Lines">Long +<a name="quickbook.syntax.block.lists.long_list_lines"></a><a name="quickbook.ref.long_list_lines"></a><a class="link" href="block.html#quickbook.syntax.block.lists.long_list_lines" title="Long List Lines">Long List Lines</a> </h4></div></div></div> <p> @@ -208,7 +211,7 @@ </div> <div class="section"> <div class="titlepage"><div><div><h4 class="title"> -<a name="quickbook.syntax.block.lists.unordered_lists"></a><a class="link" href="block.html#quickbook.syntax.block.lists.unordered_lists" title="Unordered lists">Unordered +<a name="quickbook.syntax.block.lists.unordered_lists"></a><a name="quickbook.ref.unordered_lists"></a><a class="link" href="block.html#quickbook.syntax.block.lists.unordered_lists" title="Unordered lists">Unordered lists</a> </h4></div></div></div> <pre class="programlisting">* First @@ -232,7 +235,8 @@ </div> <div class="section"> <div class="titlepage"><div><div><h4 class="title"> -<a name="quickbook.syntax.block.lists.mixed_lists"></a><a class="link" href="block.html#quickbook.syntax.block.lists.mixed_lists" title="Mixed lists">Mixed lists</a> +<a name="quickbook.syntax.block.lists.mixed_lists"></a><a name="quickbook.ref.mixed_lists"></a><a class="link" href="block.html#quickbook.syntax.block.lists.mixed_lists" title="Mixed lists">Mixed + lists</a> </h4></div></div></div> <p> Mixed lists (ordered and unordered) are supported. Example: @@ -344,11 +348,11 @@ </div> <div class="section"> <div class="titlepage"><div><div><h3 class="title"> -<a name="quickbook.syntax.block.code"></a><a class="link" href="block.html#quickbook.syntax.block.code" title="Code">Code</a> +<a name="quickbook.syntax.block.code"></a><a name="quickbook.ref.code"></a><a class="link" href="block.html#quickbook.syntax.block.code" title="Code">Code</a> </h3></div></div></div> <p> Preformatted code starts with a space or a tab. The code will be syntax highlighted - according to the current <a class="link" href="phrase.html#quickbook.syntax.phrase.source_mode" title="Source Mode">Source + according to the current <a class="link" href="phrase.html#quickbook.ref.source_mode">Source Mode</a>: </p> <pre class="programlisting"><span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">iostream</span><span class="special">></span> @@ -383,8 +387,8 @@ </div> <div class="section"> <div class="titlepage"><div><div><h3 class="title"> -<a name="quickbook.syntax.block.escape_back"></a><a class="link" href="block.html#quickbook.syntax.block.escape_back" title="Escaping Back To QuickBook">Escaping Back To - QuickBook</a> +<a name="quickbook.syntax.block.escape_back"></a><a name="quickbook.ref.escape_back"></a><a class="link" href="block.html#quickbook.syntax.block.escape_back" title="Escaping Back To QuickBook">Escaping + Back To QuickBook</a> </h3></div></div></div> <p> Inside code, code blocks and inline code, QuickBook does not allow any markup @@ -412,7 +416,7 @@ </div> <div class="section"> <div class="titlepage"><div><div><h3 class="title"> -<a name="quickbook.syntax.block.preformatted"></a><a class="link" href="block.html#quickbook.syntax.block.preformatted" title="Preformatted">Preformatted</a> +<a name="quickbook.syntax.block.preformatted"></a><a name="quickbook.ref.preformatted"></a><a class="link" href="block.html#quickbook.syntax.block.preformatted" title="Preformatted">Preformatted</a> </h3></div></div></div> <p> Sometimes, you don't want some preformatted text to be parsed as source code. @@ -448,7 +452,7 @@ Some <span class="bold"><strong>preformatted</strong></span> text </div> <div class="section"> <div class="titlepage"><div><div><h3 class="title"> -<a name="quickbook.syntax.block.blockquote"></a><a class="link" href="block.html#quickbook.syntax.block.blockquote" title="Blockquote">Blockquote</a> +<a name="quickbook.syntax.block.blockquote"></a><a name="quickbook.ref.blockquote"></a><a class="link" href="block.html#quickbook.syntax.block.blockquote" title="Blockquote">Blockquote</a> </h3></div></div></div> <pre class="programlisting">[:sometext...] </pre> @@ -458,7 +462,7 @@ Some <span class="bold"><strong>preformatted</strong></span> text </div> <div class="section"> <div class="titlepage"><div><div><h3 class="title"> -<a name="quickbook.syntax.block.admonitions"></a><a class="link" href="block.html#quickbook.syntax.block.admonitions" title="Admonitions">Admonitions</a> +<a name="quickbook.syntax.block.admonitions"></a><a name="quickbook.ref.admonitions"></a><a class="link" href="block.html#quickbook.syntax.block.admonitions" title="Admonitions">Admonitions</a> </h3></div></div></div> <pre class="programlisting">[note This is a note] [tip This is a tip] @@ -522,7 +526,7 @@ Some <span class="bold"><strong>preformatted</strong></span> text </div> <div class="section"> <div class="titlepage"><div><div><h3 class="title"> -<a name="quickbook.syntax.block.headings"></a><a class="link" href="block.html#quickbook.syntax.block.headings" title="Headings">Headings</a> +<a name="quickbook.syntax.block.headings"></a><a name="quickbook.ref.headings"></a><a class="link" href="block.html#quickbook.syntax.block.headings" title="Headings">Headings</a> </h3></div></div></div> <pre class="programlisting">[h1 Heading 1] [h2 Heading 2] @@ -573,14 +577,14 @@ Some <span class="bold"><strong>preformatted</strong></span> text <pre class="programlisting">[link document_id.section_id.normalized_header_text The link text] </pre> <p> - to link to them. See <a class="link" href="phrase.html#quickbook.syntax.phrase.anchor_links" title="Anchor links">Anchor - links</a> and <a class="link" href="structure.html#quickbook.syntax.structure.section" title="Sections">Section</a> - for more info. + to link to them. See <a class="link" href="phrase.html#quickbook.ref.anchor_links">Anchor links</a> + and <a class="link" href="structure.html#quickbook.ref.section">Section</a> for more info. </p> </div> <div class="section"> <div class="titlepage"><div><div><h3 class="title"> -<a name="quickbook.syntax.block.generic_heading"></a><a class="link" href="block.html#quickbook.syntax.block.generic_heading" title="Generic Heading">Generic Heading</a> +<a name="quickbook.syntax.block.generic_heading"></a><a name="quickbook.ref.generic_heading"></a><a class="link" href="block.html#quickbook.syntax.block.generic_heading" title="Generic Heading">Generic + Heading</a> </h3></div></div></div> <p> In cases when you don't want to care about the heading level (1 to 6), you @@ -628,7 +632,7 @@ Some <span class="bold"><strong>preformatted</strong></span> text </div> <div class="section"> <div class="titlepage"><div><div><h3 class="title"> -<a name="quickbook.syntax.block.macros"></a><a class="link" href="block.html#quickbook.syntax.block.macros" title="Macros">Macros</a> +<a name="quickbook.syntax.block.macros"></a><a name="quickbook.ref.macros"></a><a class="link" href="block.html#quickbook.syntax.block.macros" title="Macros">Macros</a> </h3></div></div></div> <pre class="programlisting">[def macro_identifier some text] </pre> @@ -674,7 +678,7 @@ sf_logo [def __spirit__ [@http://spirit.sourceforge.net Spirit]] </pre> <p> - (See <a class="link" href="phrase.html#quickbook.syntax.phrase.images" title="Images">Images</a> and <a class="link" href="phrase.html#quickbook.syntax.phrase.links" title="Links">Links</a>) + (See <a class="link" href="phrase.html#quickbook.ref.images">Images</a> and <a class="link" href="phrase.html#quickbook.ref.links">Links</a>) </p> <p> Invoking these macros: @@ -690,7 +694,7 @@ sf_logo </div> <div class="section"> <div class="titlepage"><div><div><h3 class="title"> -<a name="quickbook.syntax.block.predefined_macros"></a><a class="link" href="block.html#quickbook.syntax.block.predefined_macros" title="Predefined Macros">Predefined +<a name="quickbook.syntax.block.predefined_macros"></a><a name="quickbook.ref.predefined_macros"></a><a class="link" href="block.html#quickbook.syntax.block.predefined_macros" title="Predefined Macros">Predefined Macros</a> </h3></div></div></div> <p> @@ -735,7 +739,7 @@ sf_logo </td> <td> <p> - 2012-Feb-20 + 2012-Aug-16 </p> </td> </tr> @@ -752,7 +756,7 @@ sf_logo </td> <td> <p> - 08:52:05 PM + 12:45:07 AM </p> </td> </tr> @@ -780,7 +784,7 @@ sf_logo </div> <div class="section"> <div class="titlepage"><div><div><h3 class="title"> -<a name="quickbook.syntax.block.templates"></a><a class="link" href="block.html#quickbook.syntax.block.templates" title="Templates">Templates</a> +<a name="quickbook.syntax.block.templates"></a><a name="quickbook.ref.templates"></a><a class="link" href="block.html#quickbook.syntax.block.templates" title="Templates">Templates</a> </h3></div></div></div> <p> Templates provide a more versatile text substitution mechanism. Templates @@ -799,7 +803,7 @@ Hi, my name is [name]. I am [age] years old. I am a [what]. ] </pre> -<h4> +<a name="quickbook.ref.template_identifier"></a><h4> <a name="quickbook.syntax.block.templates.h0"></a> <span><a name="quickbook.syntax.block.templates.template_identifier"></a></span><a class="link" href="block.html#quickbook.syntax.block.templates.template_identifier">Template Identifier</a> </h4> @@ -828,7 +832,7 @@ Hi, my name is [name]. I am [age] years old. I am a [what]. </p> <p> A template formal argument temporarily hides a template of the same name - at the point where the <a class="link" href="block.html#quickbook.syntax.block.templates.template_expansion">template + at the point where the <a class="link" href="phrase.html#quickbook.ref.template_expansion">template is expanded</a>. Note that the body of the <code class="literal">person</code> template above refers to <code class="literal">name</code> <code class="literal">age</code> and <code class="literal">what</code> as <code class="literal">[name]</code> <code class="literal">[age]</code> and <code class="literal">[what]</code>. @@ -958,7 +962,7 @@ replacement text... </p> <div class="itemizedlist"><ul class="itemizedlist" type="disc"> <li class="listitem"> - The explicit <a class="link" href="block.html#quickbook.syntax.block.templates.template_expansion">template + The explicit <a class="link" href="phrase.html#quickbook.ref.template_expansion">template expansion syntax</a>. This is an advantage because, now, we don't have to use obscure naming conventions like double underscores (e.g. __alpha__) to avoid unwanted macro replacement. @@ -1092,8 +1096,8 @@ for the journey to old age.]]] in QuickBook (as a qbk library). For that to happen, we need to accommodate single character punctuation templates which are fairly common in QuickBook. You might have noticed that single character punctuations are allowed as - <a class="link" href="block.html#quickbook.syntax.block.templates.template_identifier">template - identifiers</a>. Example: + <a class="link" href="block.html#quickbook.ref.template_identifier">template identifiers</a>. + Example: </p> <pre class="programlisting">[template ![bar] <hey>[bar]</hey>] </pre> @@ -1110,7 +1114,7 @@ for the journey to old age.]]] </div> <div class="section"> <div class="titlepage"><div><div><h3 class="title"> -<a name="quickbook.syntax.block.blurbs"></a><a class="link" href="block.html#quickbook.syntax.block.blurbs" title="Blurbs">Blurbs</a> +<a name="quickbook.syntax.block.blurbs"></a><a name="quickbook.ref.blurbs"></a><a class="link" href="block.html#quickbook.syntax.block.blurbs" title="Blurbs">Blurbs</a> </h3></div></div></div> <pre class="programlisting">[blurb :-) [*An eye catching advertisement or note...] @@ -1142,14 +1146,14 @@ for the journey to old age.]]] <th align="left">Note</th> </tr> <tr><td align="left" valign="top"><p> - Prefer <a class="link" href="block.html#quickbook.syntax.block.admonitions" title="Admonitions">admonitions</a> - wherever appropriate. + Prefer <a class="link" href="block.html#quickbook.ref.admonitions">admonitions</a> wherever + appropriate. </p></td></tr> </table></div> </div> <div class="section"> <div class="titlepage"><div><div><h3 class="title"> -<a name="quickbook.syntax.block.tables"></a><a class="link" href="block.html#quickbook.syntax.block.tables" title="Tables">Tables</a> +<a name="quickbook.syntax.block.tables"></a><a name="quickbook.ref.tables"></a><a class="link" href="block.html#quickbook.syntax.block.tables" title="Tables">Tables</a> </h3></div></div></div> <pre class="programlisting">[table:id A Simple Table [[Heading 1] [Heading 2] [Heading 3]] @@ -1402,7 +1406,8 @@ int main() </div> <div class="section"> <div class="titlepage"><div><div><h3 class="title"> -<a name="quickbook.syntax.block.variable_lists"></a><a class="link" href="block.html#quickbook.syntax.block.variable_lists" title="Variable Lists">Variable Lists</a> +<a name="quickbook.syntax.block.variable_lists"></a><a name="quickbook.ref.variable_lists"></a><a class="link" href="block.html#quickbook.syntax.block.variable_lists" title="Variable Lists">Variable + Lists</a> </h3></div></div></div> <pre class="programlisting">[variablelist A Variable List [[term 1] [The definition of term 1]] @@ -1448,7 +1453,7 @@ int main() </div> <div class="section"> <div class="titlepage"><div><div><h3 class="title"> -<a name="quickbook.syntax.block.include"></a><a class="link" href="block.html#quickbook.syntax.block.include" title="Include">Include</a> +<a name="quickbook.syntax.block.include"></a><a name="quickbook.ref.include"></a><a class="link" href="block.html#quickbook.syntax.block.include" title="Include">Include</a> </h3></div></div></div> <p> You can include one QuickBook file from another. The syntax is simply: @@ -1485,7 +1490,7 @@ int main() </div> <div class="section"> <div class="titlepage"><div><div><h3 class="title"> -<a name="quickbook.syntax.block.import"></a><a class="link" href="block.html#quickbook.syntax.block.import" title="Import">Import</a> +<a name="quickbook.syntax.block.import"></a><a name="quickbook.ref.import"></a><a class="link" href="block.html#quickbook.syntax.block.import" title="Import">Import</a> </h3></div></div></div> <p> When documenting code, you'd surely need to present code from actual source |