add headerref to link to header Doxygen entities (uses <headername> BoostBook tag)
[SVN r26943]
This commit is contained in:
Eric Niebler
parent
84c14dd517
commit
ca10e3b8b1
@ -557,6 +557,8 @@ namespace quickbook
|
||||
const char* memberref_post_ = "</methodname>";
|
||||
const char* enumref_pre_ = "<enumname alt=\"";
|
||||
const char* enumref_post_ = "</enumname>";
|
||||
const char* headerref_pre_ = "<headername alt=\"";
|
||||
const char* headerref_post_ = "</headername>";
|
||||
}
|
||||
|
||||
struct raw_char_action
|
||||
|
||||
@ -68,6 +68,8 @@ namespace quickbook
|
||||
, memberref_post(phrase, memberref_post_)
|
||||
, enumref_pre(phrase, enumref_pre_)
|
||||
, enumref_post(phrase, enumref_post_)
|
||||
, headerref_pre(phrase, headerref_pre_)
|
||||
, headerref_post(phrase, headerref_post_)
|
||||
, bold_pre(phrase, bold_pre_)
|
||||
, bold_post(phrase, bold_post_)
|
||||
, italic_pre(phrase, italic_pre_)
|
||||
@ -179,6 +181,8 @@ namespace quickbook
|
||||
markup_action memberref_post;
|
||||
link_action enumref_pre;
|
||||
markup_action enumref_post;
|
||||
link_action headerref_pre;
|
||||
markup_action headerref_post;
|
||||
|
||||
markup_action bold_pre;
|
||||
markup_action bold_post;
|
||||
|
||||
@ -30,7 +30,7 @@
|
||||
</h3></div></div>
|
||||
<div><p class="copyright">Copyright © 2002, 2004 Joel de Guzman, Eric Niebler</p></div>
|
||||
<div><div class="legalnotice">
|
||||
<a name="id374150"></a><p>
|
||||
<a name="id4748485"></a><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">
|
||||
@ -91,7 +91,7 @@ CSS support
|
||||
</div>
|
||||
</div>
|
||||
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
|
||||
<td align="left"><small><p>Last revised: January 21, 2005 at 06:19:27 GMT</p></small></td>
|
||||
<td align="left"><small><p>Last revised: January 26, 2005 at 19:17:23 GMT</p></small></td>
|
||||
<td align="right"><small></small></td>
|
||||
</tr></table>
|
||||
<hr>
|
||||
|
||||
@ -417,6 +417,7 @@ phrase_markup</span><span class="special"> =</span><span class="char">
|
||||
|</span><span class="identifier"> classref</span><span class="special">
|
||||
|</span><span class="identifier"> memberref</span><span class="special">
|
||||
|</span><span class="identifier"> enumref</span><span class="special">
|
||||
|</span><span class="identifier"> headerref</span><span class="special">
|
||||
|</span><span class="identifier"> bold</span><span class="special">
|
||||
|</span><span class="identifier"> italic</span><span class="special">
|
||||
|</span><span class="identifier"> underline</span><span class="special">
|
||||
@ -504,6 +505,15 @@ enumref</span><span class="special"> =</span><span class="string">
|
||||
)</span><span class="special">
|
||||
;</span><span class="identifier">
|
||||
|
||||
headerref</span><span class="special"> =</span><span class="string">
|
||||
"headerref"</span><span class="special"> >></span><span class="identifier"> hard_space</span><span class="special">
|
||||
>></span><span class="special"> (*(</span><span class="identifier">anychar_p</span><span class="special"> -</span><span class="special">
|
||||
(</span><span class="char">']'</span><span class="special"> |</span><span class="identifier"> hard_space</span><span class="special">)))</span><span class="special">
|
||||
>></span><span class="special"> (</span><span class="identifier"> eps_p</span><span class="special">(</span><span class="char">']'</span><span class="special">)</span><span class="special">
|
||||
|</span><span class="special"> (</span><span class="identifier">hard_space</span><span class="special"> >></span><span class="identifier"> phrase</span><span class="special">)</span><span class="special">
|
||||
)</span><span class="special">
|
||||
;</span><span class="identifier">
|
||||
|
||||
bold</span><span class="special"> =</span><span class="identifier">
|
||||
ch_p</span><span class="special">(</span><span class="char">'*'</span><span class="special">)</span><span class="special">
|
||||
>></span><span class="identifier"> blank</span><span class="special"> >></span><span class="identifier"> phrase</span><span class="special">
|
||||
|
||||
@ -27,7 +27,7 @@
|
||||
<a name="quickbook.ref"></a> Quick Reference</h2></div></div></div>
|
||||
<div class="informaltable">
|
||||
<h4>
|
||||
<a name="id444390"></a><span class="table-title">Syntax Compendium</span>
|
||||
<a name="id4812256"></a><span class="table-title">Syntax Compendium</span>
|
||||
</h4>
|
||||
<table class="table">
|
||||
<colgroup>
|
||||
@ -110,6 +110,10 @@
|
||||
<td><tt class="literal">[enumref fully::qualified::enum_name Link text]</tt></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>header link</td>
|
||||
<td><tt class="literal">[headerref path/to/header.hpp Link text]</tt></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>escape</td>
|
||||
<td><tt class="literal">'''escaped text (no processing/formatting)'''</tt></td>
|
||||
</tr>
|
||||
|
||||
@ -40,15 +40,15 @@ Phrases in each block cannot contain a block terminator. This way, syntax errors
|
||||
such as un-matched closing brackets do not go haywire and corrupt anything past
|
||||
a single block.</p>
|
||||
<a name="syntax.comments"></a><h2>
|
||||
<a name="id373011"></a>Comments</h2>
|
||||
<a name="id4747517"></a>Comments</h2>
|
||||
<p>
|
||||
Can be placed anywhere.</p>
|
||||
<pre class="programlisting"><tt class="literal">[/ comment (no output generated) ]
|
||||
</tt></pre>
|
||||
<a name="syntax.phrase_level_elements"></a><h2>
|
||||
<a name="id373031"></a>Phrase Level Elements</h2>
|
||||
<a name="id4747539"></a>Phrase Level Elements</h2>
|
||||
<a name="syntax.font_styles"></a><h3>
|
||||
<a name="id373042"></a>Font Styles</h3>
|
||||
<a name="id4747549"></a>Font Styles</h3>
|
||||
<pre class="programlisting"><tt class="literal">['italic], [*bold], [_underline], [^teletype]
|
||||
</tt></pre>
|
||||
<p>
|
||||
@ -62,7 +62,7 @@ Like all non-terminal phrase level elements, this can of course be nested:</p>
|
||||
will generate:</p>
|
||||
<p><span class="bold"><b><span class="emphasis"><em>bold-italic</em></span></b></span></p>
|
||||
<a name="syntax.simple_formatting"></a><h3>
|
||||
<a name="id371768"></a>Simple formatting</h3>
|
||||
<a name="id4747612"></a>Simple formatting</h3>
|
||||
<p>
|
||||
Simple markup for formatting text, common in many applications, is now supported:</p>
|
||||
<pre class="programlisting"><tt class="literal">/italic/, *bold*, _underline_, =teletype=
|
||||
@ -100,7 +100,7 @@ A line starting with the star will be interpreted as an unordered list.
|
||||
</ul></div>
|
||||
<div class="informaltable">
|
||||
<h4>
|
||||
<a name="id371958"></a><span class="table-title">More Formatting Samples</span>
|
||||
<a name="id4747693"></a><span class="table-title">More Formatting Samples</span>
|
||||
</h4>
|
||||
<table class="table">
|
||||
<colgroup>
|
||||
@ -181,7 +181,7 @@ and teaching me these obscure formatting rules. I wasn't sure at all if <a href=
|
||||
being more or less a formal EBNF parser, can handle the context sensitivity and ambiguity.</td></tr></tbody>
|
||||
</table></div>
|
||||
<a name="syntax.inline_code"></a><h3>
|
||||
<a name="id372692"></a>Inline code</h3>
|
||||
<a name="id4746884"></a>Inline code</h3>
|
||||
<p>
|
||||
Inlining code in paragraphs is quite common when writing C++ documentation. We
|
||||
provide a very simple markup for this. For example, this:</p>
|
||||
@ -202,7 +202,7 @@ single quote: <tt class="computeroutput"><span class="string">"'"</span></tt>. N
|
||||
</td></tr></tbody>
|
||||
</table></div>
|
||||
<a name="syntax.source_mode"></a><h3>
|
||||
<a name="id372818"></a>Source Mode</h3>
|
||||
<a name="id4747000"></a>Source Mode</h3>
|
||||
<p>
|
||||
If a document contains more than one type of source code then the source mode
|
||||
may be changed dynamically as the document is processed. All QuickBook
|
||||
@ -223,7 +223,7 @@ C++ comment <tt class="computeroutput"><span class="comment">// looks like this<
|
||||
<tt class="computeroutput"><span class="comment">#looks like this</span></tt>.</p>
|
||||
<div class="informaltable">
|
||||
<h4>
|
||||
<a name="id372918"></a><span class="table-title">Supported Source Modes</span>
|
||||
<a name="id4747091"></a><span class="table-title">Supported Source Modes</span>
|
||||
</h4>
|
||||
<table class="table">
|
||||
<colgroup>
|
||||
@ -252,7 +252,7 @@ C++ comment <tt class="computeroutput"><span class="comment">// looks like this<
|
||||
<span class="inlinemediaobject"><img src="../images/note.png"></span> The source mode strings are lowercase.</td></tr></tbody>
|
||||
</table></div>
|
||||
<a name="syntax.line_break"></a><h3>
|
||||
<a name="id372987"></a>line-break</h3>
|
||||
<a name="id4747153"></a>line-break</h3>
|
||||
<pre class="programlisting"><tt class="literal">[br]
|
||||
</tt></pre>
|
||||
<div class="informaltable"><table class="table">
|
||||
@ -261,7 +261,7 @@ C++ comment <tt class="computeroutput"><span class="comment">// looks like this<
|
||||
<span class="inlinemediaobject"><img src="../images/note.png"></span> Note that <tt class="computeroutput"><span class="special">\</span><span class="identifier">n</span></tt> is now preferred over <tt class="computeroutput"><span class="special">[</span><span class="identifier">br</span><span class="special">]</span></tt>.</td></tr></tbody>
|
||||
</table></div>
|
||||
<a name="syntax.anchors"></a><h3>
|
||||
<a name="id442370"></a>Anchors</h3>
|
||||
<a name="id4810232"></a>Anchors</h3>
|
||||
<pre class="programlisting"><tt class="literal">[#named_anchor]
|
||||
</tt></pre>
|
||||
<p>
|
||||
@ -270,7 +270,7 @@ document. You can then reference an anchor with <tt class="literal">[link named_
|
||||
More on anchors <a href="syntax.html#syntax.anchor_links">here</a>, <a href="syntax.html#syntax.section">here</a> and
|
||||
<a href="syntax.html#syntax.headings">here</a>.</p>
|
||||
<a name="syntax.links"></a><h3>
|
||||
<a name="id442429"></a>Links</h3>
|
||||
<a name="id4810285"></a>Links</h3>
|
||||
<pre class="programlisting"><tt class="literal">[@http://www.boost.org this is [*boost's] website....]
|
||||
</tt></pre>
|
||||
<p>
|
||||
@ -289,7 +289,7 @@ will generate:</p>
|
||||
<p>
|
||||
see <a href="http://spirit.sourceforge.net/" target="_top">http://spirit.sourceforge.net/</a></p>
|
||||
<a name="syntax.anchor_links"></a><h3>
|
||||
<a name="id442500"></a>Anchor links</h3>
|
||||
<a name="id4810353"></a>Anchor links</h3>
|
||||
<p>
|
||||
You can link within a document using:</p>
|
||||
<pre class="programlisting"><tt class="literal">[link section_id.normalized_header_text The link text]
|
||||
@ -298,7 +298,7 @@ You can link within a document using:</p>
|
||||
See sections <a href="syntax.html#syntax.section">Section</a> and <a href="syntax.html#syntax.headings">Headings</a>
|
||||
for more info.</p>
|
||||
<a name="syntax.refentry_links"></a><h3>
|
||||
<a name="id442543"></a>refentry links</h3>
|
||||
<a name="id4810392"></a>refentry links</h3>
|
||||
<p>
|
||||
In addition, you can link internally to an XML refentry like:</p>
|
||||
<pre class="programlisting"><tt class="literal">[link xml.refentry The link text]
|
||||
@ -312,15 +312,16 @@ automatically be the refentry. Example:</p>
|
||||
</tt></pre>
|
||||
<p>
|
||||
This gets converted into <tt class="literal"><link linkend="xml.refentry">xml.refentry</link></tt>.</p>
|
||||
<a name="syntax.function__class_or_member_links"></a><h3>
|
||||
<a name="id442601"></a>function, class or member links</h3>
|
||||
<a name="syntax.function__class__member__enum_or_header_links"></a><h3>
|
||||
<a name="id4810443"></a>function, class, member, enum or header links</h3>
|
||||
<p>
|
||||
If you want to link to a function, class, member or enum in the reference section, you
|
||||
can use:</p>
|
||||
If you want to link to a function, class, member, enum or header in the reference
|
||||
section, you can use:</p>
|
||||
<pre class="programlisting"><tt class="literal">[funcref fully::qualified::function_name The link text]
|
||||
[classref fully::qualified::class_name The link text]
|
||||
[memberref fully::qualified::member_name The link text]
|
||||
[enumref fully::qualified::enum_name The link text]
|
||||
[headerref path/to/header.hpp The link text]
|
||||
</tt></pre>
|
||||
<p>
|
||||
Again, the link text is optional. If this is not present, the link text will
|
||||
@ -330,7 +331,7 @@ automatically be the function, class, member or enum. Example:</p>
|
||||
<p>
|
||||
would have "boost::bar::baz" as the link text.</p>
|
||||
<a name="syntax.escape"></a><h3>
|
||||
<a name="id442644"></a>Escape</h3>
|
||||
<a name="id4810489"></a>Escape</h3>
|
||||
<p>
|
||||
The escape mark-up is used when we don't want to do any processing.</p>
|
||||
<pre class="programlisting"><tt class="literal">'''
|
||||
@ -351,7 +352,7 @@ Escaping allows us to pass XML markup to <a href="http://www.boost.org/doc/html/
|
||||
<a href="http://www.boost.org/doc/html/boostbook.html" target="_top">BoostBook</a>/<a href="http://www.docbook.org/" target="_top">DocBook</a> syntax.</td></tr></tbody>
|
||||
</table></div>
|
||||
<a name="syntax.single_char_escape"></a><h3>
|
||||
<a name="id442736"></a>Single char escape</h3>
|
||||
<a name="id4810575"></a>Single char escape</h3>
|
||||
<p>
|
||||
The backslash may be used to escape a single punctuation character. The
|
||||
punctuation immediately after the backslash is passed without any processing.
|
||||
@ -360,13 +361,13 @@ For example, how do you escape the triple quote? Simple: <tt class="literal">\'\
|
||||
<p><tt class="computeroutput"><span class="special">\</span><span class="identifier">n</span></tt> has a special meaning. It is used to generate line breaks. Note that <tt class="computeroutput"><span class="special">\</span><span class="identifier">n</span></tt>
|
||||
is now preferred over <tt class="computeroutput"><span class="special">[</span><span class="identifier">br</span><span class="special">]</span></tt>.</p>
|
||||
<a name="syntax.images__terminal_"></a><h3>
|
||||
<a name="id442829"></a>Images (terminal)</h3>
|
||||
<a name="id4810662"></a>Images (terminal)</h3>
|
||||
<pre class="programlisting"><tt class="literal">[$image.jpg]
|
||||
</tt></pre>
|
||||
<a name="syntax.block_level_elements"></a><h2>
|
||||
<a name="id442847"></a>Block Level Elements</h2>
|
||||
<a name="id4810680"></a>Block Level Elements</h2>
|
||||
<a name="syntax.document"></a><h3>
|
||||
<a name="id442858"></a>Document</h3>
|
||||
<a name="id4810690"></a>Document</h3>
|
||||
<p>
|
||||
Every document must begin with a Document Info section, which should look
|
||||
like this:</p>
|
||||
@ -410,7 +411,7 @@ Here <tt class="literal">source-type</tt> is a lowercase string setting the init
|
||||
<a href="syntax.html#syntax.source_mode">source mode</a>. If the <tt class="literal">source-mode</tt> field is omitted, a
|
||||
default value of <tt class="literal">c++</tt> will be used.</p>
|
||||
<a name="syntax.section"></a><h3>
|
||||
<a name="id443004"></a>Section</h3>
|
||||
<a name="id4746589"></a>Section</h3>
|
||||
<p>
|
||||
Starting a new section is accomplished with:</p>
|
||||
<pre class="programlisting"><tt class="literal">[section:id The Section Title]
|
||||
@ -428,7 +429,7 @@ End a section with:</p>
|
||||
<p>
|
||||
Sections can nest, and that results in a hierarchy in the table of contents.</p>
|
||||
<a name="syntax.xinclude"></a><h3>
|
||||
<a name="id443079"></a>xinclude</h3>
|
||||
<a name="id4811030"></a>xinclude</h3>
|
||||
<p>
|
||||
You can include another XML file with:</p>
|
||||
<pre class="programlisting"><tt class="literal">[xinclude file.xml]
|
||||
@ -437,13 +438,13 @@ You can include another XML file with:</p>
|
||||
This is useful when file.xml has been generated by Doxygen and contains your
|
||||
reference section.</p>
|
||||
<a name="syntax.paragraphs"></a><h3>
|
||||
<a name="id443106"></a>Paragraphs</h3>
|
||||
<a name="id4811055"></a>Paragraphs</h3>
|
||||
<p>
|
||||
Paragraphs start left-flushed and are terminated by two or more newlines. No
|
||||
markup is needed for paragraphs. QuickBook automatically detects paragraphs from
|
||||
the context.</p>
|
||||
<a name="syntax.ordered_lists"></a><h3>
|
||||
<a name="id443122"></a>Ordered lists</h3>
|
||||
<a name="id4811070"></a>Ordered lists</h3>
|
||||
<pre class="programlisting"><tt class="literal"># One
|
||||
# Two
|
||||
# Three
|
||||
@ -541,7 +542,7 @@ A short item.
|
||||
</li>
|
||||
</ol></div>
|
||||
<a name="syntax.unordered_lists"></a><h3>
|
||||
<a name="id443263"></a>Unordered lists</h3>
|
||||
<a name="id4811208"></a>Unordered lists</h3>
|
||||
<pre class="programlisting"><tt class="literal">* First
|
||||
* Second
|
||||
* Third
|
||||
@ -592,7 +593,7 @@ Three.c
|
||||
</li>
|
||||
</ol></div>
|
||||
<a name="syntax.code"></a><h3>
|
||||
<a name="id443333"></a>Code</h3>
|
||||
<a name="id4811272"></a>Code</h3>
|
||||
<p>
|
||||
Preformatted code starts with a space or a tab. The code will be
|
||||
syntax highlighted according to the current <a href="syntax.html#syntax.source_mode">source mode</a>:</p>
|
||||
@ -623,7 +624,7 @@ Macros that are already defined are expanded in source code. Example:</p>
|
||||
Generates:</p>
|
||||
<pre class="programlisting"><tt class="literal"><span class="identifier">using</span><span class="identifier"> __quickbook__</span><span class="special">::</span><span class="identifier">__syntax_highlight__</span><span class="special">;</span></tt></pre>
|
||||
<a name="syntax.preformatted"></a><h3>
|
||||
<a name="id443597"></a>Preformatted</h3>
|
||||
<a name="id4811512"></a>Preformatted</h3>
|
||||
<p>
|
||||
Sometimes, you don't want some preformatted text to be parsed as C++. In such
|
||||
cases, use the <tt class="literal">[pre ... ]</tt> markup block.</p>
|
||||
@ -652,12 +653,12 @@ markup above will generate:</p>
|
||||
Notice that unlike Code, phrase markup such as font style is still permitted
|
||||
inside <tt class="literal">pre</tt> blocks.</p>
|
||||
<a name="syntax.blockquote"></a><h3>
|
||||
<a name="id443696"></a>Blockquote</h3>
|
||||
<a name="id4811604"></a>Blockquote</h3>
|
||||
<pre class="programlisting"><tt class="literal">[:sometext...]
|
||||
</tt></pre>
|
||||
<div class="blockquote"><blockquote class="blockquote"><p>Indents the paragraph. This applies to one paragraph only.</p></blockquote></div>
|
||||
<a name="syntax.headings"></a><h3>
|
||||
<a name="id443720"></a>Headings</h3>
|
||||
<a name="id4811626"></a>Headings</h3>
|
||||
<pre class="programlisting"><tt class="literal">[h1 Heading 1]
|
||||
[h2 Heading 2]
|
||||
[h3 Heading 3]
|
||||
@ -666,17 +667,17 @@ inside <tt class="literal">pre</tt> blocks.</p>
|
||||
[h6 Heading 6]
|
||||
</tt></pre>
|
||||
<a name="syntax.heading_1"></a><h1>
|
||||
<a name="id443741"></a>Heading 1</h1>
|
||||
<a name="id4811645"></a>Heading 1</h1>
|
||||
<a name="syntax.heading_2"></a><h2>
|
||||
<a name="id443753"></a>Heading 2</h2>
|
||||
<a name="id4811655"></a>Heading 2</h2>
|
||||
<a name="syntax.heading_3"></a><h3>
|
||||
<a name="id443763"></a>Heading 3</h3>
|
||||
<a name="id4811664"></a>Heading 3</h3>
|
||||
<a name="syntax.heading_4"></a><h4>
|
||||
<a name="id443774"></a>Heading 4</h4>
|
||||
<a name="id4811674"></a>Heading 4</h4>
|
||||
<a name="syntax.heading_5"></a><h5>
|
||||
<a name="id443785"></a>Heading 5</h5>
|
||||
<a name="id4811683"></a>Heading 5</h5>
|
||||
<a name="syntax.heading_6"></a><h3>
|
||||
<a name="id443796"></a>Heading 6</h3>
|
||||
<a name="id4811692"></a>Heading 6</h3>
|
||||
<p>
|
||||
Headings 1-3 [h1 h2 and h3] will automatically have anchors with normalized
|
||||
names with <tt class="literal">name="section_id.normalized_header_text"</tt> (i.e. valid characters are
|
||||
@ -689,7 +690,7 @@ and all upper-case are converted to lower-case. For example: Heading
|
||||
to link to them. See <a href="syntax.html#syntax.anchor_links">Anchor links</a> and
|
||||
<a href="syntax.html#syntax.section">Section</a> for more info.</p>
|
||||
<a name="syntax.macros"></a><h3>
|
||||
<a name="id443880"></a>Macros</h3>
|
||||
<a name="id4811770"></a>Macros</h3>
|
||||
<pre class="programlisting"><tt class="literal">[def macro_identifier some text]
|
||||
</tt></pre>
|
||||
<p>
|
||||
@ -732,12 +733,12 @@ will generate this:</p>
|
||||
<p>
|
||||
Hi <a href="http://spirit.sourceforge.net" target="_top">Spirit</a><span class="inlinemediaobject"><img src="../images/smiley.png"></span></p>
|
||||
<a name="syntax.predefined_macros"></a><h3>
|
||||
<a name="id444053"></a>Predefined Macros</h3>
|
||||
<a name="id4811933"></a>Predefined Macros</h3>
|
||||
<p>
|
||||
Quickbook has some predefined macros that you can already use.</p>
|
||||
<div class="informaltable">
|
||||
<h4>
|
||||
<a name="id444066"></a><span class="table-title">Predefined Macros</span>
|
||||
<a name="id4811944"></a><span class="table-title">Predefined Macros</span>
|
||||
</h4>
|
||||
<table class="table">
|
||||
<colgroup>
|
||||
@ -754,12 +755,12 @@ Quickbook has some predefined macros that you can already use.</p>
|
||||
<tr>
|
||||
<td>__DATE__</td>
|
||||
<td>Today's date</td>
|
||||
<td>2005-Jan-26</td>
|
||||
<td>2005-Jan-30</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>__TIME__</td>
|
||||
<td>The current time</td>
|
||||
<td>10:59:00 AM</td>
|
||||
<td>02:48:36 PM</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>__FILENAME__</td>
|
||||
@ -770,7 +771,7 @@ Quickbook has some predefined macros that you can already use.</p>
|
||||
</table>
|
||||
</div>
|
||||
<a name="syntax.blurbs"></a><h3>
|
||||
<a name="id444124"></a>Blurbs</h3>
|
||||
<a name="id4811996"></a>Blurbs</h3>
|
||||
<pre class="programlisting"><tt class="literal">[blurb :-) [*An eye catching advertisement or note...]\n\n
|
||||
__spirit__ is an object-oriented recursive-descent parser generator framework
|
||||
implemented using template meta-programming techniques. Expression templates
|
||||
@ -790,7 +791,7 @@ will generate this:</p>
|
||||
</td></tr></tbody>
|
||||
</table></div>
|
||||
<a name="syntax.tables"></a><h3>
|
||||
<a name="id444183"></a>Tables</h3>
|
||||
<a name="id4812056"></a>Tables</h3>
|
||||
<pre class="programlisting"><tt class="literal">[table A Simple Table
|
||||
[[Heading 1] [Heading 2] [Heading 3]]
|
||||
[[R0-C0] [R0-C1] [R0-C2]]
|
||||
@ -802,7 +803,7 @@ will generate this:</p>
|
||||
will generate:</p>
|
||||
<div class="informaltable">
|
||||
<h4>
|
||||
<a name="id444205"></a><span class="table-title">A Simple Table</span>
|
||||
<a name="id4812077"></a><span class="table-title">A Simple Table</span>
|
||||
</h4>
|
||||
<table class="table">
|
||||
<colgroup>
|
||||
@ -860,7 +861,7 @@ cells to be formatted nicely. Example:</p>
|
||||
and thus:</p>
|
||||
<div class="informaltable">
|
||||
<h4>
|
||||
<a name="id444286"></a><span class="table-title">Table with fat cells</span>
|
||||
<a name="id4812158"></a><span class="table-title">Table with fat cells</span>
|
||||
</h4>
|
||||
<table class="table">
|
||||
<colgroup>
|
||||
@ -889,7 +890,7 @@ and thus:</p>
|
||||
</table>
|
||||
</div>
|
||||
<a name="syntax.variable_lists"></a><h3>
|
||||
<a name="id444330"></a>Variable Lists</h3>
|
||||
<a name="id4812199"></a>Variable Lists</h3>
|
||||
<pre class="programlisting"><tt class="literal">[variablelist A Variable List
|
||||
[[term 1] [The definition of term 1]]
|
||||
[[term 2] [The definition of term 2]]
|
||||
|
||||
@ -283,16 +283,17 @@ automatically be the refentry. Example:
|
||||
|
||||
This gets converted into [^<link linkend="xml.refentry">xml.refentry</link>].
|
||||
|
||||
[h3 function, class or member links]
|
||||
[h3 function, class, member, enum or header links]
|
||||
|
||||
If you want to link to a function, class, member or enum in the reference section, you
|
||||
can use:
|
||||
If you want to link to a function, class, member, enum or header in the reference
|
||||
section, you can use:
|
||||
|
||||
[pre'''
|
||||
[funcref fully::qualified::function_name The link text]
|
||||
[classref fully::qualified::class_name The link text]
|
||||
[memberref fully::qualified::member_name The link text]
|
||||
[enumref fully::qualified::enum_name The link text]
|
||||
[headerref path/to/header.hpp The link text]
|
||||
''']
|
||||
|
||||
Again, the link text is optional. If this is not present, the link text will
|
||||
@ -822,6 +823,7 @@ will recognize this as a "definition list".
|
||||
[[class link] [[^'''[classref fully::qualified::class_name Link text]''']]]
|
||||
[[member link] [[^'''[memberref fully::qualified::member_name Link text]''']]]
|
||||
[[enum link] [[^'''[enumref fully::qualified::enum_name Link text]''']]]
|
||||
[[header link] [[^'''[headerref path/to/header.hpp Link text]''']]]
|
||||
[[escape] [[^\'\'\'escaped text (no processing/formatting)\'\'\']]]
|
||||
[[single char escape] [[^\\c]]]
|
||||
[[images] [[^'''[$image.jpg]''']]]
|
||||
@ -1373,6 +1375,7 @@ will recognize this as a "definition list".
|
||||
| classref
|
||||
| memberref
|
||||
| enumref
|
||||
| headerref
|
||||
| bold
|
||||
| italic
|
||||
| underline
|
||||
@ -1460,6 +1463,15 @@ will recognize this as a "definition list".
|
||||
)
|
||||
;
|
||||
|
||||
headerref =
|
||||
"headerref" >> hard_space
|
||||
>> (*(anychar_p -
|
||||
(']' | hard_space)))
|
||||
>> ( eps_p(']')
|
||||
| (hard_space >> phrase)
|
||||
)
|
||||
;
|
||||
|
||||
bold =
|
||||
ch_p('*')
|
||||
>> blank >> phrase
|
||||
|
||||
@ -295,13 +295,14 @@ automatically be the refentry. Example:</para>
|
||||
<programlisting><literal>[link xml.refentry]
|
||||
</literal></programlisting><para>
|
||||
This gets converted into <literal><link linkend="xml.refentry">xml.refentry</link></literal>.</para>
|
||||
<anchor id="syntax.function__class_or_member_links" /><bridgehead renderas="sect3">function, class or member links</bridgehead><para>
|
||||
If you want to link to a function, class, member or enum in the reference section, you
|
||||
can use:</para>
|
||||
<anchor id="syntax.function__class__member__enum_or_header_links" /><bridgehead renderas="sect3">function, class, member, enum or header links</bridgehead><para>
|
||||
If you want to link to a function, class, member, enum or header in the reference
|
||||
section, you can use:</para>
|
||||
<programlisting><literal>[funcref fully::qualified::function_name The link text]
|
||||
[classref fully::qualified::class_name The link text]
|
||||
[memberref fully::qualified::member_name The link text]
|
||||
[enumref fully::qualified::enum_name The link text]
|
||||
[headerref path/to/header.hpp The link text]
|
||||
</literal></programlisting><para>
|
||||
Again, the link text is optional. If this is not present, the link text will
|
||||
automatically be the function, class, member or enum. Example:</para>
|
||||
@ -654,8 +655,8 @@ Quickbook has some predefined macros that you can already use.</para>
|
||||
<thead><row><entry>Macro</entry><entry>Meaning</entry><entry>Example</entry></row>
|
||||
</thead>
|
||||
<tbody>
|
||||
<row><entry>__DATE__</entry><entry>Today's date</entry><entry>2005-Jan-26</entry></row>
|
||||
<row><entry>__TIME__</entry><entry>The current time</entry><entry>10:59:00 AM</entry></row>
|
||||
<row><entry>__DATE__</entry><entry>Today's date</entry><entry>2005-Jan-30</entry></row>
|
||||
<row><entry>__TIME__</entry><entry>The current time</entry><entry>02:48:36 PM</entry></row>
|
||||
<row><entry>__FILENAME__</entry><entry>Quickbook source filename</entry><entry>quickbook.qbk</entry></row>
|
||||
</tbody>
|
||||
</tgroup>
|
||||
@ -789,6 +790,7 @@ will recognize this as a "definition list".</para>
|
||||
<row><entry>class link</entry><entry><literal>[classref fully::qualified::class_name Link text]</literal></entry></row>
|
||||
<row><entry>member link</entry><entry><literal>[memberref fully::qualified::member_name Link text]</literal></entry></row>
|
||||
<row><entry>enum link</entry><entry><literal>[enumref fully::qualified::enum_name Link text]</literal></entry></row>
|
||||
<row><entry>header link</entry><entry><literal>[headerref path/to/header.hpp Link text]</literal></entry></row>
|
||||
<row><entry>escape</entry><entry><literal>'''escaped text (no processing/formatting)'''</literal></entry></row>
|
||||
<row><entry>single char escape</entry><entry><literal>\c</literal></entry></row>
|
||||
<row><entry>images</entry><entry><literal>[$image.jpg]</literal></entry></row>
|
||||
@ -1358,6 +1360,7 @@ phrase_markup</phrase><phrase role="special"> =</phrase><phrase role="char">
|
||||
|</phrase><phrase role="identifier"> classref</phrase><phrase role="special">
|
||||
|</phrase><phrase role="identifier"> memberref</phrase><phrase role="special">
|
||||
|</phrase><phrase role="identifier"> enumref</phrase><phrase role="special">
|
||||
|</phrase><phrase role="identifier"> headerref</phrase><phrase role="special">
|
||||
|</phrase><phrase role="identifier"> bold</phrase><phrase role="special">
|
||||
|</phrase><phrase role="identifier"> italic</phrase><phrase role="special">
|
||||
|</phrase><phrase role="identifier"> underline</phrase><phrase role="special">
|
||||
@ -1445,6 +1448,15 @@ enumref</phrase><phrase role="special"> =</phrase><phrase role="string">
|
||||
)</phrase><phrase role="special">
|
||||
;</phrase><phrase role="identifier">
|
||||
|
||||
headerref</phrase><phrase role="special"> =</phrase><phrase role="string">
|
||||
"headerref"</phrase><phrase role="special"> >></phrase><phrase role="identifier"> hard_space</phrase><phrase role="special">
|
||||
>></phrase><phrase role="special"> (*(</phrase><phrase role="identifier">anychar_p</phrase><phrase role="special"> -</phrase><phrase role="special">
|
||||
(</phrase><phrase role="char">']'</phrase><phrase role="special"> |</phrase><phrase role="identifier"> hard_space</phrase><phrase role="special">)))</phrase><phrase role="special">
|
||||
>></phrase><phrase role="special"> (</phrase><phrase role="identifier"> eps_p</phrase><phrase role="special">(</phrase><phrase role="char">']'</phrase><phrase role="special">)</phrase><phrase role="special">
|
||||
|</phrase><phrase role="special"> (</phrase><phrase role="identifier">hard_space</phrase><phrase role="special"> >></phrase><phrase role="identifier"> phrase</phrase><phrase role="special">)</phrase><phrase role="special">
|
||||
)</phrase><phrase role="special">
|
||||
;</phrase><phrase role="identifier">
|
||||
|
||||
bold</phrase><phrase role="special"> =</phrase><phrase role="identifier">
|
||||
ch_p</phrase><phrase role="special">(</phrase><phrase role="char">'*'</phrase><phrase role="special">)</phrase><phrase role="special">
|
||||
>></phrase><phrase role="identifier"> blank</phrase><phrase role="special"> >></phrase><phrase role="identifier"> phrase</phrase><phrase role="special">
|
||||
|
||||
@ -428,6 +428,7 @@ namespace quickbook
|
||||
| classref
|
||||
| memberref
|
||||
| enumref
|
||||
| headerref
|
||||
| bold
|
||||
| italic
|
||||
| underline
|
||||
@ -515,6 +516,15 @@ namespace quickbook
|
||||
) [self.actions.enumref_post]
|
||||
;
|
||||
|
||||
headerref =
|
||||
"headerref" >> hard_space
|
||||
>> (*(anychar_p -
|
||||
(']' | hard_space))) [self.actions.headerref_pre]
|
||||
>> ( eps_p(']')
|
||||
| (hard_space >> phrase)
|
||||
) [self.actions.headerref_post]
|
||||
;
|
||||
|
||||
bold =
|
||||
ch_p('*') [self.actions.bold_pre]
|
||||
>> blank >> phrase [self.actions.bold_post]
|
||||
@ -546,7 +556,7 @@ namespace quickbook
|
||||
escape, def_macro, identifier, url, table, table_row,
|
||||
variablelist, varlistentry, varlistterm, varlistitem,
|
||||
table_cell, preformatted, list_item, common,
|
||||
funcref, classref, memberref, enumref, anchor, link,
|
||||
funcref, classref, memberref, enumref, headerref, anchor, link,
|
||||
begin_section, end_section, xinclude, hard_space, eol,
|
||||
inline_code, simple_format, simple_bold, simple_italic,
|
||||
simple_underline, simple_teletype;
|
||||
|
||||
Loading…
Reference in New Issue
Block a user