Update of /cvsroot/boost/boost/tools/quickbook/doc/html/quickbook/syntax
In directory
sc8-pr-cvs3.sourceforge.net:/tmp/cvs-serv8034/doc/html/quickbook/syntax
Modified Files:
block.html comments.html phrase.html
Log Message:
- fix bug in paragraphs inside tables where there's an empty line with some
space
- adjusted the tests to new code changes
- doc updates
Index: block.html
===================================================================
RCS file:
/cvsroot/boost/boost/tools/quickbook/doc/html/quickbook/syntax/block.html,v
retrieving revision 1.42
retrieving revision 1.43
diff -u -d -r1.42 -r1.43
--- block.html 4 Jun 2007 15:08:36 -0000 1.42
+++ block.html 21 Jul 2007 04:56:36 -0000 1.43
@@ -3,29 +3,28 @@
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title> Block Level Elements</title>
<link rel="stylesheet" href="../../boostbook.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.70.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.66.1">
<link rel="start" href="../../index.html" title="Quickbook 1.4">
<link rel="up" href="../syntax.html" title=" Syntax Summary">
<link rel="prev" href="phrase.html" title=" Phrase Level Elements">
<link rel="next" href="../install.html" title=" Installation and
configuration">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084"
alink="#0000FF">
[...1011 lines suppressed...]
+<td valign="top" align="left"><p> Get the <tt class="computeroutput"><span
class="identifier">n</span></tt>
member variable </p></td>
</tr>
<tr>
<td width="5%" valign="top" align="left">
<a name="quickbook5"></a><a href="#quickbook5co"><img
src="../../images/callouts/4.png" alt="4" border="0"></a> </td>
-<td valign="top" align="left"><p> Set the <code class="computeroutput"><span
class="identifier">n</span></code>
+<td valign="top" align="left"><p> Set the <tt class="computeroutput"><span
class="identifier">n</span></tt>
member variable </p></td>
</tr>
</table></div>
@@ -1908,7 +1929,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="phrase.html"><img src="../../images/prev.png"
alt="Prev"></a><a accesskey="u" href="../syntax.html"><img
src="../../images/up.png" alt="Up"></a><a accesskey="h"
href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a
accesskey="n" href="../install.html"><img src="../../images/next.png"
alt="Next"></a>
+<a accesskey="p" href="phrase.html"><img
src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a
accesskey="u" href="../syntax.html"><img
src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h"
href="../../index.html"><img src="../../../../../../doc/html/images/home.png"
alt="Home"></a><a accesskey="n" href="../install.html"><img
src="../../../../../../doc/html/images/next.png" alt="Next"></a>
</div>
</body>
</html>
Index: comments.html
===================================================================
RCS file:
/cvsroot/boost/boost/tools/quickbook/doc/html/quickbook/syntax/comments.html,v
retrieving revision 1.15
retrieving revision 1.16
diff -u -d -r1.15 -r1.16
--- comments.html 4 Jun 2007 15:08:36 -0000 1.15
+++ comments.html 21 Jul 2007 04:56:36 -0000 1.16
@@ -3,29 +3,28 @@
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Comments</title>
<link rel="stylesheet" href="../../boostbook.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.70.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.66.1">
<link rel="start" href="../../index.html" title="Quickbook 1.4">
<link rel="up" href="../syntax.html" title=" Syntax Summary">
<link rel="prev" href="../syntax.html" title=" Syntax Summary">
<link rel="next" href="phrase.html" title=" Phrase Level Elements">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084"
alink="#0000FF">
-<table cellpadding="2" width="100%">
+<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.htm">Home</a></td>
<td align="center"><a
href="../../../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a
href="../../../../../../people/people.htm">People</a></td>
<td align="center"><a href="../../../../../../more/faq.htm">FAQ</a></td>
<td align="center"><a href="../../../../../../more/index.htm">More</a></td>
-</table>
+</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="../syntax.html"><img src="../../images/prev.png"
alt="Prev"></a><a accesskey="u" href="../syntax.html"><img
src="../../images/up.png" alt="Up"></a><a accesskey="h"
href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a
accesskey="n" href="phrase.html"><img src="../../images/next.png"
alt="Next"></a>
+<a accesskey="p" href="../syntax.html"><img
src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a
accesskey="u" href="../syntax.html"><img
src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h"
href="../../index.html"><img src="../../../../../../doc/html/images/home.png"
alt="Home"></a><a accesskey="n" href="phrase.html"><img
src="../../../../../../doc/html/images/next.png" alt="Next"></a>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
-<a name="quickbook.syntax.comments"></a><a href="comments.html"
title="Comments">Comments</a>
-</h3></div></div></div>
+<a name="quickbook.syntax.comments"></a><a href="comments.html"
title="Comments">Comments</a></h3></div></div></div>
<p>
Can be placed anywhere.
</p>
@@ -43,7 +42,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="../syntax.html"><img src="../../images/prev.png"
alt="Prev"></a><a accesskey="u" href="../syntax.html"><img
src="../../images/up.png" alt="Up"></a><a accesskey="h"
href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a
accesskey="n" href="phrase.html"><img src="../../images/next.png"
alt="Next"></a>
+<a accesskey="p" href="../syntax.html"><img
src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a
accesskey="u" href="../syntax.html"><img
src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h"
href="../../index.html"><img src="../../../../../../doc/html/images/home.png"
alt="Home"></a><a accesskey="n" href="phrase.html"><img
src="../../../../../../doc/html/images/next.png" alt="Next"></a>
</div>
</body>
</html>
Index: phrase.html
===================================================================
RCS file:
/cvsroot/boost/boost/tools/quickbook/doc/html/quickbook/syntax/phrase.html,v
retrieving revision 1.32
retrieving revision 1.33
diff -u -d -r1.32 -r1.33
--- phrase.html 4 Jun 2007 15:08:36 -0000 1.32
+++ phrase.html 21 Jul 2007 04:56:36 -0000 1.33
@@ -3,29 +3,28 @@
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title> Phrase Level Elements</title>
<link rel="stylesheet" href="../../boostbook.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.70.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.66.1">
<link rel="start" href="../../index.html" title="Quickbook 1.4">
<link rel="up" href="../syntax.html" title=" Syntax Summary">
<link rel="prev" href="comments.html" title="Comments">
<link rel="next" href="block.html" title=" Block Level Elements">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084"
alink="#0000FF">
-<table cellpadding="2" width="100%">
+<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.htm">Home</a></td>
<td align="center"><a
href="../../../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a
href="../../../../../../people/people.htm">People</a></td>
<td align="center"><a href="../../../../../../more/faq.htm">FAQ</a></td>
<td align="center"><a href="../../../../../../more/index.htm">More</a></td>
-</table>
+</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="comments.html"><img src="../../images/prev.png"
alt="Prev"></a><a accesskey="u" href="../syntax.html"><img
src="../../images/up.png" alt="Up"></a><a accesskey="h"
href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a
accesskey="n" href="block.html"><img src="../../images/next.png" alt="Next"></a>
+<a accesskey="p" href="comments.html"><img
src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a
accesskey="u" href="../syntax.html"><img
src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h"
href="../../index.html"><img src="../../../../../../doc/html/images/home.png"
alt="Home"></a><a accesskey="n" href="block.html"><img
src="../../../../../../doc/html/images/next.png" alt="Next"></a>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
-<a name="quickbook.syntax.phrase"></a><a href="phrase.html" title=" Phrase
Level Elements"> Phrase Level Elements</a>
-</h3></div></div></div>
+<a name="quickbook.syntax.phrase"></a><a href="phrase.html" title=" Phrase
Level Elements"> Phrase Level Elements</a></h3></div></div></div>
<div class="toc"><dl>
<dt><span class="section"><a
href="phrase.html#quickbook.syntax.phrase.font_styles">Font
Styles</a></span></dt>
<dt><span class="section"><a
href="phrase.html#quickbook.syntax.phrase.replaceable">Replaceable</a></span></dt>
@@ -48,15 +47,14 @@
</dl></div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h4 class="title">
-<a name="quickbook.syntax.phrase.font_styles"></a><a
href="phrase.html#quickbook.syntax.phrase.font_styles" title="Font Styles">Font
Styles</a>
-</h4></div></div></div>
+<a name="quickbook.syntax.phrase.font_styles"></a><a
href="phrase.html#quickbook.syntax.phrase.font_styles" title="Font Styles">Font
Styles</a></h4></div></div></div>
<pre class="programlisting">['italic], [*bold], [_underline], [^teletype],
[-strikethrough]
</pre>
<p>
will generate:
</p>
<p>
- <span class="emphasis"><em>italic</em></span>, <span
class="bold"><strong>bold</strong></span>, <span
class="underline">underline</span>, <code class="literal">teletype</code>,
<span class="strikethrough">strikethrough</span>
+ <span class="emphasis"><em>italic</em></span>, <span
class="bold"><b>bold</b></span>, <span class="underline">underline</span>, <tt
class="literal">teletype</tt>, <span class="strikethrough">strikethrough</span>
</p>
<p>
Like all non-terminal phrase level elements, this can of course be
nested:
@@ -67,13 +65,12 @@
will generate:
</p>
<p>
- <span class="bold"><strong><span
class="emphasis"><em>bold-italic</em></span></strong></span>
+ <span class="bold"><b><span
class="emphasis"><em>bold-italic</em></span></b></span>
</p>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h4 class="title">
-<a name="quickbook.syntax.phrase.replaceable"></a><a
href="phrase.html#quickbook.syntax.phrase.replaceable"
title="Replaceable">Replaceable</a>
-</h4></div></div></div>
+<a name="quickbook.syntax.phrase.replaceable"></a><a
href="phrase.html#quickbook.syntax.phrase.replaceable"
title="Replaceable">Replaceable</a></h4></div></div></div>
<p>
When you want content that may or must be replaced by the user, use
the
syntax:
@@ -84,15 +81,14 @@
This will generate:
</p>
<p>
- <em class="replaceable"><code>
+ <i class="replaceable"><tt>
replacement
- </code></em>
+ </tt></i>
</p>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h4 class="title">
-<a name="quickbook.syntax.phrase.quotations"></a><a
href="phrase.html#quickbook.syntax.phrase.quotations"
title="Quotations">Quotations</a>
-</h4></div></div></div>
+<a name="quickbook.syntax.phrase.quotations"></a><a
href="phrase.html#quickbook.syntax.phrase.quotations"
title="Quotations">Quotations</a></h4></div></div></div>
<pre class="programlisting">["A question that sometimes drives me hazy: am I
or are the others crazy?]--Einstein
</pre>
<p>
@@ -123,8 +119,7 @@
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h4 class="title">
-<a name="quickbook.syntax.phrase.simple_formatting"></a><a
href="phrase.html#quickbook.syntax.phrase.simple_formatting" title="Simple
formatting">Simple formatting</a>
-</h4></div></div></div>
+<a name="quickbook.syntax.phrase.simple_formatting"></a><a
href="phrase.html#quickbook.syntax.phrase.simple_formatting" title="Simple
formatting">Simple formatting</a></h4></div></div></div>
<p>
Simple markup for formatting text, common in many applications, is
now
supported:
@@ -135,12 +130,12 @@
will generate:
</p>
<p>
- <span class="emphasis"><em>italic</em></span>, <span
class="bold"><strong>bold</strong></span>, <span
class="underline">underline</span>, <code class="literal">teletype</code>
+ <span class="emphasis"><em>italic</em></span>, <span
class="bold"><b>bold</b></span>, <span class="underline">underline</span>, <tt
class="literal">teletype</tt>
</p>
<p>
Unlike QuickBook's standard formatting scheme, the rules for simpler
alternatives
are much stricter
- <sup>[<a name="id2614286" href="#ftn.id2614286">1</a>]</sup>
+ <sup>[<a name="id385487" href="#ftn.id385487">1</a>]</sup>
.
</p>
<div class="itemizedlist"><ul type="disc">
@@ -176,8 +171,8 @@
</li>
</ul></div>
<div class="table">
-<a name="id2614374"></a><p class="title"><b>Table 1. More Formatting
Samples</b></p>
-<div class="table-contents"><table class="table" summary="More Formatting
Samples">
+<a name="id455953"></a><p class="title"><b>Table 1. More Formatting
Samples</b></p>
+<table class="table" summary="More Formatting Samples">
<colgroup>
<col>
<col>
@@ -198,31 +193,31 @@
<tr>
<td>
<p>
- <code class="literal">*Bold*</code>
+ <tt class="literal">*Bold*</tt>
</p>
</td>
<td>
<p>
- <span class="bold"><strong>Bold</strong></span>
+ <span class="bold"><b>Bold</b></span>
</p>
</td>
</tr>
<tr>
<td>
<p>
- <code class="literal">*Is bold*</code>
+ <tt class="literal">*Is bold*</tt>
</p>
</td>
<td>
<p>
- <span class="bold"><strong>Is bold</strong></span>
+ <span class="bold"><b>Is bold</b></span>
</p>
</td>
</tr>
<tr>
<td>
<p>
- <code class="literal">* Not bold* *Not bold * * Not bold
*</code>
+ <tt class="literal">* Not bold* *Not bold * * Not bold *</tt>
</p>
</td>
<td>
@@ -234,7 +229,7 @@
<tr>
<td>
<p>
- <code class="literal">This*Isn't*Bold (no bold)</code>
+ <tt class="literal">This*Isn't*Bold (no bold)</tt>
</p>
</td>
<td>
@@ -246,31 +241,31 @@
<tr>
<td>
<p>
- <code class="literal">(*Bold Inside*) (parenthesis not
bold)</code>
+ <tt class="literal">(*Bold Inside*) (parenthesis not bold)</tt>
</p>
</td>
<td>
<p>
- (<span class="bold"><strong>Bold Inside</strong></span>)
(parenthesis not bold)
+ (<span class="bold"><b>Bold Inside</b></span>) (parenthesis
not bold)
</p>
</td>
</tr>
<tr>
<td>
<p>
- <code class="literal">*(Bold Outside)* (parenthesis
bold)</code>
+ <tt class="literal">*(Bold Outside)* (parenthesis bold)</tt>
</p>
</td>
<td>
<p>
- <span class="bold"><strong>(Bold Outside)</strong></span>
(parenthesis bold)
+ <span class="bold"><b>(Bold Outside)</b></span> (parenthesis
bold)
</p>
</td>
</tr>
<tr>
<td>
<p>
- <code class="literal">3*4*5 = 60 (no bold)</code>
+ <tt class="literal">3*4*5 = 60 (no bold)</tt>
</p>
</td>
<td>
@@ -282,7 +277,7 @@
<tr>
<td>
<p>
- <code class="literal">3 * 4 * 5 = 60 (no bold)</code>
+ <tt class="literal">3 * 4 * 5 = 60 (no bold)</tt>
</p>
</td>
<td>
@@ -294,79 +289,79 @@
<tr>
<td>
<p>
- <code class="literal">3 *4* 5 = 60 (4 is bold)</code>
+ <tt class="literal">3 *4* 5 = 60 (4 is bold)</tt>
</p>
</td>
<td>
<p>
- 3 <span class="bold"><strong>4</strong></span> 5 = 60 (4 is
bold)
+ 3 <span class="bold"><b>4</b></span> 5 = 60 (4 is bold)
</p>
</td>
</tr>
<tr>
<td>
<p>
- <code class="literal">*This is bold* this is not *but this
is*</code>
+ <tt class="literal">*This is bold* this is not *but this
is*</tt>
</p>
</td>
<td>
<p>
- <span class="bold"><strong>This is bold</strong></span> this
is not <span class="bold"><strong>but this is</strong></span>
+ <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>
<p>
- <code class="literal">*This is bold*.</code>
+ <tt class="literal">*This is bold*.</tt>
</p>
</td>
<td>
<p>
- <span class="bold"><strong>This is bold</strong></span>.
+ <span class="bold"><b>This is bold</b></span>.
</p>
</td>
</tr>
<tr>
<td>
<p>
- <code class="literal">*B*. (bold B)</code>
+ <tt class="literal">*B*. (bold B)</tt>
</p>
</td>
<td>
<p>
- <span class="bold"><strong>B</strong></span>. (bold B)
+ <span class="bold"><b>B</b></span>. (bold B)
</p>
</td>
</tr>
<tr>
<td>
<p>
- <code class="literal">['*Bold-Italic*]</code>
+ <tt class="literal">['*Bold-Italic*]</tt>
</p>
</td>
<td>
<p>
- <span class="emphasis"><em><span
class="bold"><strong>Bold-Italic</strong></span></em></span>
+ <span class="emphasis"><em><span
class="bold"><b>Bold-Italic</b></span></em></span>
</p>
</td>
</tr>
<tr>
<td>
<p>
- <code class="literal">*side-by*/-side/</code>
+ <tt class="literal">*side-by*/-side/</tt>
</p>
</td>
<td>
<p>
- <span class="bold"><strong>side-by</strong></span><span
class="emphasis"><em>-side</em></span>
+ <span class="bold"><b>side-by</b></span><span
class="emphasis"><em>-side</em></span>
</p>
</td>
</tr>
</tbody>
-</table></div>
+</table>
</div>
-<br class="table-break"><p>
+<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:
@@ -377,8 +372,8 @@
And one for the little boy who lives down the lane.
</pre>
<p>
- Baa baa black sheep, <span class="bold"><strong>have you any wool?
Yes sir,
- yes sir, three bags full!</strong></span> One for the master, one
for the dame,
+ 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>
@@ -397,8 +392,7 @@
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h4 class="title">
-<a name="quickbook.syntax.phrase.inline_code"></a><a
href="phrase.html#quickbook.syntax.phrase.inline_code" title="Inline
code">Inline code</a>
-</h4></div></div></div>
+<a name="quickbook.syntax.phrase.inline_code"></a><a
href="phrase.html#quickbook.syntax.phrase.inline_code" title="Inline
code">Inline code</a></h4></div></div></div>
<p>
Inlining code in paragraphs is quite common when writing C++
documentation.
We provide a very simple markup for this. For example, this:
@@ -409,21 +403,21 @@
will generate:
</p>
<p>
- This text has inlined code <code class="computeroutput"><span
class="keyword">int</span> <span class="identifier">main</span><span
class="special">()</span> <span class="special">{</span> <span
class="keyword">return</span> <span class="number">0</span><span
class="special">;</span> <span class="special">}</span></code>
+ This text has inlined code <tt class="computeroutput"><span
class="keyword">int</span> <span class="identifier">main</span><span
class="special">()</span> <span class="special">{</span> <span
class="keyword">return</span> <span class="number">0</span><span
class="special">;</span> <span class="special">}</span></tt>
in it. The code will be syntax highlighted.
</p>
<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>
+<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]"
src="../../../../../../doc/html/images/note.png"></td>
<th align="left">Note</th>
</tr>
-<tr><td align="left" valign="top">
+<tr><td colspan="2" align="left" valign="top">
<p>
</p>
<p>
- We simply enclose the code with the tick: <code
class="literal">"`"</code>, not
- the single quote: <code class="computeroutput"><span
class="string">"'"</span></code>.
- Note too that <code class="literal">`some code`</code> is
preferred over <code class="literal">[^some code]</code>.
+ 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>
@@ -432,8 +426,7 @@
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h4 class="title">
-<a name="quickbook.syntax.phrase.code_blocks"></a><a
href="phrase.html#quickbook.syntax.phrase.code_blocks" title="Code blocks">Code
blocks</a>
-</h4></div></div></div>
+<a name="quickbook.syntax.phrase.code_blocks"></a><a
href="phrase.html#quickbook.syntax.phrase.code_blocks" title="Code blocks">Code
blocks</a></h4></div></div></div>
<p>
Preformatted code simply starts with a space or a tab (See <a
href="block.html#quickbook.syntax.block.code" title="Code">Code</a>).
However, such a simple syntax cannot be used as phrase elements in
lists
@@ -480,8 +473,7 @@
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h4 class="title">
-<a name="quickbook.syntax.phrase.source_mode"></a><a
href="phrase.html#quickbook.syntax.phrase.source_mode" title="Source
Mode">Source Mode</a>
-</h4></div></div></div>
+<a name="quickbook.syntax.phrase.source_mode"></a><a
href="phrase.html#quickbook.syntax.phrase.source_mode" title="Source
Mode">Source Mode</a></h4></div></div></div>
<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
@@ -490,8 +482,8 @@
section.
</p>
<p>
- To change the source mode, use the <code
class="literal">[source-mode]</code> markup,
- where <code class="literal">source-mode</code> is one of the
supported modes. For
+ To change the source mode, use the <tt
class="literal">[source-mode]</tt> markup,
+ where <tt class="literal">source-mode</tt> is one of the supported
modes. For
example, this:
</p>
<pre class="programlisting">Python's [python] `import` is rather like C++'s
[c++] `#include`. A
@@ -502,14 +494,14 @@
will generate:
</p>
<p>
- Python's <code class="computeroutput"><span
class="keyword">import</span></code> is rather
- like C++'s <code class="computeroutput"><span
class="preprocessor">#include</span></code>.
- A C++ comment <code class="computeroutput"><span class="comment">//
looks like this</span></code>
- whereas a Python comment <code class="computeroutput"><span
class="comment">#looks like this</span></code>.
+ Python's <tt class="computeroutput"><span
class="keyword">import</span></tt> is rather
+ like C++'s <tt class="computeroutput"><span
class="preprocessor">#include</span></tt>.
+ A C++ comment <tt class="computeroutput"><span class="comment">//
looks like this</span></tt>
+ whereas a Python comment <tt class="computeroutput"><span
class="comment">#looks like this</span></tt>.
</p>
<div class="table">
-<a name="id2615277"></a><p class="title"><b>Table 2. Supported Source
Modes</b></p>
-<div class="table-contents"><table class="table" summary="Supported Source
Modes">
+<a name="id456938"></a><p class="title"><b>Table 2. Supported Source
Modes</b></p>
+<table class="table" summary="Supported Source Modes">
<colgroup>
<col>
<col>
@@ -535,7 +527,7 @@
</td>
<td>
<p>
- <code class="literal">[c++]</code>
+ <tt class="literal">[c++]</tt>
</p>
</td>
</tr>
@@ -547,19 +539,19 @@
</td>
<td>
<p>
- <code class="literal">[python]</code>
+ <tt class="literal">[python]</tt>
</p>
</td>
</tr>
</tbody>
-</table></div>
+</table>
</div>
-<br class="table-break"><div class="note"><table border="0" summary="Note">
+<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>
+<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]"
src="../../../../../../doc/html/images/note.png"></td>
<th align="left">Note</th>
</tr>
-<tr><td align="left" valign="top">
+<tr><td colspan="2" align="left" valign="top">
<p>
</p>
<p>
@@ -572,20 +564,19 @@
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h4 class="title">
-<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>
+<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="warning"><table border="0" summary="Warning">
<tr>
-<td rowspan="2" align="center" valign="top" width="25"><img alt="[Warning]"
src="../../images/warning.png"></td>
+<td rowspan="2" align="center" valign="top" width="25"><img alt="[Warning]"
src="../../../../../../doc/html/images/warning.png"></td>
<th align="left">Warning</th>
</tr>
-<tr><td align="left" valign="top">
+<tr><td colspan="2" align="left" valign="top">
<p>
</p>
<p>
- <code class="computeroutput"><span class="special">[</span><span
class="identifier">br</span><span class="special">]</span></code> is now
deprecated. <a href="block.html#quickbook.syntax.block.blurbs"
title="Blurbs">Blurbs</a>,
+ <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.
@@ -597,29 +588,27 @@
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h4 class="title">
-<a name="quickbook.syntax.phrase.anchors"></a><a
href="phrase.html#quickbook.syntax.phrase.anchors" title="Anchors">Anchors</a>
-</h4></div></div></div>
+<a name="quickbook.syntax.phrase.anchors"></a><a
href="phrase.html#quickbook.syntax.phrase.anchors"
title="Anchors">Anchors</a></h4></div></div></div>
<pre class="programlisting">[#named_anchor]
</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 <code
class="literal">[link named_anchor
-Some link text]</code>.
+ 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">
<div class="titlepage"><div><div><h4 class="title">
-<a name="quickbook.syntax.phrase.links"></a><a
href="phrase.html#quickbook.syntax.phrase.links" title="Links">Links</a>
-</h4></div></div></div>
+<a name="quickbook.syntax.phrase.links"></a><a
href="phrase.html#quickbook.syntax.phrase.links"
title="Links">Links</a></h4></div></div></div>
<pre class="programlisting">[EMAIL PROTECTED]://www.boost.org this is
[*boost's] website....]
</pre>
<p>
will generate:
</p>
<p>
- <a href="http://www.boost.org"; target="_top">this is <span
class="bold"><strong>boost's</strong></span>
+ <a href="http://www.boost.org"; target="_top">this is <span
class="bold"><b>boost's</b></span>
website....</a>
</p>
<p>
@@ -641,8 +630,7 @@
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h4 class="title">
-<a name="quickbook.syntax.phrase.anchor_links"></a><a
href="phrase.html#quickbook.syntax.phrase.anchor_links" title="Anchor
links">Anchor links</a>
-</h4></div></div></div>
+<a name="quickbook.syntax.phrase.anchor_links"></a><a
href="phrase.html#quickbook.syntax.phrase.anchor_links" title="Anchor
links">Anchor links</a></h4></div></div></div>
<p>
You can link within a document using:
</p>
@@ -656,16 +644,15 @@
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h4 class="title">
-<a name="quickbook.syntax.phrase.refentry_links"></a><a
href="phrase.html#quickbook.syntax.phrase.refentry_links" title="refentry
links">refentry links</a>
-</h4></div></div></div>
+<a name="quickbook.syntax.phrase.refentry_links"></a><a
href="phrase.html#quickbook.syntax.phrase.refentry_links" title="refentry
links">refentry links</a></h4></div></div></div>
<p>
In addition, you can link internally to an XML refentry like:
</p>
<pre class="programlisting">[link xml.refentry The link text]
</pre>
<p>
- This gets converted into <code class="literal"><link
linkend="xml.refentry">The
- link text</link></code>.
+ This gets converted into <tt class="literal"><link
linkend="xml.refentry">The
+ link text</link></tt>.
</p>
<p>
Like URLs, the link text is optional. If this is not present, the
link
@@ -674,13 +661,12 @@
<pre class="programlisting">[link xml.refentry]
</pre>
<p>
- This gets converted into <code class="literal"><link
linkend="xml.refentry">xml.refentry</link></code>.
+ This gets converted into <tt class="literal"><link
linkend="xml.refentry">xml.refentry</link></tt>.
</p>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h4 class="title">
-<a name="quickbook.syntax.phrase.code_links"></a><a
href="phrase.html#quickbook.syntax.phrase.code_links" title=" Code Links"> Code
Links</a>
-</h4></div></div></div>
+<a name="quickbook.syntax.phrase.code_links"></a><a
href="phrase.html#quickbook.syntax.phrase.code_links" title=" Code Links"> Code
Links</a></h4></div></div></div>
<p>
If you want to link to a function, class, member, enum, concept or
header
in the reference section, you can use:
@@ -706,8 +692,7 @@
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h4 class="title">
-<a name="quickbook.syntax.phrase.escape"></a><a
href="phrase.html#quickbook.syntax.phrase.escape" title="Escape">Escape</a>
-</h4></div></div></div>
+<a name="quickbook.syntax.phrase.escape"></a><a
href="phrase.html#quickbook.syntax.phrase.escape"
title="Escape">Escape</a></h4></div></div></div>
<p>
The escape mark-up is used when we don't want to do any processing.
</p>
@@ -724,14 +709,14 @@
'''
</pre>
<p>
- <span class="bold"><strong>This is direct XML markup</strong></span>
+ <span class="bold"><b>This is direct XML markup</b></span>
</p>
<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>
+<td rowspan="2" align="center" valign="top" width="25"><img alt="[Important]"
src="../../../../../../doc/html/images/important.png"></td>
<th align="left">Important</th>
</tr>
-<tr><td align="left" valign="top">
+<tr><td colspan="2" align="left" valign="top">
<p>
</p>
<p>
@@ -746,29 +731,28 @@
<div class="titlepage"><div><div><h4 class="title">
<a name="quickbook.syntax.phrase.single_char_escape"></a><a
href="phrase.html#quickbook.syntax.phrase.single_char_escape" title="Single
char escape">Single
- char escape</a>
-</h4></div></div></div>
+ char escape</a></h4></div></div></div>
<p>
The backslash may be used to escape a single punctuation character.
The
punctuation immediately after the backslash is passed without any
processing.
- This is useful when we need to escape QuickBook punctuations such as
<code class="computeroutput"><span class="special">[</span></code> and <code
class="computeroutput"><span class="special">]</span></code>.
- For example, how do you escape the triple quote? Simple: <code
class="literal">\'\'\'</code>
+ This is useful when we need to escape QuickBook punctuations such as
<tt class="computeroutput"><span class="special">[</span></tt> and <tt
class="computeroutput"><span class="special">]</span></tt>.
+ For example, how do you escape the triple quote? Simple: <tt
class="literal">\'\'\'</tt>
</p>
<p>
- <code class="computeroutput"><span class="special">\</span><span
class="identifier">n</span></code>
+ <tt class="computeroutput"><span class="special">\</span><span
class="identifier">n</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>
+<td rowspan="2" align="center" valign="top" width="25"><img alt="[Warning]"
src="../../../../../../doc/html/images/warning.png"></td>
<th align="left">Warning</th>
</tr>
-<tr><td align="left" valign="top">
+<tr><td colspan="2" align="left" valign="top">
<p>
</p>
<p>
- <code class="computeroutput"><span class="special">\</span><span
class="identifier">n</span></code>
- and <code class="computeroutput"><span
class="special">[</span><span class="identifier">br</span><span
class="special">]</span></code> are now deprecated. <a
href="block.html#quickbook.syntax.block.blurbs" title="Blurbs">Blurbs</a>,
+ <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.
@@ -778,21 +762,19 @@
</td></tr>
</table></div>
<p>
- The escaped space: <code class="computeroutput"><span
class="special">\</span> </code> also
+ The escaped space: <tt class="computeroutput"><span
class="special">\</span> </tt> also
has a special meaning. The escaped space is removed from the output.
</p>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h4 class="title">
-<a name="quickbook.syntax.phrase.images"></a><a
href="phrase.html#quickbook.syntax.phrase.images" title="Images">Images</a>
-</h4></div></div></div>
+<a name="quickbook.syntax.phrase.images"></a><a
href="phrase.html#quickbook.syntax.phrase.images"
title="Images">Images</a></h4></div></div></div>
<pre class="programlisting">[$image.jpg]
</pre>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h4 class="title">
-<a name="quickbook.syntax.phrase.footnotes"></a><a
href="phrase.html#quickbook.syntax.phrase.footnotes"
title="Footnotes">Footnotes</a>
-</h4></div></div></div>
+<a name="quickbook.syntax.phrase.footnotes"></a><a
href="phrase.html#quickbook.syntax.phrase.footnotes"
title="Footnotes">Footnotes</a></h4></div></div></div>
<div class="toc"><dl>
<dt><span class="section"><a
href="phrase.html#quickbook.syntax.phrase.footnotes.macro_expansion">Macro
Expansion</a></span></dt>
@@ -801,22 +783,21 @@
</dl></div>
<p>
As of version 1.3, QuickBook supports footnotes. Just put the text
of the
- footnote in a <code class="computeroutput"><span
class="special">[</span><span class="identifier">footnote</span><span
class="special">]</span></code> block, and the text will be put at the
+ footnote in a <tt class="computeroutput"><span
class="special">[</span><span class="identifier">footnote</span><span
class="special">]</span></tt> block, and the text will be put at the
bottom of the current page. For example, this:
</p>
<pre class="programlisting">[footnote A sample footnote]
</pre>
<p>
will generate this
- <sup>[<a name="id2616086" href="#ftn.id2616086">2</a>]</sup>
+ <sup>[<a name="id457794" href="#ftn.id457794">2</a>]</sup>
.
</p>
<div class="section" lang="en">
<div class="titlepage"><div><div><h5 class="title">
<a name="quickbook.syntax.phrase.footnotes.macro_expansion"></a><a
href="phrase.html#quickbook.syntax.phrase.footnotes.macro_expansion"
title="Macro
Expansion">Macro
- Expansion</a>
-</h5></div></div></div>
+ Expansion</a></h5></div></div></div>
<pre class="programlisting">__a_macro_identifier__
</pre>
<p>
@@ -827,8 +808,7 @@
<div class="titlepage"><div><div><h5 class="title">
<a name="quickbook.syntax.phrase.footnotes.template_expansion"></a><a
href="phrase.html#quickbook.syntax.phrase.footnotes.template_expansion"
title="Template
Expansion">Template
- Expansion</a>
-</h5></div></div></div>
+ Expansion</a></h5></div></div></div>
<pre class="programlisting">[a_template_identifier]
</pre>
<p>
@@ -839,14 +819,14 @@
</div>
<div class="footnotes">
<br><hr width="100" align="left">
-<div class="footnote"><p><sup>[<a name="ftn.id2614286"
href="#id2614286">1</a>] </sup>
+<div class="footnote"><p><sup>[<a name="ftn.id385487" href="#id385487">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.id2616086"
href="#id2616086">2</a>] </sup>
+<div class="footnote"><p><sup>[<a name="ftn.id457794" href="#id457794">2</a>]
</sup>
A sample footnote
</p></div>
</div>
@@ -858,7 +838,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="comments.html"><img src="../../images/prev.png"
alt="Prev"></a><a accesskey="u" href="../syntax.html"><img
src="../../images/up.png" alt="Up"></a><a accesskey="h"
href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a
accesskey="n" href="block.html"><img src="../../images/next.png" alt="Next"></a>
+<a accesskey="p" href="comments.html"><img
src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a
accesskey="u" href="../syntax.html"><img
src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h"
href="../../index.html"><img src="../../../../../../doc/html/images/home.png"
alt="Home"></a><a accesskey="n" href="block.html"><img
src="../../../../../../doc/html/images/next.png" alt="Next"></a>
</div>
</body>
</html>
-------------------------------------------------------------------------
This SF.net email is sponsored by: Microsoft
Defy all challenges. Microsoft(R) Visual Studio 2005.
http://clk.atdmt.com/MRT/go/vse0120000070mrt/direct/01/
_______________________________________________
Boost-cvs mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/boost-cvs
