Update of /cvsroot/boost/boost/tools/quickbook/doc/html/quickbook/syntax
In directory
sc8-pr-cvs3.sourceforge.net:/tmp/cvs-serv28405/tools/quickbook/doc/html/quickbook/syntax
Modified Files:
block.html phrase.html
Log Message:
Index: block.html
===================================================================
RCS file:
/cvsroot/boost/boost/tools/quickbook/doc/html/quickbook/syntax/block.html,v
retrieving revision 1.10
retrieving revision 1.11
diff -u -d -r1.10 -r1.11
--- block.html 22 May 2006 09:06:57 -0000 1.10
+++ block.html 3 Jun 2006 04:27:08 -0000 1.11
@@ -632,27 +632,27 @@
[h6 Heading 6]
</pre>
<a name="quickbook.syntax.block.headings.heading_1"></a><h1>
-<a name="id445811"></a>
+<a name="id445801"></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="id445836"></a>
+<a name="id445825"></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="id445860"></a>
+<a name="id445850"></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="id445885"></a>
+<a name="id445874"></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="id445910"></a>
+<a name="id445900"></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="id445935"></a>
+<a name="id445925"></a>
<a
href="block.html#quickbook.syntax.block.headings.heading_6">Heading 6</a>
</h5>
<p>
@@ -748,20 +748,16 @@
<tr><td colspan="2" align="left" valign="top"><p>
It's a good idea to use macro identifiers that are
distinguishable. For
instance, in this document, macro identifiers have two leading and
trailing
- underscores (e.g. <tt class="literal">
-__spirit__
- </tt>). The reason is to avoid unwanted macro replacement.
+ underscores (e.g. <tt class="literal">__spirit__</tt>). The reason
is to avoid unwanted
+ macro replacement.
</p></td></tr>
</table></div>
<p>
Links (URLS) and images are good candidates for macros. <span
class="bold"><b>1</b></span>)
They tend to change a lot. It is a good idea to place all links and
images
in one place near the top to make it easy to make changes. <span
class="bold"><b>2</b></span>)
- The syntax is not pretty. It's easier to read and write, e.g. <tt
class="literal">
-__spirit__
- </tt> than <tt class="literal">
[EMAIL PROTECTED]://spirit.sourceforge.net Spirit]
- </tt>.
+ The syntax is not pretty. It's easier to read and write, e.g. <tt
class="literal">__spirit__</tt>
+ than <tt class="literal">[EMAIL PROTECTED]://spirit.sourceforge.net
Spirit]</tt>.
</p>
<p>
Some more examples:
@@ -795,7 +791,7 @@
</p>
<div class="informaltable">
<h4>
-<a name="id446370"></a>
+<a name="id446361"></a>
<span class="table-title">Predefined Macros</span>
</h4>
<table class="table">
@@ -811,23 +807,17 @@
</tr></thead>
<tbody>
<tr>
-<td>
-__DATE__
- </td>
+<td>__DATE__</td>
<td>Today's date</td>
-<td>2006-May-22</td>
+<td>2006-Jun-03</td>
</tr>
<tr>
-<td>
-__TIME__
- </td>
+<td>__TIME__</td>
<td>The current time</td>
-<td>05:05:58 PM</td>
+<td>12:09:28 PM</td>
</tr>
<tr>
-<td>
-__FILENAME__
- </td>
+<td>__FILENAME__</td>
<td>Quickbook source filename</td>
<td>C:\dev\boost\tools\quickbook\doc\quickbook.qbk</td>
</tr>
@@ -849,7 +839,7 @@
<p>
Example template:
</p>
-<pre class="programlisting">[template person(name_, age_, id_)
+<pre class="programlisting">[template person[name_ age_ id_]
Hi, my name is name_. I am age_ years old. My id is id_.
@@ -859,13 +849,13 @@
Template formal arguments are identifiers consisting of an initial
alphabetic
character or the underscore, followed by zero or more alphanumeric
characters
or the underscore. This is similar to your typical C/C++ identifier.
A
- template formal argument temporarily hides a macro of the same name
at
- the point where the template is invoked. At template invocation, you
supply
- the actual arguments. At that point, the template will be expanded
with
- your supplied arguments. Example:
+ template formal argument temporarily hides a template of the same
name
+ at the point where the template is invoked. At template invocation,
you
+ supply the actual arguments. At that point, the template will be
expanded
+ with your supplied arguments. Example:
</p>
-<pre class="programlisting">person(James Bond, 39, 007)
-person(Santa Clause, 87, 12-25)
+<pre class="programlisting">[person James Bond..39..007]
+[person Santa Clause..87..12-25]
</pre>
<p>
Which will expand to:
@@ -873,24 +863,20 @@
<p>
</p>
<p>
- Hi, my name is <span class="bold"><b>James Bond</b></span>. I am
<span class="bold"><b> 39</b></span> years old. My id is <span class="bold"><b>
- 007</b></span>.
+ Hi, my name is <span class="bold"><b>James Bond</b></span>. I am
<span class="bold"><b>39</b></span> years old. My id is <span
class="bold"><b>007</b></span>.
</p>
<p>
</p>
<p>
- Hi, my name is <span class="bold"><b>Santa Clause</b></span>. I am
<span class="bold"><b> 87</b></span> years old. My id is <span class="bold"><b>
- 12-25</b></span>.
+ Hi, my name is <span class="bold"><b>Santa Clause</b></span>. I am
<span class="bold"><b>87</b></span> years old. My id is <span
class="bold"><b>12-25</b></span>.
</p>
<p>
</p>
<p>
Each actual argument can be a word, a text fragment or just about any
<a href="phrase.html" title=" Phrase Level Elements">QuickBook
phrase</a>. Arguments
- are comma separated and terminated by the close parenthesis. If your
arguments
- have embedded commas or close parentheses, you'll have to <a
href="phrase.html#quickbook.syntax.phrase.single_char_escape" title="Single
- char escape">escape
- them</a>.
+ are separated by the double dot ".." and terminated by the close
+ parenthesis.
</p>
<div class="caution"><table border="0" summary="Caution">
<tr>
@@ -907,12 +893,12 @@
<p>
Templates may be phrase or block level. Phrase 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>
Block templates are of the form:
</p>
-<pre class="programlisting">[template sample(arg1, arg2,...argN)
+<pre class="programlisting">[template sample[arg1 arg2...argN]
replacement text...
]
</pre>
@@ -970,7 +956,7 @@
</p>
<div class="informaltable">
<h4>
-<a name="id446766"></a>
+<a name="id446744"></a>
<span class="table-title">A Simple Table</span>
</h4>
<table class="table">
@@ -1032,7 +1018,7 @@
</p>
<div class="informaltable">
<h4>
-<a name="id446883"></a>
+<a name="id446861"></a>
<span class="table-title">Table with fat cells</span>
</h4>
<table class="table">
@@ -1081,7 +1067,7 @@
</pre>
<div class="informaltable">
<h4>
-<a name="id446972"></a>
+<a name="id446944"></a>
<span class="table-title">Table with code</span>
</h4>
<table class="table">
@@ -1160,9 +1146,8 @@
</p>
<div class="itemizedlist"><ul type="disc">
<li>
- The
-__FILENAME__
- predefined macro will reflect the name of the file currently being
processed.
+ The __FILENAME__predefined macro will reflect the name of the file
currently being
+ processed.
</li>
<li>
Any macros defined in the included file are scoped to that file.
Index: phrase.html
===================================================================
RCS file:
/cvsroot/boost/boost/tools/quickbook/doc/html/quickbook/syntax/phrase.html,v
retrieving revision 1.10
retrieving revision 1.11
diff -u -d -r1.10 -r1.11
--- phrase.html 22 May 2006 09:06:57 -0000 1.10
+++ phrase.html 3 Jun 2006 04:27:08 -0000 1.11
@@ -182,91 +182,68 @@
</tr></thead>
<tbody>
<tr>
-<td><tt class="literal">
-*Bold*
- </tt></td>
+<td><tt class="literal">*Bold*</tt></td>
<td><span class="bold"><b>Bold</b></span></td>
</tr>
<tr>
-<td><tt class="literal">
-*Is bold*
- </tt></td>
-<td><span class="bold"><b>Is bold</b></span></td>
+<td><tt class="literal">*Is bold*</tt></td>
+<td><span class="bold"><b>Is
+ bold</b></span></td>
</tr>
<tr>
-<td><tt class="literal">
-* Not bold* *Not bold * * Not bold *
- </tt></td>
-<td>* Not bold* *Not bold * * Not bold *</td>
+<td><tt class="literal">* Not bold* *Not bold * * Not bold *</tt></td>
+<td>* Not bold* *Not bold *
+ * Not bold *</td>
</tr>
<tr>
-<td><tt class="literal">
-This*Isn't*Bold (no bold)
- </tt></td>
+<td><tt class="literal">This*Isn't*Bold (no bold)</tt></td>
<td>This*Isn't*Bold (no bold)</td>
</tr>
<tr>
-<td><tt class="literal">
-(*Bold Inside*) (parenthesis not bold)
- </tt></td>
-<td>(<span class="bold"><b>Bold Inside</b></span>)
- (parenthesis not bold)</td>
+<td><tt class="literal">(*Bold Inside*) (parenthesis not bold)</tt></td>
+<td>(<span class="bold"><b>Bold
+ Inside</b></span>) (parenthesis not bold)</td>
</tr>
<tr>
-<td><tt class="literal">
-*(Bold Outside)* (parenthesis bold)
- </tt></td>
+<td><tt class="literal">*(Bold Outside)* (parenthesis bold)</tt></td>
<td>
-<span class="bold"><b>(Bold Outside)</b></span>
- (parenthesis bold)</td>
+<span class="bold"><b>(Bold
+ Outside)</b></span> (parenthesis bold)</td>
</tr>
<tr>
-<td><tt class="literal">
-3*4*5 = 60 (no bold)
- </tt></td>
+<td><tt class="literal">3*4*5 = 60 (no bold)</tt></td>
<td>3*4*5 = 60 (no bold)</td>
</tr>
<tr>
-<td><tt class="literal">
-3 * 4 * 5 = 60 (no bold)
- </tt></td>
+<td><tt class="literal">3 * 4 * 5 = 60 (no bold)</tt></td>
<td>3 * 4 * 5 = 60 (no bold)</td>
</tr>
<tr>
-<td><tt class="literal">
-3 *4* 5 = 60 (4 is bold)
- </tt></td>
-<td>3 <span class="bold"><b>4</b></span> 5 =
- 60 (4 is bold)</td>
+<td><tt class="literal">3 *4* 5 = 60 (4 is bold)</tt></td>
+<td>3 <span class="bold"><b>4</b></span>
+ 5 = 60 (4 is bold)</td>
</tr>
<tr>
-<td><tt class="literal">
-*This is bold* this is not *but this is*
- </tt></td>
+<td><tt class="literal">*This is bold* this is not *but this is*</tt></td>
<td>
-<span class="bold"><b>This is bold</b></span>
- this is not <span class="bold"><b>but this is</b></span>
+<span class="bold"><b>This
+ is bold</b></span> this is not <span class="bold"><b>but this
is</b></span>
</td>
</tr>
<tr>
-<td><tt class="literal">
-*This is bold*.
- </tt></td>
+<td><tt class="literal">*This is bold*.</tt></td>
<td>
-<span class="bold"><b>This is bold</b></span>.</td>
+<span class="bold"><b>This
+ is bold</b></span>.</td>
</tr>
<tr>
-<td><tt class="literal">
-*B*. (bold B)
- </tt></td>
+<td><tt class="literal">*B*. (bold B)</tt></td>
<td>
-<span class="bold"><b>B</b></span>. (bold
- B)</td>
+<span class="bold"><b>B</b></span>.
+ (bold B)</td>
</tr>
<tr>
-<td><tt class="literal">
-['*Bold-Italic*]
- </tt></td>
+<td><tt class="literal">['*Bold-Italic*]</tt></td>
<td><span class="emphasis"><em><span
class="bold"><b>Bold-Italic</b></span></em></span></td>
</tr>
</tbody>
@@ -294,14 +271,9 @@
<th align="left">Note</th>
</tr>
<tr><td colspan="2" align="left" valign="top"><p>
- We simply enclose the code with the tick: <tt class="literal">
-"`"
- </tt>, not the single quote: <tt class="computeroutput"><span
class="string">"'"</span></tt>.
- Note too that <tt class="literal">
-`some code`
- </tt> is prefered over <tt class="literal">
-[^some code]
- </tt>.
+ We simply enclose the code with the tick: <tt
class="literal">"`"</tt>, not the
+ single quote: <tt class="computeroutput"><span
class="string">"'"</span></tt>.
+ Note too that <tt class="literal">`some code`</tt> is prefered
over <tt class="literal">[^some code]</tt>.
</p></td></tr>
</table></div>
</div>
@@ -382,7 +354,7 @@
</p>
<div class="informaltable">
<h4>
-<a name="id443563"></a>
+<a name="id443559"></a>
<span class="table-title">Supported Source Modes</span>
</h4>
<table class="table">
@@ -439,12 +411,10 @@
</pre>
<p>
A named anchor is a hook that can be referenced by a link elsewhere
in
- the document. You can then reference an anchor with <tt
class="literal">
-[link named_anchor
-Some link text]
- </tt>. See <a
href="phrase.html#quickbook.syntax.phrase.anchor_links" title="Anchor
links">Anchor
- links</a>, <a href="block.html#quickbook.syntax.block.section"
title="Section">Section</a>
- and <a href="block.html#quickbook.syntax.block.headings"
title="Headings">Heading</a>.
+ the document. You can then reference an anchor with <tt
class="literal">[link named_anchor
+Some link text]</tt>.
+ See <a href="phrase.html#quickbook.syntax.phrase.anchor_links"
title="Anchor links">Anchor links</a>,
+ <a href="block.html#quickbook.syntax.block.section"
title="Section">Section</a> and <a
href="block.html#quickbook.syntax.block.headings" title="Headings">Heading</a>.
</p>
</div>
<div class="section" lang="en">
@@ -554,8 +524,7 @@
'''
</pre>
<p>
-
-<span class="bold"><b>This is direct XML markup</b></span>
+ <span class="bold"><b>This is direct XML markup</b></span>
</p>
<div class="important"><table border="0" summary="Important">
@@ -603,7 +572,7 @@
</pre>
<p>
will generate this
- <sup>[<a name="id444304" href="#ftn.id444304">2</a>]</sup>
+ <sup>[<a name="id444300" href="#ftn.id444300">2</a>]</sup>
.
</p>
</div>
@@ -616,7 +585,7 @@
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.id444304" href="#id444304">2</a>]
</sup>
+<div class="footnote"><p><sup>[<a name="ftn.id444300" href="#id444300">2</a>]
</sup>
A sample footnote
</p></div>
</div>
_______________________________________________
Boost-cvs mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/boost-cvs
