Update of /cvsroot/boost/boost/tools/quickbook/doc/html/quickbook/syntax
In directory
sc8-pr-cvs3.sourceforge.net:/tmp/cvs-serv7436/doc/html/quickbook/syntax
Modified Files:
block.html comments.html phrase.html
Log Message:
* Simple markups can now span a whole block.
* __blurbs__, __admonitions__ and table cells (see __tables__) may now
contain paragraphs.
* `\n` and `[br]` are now deprecated.
Index: block.html
===================================================================
RCS file:
/cvsroot/boost/boost/tools/quickbook/doc/html/quickbook/syntax/block.html,v
retrieving revision 1.37
retrieving revision 1.38
diff -u -d -r1.37 -r1.38
--- block.html 21 Feb 2007 00:48:29 -0000 1.37
+++ block.html 27 Feb 2007 15:22:16 -0000 1.38
@@ -557,9 +557,15 @@
<a name="quickbook.syntax.block.blockquote"></a><a
href="block.html#quickbook.syntax.block.blockquote"
title="Blockquote">Blockquote</a></h4></div></div></div>
<pre class="programlisting">[:sometext...]
</pre>
-<div class="blockquote"><blockquote class="blockquote"><p>
- Indents the paragraph. This applies to one paragraph only.
- </p></blockquote></div>
+<div class="blockquote"><blockquote class="blockquote">
+<p>
+ </p>
+<p>
+ Indents the paragraph. This applies to one paragraph only.
+ </p>
+<p>
+ </p>
+</blockquote></div>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h4 class="title">
@@ -578,45 +584,75 @@
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]"
src="../../images/note.png"></td>
<th align="left">Note</th>
</tr>
-<tr><td colspan="2" align="left" valign="top"><p>
- This is a note
- </p></td></tr>
+<tr><td colspan="2" align="left" valign="top">
+<p>
+ </p>
+<p>
+ This is a note
+ </p>
+<p>
+ </p>
+</td></tr>
</table></div>
<div class="tip"><table border="0" summary="Tip">
<tr>
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Tip]"
src="../../images/tip.png"></td>
<th align="left">Tip</th>
</tr>
-<tr><td colspan="2" align="left" valign="top"><p>
- This is a tip
- </p></td></tr>
+<tr><td colspan="2" align="left" valign="top">
+<p>
+ </p>
+<p>
+ This is a tip
+ </p>
+<p>
+ </p>
+</td></tr>
</table></div>
<div class="important"><table border="0" summary="Important">
<tr>
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Important]"
src="../../images/important.png"></td>
<th align="left">Important</th>
</tr>
-<tr><td colspan="2" align="left" valign="top"><p>
- This is important
- </p></td></tr>
+<tr><td colspan="2" align="left" valign="top">
+<p>
+ </p>
+<p>
+ This is important
+ </p>
+<p>
+ </p>
+</td></tr>
</table></div>
<div class="caution"><table border="0" summary="Caution">
<tr>
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Caution]"
src="../../images/caution.png"></td>
<th align="left">Caution</th>
</tr>
-<tr><td colspan="2" align="left" valign="top"><p>
- This is a caution
- </p></td></tr>
+<tr><td colspan="2" align="left" valign="top">
+<p>
+ </p>
+<p>
+ This is a caution
+ </p>
+<p>
+ </p>
+</td></tr>
</table></div>
<div class="warning"><table border="0" summary="Warning">
<tr>
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Warning]"
src="../../images/warning.png"></td>
<th align="left">Warning</th>
</tr>
-<tr><td colspan="2" align="left" valign="top"><p>
- This is a warning
- </p></td></tr>
+<tr><td colspan="2" align="left" valign="top">
+<p>
+ </p>
+<p>
+ This is a warning
+ </p>
+<p>
+ </p>
+</td></tr>
</table></div>
<p>
These are the only admonitions supported by <a
href="http://www.docbook.org/"; target="_top">DocBook</a>.
@@ -635,27 +671,27 @@
[h6 Heading 6]
</pre>
<a name="quickbook.syntax.block.headings.heading_1"></a><h1>
-<a name="id456618"></a>
+<a name="id457025"></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="id456642"></a>
+<a name="id457050"></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="id456667"></a>
+<a name="id457074"></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="id456691"></a>
+<a name="id457099"></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="id456716"></a>
+<a name="id457124"></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="id456742"></a>
+<a name="id457149"></a>
<a
href="block.html#quickbook.syntax.block.headings.heading_6">Heading 6</a>
</h5>
<p>
@@ -748,12 +784,18 @@
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Tip]"
src="../../images/tip.png"></td>
<th align="left">Tip</th>
</tr>
-<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.
- </p></td></tr>
+<tr><td colspan="2" align="left" valign="top">
+<p>
+ </p>
+<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.
+ </p>
+<p>
+ </p>
+</td></tr>
</table></div>
<p>
Links (URLS) and images are good candidates for macros. <span
class="bold"><b>1</b></span>)
@@ -793,7 +835,7 @@
Quickbook has some predefined macros that you can already use.
</p>
<div class="table">
-<a name="id457178"></a><p class="title"><b>Table 3. Predefined Macros</b></p>
+<a name="id457591"></a><p class="title"><b>Table 3. Predefined Macros</b></p>
<table class="table" summary="Predefined Macros">
<colgroup>
<col>
@@ -801,25 +843,73 @@
<col>
</colgroup>
<thead><tr>
-<th>Macro</th>
-<th>Meaning</th>
-<th>Example</th>
+<th>
+ <p>
+ Macro
+ </p>
+ </th>
+<th>
+ <p>
+ Meaning
+ </p>
+ </th>
+<th>
+ <p>
+ Example
+ </p>
+ </th>
</tr></thead>
<tbody>
<tr>
-<td>__DATE__</td>
-<td>Today's date</td>
-<td>2007-Feb-21</td>
+<td>
+ <p>
+ __DATE__
+ </p>
+ </td>
+<td>
+ <p>
+ Today's date
+ </p>
+ </td>
+<td>
+ <p>
+ 2007-Feb-27
+ </p>
+ </td>
</tr>
<tr>
-<td>__TIME__</td>
-<td>The current time</td>
-<td>08:18:03 AM</td>
+<td>
+ <p>
+ __TIME__
+ </p>
+ </td>
+<td>
+ <p>
+ The current time
+ </p>
+ </td>
+<td>
+ <p>
+ 11:13:46 PM
+ </p>
+ </td>
</tr>
<tr>
-<td>__FILENAME__</td>
-<td>Quickbook source filename</td>
-<td>C:\dev\boost\tools\quickbook\doc\quickbook.qbk</td>
+<td>
+ <p>
+ __FILENAME__
+ </p>
+ </td>
+<td>
+ <p>
+ Quickbook source filename
+ </p>
+ </td>
+<td>
+ <p>
+ C:\dev\boost\tools\quickbook\doc\quickbook.qbk
+ </p>
+ </td>
</tr>
</tbody>
</table>
@@ -846,7 +936,7 @@
]
</pre>
<a name="quickbook.syntax.block.templates.template_identifier"></a><h5>
-<a name="id457306"></a>
+<a name="id457777"></a>
<a
href="block.html#quickbook.syntax.block.templates.template_identifier">Template
Identifier</a>
</h5>
@@ -864,7 +954,7 @@
</li>
</ul></div>
<a name="quickbook.syntax.block.templates.formal_template_arguments"></a><h5>
-<a name="id457354"></a>
+<a name="id457825"></a>
<a
href="block.html#quickbook.syntax.block.templates.formal_template_arguments">Formal
Template Arguments</a>
</h5>
@@ -884,7 +974,7 @@
of the template call.
</p>
<a name="quickbook.syntax.block.templates.template_body"></a><h5>
-<a name="id457473"></a>
+<a name="id457944"></a>
<a
href="block.html#quickbook.syntax.block.templates.template_body">Template
Body</a>
</h5>
@@ -909,7 +999,7 @@
block level elements are not allowed in phrase templates.
</p>
<a name="quickbook.syntax.block.templates.template_expansion"></a><h5>
-<a name="id457528"></a>
+<a name="id457999"></a>
<a
href="block.html#quickbook.syntax.block.templates.template_expansion">Template
Expansion</a>
</h5>
@@ -945,13 +1035,19 @@
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Caution]"
src="../../images/caution.png"></td>
<th align="left">Caution</th>
</tr>
-<tr><td colspan="2" align="left" valign="top"><p>
- A word of caution: Templates are recursive. A template can call
another
- template or even itself, directly or indirectly. There are no
control
- structures in QuickBook (yet) so this will always mean infinite
recursion.
- QuickBook can detect this situation and report an error if
recursion
- exceeds a certain limit.
- </p></td></tr>
+<tr><td colspan="2" align="left" valign="top">
+<p>
+ </p>
+<p>
+ A word of caution: Templates are recursive. A template can call
another
+ template or even itself, directly or indirectly. There are no
control
+ structures in QuickBook (yet) so this will always mean infinite
recursion.
+ QuickBook can detect this situation and report an error if
recursion
+ exceeds a certain limit.
+ </p>
+<p>
+ </p>
+</td></tr>
</table></div>
<p>
Each actual argument can be a word, a text fragment or just about any
@@ -960,7 +1056,7 @@
by the close parenthesis.
</p>
<a name="quickbook.syntax.block.templates.nullary_templates"></a><h5>
-<a name="id457632"></a>
+<a name="id458100"></a>
<a
href="block.html#quickbook.syntax.block.templates.nullary_templates">Nullary
Templates</a>
</h5>
@@ -1043,7 +1139,7 @@
brackets, though.
</p>
<a name="quickbook.syntax.block.templates.simple_arguments"></a><h5>
-<a name="id457852"></a>
+<a name="id458321"></a>
<a
href="block.html#quickbook.syntax.block.templates.simple_arguments">Simple
Arguments</a>
</h5>
@@ -1111,7 +1207,7 @@
what do you think man?
</p>
<a name="quickbook.syntax.block.templates.punctuation_templates"></a><h5>
-<a name="id458019"></a>
+<a name="id458488"></a>
<a
href="block.html#quickbook.syntax.block.templates.punctuation_templates">Punctuation
Templates</a>
</h5>
@@ -1139,7 +1235,8 @@
<div class="section" lang="en">
<div class="titlepage"><div><div><h4 class="title">
<a name="quickbook.syntax.block.blurbs"></a><a
href="block.html#quickbook.syntax.block.blurbs"
title="Blurbs">Blurbs</a></h4></div></div></div>
-<pre class="programlisting">[blurb :-) [*An eye catching advertisement or
note...]\n\n
+<pre class="programlisting">[blurb :-) [*An eye catching advertisement or
note...]
+
__spirit__ is an object-oriented recursive-descent parser generator
framework
implemented using template meta-programming techniques. Expression
templates
allow us to approximate the syntax of Extended Backus-Normal Form (EBNF)
@@ -1149,23 +1246,33 @@
<p>
will generate this:
</p>
-<p class="blurb">
+<div class="sidebar">
+<p>
<span class="inlinemediaobject"><img src="../../images/smiley.png"
alt="smiley"></span> <span class="bold"><b>An eye catching advertisement
- or note...</b></span><br> <br> <a
href="http://spirit.sourceforge.net"; target="_top">Spirit</a>
- is an object-oriented recursive-descent parser generator framework
implemented
- using template meta-programming techniques. Expression templates
allow
- us to approximate the syntax of Extended Backus-Normal Form (EBNF)
completely
- in C++.
+ or note...</b></span>
</p>
+<p>
+ <a href="http://spirit.sourceforge.net"; target="_top">Spirit</a> is
an object-oriented
+ recursive-descent parser generator framework implemented using
template
+ meta-programming techniques. Expression templates allow us to
approximate
+ the syntax of Extended Backus-Normal Form (EBNF) completely in C++.
+ </p>
+</div>
<div class="note"><table border="0" summary="Note">
<tr>
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]"
src="../../images/note.png"></td>
<th align="left">Note</th>
</tr>
-<tr><td colspan="2" align="left" valign="top"><p>
- Prefer <a href="block.html#quickbook.syntax.block.admonitions"
title="Admonitions">admonitions</a>
- wherever appropriate.
- </p></td></tr>
+<tr><td colspan="2" align="left" valign="top">
+<p>
+ </p>
+<p>
+ Prefer <a href="block.html#quickbook.syntax.block.admonitions"
title="Admonitions">admonitions</a>
+ wherever appropriate.
+ </p>
+<p>
+ </p>
+</td></tr>
</table></div>
</div>
<div class="section" lang="en">
@@ -1182,7 +1289,7 @@
will generate:
</p>
<div class="table">
-<a name="id458213"></a><p class="title"><b>Table 4. A Simple Table</b></p>
+<a name="id458688"></a><p class="title"><b>Table 4. A Simple Table</b></p>
<table class="table" summary="A Simple Table">
<colgroup>
<col>
@@ -1190,25 +1297,73 @@
<col>
</colgroup>
<thead><tr>
-<th>Heading 1</th>
-<th>Heading 2</th>
-<th>Heading 3</th>
+<th>
+ <p>
+ Heading 1
+ </p>
+ </th>
+<th>
+ <p>
+ Heading 2
+ </p>
+ </th>
+<th>
+ <p>
+ Heading 3
+ </p>
+ </th>
</tr></thead>
<tbody>
<tr>
-<td>R0-C0</td>
-<td>R0-C1</td>
-<td>R0-C2</td>
+<td>
+ <p>
+ R0-C0
+ </p>
+ </td>
+<td>
+ <p>
+ R0-C1
+ </p>
+ </td>
+<td>
+ <p>
+ R0-C2
+ </p>
+ </td>
</tr>
<tr>
-<td>R2-C0</td>
-<td>R2-C1</td>
-<td>R2-C2</td>
+<td>
+ <p>
+ R2-C0
+ </p>
+ </td>
+<td>
+ <p>
+ R2-C1
+ </p>
+ </td>
+<td>
+ <p>
+ R2-C2
+ </p>
+ </td>
</tr>
<tr>
-<td>R3-C0</td>
-<td>R3-C1</td>
-<td>R3-C2</td>
+<td>
+ <p>
+ R3-C0
+ </p>
+ </td>
+<td>
+ <p>
+ R3-C1
+ </p>
+ </td>
+<td>
+ <p>
+ R3-C2
+ </p>
+ </td>
</tr>
</tbody>
</table>
@@ -1225,10 +1380,14 @@
[
[Row 0, Col 0: a small cell]
[
- Row 0, Col 1:
- A very big cell...A very big cell...A very big cell...
- A very big cell...A very big cell...A very big cell...
- A very big cell...A very big cell...A very big cell...
+ Row 0, Col 1: a big fat cell with paragraphs
+
+ Boost provides free peer-reviewed portable C++ source libraries.
+
+ We emphasize libraries that work well with the C++ Standard
Library.
+ Boost libraries are intended to be widely useful, and usable across
+ a broad spectrum of applications. The Boost license encourages both
+ commercial and non-commercial use.
]
]
[
@@ -1241,28 +1400,57 @@
and thus:
</p>
<div class="table">
-<a name="id458322"></a><p class="title"><b>Table 5. Table with fat
cells</b></p>
+<a name="id458849"></a><p class="title"><b>Table 5. Table with fat
cells</b></p>
<table class="table" summary="Table with fat cells">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
-<th>Heading 1</th>
-<th>Heading 2</th>
+<th>
+ <p>
+ Heading 1
+ </p>
+ </th>
+<th>
+ <p>
+ Heading 2
+ </p>
+ </th>
</tr></thead>
<tbody>
<tr>
-<td>Row 0, Col 0: a small cell</td>
-<td> Row 0, Col 1: A very
- big cell...A very big cell...A very big cell... A very big
cell...A
- very big cell...A very big cell... A very big cell...A very big
cell...A
- very big cell... </td>
+<td>
+ <p>
+ Row 0, Col 0: a small cell
+ </p>
+ </td>
+<td>
+ <p>
+ Row 0, Col 1: a big fat cell with paragraphs
+ </p>
+ <p>
+ Boost provides free peer-reviewed portable C++ source
libraries.
+ </p>
+ <p>
+ We emphasize libraries that work well with the C++ Standard
Library.
+ Boost libraries are intended to be widely useful, and usable
across
+ a broad spectrum of applications. The Boost license encourages
both
+ commercial and non-commercial use.
+ </p>
+ </td>
</tr>
<tr>
-<td>Row 1, Col 0: a small cell</td>
-<td>Row 1, Col 1: a small
- cell</td>
+<td>
+ <p>
+ Row 1, Col 0: a small cell
+ </p>
+ </td>
+<td>
+ <p>
+ Row 1, Col 1: a small cell
+ </p>
+ </td>
</tr>
</tbody>
</table>
@@ -1287,19 +1475,34 @@
]
</pre>
<div class="table">
-<a name="id458402"></a><p class="title"><b>Table 6. Table with code</b></p>
+<a name="id458967"></a><p class="title"><b>Table 6. Table with code</b></p>
<table class="table" summary="Table with code">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
-<th>Comment</th>
-<th>Code</th>
+<th>
+ <p>
+ Comment
+ </p>
+ </th>
+<th>
+ <p>
+ Code
+ </p>
+ </th>
</tr></thead>
<tbody><tr>
-<td>My first program</td>
<td>
+ <p>
+ My first program
+ </p>
+ </td>
+<td>
+ <p>
+
+</p>
<pre class="programlisting">
<span class="preprocessor">#include</span> <span
class="special"><</span><span class="identifier">iostream</span><span
class="special">></span>
@@ -1309,6 +1512,8 @@
<span class="keyword">return</span> <span class="number">0</span><span
class="special">;</span>
<span class="special">}</span>
</pre>
+<p>
+ </p>
</td>
</tr></tbody>
</table>
@@ -1401,7 +1606,7 @@
QuickBook's import facility provides a nice solution.
</p>
<a name="quickbook.syntax.block.import.example"></a><h5>
-<a name="id458788"></a>
+<a name="id459378"></a>
<a
href="block.html#quickbook.syntax.block.import.example">Example</a>
</h5>
<p>
@@ -1462,7 +1667,7 @@
<p>
</p>
<a name="quickbook.syntax.block.import.code_snippet_markup"></a><h5>
-<a name="id459046"></a>
+<a name="id459636"></a>
<a
href="block.html#quickbook.syntax.block.import.code_snippet_markup">Code
Snippet Markup</a>
</h5>
@@ -1483,7 +1688,7 @@
This too will not be visible in quickbook.
</p>
<a name="quickbook.syntax.block.import.special_comments"></a><h5>
-<a name="id459164"></a>
+<a name="id459754"></a>
<a
href="block.html#quickbook.syntax.block.import.special_comments">Special
Comments</a>
</h5>
@@ -1506,7 +1711,7 @@
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 name="id459825"></a>
<a
href="block.html#quickbook.syntax.block.import.callouts">Callouts</a>
</h5>
<p>
Index: comments.html
===================================================================
RCS file:
/cvsroot/boost/boost/tools/quickbook/doc/html/quickbook/syntax/comments.html,v
retrieving revision 1.13
retrieving revision 1.14
diff -u -d -r1.13 -r1.14
--- comments.html 20 Dec 2006 15:41:53 -0000 1.13
+++ comments.html 27 Feb 2007 15:22:16 -0000 1.14
@@ -30,8 +30,6 @@
</p>
<pre class="programlisting">[/ comment (no output generated) ]
</pre>
-<pre class="programlisting">[// Line-end terminates this type of comment
-</pre>
<pre class="programlisting">[/ comments can be nested [/ some more here] ]
</pre>
<pre class="programlisting">[/ Quickbook blocks can nest inside comments.
[*Comment this out too!] ]
Index: phrase.html
===================================================================
RCS file:
/cvsroot/boost/boost/tools/quickbook/doc/html/quickbook/syntax/phrase.html,v
retrieving revision 1.29
retrieving revision 1.30
diff -u -d -r1.29 -r1.30
--- phrase.html 21 Feb 2007 00:48:29 -0000 1.29
+++ phrase.html 27 Feb 2007 15:22:16 -0000 1.30
@@ -135,7 +135,7 @@
<p>
Unlike QuickBook's standard formatting scheme, the rules for simpler
alternatives
are much stricter
- <sup>[<a name="id383261" href="#ftn.id383261">1</a>]</sup>
+ <sup>[<a name="id383135" href="#ftn.id383135">1</a>]</sup>
.
</p>
<div class="itemizedlist"><ul type="disc">
@@ -156,11 +156,12 @@
A space or a punctuation must follow the trailing markup
</li>
<li>
- If the matching markup cannot be found within a line, the
formatting
+ If the matching markup cannot be found within a block, the
formatting
will not be applied. This is to ensure that un-matched formatting
markups,
which can be a common mistake, does not corrupt anything past a
single
- line. We do not want the rest of the document to be rendered bold
just
- because we forgot a trailing '*'.
+ block. We do not want the rest of the document to be rendered bold
just
+ because we forgot a trailing '*'. A single block is terminated by
two
+ end of lines or the close bracket: ']'.
</li>
<li>
A line starting with the star will be interpreted as an unordered
list.
@@ -170,90 +171,224 @@
</li>
</ul></div>
<div class="table">
-<a name="id453521"></a><p class="title"><b>Table 1. More Formatting
Samples</b></p>
+<a name="id453602"></a><p class="title"><b>Table 1. More Formatting
Samples</b></p>
<table class="table" summary="More Formatting Samples">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
-<th>Markup</th>
-<th>Result</th>
+<th>
+ <p>
+ Markup
+ </p>
+ </th>
+<th>
+ <p>
+ Result
+ </p>
+ </th>
</tr></thead>
<tbody>
<tr>
-<td><tt class="literal">*Bold*</tt></td>
-<td><span class="bold"><b>Bold</b></span></td>
+<td>
+ <p>
+ <tt class="literal">*Bold*</tt>
+ </p>
+ </td>
+<td>
+ <p>
+ <span class="bold"><b>Bold</b></span>
+ </p>
+ </td>
</tr>
<tr>
-<td><tt class="literal">*Is bold*</tt></td>
-<td><span class="bold"><b>Is bold</b></span></td>
+<td>
+ <p>
+ <tt class="literal">*Is bold*</tt>
+ </p>
+ </td>
+<td>
+ <p>
+ <span class="bold"><b>Is bold</b></span>
+ </p>
+ </td>
</tr>
<tr>
-<td><tt class="literal">* Not bold* *Not bold * * Not bold *</tt></td>
-<td>* Not bold* *Not bold * *
- Not bold *</td>
+<td>
+ <p>
+ <tt class="literal">* Not bold* *Not bold * * Not bold *</tt>
+ </p>
+ </td>
+<td>
+ <p>
+ * Not bold* *Not bold * * Not bold *
+ </p>
+ </td>
</tr>
<tr>
-<td><tt class="literal">This*Isn't*Bold (no bold)</tt></td>
-<td>This*Isn't*Bold (no bold)</td>
+<td>
+ <p>
+ <tt class="literal">This*Isn't*Bold (no bold)</tt>
+ </p>
+ </td>
+<td>
+ <p>
+ This*Isn't*Bold (no bold)
+ </p>
+ </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>
+ <p>
+ <tt class="literal">(*Bold Inside*) (parenthesis not bold)</tt>
+ </p>
+ </td>
+<td>
+ <p>
+ (<span class="bold"><b>Bold Inside</b></span>) (parenthesis
not bold)
+ </p>
+ </td>
</tr>
<tr>
-<td><tt class="literal">*(Bold Outside)* (parenthesis bold)</tt></td>
<td>
-<span class="bold"><b>(Bold
- Outside)</b></span> (parenthesis bold)</td>
+ <p>
+ <tt class="literal">*(Bold Outside)* (parenthesis bold)</tt>
+ </p>
+ </td>
+<td>
+ <p>
+ <span class="bold"><b>(Bold Outside)</b></span> (parenthesis
bold)
+ </p>
+ </td>
</tr>
<tr>
-<td><tt class="literal">3*4*5 = 60 (no bold)</tt></td>
-<td>3*4*5 = 60 (no bold)</td>
+<td>
+ <p>
+ <tt class="literal">3*4*5 = 60 (no bold)</tt>
+ </p>
+ </td>
+<td>
+ <p>
+ 3*4*5 = 60 (no bold)
+ </p>
+ </td>
</tr>
<tr>
-<td><tt class="literal">3 * 4 * 5 = 60 (no bold)</tt></td>
-<td>3 * 4 * 5 = 60 (no bold)</td>
+<td>
+ <p>
+ <tt class="literal">3 * 4 * 5 = 60 (no bold)</tt>
+ </p>
+ </td>
+<td>
+ <p>
+ 3 * 4 * 5 = 60 (no bold)
+ </p>
+ </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>
+ <p>
+ <tt class="literal">3 *4* 5 = 60 (4 is bold)</tt>
+ </p>
+ </td>
+<td>
+ <p>
+ 3 <span class="bold"><b>4</b></span> 5 = 60 (4 is bold)
+ </p>
+ </td>
</tr>
<tr>
-<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>
-</td>
+ <p>
+ <tt class="literal">*This is bold* this is not *but this
is*</tt>
+ </p>
+ </td>
+<td>
+ <p>
+ <span class="bold"><b>This is bold</b></span> this is not
<span class="bold"><b>but this is</b></span>
+ </p>
+ </td>
</tr>
<tr>
-<td><tt class="literal">*This is bold*.</tt></td>
<td>
-<span class="bold"><b>This
- is bold</b></span>.</td>
+ <p>
+ <tt class="literal">*This is bold*.</tt>
+ </p>
+ </td>
+<td>
+ <p>
+ <span class="bold"><b>This is bold</b></span>.
+ </p>
+ </td>
</tr>
<tr>
-<td><tt class="literal">*B*. (bold B)</tt></td>
<td>
-<span class="bold"><b>B</b></span>.
- (bold B)</td>
+ <p>
+ <tt class="literal">*B*. (bold B)</tt>
+ </p>
+ </td>
+<td>
+ <p>
+ <span class="bold"><b>B</b></span>. (bold B)
+ </p>
+ </td>
</tr>
<tr>
-<td><tt class="literal">['*Bold-Italic*]</tt></td>
-<td><span class="emphasis"><em><span
class="bold"><b>Bold-Italic</b></span></em></span></td>
+<td>
+ <p>
+ <tt class="literal">['*Bold-Italic*]</tt>
+ </p>
+ </td>
+<td>
+ <p>
+ <span class="emphasis"><em><span
class="bold"><b>Bold-Italic</b></span></em></span>
+ </p>
+ </td>
</tr>
<tr>
-<td><tt class="literal">*side-by*/-side/</tt></td>
<td>
-<span class="bold"><b>side-by</b></span><span
class="emphasis"><em>-side</em></span>
-</td>
+ <p>
+ <tt class="literal">*side-by*/-side/</tt>
+ </p>
+ </td>
+<td>
+ <p>
+ <span class="bold"><b>side-by</b></span><span
class="emphasis"><em>-side</em></span>
+ </p>
+ </td>
</tr>
</tbody>
</table>
</div>
+<p>
+ As mentioned, simple markups cannot go past a single block. The text
from
+ "have" to "full" in the following paragraph will be
+ rendered as bold:
+ </p>
+<pre class="programlisting">Baa baa black sheep, *have you any wool?
+Yes sir, yes sir, three bags full!*
+One for the master, one for the dame,
+And one for the little boy who lives down the lane.
+</pre>
+<p>
+ Baa baa black sheep, <span class="bold"><b>have you any wool? Yes
sir,
+ yes sir, three bags full!</b></span> One for the master, one for the
dame,
+ And one for the little boy who lives down the lane.
+ </p>
+<p>
+ But in the following paragraph, bold is not applied:
+ </p>
+<pre class="programlisting">Baa baa black sheep, *have you any wool?
+Yes sir, yes sir, three bags full!
+One for the master, one for the dame,
+And one for the little boy who lives down the lane.
+</pre>
+<p>
+ Baa baa black sheep, *have you any wool? Yes sir, yes sir, three
bags full!
+ One for the master, one for the dame, And one for the little boy who
lives
+ down the lane.
+ </p>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h4 class="title">
@@ -276,11 +411,17 @@
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]"
src="../../images/note.png"></td>
<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 preferred
over <tt class="literal">[^some code]</tt>.
- </p></td></tr>
+<tr><td colspan="2" align="left" valign="top">
+<p>
+ </p>
+<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 preferred
over <tt class="literal">[^some code]</tt>.
+ </p>
+<p>
+ </p>
+</td></tr>
</table></div>
</div>
<div class="section" lang="en">
@@ -359,24 +500,48 @@
whereas a Python comment <tt class="computeroutput"><span
class="comment">#looks like this</span></tt>.
</p>
<div class="table">
-<a name="id454273"></a><p class="title"><b>Table 2. Supported Source
Modes</b></p>
+<a name="id454572"></a><p class="title"><b>Table 2. Supported Source
Modes</b></p>
<table class="table" summary="Supported Source Modes">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
-<th>Mode</th>
-<th>Source Mode Markup</th>
+<th>
+ <p>
+ Mode
+ </p>
+ </th>
+<th>
+ <p>
+ Source Mode Markup
+ </p>
+ </th>
</tr></thead>
<tbody>
<tr>
-<td>C++</td>
-<td><tt class="literal">[c++]</tt></td>
+<td>
+ <p>
+ C++
+ </p>
+ </td>
+<td>
+ <p>
+ <tt class="literal">[c++]</tt>
+ </p>
+ </td>
</tr>
<tr>
-<td>Python</td>
-<td><tt class="literal">[python]</tt></td>
+<td>
+ <p>
+ Python
+ </p>
+ </td>
+<td>
+ <p>
+ <tt class="literal">[python]</tt>
+ </p>
+ </td>
</tr>
</tbody>
</table>
@@ -386,9 +551,15 @@
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]"
src="../../images/note.png"></td>
<th align="left">Note</th>
</tr>
-<tr><td colspan="2" align="left" valign="top"><p>
- The source mode strings are lowercase.
- </p></td></tr>
+<tr><td colspan="2" align="left" valign="top">
+<p>
+ </p>
+<p>
+ The source mode strings are lowercase.
+ </p>
+<p>
+ </p>
+</td></tr>
</table></div>
</div>
<div class="section" lang="en">
@@ -396,15 +567,23 @@
<a name="quickbook.syntax.phrase.line_break"></a><a
href="phrase.html#quickbook.syntax.phrase.line_break"
title="line-break">line-break</a></h4></div></div></div>
<pre class="programlisting">[br]
</pre>
-<div class="note"><table border="0" summary="Note">
+<div class="warning"><table border="0" summary="Warning">
<tr>
-<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]"
src="../../images/note.png"></td>
-<th align="left">Note</th>
+<td rowspan="2" align="center" valign="top" width="25"><img alt="[Warning]"
src="../../images/warning.png"></td>
+<th align="left">Warning</th>
</tr>
-<tr><td colspan="2" align="left" valign="top"><p>
- 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></td></tr>
+<tr><td colspan="2" align="left" valign="top">
+<p>
+ </p>
+<p>
+ <tt class="computeroutput"><span class="special">[</span><span
class="identifier">br</span><span class="special">]</span></tt> is now
deprecated. <a href="block.html#quickbook.syntax.block.blurbs"
title="Blurbs">Blurbs</a>,
+ <a href="block.html#quickbook.syntax.block.admonitions"
title="Admonitions">Admonitions</a>
+ and table cells (see <a
href="block.html#quickbook.syntax.block.tables" title="Tables">Tables</a>)
+ may now contain paragraphs.
+ </p>
+<p>
+ </p>
+</td></tr>
</table></div>
</div>
<div class="section" lang="en">
@@ -537,9 +716,15 @@
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Important]"
src="../../images/important.png"></td>
<th align="left">Important</th>
</tr>
-<tr><td colspan="2" align="left" valign="top"><p>
- Be careful when using the escape. The text must conform to <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.
- </p></td></tr>
+<tr><td colspan="2" align="left" valign="top">
+<p>
+ </p>
+<p>
+ Be careful when using the escape. The text must conform to <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.
+ </p>
+<p>
+ </p>
+</td></tr>
</table></div>
</div>
<div class="section" lang="en">
@@ -555,9 +740,27 @@
</p>
<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>.
+ has a special meaning. It is used to generate line breaks.
</p>
+<div class="warning"><table border="0" summary="Warning">
+<tr>
+<td rowspan="2" align="center" valign="top" width="25"><img alt="[Warning]"
src="../../images/warning.png"></td>
+<th align="left">Warning</th>
+</tr>
+<tr><td colspan="2" align="left" valign="top">
+<p>
+ </p>
+<p>
+ <tt class="computeroutput"><span class="special">\</span><span
class="identifier">n</span></tt>
+ and <tt class="computeroutput"><span
class="special">[</span><span class="identifier">br</span><span
class="special">]</span></tt> are now deprecated. <a
href="block.html#quickbook.syntax.block.blurbs" title="Blurbs">Blurbs</a>,
+ <a href="block.html#quickbook.syntax.block.admonitions"
title="Admonitions">Admonitions</a>
+ and table cells (see <a
href="block.html#quickbook.syntax.block.tables" title="Tables">Tables</a>)
+ may now contain paragraphs.
+ </p>
+<p>
+ </p>
+</td></tr>
+</table></div>
<p>
The escaped space: <tt class="computeroutput"><span
class="special">\</span> </tt> also
has a special meaning. The escaped space is removed from the output.
@@ -587,7 +790,7 @@
</pre>
<p>
will generate this
- <sup>[<a name="id455028" href="#ftn.id455028">2</a>]</sup>
+ <sup>[<a name="id455412" href="#ftn.id455412">2</a>]</sup>
.
</p>
<div class="section" lang="en">
@@ -616,14 +819,14 @@
</div>
<div class="footnotes">
<br><hr width="100" align="left">
-<div class="footnote"><p><sup>[<a name="ftn.id383261" href="#id383261">1</a>]
</sup>
+<div class="footnote"><p><sup>[<a name="ftn.id383135" href="#id383135">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.id455028" href="#id455028">2</a>]
</sup>
+<div class="footnote"><p><sup>[<a name="ftn.id455412" href="#id455412">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
