Update of /cvsroot/boost/boost/tools/quickbook/doc/html/quickbook/syntax
In directory
sc8-pr-cvs3.sourceforge.net:/tmp/cvs-serv15575/doc/html/quickbook/syntax
Modified Files:
block.html phrase.html
Log Message:
added callouts
Index: block.html
===================================================================
RCS file:
/cvsroot/boost/boost/tools/quickbook/doc/html/quickbook/syntax/block.html,v
retrieving revision 1.36
retrieving revision 1.37
diff -u -d -r1.36 -r1.37
--- block.html 25 Dec 2006 00:34:00 -0000 1.36
+++ block.html 21 Feb 2007 00:48:29 -0000 1.37
@@ -635,27 +635,27 @@
[h6 Heading 6]
</pre>
<a name="quickbook.syntax.block.headings.heading_1"></a><h1>
-<a name="id450863"></a>
+<a name="id456618"></a>
<a
href="block.html#quickbook.syntax.block.headings.heading_1">Heading 1</a>
</h1>
<a name="quickbook.syntax.block.headings.heading_2"></a><h2>
-<a name="id450888"></a>
+<a name="id456642"></a>
<a
href="block.html#quickbook.syntax.block.headings.heading_2">Heading 2</a>
</h2>
<a name="quickbook.syntax.block.headings.heading_3"></a><h3>
-<a name="id450912"></a>
+<a name="id456667"></a>
<a
href="block.html#quickbook.syntax.block.headings.heading_3">Heading 3</a>
</h3>
<a name="quickbook.syntax.block.headings.heading_4"></a><h4>
-<a name="id450937"></a>
+<a name="id456691"></a>
<a
href="block.html#quickbook.syntax.block.headings.heading_4">Heading 4</a>
</h4>
<a name="quickbook.syntax.block.headings.heading_5"></a><h5>
-<a name="id450962"></a>
+<a name="id456716"></a>
<a
href="block.html#quickbook.syntax.block.headings.heading_5">Heading 5</a>
</h5>
<a name="quickbook.syntax.block.headings.heading_6"></a><h5>
-<a name="id450987"></a>
+<a name="id456742"></a>
<a
href="block.html#quickbook.syntax.block.headings.heading_6">Heading 6</a>
</h5>
<p>
@@ -698,7 +698,7 @@
[h2 X]
[h2 Y]
[h2 Z]
-[endsect]
+[endsect]
</pre>
<p>
Here we use h2 assuming that section A is the outermost level. If it
is
@@ -711,7 +711,7 @@
[heading X]
[heading Y]
[heading Z]
-[endsect]
+[endsect]
</pre>
<p>
They work well regardless where you place them. You can rearrange
sections
@@ -793,7 +793,7 @@
Quickbook has some predefined macros that you can already use.
</p>
<div class="table">
-<a name="id451424"></a><p class="title"><b>Table 3. Predefined Macros</b></p>
+<a name="id457178"></a><p class="title"><b>Table 3. Predefined Macros</b></p>
<table class="table" summary="Predefined Macros">
<colgroup>
<col>
@@ -809,12 +809,12 @@
<tr>
<td>__DATE__</td>
<td>Today's date</td>
-<td>2006-Dec-25</td>
+<td>2007-Feb-21</td>
</tr>
<tr>
<td>__TIME__</td>
<td>The current time</td>
-<td>08:32:53 AM</td>
+<td>08:18:03 AM</td>
</tr>
<tr>
<td>__FILENAME__</td>
@@ -846,7 +846,7 @@
]
</pre>
<a name="quickbook.syntax.block.templates.template_identifier"></a><h5>
-<a name="id451552"></a>
+<a name="id457306"></a>
<a
href="block.html#quickbook.syntax.block.templates.template_identifier">Template
Identifier</a>
</h5>
@@ -864,7 +864,7 @@
</li>
</ul></div>
<a name="quickbook.syntax.block.templates.formal_template_arguments"></a><h5>
-<a name="id451599"></a>
+<a name="id457354"></a>
<a
href="block.html#quickbook.syntax.block.templates.formal_template_arguments">Formal
Template Arguments</a>
</h5>
@@ -884,7 +884,7 @@
of the template call.
</p>
<a name="quickbook.syntax.block.templates.template_body"></a><h5>
-<a name="id451719"></a>
+<a name="id457473"></a>
<a
href="block.html#quickbook.syntax.block.templates.template_body">Template
Body</a>
</h5>
@@ -898,8 +898,8 @@
<p>
Block templates are of the form:
</p>
-<pre class="programlisting">[template sample[arg1 arg2...argN]
-replacement text...
+<pre class="programlisting">[template sample[arg1 arg2...argN]
+replacement text...
]
</pre>
<p>
@@ -909,7 +909,7 @@
block level elements are not allowed in phrase templates.
</p>
<a name="quickbook.syntax.block.templates.template_expansion"></a><h5>
-<a name="id451774"></a>
+<a name="id457528"></a>
<a
href="block.html#quickbook.syntax.block.templates.template_expansion">Template
Expansion</a>
</h5>
@@ -960,7 +960,7 @@
by the close parenthesis.
</p>
<a name="quickbook.syntax.block.templates.nullary_templates"></a><h5>
-<a name="id451877"></a>
+<a name="id457632"></a>
<a
href="block.html#quickbook.syntax.block.templates.nullary_templates">Nullary
Templates</a>
</h5>
@@ -1002,7 +1002,7 @@
indicates no arguments. If the template body does not look like a
template
argument list, we can elide the empty brackets. Example:
</p>
-<pre class="programlisting">[template aristotle_quote Aristotle: [*['Education
is the best provision
+<pre class="programlisting">[template aristotle_quote Aristotle: [*['Education
is the best provision
for the journey to old age.]]]
</pre>
<p>
@@ -1043,7 +1043,7 @@
brackets, though.
</p>
<a name="quickbook.syntax.block.templates.simple_arguments"></a><h5>
-<a name="id452097"></a>
+<a name="id457852"></a>
<a
href="block.html#quickbook.syntax.block.templates.simple_arguments">Simple
Arguments</a>
</h5>
@@ -1111,7 +1111,7 @@
what do you think man?
</p>
<a name="quickbook.syntax.block.templates.punctuation_templates"></a><h5>
-<a name="id452264"></a>
+<a name="id458019"></a>
<a
href="block.html#quickbook.syntax.block.templates.punctuation_templates">Punctuation
Templates</a>
</h5>
@@ -1182,7 +1182,7 @@
will generate:
</p>
<div class="table">
-<a name="id452458"></a><p class="title"><b>Table 4. A Simple Table</b></p>
+<a name="id458213"></a><p class="title"><b>Table 4. A Simple Table</b></p>
<table class="table" summary="A Simple Table">
<colgroup>
<col>
@@ -1241,7 +1241,7 @@
and thus:
</p>
<div class="table">
-<a name="id452567"></a><p class="title"><b>Table 5. Table with fat
cells</b></p>
+<a name="id458322"></a><p class="title"><b>Table 5. Table with fat
cells</b></p>
<table class="table" summary="Table with fat cells">
<colgroup>
<col>
@@ -1287,7 +1287,7 @@
]
</pre>
<div class="table">
-<a name="id452647"></a><p class="title"><b>Table 6. Table with code</b></p>
+<a name="id458402"></a><p class="title"><b>Table 6. Table with code</b></p>
<table class="table" summary="Table with code">
<colgroup>
<col>
@@ -1401,7 +1401,7 @@
QuickBook's import facility provides a nice solution.
</p>
<a name="quickbook.syntax.block.import.example"></a><h5>
-<a name="id453033"></a>
+<a name="id458788"></a>
<a
href="block.html#quickbook.syntax.block.import.example">Example</a>
</h5>
<p>
@@ -1443,7 +1443,10 @@
<span class="special">}</span>
</pre>
<p>
- This is the <span class="bold"><b><span
class="emphasis"><em>bar</em></span></b></span> function
+ </p>
+<div class="calloutlist"><table border="0" summary="Callout
list"></table></div>
+<p>
+This is the <span class="bold"><b><span
class="emphasis"><em>bar</em></span></b></span> function
</p>
<pre class="programlisting">
@@ -1454,9 +1457,12 @@
<span class="special">}</span>
</pre>
<p>
+ </p>
+<div class="calloutlist"><table border="0" summary="Callout
list"></table></div>
+<p>
</p>
<a name="quickbook.syntax.block.import.code_snippet_markup"></a><h5>
-<a name="id453286"></a>
+<a name="id459046"></a>
<a
href="block.html#quickbook.syntax.block.import.code_snippet_markup">Code
Snippet Markup</a>
</h5>
@@ -1477,7 +1483,7 @@
This too will not be visible in quickbook.
</p>
<a name="quickbook.syntax.block.import.special_comments"></a><h5>
-<a name="id453404"></a>
+<a name="id459164"></a>
<a
href="block.html#quickbook.syntax.block.import.special_comments">Special
Comments</a>
</h5>
@@ -1499,6 +1505,60 @@
slash-slash, tick and white-space shall be ignored. In the second,
the
initial slash-star-tick and the final star-slash shall be ignored.
</p>
+<a name="quickbook.syntax.block.import.callouts"></a><h5>
+<a name="id459235"></a>
+ <a
href="block.html#quickbook.syntax.block.import.callouts">Callouts</a>
+ </h5>
+<p>
+ Special comments of the form:
+ </p>
+<pre class="programlisting">
+<span class="comment">/*< some [*quickbook] markup here >*/</span>
+</pre>
+<p>
+ will be regarded as callouts. These will be collected, numbered and
rendered
+ as a "callout bug" (a small icon with a number). After the whole
+ snippet is parsed, the callout list is generated. See <a
href="http://www.docbook.org/tdg/en/html/callout.html";
target="_top">Callouts</a>
+ for details. Example:
+ </p>
+<p>
+ </p>
+<p>
+
+</p>
+<pre class="programlisting">
+<span class="identifier">std</span><span class="special">::</span><span
class="identifier">string</span> <span class="identifier">foo_bar</span><span
class="special">()</span> <a name="quickbook0co"
href="block.html#quickbook0"><img src="../../images/callouts/1.png" alt="1"
border="0"></a>
+<span class="special">{</span>
+ <span class="keyword">return</span> <span
class="string">"foo-bar"</span><span class="special">;</span> <a
name="quickbook1co" href="block.html#quickbook1"><img
src="../../images/callouts/2.png" alt="2" border="0"></a>
+<span class="special">}</span>
+</pre>
+<p>
+ </p>
+<p>
+ </p>
+<p>
+ </p>
+<div class="calloutlist"><table border="0" summary="Callout list">
+<tr>
+<td width="5%" valign="top" align="left">
+<a name="quickbook0"></a><a href="#quickbook0co"><img
src="../../images/callouts/1.png" alt="1" border="0"></a> </td>
+<td valign="top" align="left"><p> The <span
class="bold"><b>Mythical</b></span> FooBar. See <a
href="http://en.wikipedia.org/wiki/Foobar"; target="_top">Foobar
+ for details</a> </p></td>
+</tr>
+<tr>
+<td width="5%" valign="top" align="left">
+<a name="quickbook1"></a><a href="#quickbook1co"><img
src="../../images/callouts/2.png" alt="2" border="0"></a> </td>
+<td valign="top" align="left"><p> return 'em, foo-bar man! </p></td>
+</tr>
+</table></div>
+<p>
+ </p>
+<p>
+ </p>
+<p>
+ Checkout <a href="../../../../test/stub.cpp"
target="_top">stub.cpp</a> to see the actual
+ code.
+ </p>
</div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision";
width="100%"><tr>
Index: phrase.html
===================================================================
RCS file:
/cvsroot/boost/boost/tools/quickbook/doc/html/quickbook/syntax/phrase.html,v
retrieving revision 1.28
retrieving revision 1.29
diff -u -d -r1.28 -r1.29
--- phrase.html 25 Dec 2006 00:10:58 -0000 1.28
+++ phrase.html 21 Feb 2007 00:48:29 -0000 1.29
@@ -135,7 +135,7 @@
<p>
Unlike QuickBook's standard formatting scheme, the rules for simpler
alternatives
are much stricter
- <sup>[<a name="id379391" href="#ftn.id379391">1</a>]</sup>
+ <sup>[<a name="id383261" href="#ftn.id383261">1</a>]</sup>
.
</p>
<div class="itemizedlist"><ul type="disc">
@@ -170,7 +170,7 @@
</li>
</ul></div>
<div class="table">
-<a name="id447766"></a><p class="title"><b>Table 1. More Formatting
Samples</b></p>
+<a name="id453521"></a><p class="title"><b>Table 1. More Formatting
Samples</b></p>
<table class="table" summary="More Formatting Samples">
<colgroup>
<col>
@@ -359,7 +359,7 @@
whereas a Python comment <tt class="computeroutput"><span
class="comment">#looks like this</span></tt>.
</p>
<div class="table">
-<a name="id448519"></a><p class="title"><b>Table 2. Supported Source
Modes</b></p>
+<a name="id454273"></a><p class="title"><b>Table 2. Supported Source
Modes</b></p>
<table class="table" summary="Supported Source Modes">
<colgroup>
<col>
@@ -587,7 +587,7 @@
</pre>
<p>
will generate this
- <sup>[<a name="id449274" href="#ftn.id449274">2</a>]</sup>
+ <sup>[<a name="id455028" href="#ftn.id455028">2</a>]</sup>
.
</p>
<div class="section" lang="en">
@@ -616,14 +616,14 @@
</div>
<div class="footnotes">
<br><hr width="100" align="left">
-<div class="footnote"><p><sup>[<a name="ftn.id379391" href="#id379391">1</a>]
</sup>
+<div class="footnote"><p><sup>[<a name="ftn.id383261" href="#id383261">1</a>]
</sup>
Thanks to David Barrett, author of <a
href="http://quinthar.com/qwikiwiki/index.php?page=Home";
target="_top">Qwiki</a>,
for sharing these samples and teaching me these obscure
formatting
rules. I wasn't sure at all if <a
href="http://spirit.sourceforge.net"; target="_top">Spirit</a>,
being more or less a formal EBNF parser, can handle the context
sensitivity
and ambiguity.
</p></div>
-<div class="footnote"><p><sup>[<a name="ftn.id449274" href="#id449274">2</a>]
</sup>
+<div class="footnote"><p><sup>[<a name="ftn.id455028" href="#id455028">2</a>]
</sup>
A sample footnote
</p></div>
</div>
-------------------------------------------------------------------------
Take Surveys. Earn Cash. Influence the Future of IT
Join SourceForge.net's Techsay panel and you'll get the chance to share your
opinions on IT & business topics through brief surveys-and earn cash
http://www.techsay.com/default.php?page=join.php&p=sourceforge&CID=DEVDEV
_______________________________________________
Boost-cvs mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/boost-cvs
