<html> <head> <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> <title>Quick Reference</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="faq.html" title="Frequently Asked Questions"> <link rel="next" href="../jam.html" title="Chapter 32. Boost.Jam : 3.1.18"> </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="faq.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="../jam.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.ref"></a><a class="link" href="ref.html" title="Quick Reference"> Quick Reference</a> </h2></div></div></div> <p> </p> <div class="table"> <a name="quickbook.ref.syntax_compendium"></a><p class="title"><b>Table 31.8. Syntax Compendium</b></p> <div class="table-contents"><table class="table" summary="Syntax Compendium"> <colgroup> <col> <col> <col> </colgroup> <thead><tr> <th> <p> To do this... </p> </th> <th> <p> Use this... </p> </th> <th> <p> See this... </p> </th> </tr></thead> <tbody> <tr> <td> <p> comment </p> </td> <td> <p> <code class="literal">[/ some comment]</code> </p> </td> <td> <p> <a class="link" href="syntax.html#quickbook.syntax.comments" title="Comments">Comments</a> </p> </td> </tr> <tr> <td> <p> <span class="emphasis"><em>italics</em></span> </p> </td> <td> <p> <code class="literal">['italics] or /italics/</code> </p> </td> <td> <p> <a class="link" href="syntax.html#quickbook.syntax.phrase.font_styles" title="Font Styles">Font Styles</a> and <a class="link" href="syntax.html#quickbook.syntax.phrase.simple_formatting" title="Simple formatting">Simple formatting</a> </p> </td> </tr> <tr> <td> <p> <span class="bold"><strong>bold</strong></span> </p> </td> <td> <p> <code class="literal">[*bold] or *bold*</code> </p> </td> <td> <p> <a class="link" href="syntax.html#quickbook.syntax.phrase.font_styles" title="Font Styles">Font Styles</a> and <a class="link" href="syntax.html#quickbook.syntax.phrase.simple_formatting" title="Simple formatting">Simple formatting</a> </p> </td> </tr> <tr> <td> <p> <span class="underline">underline</span> </p> </td> <td> <p> <code class="literal">[_underline] or _underline_</code> </p> </td> <td> <p> <a class="link" href="syntax.html#quickbook.syntax.phrase.font_styles" title="Font Styles">Font Styles</a> and <a class="link" href="syntax.html#quickbook.syntax.phrase.simple_formatting" title="Simple formatting">Simple formatting</a> </p> </td> </tr> <tr> <td> <p> <code class="literal">teletype</code> </p> </td> <td> <p> <code class="literal">[^teletype] or =teletype=</code> </p> </td> <td> <p> <a class="link" href="syntax.html#quickbook.syntax.phrase.font_styles" title="Font Styles">Font Styles</a> and <a class="link" href="syntax.html#quickbook.syntax.phrase.simple_formatting" title="Simple formatting">Simple formatting</a> </p> </td> </tr> <tr> <td> <p> <span class="strikethrough">strikethrough</span> </p> </td> <td> <p> <code class="literal">[-strikethrough]</code> </p> </td> <td> <p> <a class="link" href="syntax.html#quickbook.syntax.phrase.font_styles" title="Font Styles">Font Styles</a> and <a class="link" href="syntax.html#quickbook.syntax.phrase.simple_formatting" title="Simple formatting">Simple formatting</a> </p> </td> </tr> <tr> <td> <p> <em class="replaceable"><code>replaceable</code></em> </p> </td> <td> <p> <code class="literal">[~replaceable]</code> </p> </td> <td> <p> <a class="link" href="syntax.html#quickbook.syntax.phrase.replaceable" title="Replaceable">Replaceble</a> </p> </td> </tr> <tr> <td> <p> source mode </p> </td> <td> <p> <code class="literal">[c++]</code> or <code class="literal">[python]</code> </p> </td> <td> <p> <a class="link" href="syntax.html#quickbook.syntax.phrase.source_mode" title="Source Mode">Source Mode</a> </p> </td> </tr> <tr> <td> <p> inline code </p> </td> <td> <p> <code class="literal">`int main();`</code> </p> </td> <td> <p> <a class="link" href="syntax.html#quickbook.syntax.phrase.inline_code" title="Inline code">Inline code</a> </p> </td> </tr> <tr> <td> <p> code block </p> </td> <td> <p> <code class="literal">``int main();``</code> </p> </td> <td> <p> <a class="link" href="syntax.html#quickbook.syntax.block.code" title="Code">Code</a> </p> </td> </tr> <tr> <td> <p> code escape </p> </td> <td> <p> <code class="literal">``from c++ to QuickBook``</code> </p> </td> <td> <p> <a class="link" href="syntax.html#quickbook.syntax.block.escape_back" title="Escaping Back To QuickBook">Escaping Back To QuickBook</a> </p> </td> </tr> <tr> <td> <p> line break </p> </td> <td> <p> <code class="literal">[br] or \n</code> </p> </td> <td> <p> <a class="link" href="syntax.html#quickbook.syntax.phrase.line_break" title="line-break">line-break</a> <span class="bold"><strong>DEPRECATED</strong></span> </p> </td> </tr> <tr> <td> <p> anchor </p> </td> <td> <p> <code class="literal">[#anchor]</code> </p> </td> <td> <p> <a class="link" href="syntax.html#quickbook.syntax.phrase.anchors" title="Anchors">Anchors</a> </p> </td> </tr> <tr> <td> <p> link </p> </td> <td> <p> <code class="literal">[@http://www.boost.org Boost]</code> </p> </td> <td> <p> <a class="link" href="syntax.html#quickbook.syntax.phrase.links" title="Links">Links</a> </p> </td> </tr> <tr> <td> <p> anchor link </p> </td> <td> <p> <code class="literal">[link section.anchor Link text]</code> </p> </td> <td> <p> <a class="link" href="syntax.html#quickbook.syntax.phrase.anchor_links" title="Anchor links">Anchor links</a> </p> </td> </tr> <tr> <td> <p> refentry link </p> </td> <td> <p> <code class="literal">[link xml.refentry Link text]</code> </p> </td> <td> <p> <a class="link" href="syntax.html#quickbook.syntax.phrase.refentry_links" title="refentry links">refentry links</a> </p> </td> </tr> <tr> <td> <p> function link </p> </td> <td> <p> <code class="literal">[funcref fully::qualified::function_name Link text]</code> </p> </td> <td> <p> <a class="link" href="syntax.html#quickbook.syntax.phrase.code_links" title="Code Links">function, class, member, enum, macro, concept or header links</a> </p> </td> </tr> <tr> <td> <p> class link </p> </td> <td> <p> <code class="literal">[classref fully::qualified::class_name Link text]</code> </p> </td> <td> <p> <a class="link" href="syntax.html#quickbook.syntax.phrase.code_links" title="Code Links">function, class, member, enum, macro, concept or header links</a> </p> </td> </tr> <tr> <td> <p> member link </p> </td> <td> <p> <code class="literal">[memberref fully::qualified::member_name Link text]</code> </p> </td> <td> <p> <a class="link" href="syntax.html#quickbook.syntax.phrase.code_links" title="Code Links">function, class, member, enum, macro, concept or header links</a> </p> </td> </tr> <tr> <td> <p> enum link </p> </td> <td> <p> <code class="literal">[enumref fully::qualified::enum_name Link text]</code> </p> </td> <td> <p> <a class="link" href="syntax.html#quickbook.syntax.phrase.code_links" title="Code Links">function, class, member, enum, macro, concept or header links</a> </p> </td> </tr> <tr> <td> <p> macro link </p> </td> <td> <p> <code class="literal">[macroref MACRO_NAME Link text]</code> </p> </td> <td> <p> <a class="link" href="syntax.html#quickbook.syntax.phrase.code_links" title="Code Links">function, class, member, enum, macro, concept or header links</a> </p> </td> </tr> <tr> <td> <p> concept link </p> </td> <td> <p> <code class="literal">[conceptref ConceptName Link text]</code> </p> </td> <td> <p> <a class="link" href="syntax.html#quickbook.syntax.phrase.code_links" title="Code Links">function, class, member, enum, macro, concept or header links</a> </p> </td> </tr> <tr> <td> <p> header link </p> </td> <td> <p> <code class="literal">[headerref path/to/header.hpp Link text]</code> </p> </td> <td> <p> <a class="link" href="syntax.html#quickbook.syntax.phrase.code_links" title="Code Links">function, class, member, enum, macro, concept or header links</a> </p> </td> </tr> <tr> <td> <p> global link </p> </td> <td> <p> <code class="literal">[globalref fully::qualified::global Link text]</code> </p> </td> <td> <p> <a class="link" href="syntax.html#quickbook.syntax.phrase.code_links" title="Code Links">function, class, member, enum, macro, concept or header links</a> </p> </td> </tr> <tr> <td> <p> escape </p> </td> <td> <p> <code class="literal">'''escaped text (no processing/formatting)'''</code> </p> </td> <td> <p> <a class="link" href="syntax.html#quickbook.syntax.phrase.escape" title="Escape">Escape</a> </p> </td> </tr> <tr> <td> <p> single char escape </p> </td> <td> <p> <code class="literal">\c</code> </p> </td> <td> <p> <a class="link" href="syntax.html#quickbook.syntax.phrase.single_char_escape" title="Single char escape">Single char escape</a> </p> </td> </tr> <tr> <td> <p> images </p> </td> <td> <p> <code class="literal">[$image.jpg]</code> </p> </td> <td> <p> <a class="link" href="syntax.html#quickbook.syntax.phrase.images" title="Images">Images</a> </p> </td> </tr> <tr> <td> <p> begin section </p> </td> <td> <p> <code class="literal">[section The Section Title]</code> </p> </td> <td> <p> <a class="link" href="syntax.html#quickbook.syntax.block.section" title="Section">Section</a> </p> </td> </tr> <tr> <td> <p> end section </p> </td> <td> <p> <code class="literal">[endsect]</code> </p> </td> <td> <p> <a class="link" href="syntax.html#quickbook.syntax.block.section" title="Section">Section</a> </p> </td> </tr> <tr> <td> <p> paragraph </p> </td> <td> <p> No markup. Paragraphs start left-flushed and are terminated by two or more newlines. </p> </td> <td> <p> <a class="link" href="syntax.html#quickbook.syntax.block.paragraphs" title="Paragraphs">Paragraphs</a> </p> </td> </tr> <tr> <td> <p> ordered list </p> </td> <td> <p> </p> <pre class="programlisting"># one # two # three </pre> <p> </p> </td> <td> <p> <a class="link" href="syntax.html#quickbook.syntax.block.lists.ordered_lists" title="Ordered lists">Ordered lists</a> </p> </td> </tr> <tr> <td> <p> unordered list </p> </td> <td> <p> </p> <pre class="programlisting">* one * two * three </pre> <p> </p> </td> <td> <p> <a class="link" href="syntax.html#quickbook.syntax.block.lists.unordered_lists" title="Unordered lists">Unordered lists</a> </p> </td> </tr> <tr> <td> <p> code </p> </td> <td> <p> No markup. Preformatted code starts with a space or a tab. </p> </td> <td> <p> <a class="link" href="syntax.html#quickbook.syntax.block.code" title="Code">Code</a> </p> </td> </tr> <tr> <td> <p> preformatted </p> </td> <td> <p> <code class="literal">[pre preformatted]</code> </p> </td> <td> <p> <a class="link" href="syntax.html#quickbook.syntax.block.preformatted" title="Preformatted">Preformatted</a> </p> </td> </tr> <tr> <td> <p> block quote </p> </td> <td> <p> <code class="literal">[:sometext...]</code> </p> </td> <td> <p> <a class="link" href="syntax.html#quickbook.syntax.block.blockquote" title="Blockquote">Blockquote</a> </p> </td> </tr> <tr> <td> <p> heading 1 </p> </td> <td> <p> <code class="literal">[h1 Heading 1]</code> </p> </td> <td> <p> <a class="link" href="syntax.html#quickbook.syntax.block.headings" title="Headings">Heading</a> </p> </td> </tr> <tr> <td> <p> heading 2 </p> </td> <td> <p> <code class="literal">[h2 Heading 2]</code> </p> </td> <td> <p> <a class="link" href="syntax.html#quickbook.syntax.block.headings" title="Headings">Heading</a> </p> </td> </tr> <tr> <td> <p> heading 3 </p> </td> <td> <p> <code class="literal">[h3 Heading 3]</code> </p> </td> <td> <p> <a class="link" href="syntax.html#quickbook.syntax.block.headings" title="Headings">Heading</a> </p> </td> </tr> <tr> <td> <p> heading 4 </p> </td> <td> <p> <code class="literal">[h4 Heading 4]</code> </p> </td> <td> <p> <a class="link" href="syntax.html#quickbook.syntax.block.headings" title="Headings">Heading</a> </p> </td> </tr> <tr> <td> <p> heading 5 </p> </td> <td> <p> <code class="literal">[h5 Heading 5]</code> </p> </td> <td> <p> <a class="link" href="syntax.html#quickbook.syntax.block.headings" title="Headings">Heading</a> </p> </td> </tr> <tr> <td> <p> heading 6 </p> </td> <td> <p> <code class="literal">[h6 Heading 6]</code> </p> </td> <td> <p> <a class="link" href="syntax.html#quickbook.syntax.block.headings" title="Headings">Heading</a> </p> </td> </tr> <tr> <td> <p> macro </p> </td> <td> <p> <code class="literal">[def macro_identifier some text]</code> </p> </td> <td> <p> <a class="link" href="syntax.html#quickbook.syntax.block.macros" title="Macros">Macros</a> </p> </td> </tr> <tr> <td> <p> template </p> </td> <td> <p> <code class="literal">[template[a b] [a] body [b]]</code> </p> </td> <td> <p> <a class="link" href="syntax.html#quickbook.syntax.block.templates" title="Templates">Templates</a> </p> </td> </tr> <tr> <td> <p> blurb </p> </td> <td> <p> <code class="literal">[blurb advertisement or note...]</code> </p> </td> <td> <p> <a class="link" href="syntax.html#quickbook.syntax.block.blurbs" title="Blurbs">Blurbs</a> </p> </td> </tr> <tr> <td> <p> admonition </p> </td> <td> <p> <code class="literal">[warning Warning text...]</code> </p> </td> <td> <p> <a class="link" href="syntax.html#quickbook.syntax.block.admonitions" title="Admonitions">Admonitions</a> </p> </td> </tr> <tr> <td> <p> table </p> </td> <td> <p> </p> <pre class="programlisting">[table Title [[a][b][c]] [[a][b][c]] ] </pre> <p> </p> </td> <td> <p> <a class="link" href="syntax.html#quickbook.syntax.block.tables" title="Tables">Tables</a> </p> </td> </tr> <tr> <td> <p> variablelist </p> </td> <td> <p> </p> <pre class="programlisting">[variablelist Title [[a][b]] [[a][b]] ] </pre> <p> </p> </td> <td> <p> <a class="link" href="syntax.html#quickbook.syntax.block.variable_lists" title="Variable Lists">Variable Lists</a> </p> </td> </tr> <tr> <td> <p> include </p> </td> <td> <p> <code class="literal">[include someother.qbk]</code> </p> </td> <td> <p> <a class="link" href="syntax.html#quickbook.syntax.block.include" title="Include">Include</a> </p> </td> </tr> <tr> <td> <p> conditional generation </p> </td> <td> <p> <code class="literal">[? symbol phrase]</code> </p> </td> <td> <p> <a class="link" href="syntax.html#quickbook.syntax.phrase.cond" title="Conditional Generation">Conditional Generation</a> </p> </td> </tr> </tbody> </table></div> </div> <br class="table-break"> </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="faq.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="../jam.html"><img src="../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html>