|
|
Boost-Commit : |
From: daniel_james_at_[hidden]
Date: 2007-12-03 15:31:03
Author: danieljames
Date: 2007-12-03 15:31:01 EST (Mon, 03 Dec 2007)
New Revision: 41662
URL: http://svn.boost.org/trac/boost/changeset/41662
Log:
Rebuild the quickbook documentation.
Text files modified:
branches/fix-links/tools/quickbook/doc/html/index.html | 12
branches/fix-links/tools/quickbook/doc/html/quickbook/change_log.html | 39 ++--
branches/fix-links/tools/quickbook/doc/html/quickbook/editors.html | 22 +
branches/fix-links/tools/quickbook/doc/html/quickbook/editors/kde_support.html | 105 +++++-----
branches/fix-links/tools/quickbook/doc/html/quickbook/editors/scite.html | 29 +-
branches/fix-links/tools/quickbook/doc/html/quickbook/faq.html | 29 +-
branches/fix-links/tools/quickbook/doc/html/quickbook/install.html | 19 +
branches/fix-links/tools/quickbook/doc/html/quickbook/install/linux.html | 43 ++--
branches/fix-links/tools/quickbook/doc/html/quickbook/install/macosx.html | 51 ++--
branches/fix-links/tools/quickbook/doc/html/quickbook/install/windows.html | 55 ++--
branches/fix-links/tools/quickbook/doc/html/quickbook/intro.html | 17
branches/fix-links/tools/quickbook/doc/html/quickbook/ref.html | 142 +++++++-------
branches/fix-links/tools/quickbook/doc/html/quickbook/syntax.html | 13
branches/fix-links/tools/quickbook/doc/html/quickbook/syntax/block.html | 377 +++++++++++++++++++++------------------
branches/fix-links/tools/quickbook/doc/html/quickbook/syntax/comments.html | 15
branches/fix-links/tools/quickbook/doc/html/quickbook/syntax/phrase.html | 249 ++++++++++++++------------
16 files changed, 637 insertions(+), 580 deletions(-)
Modified: branches/fix-links/tools/quickbook/doc/html/index.html
==============================================================================
--- branches/fix-links/tools/quickbook/doc/html/index.html (original)
+++ branches/fix-links/tools/quickbook/doc/html/index.html 2007-12-03 15:31:01 EST (Mon, 03 Dec 2007)
@@ -3,17 +3,17 @@
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Quickbook 1.4</title>
<link rel="stylesheet" href="../../../../doc/html/boostbook.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.66.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.72.0">
<link rel="start" href="index.html" title="Quickbook 1.4">
-<link rel="next" href="quickbook/intro.html" title=" Introduction">
+<link rel="next" href="quickbook/intro.html" title="Introduction">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<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">Home</td>
<td align="center">Libraries</td>
-<td align="center">People</td>
-<td align="center">FAQ</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
<td align="center">More</td>
</tr></table>
<hr>
@@ -34,7 +34,7 @@
<div><p class="copyright">Copyright © 2002, 2004, 2006 Joel de Guzman,
Eric Niebler</p></div>
<div><div class="legalnotice">
-<a name="id385586"></a><p>
+<a name="id2604240"></a><p>
Distributed under the Boost Software License, Version 1.0. (See accompanying
file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
</p>
@@ -70,7 +70,7 @@
</div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
-<td align="left"><p><small>Last revised: November 14, 2007 at 10:19:55 GMT</small></p></td>
+<td align="left"><p><small>Last revised: December 03, 2007 at 20:26:04 GMT</small></p></td>
<td align="right"><div class="copyright-footer"></div></td>
</tr></table>
<hr>
Modified: branches/fix-links/tools/quickbook/doc/html/quickbook/change_log.html
==============================================================================
--- branches/fix-links/tools/quickbook/doc/html/quickbook/change_log.html (original)
+++ branches/fix-links/tools/quickbook/doc/html/quickbook/change_log.html 2007-12-03 15:31:01 EST (Mon, 03 Dec 2007)
@@ -1,21 +1,21 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
-<title> Change Log</title>
+<title>Change Log</title>
<link rel="stylesheet" href="../../../../../doc/html/boostbook.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.66.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.72.0">
<link rel="start" href="../index.html" title="Quickbook 1.4">
<link rel="up" href="../index.html" title="Quickbook 1.4">
-<link rel="prev" href="intro.html" title=" Introduction">
-<link rel="next" href="syntax.html" title=" Syntax Summary">
+<link rel="prev" href="intro.html" title="Introduction">
+<link rel="next" href="syntax.html" title="Syntax Summary">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<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">Home</td>
<td align="center">Libraries</td>
-<td align="center">People</td>
-<td align="center">FAQ</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
<td align="center">More</td>
</tr></table>
<hr>
@@ -24,11 +24,12 @@
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
-<a name="quickbook.change_log"></a> Change Log</h2></div></div></div>
-<a name="quickbook.change_log.version_1_3"></a><h3>
-<a name="id386998"></a>
+<a name="quickbook.change_log"></a> Change Log
+</h2></div></div></div>
+<a name="quickbook.change_log.version_1_3"></a><h4>
+<a name="id2566990"></a>
<a href="change_log.html#quickbook.change_log.version_1_3">Version 1.3</a>
- </h3>
+ </h4>
<div class="itemizedlist"><ul type="disc">
<li>
Quickbook file inclusion [include].
@@ -65,7 +66,7 @@
</li>
<li>
Fully qualified section and headers. Subsection names are concatenated to
- the ID to avoid clashing. Example: <tt class="computeroutput"><span class="identifier">doc_name</span><span class="special">.</span><span class="identifier">sect_name</span><span class="special">.</span><span class="identifier">sub_sect_name</span><span class="special">.</span><span class="identifier">sub_sub_sect_name</span></tt>
+ the ID to avoid clashing. Example: <code class="computeroutput"><span class="identifier">doc_name</span><span class="special">.</span><span class="identifier">sect_name</span><span class="special">.</span><span class="identifier">sub_sect_name</span><span class="special">.</span><span class="identifier">sub_sub_sect_name</span></code>
</li>
<li>
Better &nbsp; and whitespace handling in code snippets.
@@ -93,10 +94,10 @@
Replaceable, with the [~replacement] syntax.
</li>
</ul></div>
-<a name="quickbook.change_log.version_1_4"></a><h3>
-<a name="id386285"></a>
+<a name="quickbook.change_log.version_1_4"></a><h4>
+<a name="id2565888"></a>
<a href="change_log.html#quickbook.change_log.version_1_4">Version 1.4</a>
- </h3>
+ </h4>
<div class="itemizedlist"><ul type="disc">
<li>
Generic Headers
@@ -115,7 +116,7 @@
</li>
<li>
Allow escape of spaces. The escaped space is removed from the output. Syntax:
- <tt class="computeroutput"><span class="special">\</span> </tt>.
+ <code class="computeroutput"><span class="special">\</span> </code>.
</li>
<li>
Nested comments are now allowed.
@@ -138,16 +139,16 @@
may now contain paragraphs.
</li>
<li>
-<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.
+<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.
</li>
<li>
-Conditional Generation.
+Conditional Generation.
Ala C++ #ifdef.
</li>
<li>
Searching of included and imported files in an extensible search path with
- <tt class="computeroutput"><span class="special">--</span><span class="identifier">include</span><span class="special">-</span><span class="identifier">path</span></tt> (<tt class="computeroutput"><span class="special">-</span><span class="identifier">I</span></tt>) option.
+ <code class="computeroutput"><span class="special">--</span><span class="identifier">include</span><span class="special">-</span><span class="identifier">path</span></code> (<code class="computeroutput"><span class="special">-</span><span class="identifier">I</span></code>) option.
</li>
</ul></div>
</div>
Modified: branches/fix-links/tools/quickbook/doc/html/quickbook/editors.html
==============================================================================
--- branches/fix-links/tools/quickbook/doc/html/quickbook/editors.html (original)
+++ branches/fix-links/tools/quickbook/doc/html/quickbook/editors.html 2007-12-03 15:31:01 EST (Mon, 03 Dec 2007)
@@ -1,21 +1,21 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
-<title> Editor Support</title>
+<title>Editor Support</title>
<link rel="stylesheet" href="../../../../../doc/html/boostbook.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.66.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.72.0">
<link rel="start" href="../index.html" title="Quickbook 1.4">
<link rel="up" href="../index.html" title="Quickbook 1.4">
-<link rel="prev" href="install/linux.html" title=" Debian, Ubuntu">
-<link rel="next" href="editors/scite.html" title=" Scintilla Text Editor">
+<link rel="prev" href="install/linux.html" title="Debian, Ubuntu">
+<link rel="next" href="editors/scite.html" title="Scintilla Text Editor">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<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">Home</td>
<td align="center">Libraries</td>
-<td align="center">People</td>
-<td align="center">FAQ</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
<td align="center">More</td>
</tr></table>
<hr>
@@ -24,7 +24,8 @@
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
-<a name="quickbook.editors"></a> Editor Support</h2></div></div></div>
+<a name="quickbook.editors"></a> Editor Support
+</h2></div></div></div>
<div class="toc"><dl>
<dt><span class="section"> Scintilla Text Editor</span></dt>
<dt><span class="section">KDE Support</span></dt>
@@ -34,11 +35,14 @@
The following sections list the settings for some editors which can help make
editing quickbook files a bit easier.
</p>
-<div class="sidebar"><p>
+<div class="sidebar">
+<p class="title"><b></b></p>
+<p>
<span class="inlinemediaobject"><img src="../images/note.png" alt="note"></span> You may submit your settings, tips, and suggestions to
the authors, or through the <a href="https://lists.sourceforge.net/lists/listinfo/boost-" target="_top">docs
Boost Docs mailing list</a>.
- </p></div>
+ </p>
+</div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
Modified: branches/fix-links/tools/quickbook/doc/html/quickbook/editors/kde_support.html
==============================================================================
--- branches/fix-links/tools/quickbook/doc/html/quickbook/editors/kde_support.html (original)
+++ branches/fix-links/tools/quickbook/doc/html/quickbook/editors/kde_support.html 2007-12-03 15:31:01 EST (Mon, 03 Dec 2007)
@@ -3,19 +3,19 @@
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>KDE Support</title>
<link rel="stylesheet" href="../../../../../../doc/html/boostbook.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.66.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.72.0">
<link rel="start" href="../../index.html" title="Quickbook 1.4">
-<link rel="up" href="../editors.html" title=" Editor Support">
-<link rel="prev" href="scite.html" title=" Scintilla Text Editor">
-<link rel="next" href="../faq.html" title=" Frequently Asked Questions">
+<link rel="up" href="../editors.html" title="Editor Support">
+<link rel="prev" href="scite.html" title="Scintilla Text Editor">
+<link rel="next" href="../faq.html" title="Frequently Asked Questions">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<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">Home</td>
<td align="center">Libraries</td>
-<td align="center">People</td>
-<td align="center">FAQ</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
<td align="center">More</td>
</tr></table>
<hr>
@@ -24,11 +24,12 @@
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
-<a name="quickbook.editors.kde_support"></a>KDE Support</h3></div></div></div>
-<a name="quickbook.editors.kde_support.boost__hs__quickbook"></a><h4>
-<a name="id466261"></a>
+<a name="quickbook.editors.kde_support"></a>KDE Support
+</h3></div></div></div>
+<a name="quickbook.editors.kde_support.boost__hs__quickbook"></a><h5>
+<a name="id2623073"></a>
<a href="kde_support.html#quickbook.editors.kde_support.boost__hs__quickbook">boost::hs::quickbook</a>
- </h4>
+ </h5>
<p>
boost::hs::quickbook is a syntax highlighting designed to work with Katepart.
It can be used in KWrite, Kate, Konqueror and KDevelop, and supports all
@@ -48,11 +49,11 @@
</dl>
</div>
<p>
- <span class="bold"><b>html generated from this .qbk file</b></span>
+ <span class="bold"><strong>html generated from this .qbk file</strong></span>
</p>
<div class="table">
-<a name="id466362"></a><p class="title"><b>Table 7. Code examples</b></p>
-<table class="table" summary="Code examples">
+<a name="id2623162"></a><p class="title"><b>Table 7. Code examples</b></p>
+<div class="table-contents"><table class="table" summary="Code examples">
<colgroup>
<col>
<col>
@@ -84,8 +85,8 @@
</td>
<td>
<p>
- <tt class="computeroutput"> <span class="keyword">for</span><span class="special">(</span><span class="identifier">int</span> <span class="identifier">k</span><span class="special">=</span><span class="number">0</span><span class="special">;</span>
- <span class="identifier">k</span><span class="special"><</span><span class="number">10</span><span class="special">;</span> <span class="identifier">k</span><span class="special">++)</span> <span class="identifier">v</span><span class="special">+=</span><span class="identifier">k</span><span class="special">;</span> </tt>
+ <code class="computeroutput"> <span class="keyword">for</span><span class="special">(</span><span class="identifier">int</span> <span class="identifier">k</span><span class="special">=</span><span class="number">0</span><span class="special">;</span>
+ <span class="identifier">k</span><span class="special"><</span><span class="number">10</span><span class="special">;</span> <span class="identifier">k</span><span class="special">++)</span> <span class="identifier">v</span><span class="special">+=</span><span class="identifier">k</span><span class="special">;</span> </code>
</p>
</td>
<td>
@@ -102,12 +103,12 @@
</td>
<td>
<p>
- <tt class="computeroutput"> <span class="special">{</span> <span class="identifier">int</span>
+ <code class="computeroutput"> <span class="special">{</span> <span class="identifier">int</span>
<span class="identifier">k</span><span class="special">;</span>
<span class="keyword">while</span><span class="special">(</span>
<span class="identifier">k</span> <span class="special"><</span>
<span class="number">10</span> <span class="special">)</span>
- <span class="special">{</span> <span class="identifier">v</span><span class="special">+=</span><span class="identifier">k</span><span class="special">;</span> <span class="identifier">k</span><span class="special">++</span> <span class="special">}</span> <span class="special">}</span> </tt>
+ <span class="special">{</span> <span class="identifier">v</span><span class="special">+=</span><span class="identifier">k</span><span class="special">;</span> <span class="identifier">k</span><span class="special">++</span> <span class="special">}</span> <span class="special">}</span> </code>
</p>
</td>
<td>
@@ -124,10 +125,10 @@
</td>
<td>
<p>
- <tt class="computeroutput"> <span class="keyword">while</span><span class="special">(</span>
+ <code class="computeroutput"> <span class="keyword">while</span><span class="special">(</span>
<span class="identifier">true</span> <span class="special">)</span>
<span class="special">{</span> <span class="identifier">v</span><span class="special">+=</span><span class="number">1</span><span class="special">;</span>
- <span class="special">}</span> </tt>
+ <span class="special">}</span> </code>
</p>
</td>
<td>
@@ -137,34 +138,34 @@
</td>
</tr>
</tbody>
-</table>
+</table></div>
</div>
-<a name="quickbook.editors.kde_support.code_folding_"></a><h4>
-<a name="id466769"></a>
+<br class="table-break"><a name="quickbook.editors.kde_support.code_folding_"></a><h5>
+<a name="id2623528"></a>
<a href="kde_support.html#quickbook.editors.kde_support.code_folding_">Code Folding
</a>
- </h4>
+ </h5>
<p>
boost::hs goes far beyond simple coloring. One useful thing you can get the
editor to do is to mark regions. They appear in a small grey line and each
region can be folded or unfolded independently.
</p>
-<a name="quickbook.editors.kde_support.auto_comment___uncomment_"></a><h4>
-<a name="id466801"></a>
+<a name="quickbook.editors.kde_support.auto_comment___uncomment_"></a><h5>
+<a name="id2623557"></a>
<a href="kde_support.html#quickbook.editors.kde_support.auto_comment___uncomment_">Auto
Comment / Uncomment </a>
- </h4>
+ </h5>
<p>
Another important feature is the possibility to auto-comment or uncomment
some piece of code (<span class="emphasis"><em>Tools - Comment</em></span>). Commented regions
can be uncommented simple calling the <span class="emphasis"><em>uncomment</em></span> command
while being in it.
</p>
-<a name="quickbook.editors.kde_support.styles_reference_"></a><h4>
-<a name="id466843"></a>
+<a name="quickbook.editors.kde_support.styles_reference_"></a><h5>
+<a name="id2623593"></a>
<a href="kde_support.html#quickbook.editors.kde_support.styles_reference_">Styles reference
</a>
- </h4>
+ </h5>
<div class="informaltable"><table class="table">
<colgroup>
<col>
@@ -192,7 +193,7 @@
<tr>
<td>
<p>
- <span class="bold"><b>plain text</b></span>
+ <span class="bold"><strong>plain text</strong></span>
</p>
</td>
<td>
@@ -209,7 +210,7 @@
<tr>
<td>
<p>
- <span class="bold"><b>formatted text</b></span>
+ <span class="bold"><strong>formatted text</strong></span>
</p>
</td>
<td>
@@ -226,7 +227,7 @@
<tr>
<td>
<p>
- <span class="bold"><b>structure</b></span>
+ <span class="bold"><strong>structure</strong></span>
</p>
</td>
<td>
@@ -244,7 +245,7 @@
<tr>
<td>
<p>
- <span class="bold"><b>macros</b></span>
+ <span class="bold"><strong>macros</strong></span>
</p>
</td>
<td>
@@ -262,7 +263,7 @@
<tr>
<td>
<p>
- <span class="bold"><b>templates</b></span>
+ <span class="bold"><strong>templates</strong></span>
</p>
</td>
<td>
@@ -279,7 +280,7 @@
<tr>
<td>
<p>
- <span class="bold"><b>anchors</b></span>
+ <span class="bold"><strong>anchors</strong></span>
</p>
</td>
<td>
@@ -296,7 +297,7 @@
<tr>
<td>
<p>
- <span class="bold"><b>comments</b></span>
+ <span class="bold"><strong>comments</strong></span>
</p>
</td>
<td>
@@ -313,7 +314,7 @@
<tr>
<td>
<p>
- <span class="bold"><b>tables</b></span>
+ <span class="bold"><strong>tables</strong></span>
</p>
</td>
<td>
@@ -330,7 +331,7 @@
<tr>
<td>
<p>
- <span class="bold"><b>variable lists</b></span>
+ <span class="bold"><strong>variable lists</strong></span>
</p>
</td>
<td>
@@ -347,7 +348,7 @@
<tr>
<td>
<p>
- <span class="bold"><b>c++ code</b></span>
+ <span class="bold"><strong>c++ code</strong></span>
</p>
</td>
<td>
@@ -364,7 +365,7 @@
<tr>
<td>
<p>
- <span class="bold"><b>paths</b></span>
+ <span class="bold"><strong>paths</strong></span>
</p>
</td>
<td>
@@ -381,7 +382,7 @@
<tr>
<td>
<p>
- <span class="bold"><b>IDE specific</b></span>
+ <span class="bold"><strong>IDE specific</strong></span>
</p>
</td>
<td>
@@ -397,10 +398,10 @@
</tr>
</tbody>
</table></div>
-<a name="quickbook.editors.kde_support.about_boost__hs"></a><h4>
-<a name="id467291"></a>
+<a name="quickbook.editors.kde_support.about_boost__hs"></a><h5>
+<a name="id2623995"></a>
<a href="kde_support.html#quickbook.editors.kde_support.about_boost__hs">About boost::hs</a>
- </h4>
+ </h5>
<p>
<span class="inlinemediaobject"><img src="../../images/extra/katepart/boost.hs.logo.png" alt="boost.hs.logo"></span>
</p>
@@ -414,15 +415,15 @@
<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 colspan="2" align="left" valign="top"><p>
+<tr><td align="left" valign="top"><p>
boost::hs::cpp support QuickBook code import comments style!
</p></td></tr>
</table></div>
-<a name="quickbook.editors.kde_support.installing_boost__hs"></a><h4>
-<a name="id467359"></a>
+<a name="quickbook.editors.kde_support.installing_boost__hs"></a><h5>
+<a name="id2624054"></a>
<a href="kde_support.html#quickbook.editors.kde_support.installing_boost__hs">Installing
boost::hs</a>
- </h4>
+ </h5>
<p>
There exist an ongoing effort to push boost::hs upstream to the KatePart
project. In a few months KDE may have native Quickbook support! For the moment
@@ -436,13 +437,13 @@
<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 colspan="2" align="left" valign="top"><p>
- A copy of boost::hs::quickbook and boost::hs::cpp is available in <tt class="computeroutput"><span class="identifier">boost</span><span class="special">/</span><span class="identifier">tools</span><span class="special">/</span><span class="identifier">quickbook</span><span class="special">/</span><span class="identifier">extra</span><span class="special">/</span><span class="identifier">katepart</span></tt>.
+<tr><td align="left" valign="top"><p>
+ A copy of boost::hs::quickbook and boost::hs::cpp is available in <code class="computeroutput"><span class="identifier">boost</span><span class="special">/</span><span class="identifier">tools</span><span class="special">/</span><span class="identifier">quickbook</span><span class="special">/</span><span class="identifier">extra</span><span class="special">/</span><span class="identifier">katepart</span></code>.
</p></td></tr>
</table></div>
<p>
- In order to install it you must copy the content in the folder <span class="bold"><b>katepart/syntax/</b></span> to the appropriate katepart syntax
- folder in your machine. In general this folder will be in <span class="bold"><b>/usr/share/apps/katepart/syntax</b></span>.
+ In order to install it you must copy the content in the folder <span class="bold"><strong>katepart/syntax/</strong></span> to the appropriate katepart syntax
+ folder in your machine. In general this folder will be in <span class="bold"><strong>/usr/share/apps/katepart/syntax</strong></span>.
A bash script named <span class="emphasis"><em>install.sh</em></span> is included that copy
the files to this folder.
</p>
Modified: branches/fix-links/tools/quickbook/doc/html/quickbook/editors/scite.html
==============================================================================
--- branches/fix-links/tools/quickbook/doc/html/quickbook/editors/scite.html (original)
+++ branches/fix-links/tools/quickbook/doc/html/quickbook/editors/scite.html 2007-12-03 15:31:01 EST (Mon, 03 Dec 2007)
@@ -1,12 +1,12 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
-<title> Scintilla Text Editor</title>
+<title>Scintilla Text Editor</title>
<link rel="stylesheet" href="../../../../../../doc/html/boostbook.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.66.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.72.0">
<link rel="start" href="../../index.html" title="Quickbook 1.4">
-<link rel="up" href="../editors.html" title=" Editor Support">
-<link rel="prev" href="../editors.html" title=" Editor Support">
+<link rel="up" href="../editors.html" title="Editor Support">
+<link rel="prev" href="../editors.html" title="Editor Support">
<link rel="next" href="kde_support.html" title="KDE Support">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
@@ -14,8 +14,8 @@
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td>
<td align="center">Home</td>
<td align="center">Libraries</td>
-<td align="center">People</td>
-<td align="center">FAQ</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
<td align="center">More</td>
</tr></table>
<hr>
@@ -24,7 +24,8 @@
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
-<a name="quickbook.editors.scite"></a> Scintilla Text Editor</h3></div></div></div>
+<a name="quickbook.editors.scite"></a> Scintilla Text Editor
+</h3></div></div></div>
<div class="blockquote"><blockquote class="blockquote">
<p>
</p>
@@ -38,9 +39,12 @@
The Scintilla Text Editor (SciTE) is a free source code editor for Win32
and X. It uses the SCIntilla source code editing component.
</p>
-<div class="sidebar"><p>
+<div class="sidebar">
+<p class="title"><b></b></p>
+<p>
<span class="inlinemediaobject"><img src="../../images/tip.png" alt="tip"></span> SciTE can be downloaded from http://www.scintilla.org/SciTE.html
- </p></div>
+ </p>
+</div>
<p>
You can use the following settings to highlight quickbook tags when editing
quickbook files.
@@ -57,9 +61,12 @@
comment.box.middle.props=
comment.box.end.props=]
</pre>
-<div class="sidebar"><p>
+<div class="sidebar">
+<p class="title"><b></b></p>
+<p>
<span class="inlinemediaobject"><img src="../../images/note.png" alt="note"></span> Thanks to Rene Rivera for the above SciTE settings.
- </p></div>
+ </p>
+</div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
Modified: branches/fix-links/tools/quickbook/doc/html/quickbook/faq.html
==============================================================================
--- branches/fix-links/tools/quickbook/doc/html/quickbook/faq.html (original)
+++ branches/fix-links/tools/quickbook/doc/html/quickbook/faq.html 2007-12-03 15:31:01 EST (Mon, 03 Dec 2007)
@@ -1,21 +1,21 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
-<title> Frequently Asked Questions</title>
+<title>Frequently Asked Questions</title>
<link rel="stylesheet" href="../../../../../doc/html/boostbook.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.66.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.72.0">
<link rel="start" href="../index.html" title="Quickbook 1.4">
<link rel="up" href="../index.html" title="Quickbook 1.4">
<link rel="prev" href="editors/kde_support.html" title="KDE Support">
-<link rel="next" href="ref.html" title=" Quick Reference">
+<link rel="next" href="ref.html" title="Quick Reference">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<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">Home</td>
<td align="center">Libraries</td>
-<td align="center">People</td>
-<td align="center">FAQ</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
<td align="center">More</td>
</tr></table>
<hr>
@@ -24,12 +24,13 @@
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
-<a name="quickbook.faq"></a> Frequently Asked Questions</h2></div></div></div>
-<a name="quickbook.faq.can_i_use_quickbook_for_non_boost_documentation_"></a><h3>
-<a name="id467511"></a>
+<a name="quickbook.faq"></a> Frequently Asked Questions
+</h2></div></div></div>
+<a name="quickbook.faq.can_i_use_quickbook_for_non_boost_documentation_"></a><h4>
+<a name="id2624191"></a>
<a href="faq.html#quickbook.faq.can_i_use_quickbook_for_non_boost_documentation_">Can
I use QuickBook for non-Boost documentation?</a>
- </h3>
+ </h4>
<p>
QuickBook can be used for non-Boost documentation with a little extra work.
</p>
@@ -60,18 +61,18 @@
:
my_doc
:
- <xsl:param>boost.image.src<tt class="literal">images/my_project_logo.png
- <xsl:param>boost.image.alt</tt>"\"My Project\""
+ <xsl:param>boost.image.src<code class="literal">images/my_project_logo.png
+ <xsl:param>boost.image.alt</code>"\"My Project\""
<xsl:param>boost.image.w=100
<xsl:param>boost.image.h=50
<xsl:param>nav.layout=none
;
</pre>
-<a name="quickbook.faq.is_there_an_easy_way_to_convert_boostbook_docs_to_quickbook_"></a><h3>
-<a name="id467599"></a>
+<a name="quickbook.faq.is_there_an_easy_way_to_convert_boostbook_docs_to_quickbook_"></a><h4>
+<a name="id2624269"></a>
<a href="faq.html#quickbook.faq.is_there_an_easy_way_to_convert_boostbook_docs_to_quickbook_">Is
there an easy way to convert BoostBook docs to QuickBook?</a>
- </h3>
+ </h4>
<p>
There's a stylesheet that allows Boostbook generated HTML to be viewed as quickbook
source, see http://svn.boost.org/trac/boost/wiki/QuickbookSourceStylesheetProject,
Modified: branches/fix-links/tools/quickbook/doc/html/quickbook/install.html
==============================================================================
--- branches/fix-links/tools/quickbook/doc/html/quickbook/install.html (original)
+++ branches/fix-links/tools/quickbook/doc/html/quickbook/install.html 2007-12-03 15:31:01 EST (Mon, 03 Dec 2007)
@@ -1,21 +1,21 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
-<title> Installation and configuration</title>
+<title>Installation and configuration</title>
<link rel="stylesheet" href="../../../../../doc/html/boostbook.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.66.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.72.0">
<link rel="start" href="../index.html" title="Quickbook 1.4">
<link rel="up" href="../index.html" title="Quickbook 1.4">
-<link rel="prev" href="syntax/block.html" title=" Block Level Elements">
-<link rel="next" href="install/macosx.html" title=" Mac OS X">
+<link rel="prev" href="syntax/block.html" title="Block Level Elements">
+<link rel="next" href="install/macosx.html" title="Mac OS X">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<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">Home</td>
<td align="center">Libraries</td>
-<td align="center">People</td>
-<td align="center">FAQ</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
<td align="center">More</td>
</tr></table>
<hr>
@@ -24,7 +24,8 @@
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
-<a name="quickbook.install"></a> Installation and configuration</h2></div></div></div>
+<a name="quickbook.install"></a> Installation and configuration
+</h2></div></div></div>
<div class="toc"><dl>
<dt><span class="section"> Mac OS X</span></dt>
<dt><span class="section"> Windows 2000, XP, 2003, Vista</span></dt>
@@ -37,8 +38,8 @@
<p>
Before continuing, it is very important that you keep this in mind: if you
try to build some documents and the process breaks due to misconfiguration,
- be absolutely sure to delete any <tt class="computeroutput"><span class="identifier">bin</span></tt>
- and <tt class="computeroutput"><span class="identifier">bin</span><span class="special">.</span><span class="identifier">v2</span></tt> directories generated by the build before
+ be absolutely sure to delete any <code class="computeroutput"><span class="identifier">bin</span></code>
+ and <code class="computeroutput"><span class="identifier">bin</span><span class="special">.</span><span class="identifier">v2</span></code> directories generated by the build before
trying again. Otherwise your configuration fixes will not take any effect.
</p>
</div>
Modified: branches/fix-links/tools/quickbook/doc/html/quickbook/install/linux.html
==============================================================================
--- branches/fix-links/tools/quickbook/doc/html/quickbook/install/linux.html (original)
+++ branches/fix-links/tools/quickbook/doc/html/quickbook/install/linux.html 2007-12-03 15:31:01 EST (Mon, 03 Dec 2007)
@@ -1,21 +1,21 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
-<title> Debian, Ubuntu</title>
+<title>Debian, Ubuntu</title>
<link rel="stylesheet" href="../../../../../../doc/html/boostbook.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.66.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.72.0">
<link rel="start" href="../../index.html" title="Quickbook 1.4">
-<link rel="up" href="../install.html" title=" Installation and configuration">
-<link rel="prev" href="windows.html" title=" Windows 2000, XP, 2003, Vista">
-<link rel="next" href="../editors.html" title=" Editor Support">
+<link rel="up" href="../install.html" title="Installation and configuration">
+<link rel="prev" href="windows.html" title="Windows 2000, XP, 2003, Vista">
+<link rel="next" href="../editors.html" title="Editor Support">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<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">Home</td>
<td align="center">Libraries</td>
-<td align="center">People</td>
-<td align="center">FAQ</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
<td align="center">More</td>
</tr></table>
<hr>
@@ -24,29 +24,30 @@
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
-<a name="quickbook.install.linux"></a> Debian, Ubuntu</h3></div></div></div>
+<a name="quickbook.install.linux"></a> Debian, Ubuntu
+</h3></div></div></div>
<p>
The following instructions apply to Debian and its derivatives. They are
based on a Ubuntu Edgy install but should work on other Debian based systems.
</p>
<p>
- First install the <tt class="computeroutput"><span class="identifier">bjam</span></tt>,
- <tt class="computeroutput"><span class="identifier">xsltproc</span></tt>, <tt class="computeroutput"><span class="identifier">docbook</span><span class="special">-</span><span class="identifier">xsl</span></tt> and
- <tt class="computeroutput"><span class="identifier">docbook</span><span class="special">-</span><span class="identifier">xml</span></tt> packages. For example, using <tt class="computeroutput"><span class="identifier">apt</span><span class="special">-</span><span class="identifier">get</span></tt>:
+ First install the <code class="computeroutput"><span class="identifier">bjam</span></code>,
+ <code class="computeroutput"><span class="identifier">xsltproc</span></code>, <code class="computeroutput"><span class="identifier">docbook</span><span class="special">-</span><span class="identifier">xsl</span></code> and
+ <code class="computeroutput"><span class="identifier">docbook</span><span class="special">-</span><span class="identifier">xml</span></code> packages. For example, using <code class="computeroutput"><span class="identifier">apt</span><span class="special">-</span><span class="identifier">get</span></code>:
</p>
<pre class="programlisting">
<span class="identifier">sudo</span> <span class="identifier">apt</span><span class="special">-</span><span class="identifier">get</span> <span class="identifier">install</span> <span class="identifier">xsltproc</span> <span class="identifier">docbook</span><span class="special">-</span><span class="identifier">xsl</span> <span class="identifier">docbook</span><span class="special">-</span><span class="identifier">xml</span>
</pre>
<p>
If you're planning on building boost's documentation, you'll also need to
- install the <tt class="computeroutput"><span class="identifier">doxygen</span></tt> package
+ install the <code class="computeroutput"><span class="identifier">doxygen</span></code> package
as well.
</p>
<p>
Next, we need to configure Boost Build to compile BoostBook files. Add the
- following to your <tt class="computeroutput"><span class="identifier">user</span><span class="special">-</span><span class="identifier">config</span><span class="special">.</span><span class="identifier">jam</span></tt> file, which should be in your home
+ following to your <code class="computeroutput"><span class="identifier">user</span><span class="special">-</span><span class="identifier">config</span><span class="special">.</span><span class="identifier">jam</span></code> file, which should be in your home
directory. If you don't have one, create a file containing this text. For
- more information on setting up <tt class="computeroutput"><span class="identifier">user</span><span class="special">-</span><span class="identifier">config</span><span class="special">.</span><span class="identifier">jam</span></tt>, see
+ more information on setting up <code class="computeroutput"><span class="identifier">user</span><span class="special">-</span><span class="identifier">config</span><span class="special">.</span><span class="identifier">jam</span></code>, see
the <a href="http://boost.org/boost-build2/doc/html/bbv2/advanced/configuration.html" target="_top">Boost
Build documentation</a>.
</p>
@@ -67,19 +68,19 @@
</p>
<div class="orderedlist"><ol type="1">
<li>
- Go to Quickbook's source directory (<tt class="computeroutput"><span class="identifier">BOOST_ROOT</span><span class="special">/</span><span class="identifier">tools</span><span class="special">/</span><span class="identifier">quickbook</span></tt>).
+ Go to Quickbook's source directory (<code class="computeroutput"><span class="identifier">BOOST_ROOT</span><span class="special">/</span><span class="identifier">tools</span><span class="special">/</span><span class="identifier">quickbook</span></code>).
</li>
<li>
- Build the utility by issuing <tt class="computeroutput"><span class="identifier">bjam</span>
- <span class="special">--</span><span class="identifier">v2</span></tt>.
+ Build the utility by issuing <code class="computeroutput"><span class="identifier">bjam</span>
+ <span class="special">--</span><span class="identifier">v2</span></code>.
</li>
<li>
- Copy the resulting <tt class="computeroutput"><span class="identifier">quickbook</span></tt>
- binary (located under the <tt class="computeroutput"><span class="identifier">BOOST_ROOT</span><span class="special">/</span><span class="identifier">bin</span><span class="special">.</span><span class="identifier">v2</span></tt> hierarchy)
- to a safe place. The traditional location is <tt class="computeroutput"><span class="special">/</span><span class="identifier">usr</span><span class="special">/</span><span class="identifier">local</span><span class="special">/</span><span class="identifier">bin</span></tt>.
+ Copy the resulting <code class="computeroutput"><span class="identifier">quickbook</span></code>
+ binary (located under the <code class="computeroutput"><span class="identifier">BOOST_ROOT</span><span class="special">/</span><span class="identifier">bin</span><span class="special">.</span><span class="identifier">v2</span></code> hierarchy)
+ to a safe place. The traditional location is <code class="computeroutput"><span class="special">/</span><span class="identifier">usr</span><span class="special">/</span><span class="identifier">local</span><span class="special">/</span><span class="identifier">bin</span></code>.
</li>
<li>
- Add the following to your <tt class="computeroutput"><span class="identifier">user</span><span class="special">-</span><span class="identifier">config</span><span class="special">.</span><span class="identifier">jam</span></tt>
+ Add the following to your <code class="computeroutput"><span class="identifier">user</span><span class="special">-</span><span class="identifier">config</span><span class="special">.</span><span class="identifier">jam</span></code>
file, using the full path of the quickbook executable:
</li>
</ol></div>
Modified: branches/fix-links/tools/quickbook/doc/html/quickbook/install/macosx.html
==============================================================================
--- branches/fix-links/tools/quickbook/doc/html/quickbook/install/macosx.html (original)
+++ branches/fix-links/tools/quickbook/doc/html/quickbook/install/macosx.html 2007-12-03 15:31:01 EST (Mon, 03 Dec 2007)
@@ -1,21 +1,21 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
-<title> Mac OS X</title>
+<title>Mac OS X</title>
<link rel="stylesheet" href="../../../../../../doc/html/boostbook.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.66.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.72.0">
<link rel="start" href="../../index.html" title="Quickbook 1.4">
-<link rel="up" href="../install.html" title=" Installation and configuration">
-<link rel="prev" href="../install.html" title=" Installation and configuration">
-<link rel="next" href="windows.html" title=" Windows 2000, XP, 2003, Vista">
+<link rel="up" href="../install.html" title="Installation and configuration">
+<link rel="prev" href="../install.html" title="Installation and configuration">
+<link rel="next" href="windows.html" title="Windows 2000, XP, 2003, Vista">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<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">Home</td>
<td align="center">Libraries</td>
-<td align="center">People</td>
-<td align="center">FAQ</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
<td align="center">More</td>
</tr></table>
<hr>
@@ -24,7 +24,8 @@
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
-<a name="quickbook.install.macosx"></a> Mac OS X</h3></div></div></div>
+<a name="quickbook.install.macosx"></a> Mac OS X
+</h3></div></div></div>
<div class="blockquote"><blockquote class="blockquote">
<p>
</p>
@@ -44,13 +45,13 @@
<p>
The text below assumes you want to install all the necessary utilities in
a system-wide location, allowing any user in the machine to have access to
- them. Therefore, all files will be put in the <tt class="computeroutput"><span class="special">/</span><span class="identifier">usr</span><span class="special">/</span><span class="identifier">local</span></tt>
+ them. Therefore, all files will be put in the <code class="computeroutput"><span class="special">/</span><span class="identifier">usr</span><span class="special">/</span><span class="identifier">local</span></code>
hierarchy. If you do not want this, you can choose any other prefix such
- as <tt class="computeroutput"><span class="special">~/</span><span class="identifier">Applications</span></tt>
+ as <code class="computeroutput"><span class="special">~/</span><span class="identifier">Applications</span></code>
for a single-user installation.
</p>
<p>
- Mac OS X comes with <tt class="computeroutput"><span class="identifier">xsltproc</span></tt>
+ Mac OS X comes with <code class="computeroutput"><span class="identifier">xsltproc</span></code>
and all related libraries preinstalled, so you do not need to take any extra
steps to set them up. It is probable that future versions will include them
too, but these instructions may not apply to older versions.
@@ -61,16 +62,16 @@
<div class="orderedlist"><ol type="1">
<li>
Download <a href="http://www.docbook.org/xml/4.2/docbook-xml-4.2.zip" target="_top">Docbook
- XML 4.2</a> and unpack it inside <tt class="computeroutput"><span class="special">/</span><span class="identifier">usr</span><span class="special">/</span><span class="identifier">local</span><span class="special">/</span><span class="identifier">share</span><span class="special">/</span><span class="identifier">xml</span><span class="special">/</span><span class="identifier">docbook</span><span class="special">/</span><span class="number">4.2</span></tt>.
+ XML 4.2</a> and unpack it inside <code class="computeroutput"><span class="special">/</span><span class="identifier">usr</span><span class="special">/</span><span class="identifier">local</span><span class="special">/</span><span class="identifier">share</span><span class="special">/</span><span class="identifier">xml</span><span class="special">/</span><span class="identifier">docbook</span><span class="special">/</span><span class="number">4.2</span></code>.
</li>
<li>
Download the latest <a href="http://sourceforge.net/project/showfiles.php?group_id=21935&package_id=16608" target="_top">Docbook
- XSL</a> version and unpack it. Put the results in <tt class="computeroutput"><span class="special">/</span><span class="identifier">usr</span><span class="special">/</span><span class="identifier">local</span><span class="special">/</span><span class="identifier">share</span><span class="special">/</span><span class="identifier">xsl</span><span class="special">/</span><span class="identifier">docbook</span></tt>, thus effectively removing the
+ XSL</a> version and unpack it. Put the results in <code class="computeroutput"><span class="special">/</span><span class="identifier">usr</span><span class="special">/</span><span class="identifier">local</span><span class="special">/</span><span class="identifier">share</span><span class="special">/</span><span class="identifier">xsl</span><span class="special">/</span><span class="identifier">docbook</span></code>, thus effectively removing the
version number from the directory name (for simplicity).
</li>
<li>
- Add the following to your <tt class="computeroutput"><span class="identifier">user</span><span class="special">-</span><span class="identifier">config</span><span class="special">.</span><span class="identifier">jam</span></tt>
- file, which should live in your home directory (<tt class="computeroutput"><span class="special">/</span><span class="identifier">Users</span><span class="special">/<</span><span class="identifier">your_username</span><span class="special">></span></tt>).
+ Add the following to your <code class="computeroutput"><span class="identifier">user</span><span class="special">-</span><span class="identifier">config</span><span class="special">.</span><span class="identifier">jam</span></code>
+ file, which should live in your home directory (<code class="computeroutput"><span class="special">/</span><span class="identifier">Users</span><span class="special">/<</span><span class="identifier">your_username</span><span class="special">></span></code>).
You must already have it somewhere or otherwise you could not be building
Boost (i.e. missing tools configuration).
</li>
@@ -90,20 +91,20 @@
</p>
<div class="orderedlist"><ol type="1">
<li>
- Go to Quickbook's source directory (<tt class="computeroutput"><span class="identifier">BOOST_ROOT</span><span class="special">/</span><span class="identifier">tools</span><span class="special">/</span><span class="identifier">quickbook</span></tt>).
+ Go to Quickbook's source directory (<code class="computeroutput"><span class="identifier">BOOST_ROOT</span><span class="special">/</span><span class="identifier">tools</span><span class="special">/</span><span class="identifier">quickbook</span></code>).
</li>
<li>
- Build the utility by issuing <tt class="computeroutput"><span class="identifier">bjam</span>
- <span class="special">--</span><span class="identifier">v2</span></tt>.
+ Build the utility by issuing <code class="computeroutput"><span class="identifier">bjam</span>
+ <span class="special">--</span><span class="identifier">v2</span></code>.
</li>
<li>
- Copy the resulting <tt class="computeroutput"><span class="identifier">quickbook</span></tt>
- binary (located under the <tt class="computeroutput"><span class="identifier">BOOST_ROOT</span><span class="special">/</span><span class="identifier">bin</span><span class="special">.</span><span class="identifier">v2</span></tt> hierarchy)
+ Copy the resulting <code class="computeroutput"><span class="identifier">quickbook</span></code>
+ binary (located under the <code class="computeroutput"><span class="identifier">BOOST_ROOT</span><span class="special">/</span><span class="identifier">bin</span><span class="special">.</span><span class="identifier">v2</span></code> hierarchy)
to a safe place. Following our previous example, you can install it into:
- <tt class="computeroutput"><span class="special">/</span><span class="identifier">usr</span><span class="special">/</span><span class="identifier">local</span><span class="special">/</span><span class="identifier">bin</span></tt>.
+ <code class="computeroutput"><span class="special">/</span><span class="identifier">usr</span><span class="special">/</span><span class="identifier">local</span><span class="special">/</span><span class="identifier">bin</span></code>.
</li>
<li>
- Add the following to your <tt class="computeroutput"><span class="identifier">user</span><span class="special">-</span><span class="identifier">config</span><span class="special">.</span><span class="identifier">jam</span></tt>
+ Add the following to your <code class="computeroutput"><span class="identifier">user</span><span class="special">-</span><span class="identifier">config</span><span class="special">.</span><span class="identifier">jam</span></code>
file:
</li>
</ol></div>
@@ -119,14 +120,14 @@
<div class="orderedlist"><ol type="1">
<li>
Go to the <a href="http://www.stack.nl/~dimitri/doxygen/download.html#latestsrc" target="_top">downloads
- section</a> and get the disk image (<tt class="computeroutput"><span class="identifier">dmg</span></tt>
+ section</a> and get the disk image (<code class="computeroutput"><span class="identifier">dmg</span></code>
file) for Mac OS X.
</li>
<li>
- Open the disk image and drag the Doxygen application to your <tt class="computeroutput"><span class="identifier">Applications</span></tt> folder to install it.
+ Open the disk image and drag the Doxygen application to your <code class="computeroutput"><span class="identifier">Applications</span></code> folder to install it.
</li>
<li>
- Add the following to your <tt class="computeroutput"><span class="identifier">user</span><span class="special">-</span><span class="identifier">config</span><span class="special">.</span><span class="identifier">jam</span></tt>
+ Add the following to your <code class="computeroutput"><span class="identifier">user</span><span class="special">-</span><span class="identifier">config</span><span class="special">.</span><span class="identifier">jam</span></code>
file:
</li>
</ol></div>
Modified: branches/fix-links/tools/quickbook/doc/html/quickbook/install/windows.html
==============================================================================
--- branches/fix-links/tools/quickbook/doc/html/quickbook/install/windows.html (original)
+++ branches/fix-links/tools/quickbook/doc/html/quickbook/install/windows.html 2007-12-03 15:31:01 EST (Mon, 03 Dec 2007)
@@ -1,21 +1,21 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
-<title> Windows 2000, XP, 2003, Vista</title>
+<title>Windows 2000, XP, 2003, Vista</title>
<link rel="stylesheet" href="../../../../../../doc/html/boostbook.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.66.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.72.0">
<link rel="start" href="../../index.html" title="Quickbook 1.4">
-<link rel="up" href="../install.html" title=" Installation and configuration">
-<link rel="prev" href="macosx.html" title=" Mac OS X">
-<link rel="next" href="linux.html" title=" Debian, Ubuntu">
+<link rel="up" href="../install.html" title="Installation and configuration">
+<link rel="prev" href="macosx.html" title="Mac OS X">
+<link rel="next" href="linux.html" title="Debian, Ubuntu">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<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">Home</td>
<td align="center">Libraries</td>
-<td align="center">People</td>
-<td align="center">FAQ</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
<td align="center">More</td>
</tr></table>
<hr>
@@ -24,7 +24,8 @@
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
-<a name="quickbook.install.windows"></a> Windows 2000, XP, 2003, Vista</h3></div></div></div>
+<a name="quickbook.install.windows"></a> Windows 2000, XP, 2003, Vista
+</h3></div></div></div>
<p>
</p>
<div class="blockquote"><blockquote class="blockquote">
@@ -44,39 +45,39 @@
</p>
<div class="orderedlist"><ol type="1">
<li>
- First of all you need to have a copy of <tt class="computeroutput"><span class="identifier">xsltproc</span></tt>
+ First of all you need to have a copy of <code class="computeroutput"><span class="identifier">xsltproc</span></code>
for Windows. There are many ways to get this tool, but to keep things simple,
use the binary packages
made by Igor Zlatkovic. At the very least, you need to download the following
- packages: <tt class="computeroutput"><span class="identifier">iconv</span></tt>, <tt class="computeroutput"><span class="identifier">zlib</span></tt>, <tt class="computeroutput"><span class="identifier">libxml2</span></tt>
- and <tt class="computeroutput"><span class="identifier">libxslt</span></tt>.
+ packages: <code class="computeroutput"><span class="identifier">iconv</span></code>, <code class="computeroutput"><span class="identifier">zlib</span></code>, <code class="computeroutput"><span class="identifier">libxml2</span></code>
+ and <code class="computeroutput"><span class="identifier">libxslt</span></code>.
</li>
<li>
Unpack all these packages in the same directory so that you get unique
- <tt class="computeroutput"><span class="identifier">bin</span></tt>, <tt class="computeroutput"><span class="identifier">include</span></tt>
- and <tt class="computeroutput"><span class="identifier">lib</span></tt> directories within
- the hierarchy. These instructions use <tt class="computeroutput"><span class="identifier">C</span><span class="special">:\</span><span class="identifier">Users</span><span class="special">\</span><span class="identifier">example</span><span class="special">\</span><span class="identifier">Documents</span><span class="special">\</span><span class="identifier">boost</span><span class="special">\</span><span class="identifier">xml</span></tt>
+ <code class="computeroutput"><span class="identifier">bin</span></code>, <code class="computeroutput"><span class="identifier">include</span></code>
+ and <code class="computeroutput"><span class="identifier">lib</span></code> directories within
+ the hierarchy. These instructions use <code class="computeroutput"><span class="identifier">C</span><span class="special">:\</span><span class="identifier">Users</span><span class="special">\</span><span class="identifier">example</span><span class="special">\</span><span class="identifier">Documents</span><span class="special">\</span><span class="identifier">boost</span><span class="special">\</span><span class="identifier">xml</span></code>
as the root for all files.
</li>
<li>
- From the command line, go to the <tt class="computeroutput"><span class="identifier">bin</span></tt>
- directory and launch <tt class="computeroutput"><span class="identifier">xsltproc</span><span class="special">.</span><span class="identifier">exe</span></tt>
+ From the command line, go to the <code class="computeroutput"><span class="identifier">bin</span></code>
+ directory and launch <code class="computeroutput"><span class="identifier">xsltproc</span><span class="special">.</span><span class="identifier">exe</span></code>
to ensure it works. You should get usage information on screen.
</li>
<li>
Download <a href="http://www.docbook.org/xml/4.2/docbook-xml-4.2.zip" target="_top">Docbook
XML 4.2</a> and unpack it in the same directory used above. That is:
- <tt class="computeroutput"><span class="identifier">C</span><span class="special">:\</span><span class="identifier">Users</span><span class="special">\</span><span class="identifier">example</span><span class="special">\</span><span class="identifier">Documents</span><span class="special">\</span><span class="identifier">boost</span><span class="special">\</span><span class="identifier">xml</span><span class="special">\</span><span class="identifier">docbook</span><span class="special">-</span><span class="identifier">xml</span></tt>.
+ <code class="computeroutput"><span class="identifier">C</span><span class="special">:\</span><span class="identifier">Users</span><span class="special">\</span><span class="identifier">example</span><span class="special">\</span><span class="identifier">Documents</span><span class="special">\</span><span class="identifier">boost</span><span class="special">\</span><span class="identifier">xml</span><span class="special">\</span><span class="identifier">docbook</span><span class="special">-</span><span class="identifier">xml</span></code>.
</li>
<li>
Download the latest <a href="http://sourceforge.net/project/showfiles.php?group_id=21935&package_id=16608" target="_top">Docbook
XSL</a> version and unpack it, again in the same directory used before.
To make things easier, rename the directory created during the extraction
- to <tt class="computeroutput"><span class="identifier">docbook</span><span class="special">-</span><span class="identifier">xsl</span></tt> (bypassing the version name): <tt class="computeroutput"><span class="identifier">C</span><span class="special">:\</span><span class="identifier">Users</span><span class="special">\</span><span class="identifier">example</span><span class="special">\</span><span class="identifier">Documents</span><span class="special">\</span><span class="identifier">boost</span><span class="special">\</span><span class="identifier">xml</span><span class="special">\</span><span class="identifier">docbook</span><span class="special">-</span><span class="identifier">xsl</span></tt>.
+ to <code class="computeroutput"><span class="identifier">docbook</span><span class="special">-</span><span class="identifier">xsl</span></code> (bypassing the version name): <code class="computeroutput"><span class="identifier">C</span><span class="special">:\</span><span class="identifier">Users</span><span class="special">\</span><span class="identifier">example</span><span class="special">\</span><span class="identifier">Documents</span><span class="special">\</span><span class="identifier">boost</span><span class="special">\</span><span class="identifier">xml</span><span class="special">\</span><span class="identifier">docbook</span><span class="special">-</span><span class="identifier">xsl</span></code>.
</li>
<li>
- Add the following to your <tt class="computeroutput"><span class="identifier">user</span><span class="special">-</span><span class="identifier">config</span><span class="special">.</span><span class="identifier">jam</span></tt>
- file, which should live in your home directory (<tt class="computeroutput"><span class="special">%</span><span class="identifier">HOMEDRIVE</span><span class="special">%%</span><span class="identifier">HOMEPATH</span><span class="special">%</span></tt>).
+ Add the following to your <code class="computeroutput"><span class="identifier">user</span><span class="special">-</span><span class="identifier">config</span><span class="special">.</span><span class="identifier">jam</span></code>
+ file, which should live in your home directory (<code class="computeroutput"><span class="special">%</span><span class="identifier">HOMEDRIVE</span><span class="special">%%</span><span class="identifier">HOMEPATH</span><span class="special">%</span></code>).
You must already have it somewhere or otherwise you could not be building
Boost (i.e. missing tools configuration).
</li>
@@ -97,20 +98,20 @@
</p>
<div class="orderedlist"><ol type="1">
<li>
- Go to Quickbook's source directory (<tt class="computeroutput"><span class="identifier">BOOST_ROOT</span><span class="special">\</span><span class="identifier">tools</span><span class="special">\</span><span class="identifier">quickbook</span></tt>).
+ Go to Quickbook's source directory (<code class="computeroutput"><span class="identifier">BOOST_ROOT</span><span class="special">\</span><span class="identifier">tools</span><span class="special">\</span><span class="identifier">quickbook</span></code>).
</li>
<li>
- Build the utility by issuing <tt class="computeroutput"><span class="identifier">bjam</span>
- <span class="special">--</span><span class="identifier">v2</span></tt>.
+ Build the utility by issuing <code class="computeroutput"><span class="identifier">bjam</span>
+ <span class="special">--</span><span class="identifier">v2</span></code>.
</li>
<li>
- Copy the resulting <tt class="computeroutput"><span class="identifier">quickbook</span><span class="special">.</span><span class="identifier">exe</span></tt>
- binary (located under the <tt class="computeroutput"><span class="identifier">BOOST_ROOT</span><span class="special">\</span><span class="identifier">bin</span><span class="special">.</span><span class="identifier">v2</span></tt> hierarchy)
+ Copy the resulting <code class="computeroutput"><span class="identifier">quickbook</span><span class="special">.</span><span class="identifier">exe</span></code>
+ binary (located under the <code class="computeroutput"><span class="identifier">BOOST_ROOT</span><span class="special">\</span><span class="identifier">bin</span><span class="special">.</span><span class="identifier">v2</span></code> hierarchy)
to a safe place. Following our previous example, you can install it into:
- <tt class="computeroutput"><span class="identifier">C</span><span class="special">:\</span><span class="identifier">Users</span><span class="special">\</span><span class="identifier">example</span><span class="special">\</span><span class="identifier">Documents</span><span class="special">\</span><span class="identifier">boost</span><span class="special">\</span><span class="identifier">xml</span><span class="special">\</span><span class="identifier">bin</span></tt>.
+ <code class="computeroutput"><span class="identifier">C</span><span class="special">:\</span><span class="identifier">Users</span><span class="special">\</span><span class="identifier">example</span><span class="special">\</span><span class="identifier">Documents</span><span class="special">\</span><span class="identifier">boost</span><span class="special">\</span><span class="identifier">xml</span><span class="special">\</span><span class="identifier">bin</span></code>.
</li>
<li>
- Add the following to your <tt class="computeroutput"><span class="identifier">user</span><span class="special">-</span><span class="identifier">config</span><span class="special">.</span><span class="identifier">jam</span></tt>
+ Add the following to your <code class="computeroutput"><span class="identifier">user</span><span class="special">-</span><span class="identifier">config</span><span class="special">.</span><span class="identifier">jam</span></code>
file:
</li>
</ol></div>
Modified: branches/fix-links/tools/quickbook/doc/html/quickbook/intro.html
==============================================================================
--- branches/fix-links/tools/quickbook/doc/html/quickbook/intro.html (original)
+++ branches/fix-links/tools/quickbook/doc/html/quickbook/intro.html 2007-12-03 15:31:01 EST (Mon, 03 Dec 2007)
@@ -1,21 +1,21 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
-<title> Introduction</title>
+<title>Introduction</title>
<link rel="stylesheet" href="../../../../../doc/html/boostbook.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.66.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.72.0">
<link rel="start" href="../index.html" title="Quickbook 1.4">
<link rel="up" href="../index.html" title="Quickbook 1.4">
<link rel="prev" href="../index.html" title="Quickbook 1.4">
-<link rel="next" href="change_log.html" title=" Change Log">
+<link rel="next" href="change_log.html" title="Change Log">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<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">Home</td>
<td align="center">Libraries</td>
-<td align="center">People</td>
-<td align="center">FAQ</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
<td align="center">More</td>
</tr></table>
<hr>
@@ -24,13 +24,14 @@
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
-<a name="quickbook.intro"></a> Introduction</h2></div></div></div>
+<a name="quickbook.intro"></a> Introduction
+</h2></div></div></div>
<div class="blockquote"><blockquote class="blockquote">
<p>
</p>
<p>
- <span class="bold"><b><span class="emphasis"><em>“<span class="quote">Why program by hand in five days
- what you can spend five years of your life automating?</span>”</em></span></b></span>
+ <span class="bold"><strong><span class="emphasis"><em>“<span class="quote">Why program by hand in five days
+ what you can spend five years of your life automating?</span>”</em></span></strong></span>
</p>
<p>
</p>
Modified: branches/fix-links/tools/quickbook/doc/html/quickbook/ref.html
==============================================================================
--- branches/fix-links/tools/quickbook/doc/html/quickbook/ref.html (original)
+++ branches/fix-links/tools/quickbook/doc/html/quickbook/ref.html 2007-12-03 15:31:01 EST (Mon, 03 Dec 2007)
@@ -1,20 +1,20 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
-<title> Quick Reference</title>
+<title>Quick Reference</title>
<link rel="stylesheet" href="../../../../../doc/html/boostbook.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.66.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.72.0">
<link rel="start" href="../index.html" title="Quickbook 1.4">
<link rel="up" href="../index.html" title="Quickbook 1.4">
-<link rel="prev" href="faq.html" title=" Frequently Asked Questions">
+<link rel="prev" href="faq.html" title="Frequently Asked Questions">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<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">Home</td>
<td align="center">Libraries</td>
-<td align="center">People</td>
-<td align="center">FAQ</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
<td align="center">More</td>
</tr></table>
<hr>
@@ -23,12 +23,13 @@
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
-<a name="quickbook.ref"></a> Quick Reference</h2></div></div></div>
+<a name="quickbook.ref"></a> Quick Reference
+</h2></div></div></div>
<p>
</p>
<div class="table">
-<a name="id467661"></a><p class="title"><b>Table 8. Syntax Compendium</b></p>
-<table class="table" summary="Syntax Compendium">
+<a name="id2624322"></a><p class="title"><b>Table 8. Syntax Compendium</b></p>
+<div class="table-contents"><table class="table" summary="Syntax Compendium">
<colgroup>
<col>
<col>
@@ -60,7 +61,7 @@
</td>
<td>
<p>
- <tt class="literal">[/ some comment]</tt>
+ <code class="literal">[/ some comment]</code>
</p>
</td>
<td>
@@ -77,7 +78,7 @@
</td>
<td>
<p>
- <tt class="literal">['italics] or /italics/</tt>
+ <code class="literal">['italics] or /italics/</code>
</p>
</td>
<td>
@@ -91,12 +92,12 @@
<tr>
<td>
<p>
- <span class="bold"><b>bold</b></span>
+ <span class="bold"><strong>bold</strong></span>
</p>
</td>
<td>
<p>
- <tt class="literal">[*bold] or *bold*</tt>
+ <code class="literal">[*bold] or *bold*</code>
</p>
</td>
<td>
@@ -115,7 +116,7 @@
</td>
<td>
<p>
- <tt class="literal">[_underline] or _underline_</tt>
+ <code class="literal">[_underline] or _underline_</code>
</p>
</td>
<td>
@@ -129,12 +130,12 @@
<tr>
<td>
<p>
- <tt class="literal">teletype</tt>
+ <code class="literal">teletype</code>
</p>
</td>
<td>
<p>
- <tt class="literal">[^teletype] or =teletype=</tt>
+ <code class="literal">[^teletype] or =teletype=</code>
</p>
</td>
<td>
@@ -153,7 +154,7 @@
</td>
<td>
<p>
- <tt class="literal">[-strikethrough]</tt>
+ <code class="literal">[-strikethrough]</code>
</p>
</td>
<td>
@@ -167,14 +168,14 @@
<tr>
<td>
<p>
- <i class="replaceable"><tt>
+ <em class="replaceable"><code>
replaceable
- </tt></i>
+ </code></em>
</p>
</td>
<td>
<p>
- <tt class="literal">[~replaceable]</tt>
+ <code class="literal">[~replaceable]</code>
</p>
</td>
<td>
@@ -191,7 +192,7 @@
</td>
<td>
<p>
- <tt class="literal">[c++]</tt> or <tt class="literal">[python]</tt>
+ <code class="literal">[c++]</code> or <code class="literal">[python]</code>
</p>
</td>
<td>
@@ -208,7 +209,7 @@
</td>
<td>
<p>
- <tt class="literal">`int main();`</tt>
+ <code class="literal">`int main();`</code>
</p>
</td>
<td>
@@ -225,7 +226,7 @@
</td>
<td>
<p>
- <tt class="literal">``int main();``</tt>
+ <code class="literal">``int main();``</code>
</p>
</td>
<td>
@@ -242,13 +243,12 @@
</td>
<td>
<p>
- <tt class="literal">``from c++ to QuickBook``</tt>
+ <code class="literal">``from c++ to QuickBook``</code>
</p>
</td>
<td>
<p>
- <a href="syntax/block.html#quickbook.syntax.block.escape_back" title=" Escaping Back
- To QuickBook">Escaping Back To QuickBook</a>
+ Escaping Back To QuickBook
</p>
</td>
</tr>
@@ -260,13 +260,13 @@
</td>
<td>
<p>
- <tt class="literal">[br] or \n</tt>
+ <code class="literal">[br] or \n</code>
</p>
</td>
<td>
<p>
<a href="syntax/phrase.html#quickbook.syntax.phrase.line_break" title="line-break">line-break</a>
- <span class="bold"><b>DEPRECATED</b></span>
+ <span class="bold"><strong>DEPRECATED</strong></span>
</p>
</td>
</tr>
@@ -278,7 +278,7 @@
</td>
<td>
<p>
- <tt class="literal">[#anchor]</tt>
+ <code class="literal">[#anchor]</code>
</p>
</td>
<td>
@@ -295,7 +295,7 @@
</td>
<td>
<p>
- <tt class="literal">[@http://www.boost.org Boost]</tt>
+ <code class="literal">[@http://www.boost.org Boost]</code>
</p>
</td>
<td>
@@ -312,7 +312,7 @@
</td>
<td>
<p>
- <tt class="literal">[link section.anchor Link text]</tt>
+ <code class="literal">[link section.anchor Link text]</code>
</p>
</td>
<td>
@@ -329,7 +329,7 @@
</td>
<td>
<p>
- <tt class="literal">[link xml.refentry Link text]</tt>
+ <code class="literal">[link xml.refentry Link text]</code>
</p>
</td>
<td>
@@ -346,12 +346,12 @@
</td>
<td>
<p>
- <tt class="literal">[funcref fully::qualified::function_name Link text]</tt>
+ <code class="literal">[funcref fully::qualified::function_name Link text]</code>
</p>
</td>
<td>
<p>
- <a href="syntax/phrase.html#quickbook.syntax.phrase.code_links" title=" Code Links">function, class, member,
+ <a href="syntax/phrase.html#quickbook.syntax.phrase.code_links" title="Code Links">function, class, member,
enum, macro, concept or header links</a>
</p>
</td>
@@ -364,12 +364,12 @@
</td>
<td>
<p>
- <tt class="literal">[classref fully::qualified::class_name Link text]</tt>
+ <code class="literal">[classref fully::qualified::class_name Link text]</code>
</p>
</td>
<td>
<p>
- <a href="syntax/phrase.html#quickbook.syntax.phrase.code_links" title=" Code Links">function, class, member,
+ <a href="syntax/phrase.html#quickbook.syntax.phrase.code_links" title="Code Links">function, class, member,
enum, macro, concept or header links</a>
</p>
</td>
@@ -382,12 +382,12 @@
</td>
<td>
<p>
- <tt class="literal">[memberref fully::qualified::member_name Link text]</tt>
+ <code class="literal">[memberref fully::qualified::member_name Link text]</code>
</p>
</td>
<td>
<p>
- <a href="syntax/phrase.html#quickbook.syntax.phrase.code_links" title=" Code Links">function, class, member,
+ <a href="syntax/phrase.html#quickbook.syntax.phrase.code_links" title="Code Links">function, class, member,
enum, macro, concept or header links</a>
</p>
</td>
@@ -400,12 +400,12 @@
</td>
<td>
<p>
- <tt class="literal">[enumref fully::qualified::enum_name Link text]</tt>
+ <code class="literal">[enumref fully::qualified::enum_name Link text]</code>
</p>
</td>
<td>
<p>
- <a href="syntax/phrase.html#quickbook.syntax.phrase.code_links" title=" Code Links">function, class, member,
+ <a href="syntax/phrase.html#quickbook.syntax.phrase.code_links" title="Code Links">function, class, member,
enum, macro, concept or header links</a>
</p>
</td>
@@ -418,12 +418,12 @@
</td>
<td>
<p>
- <tt class="literal">[macroref MACRO_NAME Link text]</tt>
+ <code class="literal">[macroref MACRO_NAME Link text]</code>
</p>
</td>
<td>
<p>
- <a href="syntax/phrase.html#quickbook.syntax.phrase.code_links" title=" Code Links">function, class, member,
+ <a href="syntax/phrase.html#quickbook.syntax.phrase.code_links" title="Code Links">function, class, member,
enum, macro, concept or header links</a>
</p>
</td>
@@ -436,12 +436,12 @@
</td>
<td>
<p>
- <tt class="literal">[conceptref ConceptName Link text]</tt>
+ <code class="literal">[conceptref ConceptName Link text]</code>
</p>
</td>
<td>
<p>
- <a href="syntax/phrase.html#quickbook.syntax.phrase.code_links" title=" Code Links">function, class, member,
+ <a href="syntax/phrase.html#quickbook.syntax.phrase.code_links" title="Code Links">function, class, member,
enum, macro, concept or header links</a>
</p>
</td>
@@ -454,12 +454,12 @@
</td>
<td>
<p>
- <tt class="literal">[headerref path/to/header.hpp Link text]</tt>
+ <code class="literal">[headerref path/to/header.hpp Link text]</code>
</p>
</td>
<td>
<p>
- <a href="syntax/phrase.html#quickbook.syntax.phrase.code_links" title=" Code Links">function, class, member,
+ <a href="syntax/phrase.html#quickbook.syntax.phrase.code_links" title="Code Links">function, class, member,
enum, macro, concept or header links</a>
</p>
</td>
@@ -472,7 +472,7 @@
</td>
<td>
<p>
- <tt class="literal">'''escaped text (no processing/formatting)'''</tt>
+ <code class="literal">'''escaped text (no processing/formatting)'''</code>
</p>
</td>
<td>
@@ -489,13 +489,12 @@
</td>
<td>
<p>
- <tt class="literal">\c</tt>
+ <code class="literal">\c</code>
</p>
</td>
<td>
<p>
- <a href="syntax/phrase.html#quickbook.syntax.phrase.single_char_escape" title="Single
- char escape">Single char
+ <a href="syntax/phrase.html#quickbook.syntax.phrase.single_char_escape" title="Single char escape">Single char
escape</a>
</p>
</td>
@@ -508,7 +507,7 @@
</td>
<td>
<p>
- <tt class="literal">[$image.jpg]</tt>
+ <code class="literal">[$image.jpg]</code>
</p>
</td>
<td>
@@ -525,7 +524,7 @@
</td>
<td>
<p>
- <tt class="literal">[section The Section Title]</tt>
+ <code class="literal">[section The Section Title]</code>
</p>
</td>
<td>
@@ -542,7 +541,7 @@
</td>
<td>
<p>
- <tt class="literal">[endsect]</tt>
+ <code class="literal">[endsect]</code>
</p>
</td>
<td>
@@ -588,8 +587,7 @@
</td>
<td>
<p>
- <a href="syntax/block.html#quickbook.syntax.block.lists.ordered_lists" title="Ordered
- lists">Ordered lists</a>
+ Ordered lists
</p>
</td>
</tr>
@@ -612,8 +610,7 @@
</td>
<td>
<p>
- <a href="syntax/block.html#quickbook.syntax.block.lists.unordered_lists" title="Unordered
- lists">Unordered
+ <a href="syntax/block.html#quickbook.syntax.block.lists.unordered_lists" title="Unordered lists">Unordered
lists</a>
</p>
</td>
@@ -643,7 +640,7 @@
</td>
<td>
<p>
- <tt class="literal">[pre preformatted]</tt>
+ <code class="literal">[pre preformatted]</code>
</p>
</td>
<td>
@@ -660,7 +657,7 @@
</td>
<td>
<p>
- <tt class="literal">[:sometext...]</tt>
+ <code class="literal">[:sometext...]</code>
</p>
</td>
<td>
@@ -677,7 +674,7 @@
</td>
<td>
<p>
- <tt class="literal">[h1 Heading 1]</tt>
+ <code class="literal">[h1 Heading 1]</code>
</p>
</td>
<td>
@@ -694,7 +691,7 @@
</td>
<td>
<p>
- <tt class="literal">[h2 Heading 2]</tt>
+ <code class="literal">[h2 Heading 2]</code>
</p>
</td>
<td>
@@ -711,7 +708,7 @@
</td>
<td>
<p>
- <tt class="literal">[h3 Heading 3]</tt>
+ <code class="literal">[h3 Heading 3]</code>
</p>
</td>
<td>
@@ -728,7 +725,7 @@
</td>
<td>
<p>
- <tt class="literal">[h4 Heading 4]</tt>
+ <code class="literal">[h4 Heading 4]</code>
</p>
</td>
<td>
@@ -745,7 +742,7 @@
</td>
<td>
<p>
- <tt class="literal">[h5 Heading 5]</tt>
+ <code class="literal">[h5 Heading 5]</code>
</p>
</td>
<td>
@@ -762,7 +759,7 @@
</td>
<td>
<p>
- <tt class="literal">[h6 Heading 6]</tt>
+ <code class="literal">[h6 Heading 6]</code>
</p>
</td>
<td>
@@ -779,7 +776,7 @@
</td>
<td>
<p>
- <tt class="literal">[def macro_identifier some text]</tt>
+ <code class="literal">[def macro_identifier some text]</code>
</p>
</td>
<td>
@@ -796,7 +793,7 @@
</td>
<td>
<p>
- <tt class="literal">[template[a b] [a] body [b]]</tt>
+ <code class="literal">[template[a b] [a] body [b]]</code>
</p>
</td>
<td>
@@ -813,7 +810,7 @@
</td>
<td>
<p>
- <tt class="literal">[blurb advertisement or note...]</tt>
+ <code class="literal">[blurb advertisement or note...]</code>
</p>
</td>
<td>
@@ -830,7 +827,7 @@
</td>
<td>
<p>
- <tt class="literal">[warning Warning text...]</tt>
+ <code class="literal">[warning Warning text...]</code>
</p>
</td>
<td>
@@ -895,7 +892,7 @@
</td>
<td>
<p>
- <tt class="literal">[include someother.qbk]</tt>
+ <code class="literal">[include someother.qbk]</code>
</p>
</td>
<td>
@@ -912,18 +909,19 @@
</td>
<td>
<p>
- <tt class="literal">[? symbol phrase]</tt>
+ <code class="literal">[? symbol phrase]</code>
</p>
</td>
<td>
<p>
- Conditional Generation
+ Conditional Generation
</p>
</td>
</tr>
</tbody>
-</table>
+</table></div>
</div>
+<br class="table-break">
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
Modified: branches/fix-links/tools/quickbook/doc/html/quickbook/syntax.html
==============================================================================
--- branches/fix-links/tools/quickbook/doc/html/quickbook/syntax.html (original)
+++ branches/fix-links/tools/quickbook/doc/html/quickbook/syntax.html 2007-12-03 15:31:01 EST (Mon, 03 Dec 2007)
@@ -1,12 +1,12 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
-<title> Syntax Summary</title>
+<title>Syntax Summary</title>
<link rel="stylesheet" href="../../../../../doc/html/boostbook.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.66.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.72.0">
<link rel="start" href="../index.html" title="Quickbook 1.4">
<link rel="up" href="../index.html" title="Quickbook 1.4">
-<link rel="prev" href="change_log.html" title=" Change Log">
+<link rel="prev" href="change_log.html" title="Change Log">
<link rel="next" href="syntax/comments.html" title="Comments">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
@@ -14,8 +14,8 @@
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td>
<td align="center">Home</td>
<td align="center">Libraries</td>
-<td align="center">People</td>
-<td align="center">FAQ</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
<td align="center">More</td>
</tr></table>
<hr>
@@ -24,7 +24,8 @@
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
-<a name="quickbook.syntax"></a> Syntax Summary</h2></div></div></div>
+<a name="quickbook.syntax"></a> Syntax Summary
+</h2></div></div></div>
<div class="toc"><dl>
<dt><span class="section">Comments</span></dt>
<dt><span class="section"> Phrase Level Elements</span></dt>
Modified: branches/fix-links/tools/quickbook/doc/html/quickbook/syntax/block.html
==============================================================================
--- branches/fix-links/tools/quickbook/doc/html/quickbook/syntax/block.html (original)
+++ branches/fix-links/tools/quickbook/doc/html/quickbook/syntax/block.html 2007-12-03 15:31:01 EST (Mon, 03 Dec 2007)
@@ -1,21 +1,21 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
-<title> Block Level Elements</title>
+<title>Block Level Elements</title>
<link rel="stylesheet" href="../../../../../../doc/html/boostbook.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.66.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.72.0">
<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">
+<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">
<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">Home</td>
<td align="center">Libraries</td>
-<td align="center">People</td>
-<td align="center">FAQ</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
<td align="center">More</td>
</tr></table>
<hr>
@@ -24,7 +24,8 @@
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
-<a name="quickbook.syntax.block"></a> Block Level Elements</h3></div></div></div>
+<a name="quickbook.syntax.block"></a> Block Level Elements
+</h3></div></div></div>
<div class="toc"><dl>
<dt><span class="section">Document</span></dt>
<dt><span class="section">Section</span></dt>
@@ -51,7 +52,8 @@
</dl></div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h4 class="title">
-<a name="quickbook.syntax.block.document"></a>Document</h4></div></div></div>
+<a name="quickbook.syntax.block.document"></a>Document
+</h4></div></div></div>
<p>
Every document must begin with a Document Info section, which should look
like this:
@@ -112,21 +114,22 @@
for. In its absence, version 1.1 is assumed.
</p>
<p>
- <tt class="literal">version</tt>, <tt class="literal">id</tt>, <tt class="literal">dirname</tt>,
- <tt class="literal">copyright</tt>, <tt class="literal">purpose</tt>, <tt class="literal">category</tt>,
- <tt class="literal">authors</tt>, <tt class="literal">license</tt>, <tt class="literal">last-revision</tt>
- and <tt class="literal">source-mode</tt> are optional information.
+ <code class="literal">version</code>, <code class="literal">id</code>, <code class="literal">dirname</code>,
+ <code class="literal">copyright</code>, <code class="literal">purpose</code>, <code class="literal">category</code>,
+ <code class="literal">authors</code>, <code class="literal">license</code>, <code class="literal">last-revision</code>
+ and <code class="literal">source-mode</code> are optional information.
</p>
<p>
- <tt class="literal">source-type</tt> is a lowercase string setting the initial
+ <code class="literal">source-type</code> is a lowercase string setting the initial
<a href="phrase.html#quickbook.syntax.phrase.source_mode" title="Source Mode">Source Mode</a>.
- If the <tt class="literal">source-mode</tt> field is omitted, a default value
- of <tt class="literal">c++</tt> will be used.
+ If the <code class="literal">source-mode</code> field is omitted, a default value
+ of <code class="literal">c++</code> will be used.
</p>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h4 class="title">
-<a name="quickbook.syntax.block.section"></a>Section</h4></div></div></div>
+<a name="quickbook.syntax.block.section"></a>Section
+</h4></div></div></div>
<p>
Starting a new section is accomplished with:
</p>
@@ -135,8 +138,8 @@
<p>
where <span class="emphasis"><em>id</em></span> is optional. id will be the filename of the
generated section. If it is not present, "The Section Title"
- will be normalized and become the id. Valid characters are <tt class="literal">a-Z</tt>,
- <tt class="literal">A-Z</tt>, <tt class="literal">0-9</tt> and <tt class="literal">_</tt>.
+ will be normalized and become the id. Valid characters are <code class="literal">a-Z</code>,
+ <code class="literal">A-Z</code>, <code class="literal">0-9</code> and <code class="literal">_</code>.
All non-valid characters are converted to underscore and all upper-case
are converted to lower case. Thus: "The Section Title" will be
normalized to "the_section_title".
@@ -152,7 +155,8 @@
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h4 class="title">
-<a name="quickbook.syntax.block.xinclude"></a>xinclude</h4></div></div></div>
+<a name="quickbook.syntax.block.xinclude"></a>xinclude
+</h4></div></div></div>
<p>
You can include another XML file with:
</p>
@@ -165,7 +169,8 @@
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h4 class="title">
-<a name="quickbook.syntax.block.paragraphs"></a>Paragraphs</h4></div></div></div>
+<a name="quickbook.syntax.block.paragraphs"></a>Paragraphs
+</h4></div></div></div>
<p>
Paragraphs start left-flushed and are terminated by two or more newlines.
No markup is needed for paragraphs. QuickBook automatically detects paragraphs
@@ -179,7 +184,8 @@
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h4 class="title">
-<a name="quickbook.syntax.block.lists"></a>Lists</h4></div></div></div>
+<a name="quickbook.syntax.block.lists"></a>Lists
+</h4></div></div></div>
<div class="toc"><dl>
<dt><span class="section"><a href="block.html#quickbook.syntax.block.lists.ordered_lists">Ordered
lists</a></span></dt>
@@ -193,9 +199,9 @@
</dl></div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h5 class="title">
-<a name="quickbook.syntax.block.lists.ordered_lists"></a><a href="block.html#quickbook.syntax.block.lists.ordered_lists" title="Ordered
- lists">Ordered
- lists</a></h5></div></div></div>
+<a name="quickbook.syntax.block.lists.ordered_lists"></a><a href="block.html#quickbook.syntax.block.lists.ordered_lists" title="Ordered lists">Ordered
+ lists</a>
+</h5></div></div></div>
<pre class="programlisting"># One
# Two
# Three
@@ -217,9 +223,9 @@
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h5 class="title">
-<a name="quickbook.syntax.block.lists.list_hierarchies"></a><a href="block.html#quickbook.syntax.block.lists.list_hierarchies" title="List
- Hierarchies">List
- Hierarchies</a></h5></div></div></div>
+<a name="quickbook.syntax.block.lists.list_hierarchies"></a><a href="block.html#quickbook.syntax.block.lists.list_hierarchies" title="List Hierarchies">List
+ Hierarchies</a>
+</h5></div></div></div>
<p>
List hierarchies are supported. Example:
</p>
@@ -280,9 +286,9 @@
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h5 class="title">
-<a name="quickbook.syntax.block.lists.long_list_lines"></a><a href="block.html#quickbook.syntax.block.lists.long_list_lines" title="Long
- List Lines">Long
- List Lines</a></h5></div></div></div>
+<a name="quickbook.syntax.block.lists.long_list_lines"></a><a href="block.html#quickbook.syntax.block.lists.long_list_lines" title="Long List Lines">Long
+ List Lines</a>
+</h5></div></div></div>
<p>
Long lines will be wrapped appropriately. Example:
</p>
@@ -311,9 +317,9 @@
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h5 class="title">
-<a name="quickbook.syntax.block.lists.unordered_lists"></a><a href="block.html#quickbook.syntax.block.lists.unordered_lists" title="Unordered
- lists">Unordered
- lists</a></h5></div></div></div>
+<a name="quickbook.syntax.block.lists.unordered_lists"></a><a href="block.html#quickbook.syntax.block.lists.unordered_lists" title="Unordered lists">Unordered
+ lists</a>
+</h5></div></div></div>
<pre class="programlisting">* First
* Second
* Third
@@ -335,7 +341,8 @@
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h5 class="title">
-<a name="quickbook.syntax.block.lists.mixed_lists"></a>Mixed lists</h5></div></div></div>
+<a name="quickbook.syntax.block.lists.mixed_lists"></a>Mixed lists
+</h5></div></div></div>
<p>
Mixed lists (ordered and unordered) are supported. Example:
</p>
@@ -446,7 +453,8 @@
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h4 class="title">
-<a name="quickbook.syntax.block.code"></a>Code</h4></div></div></div>
+<a name="quickbook.syntax.block.code"></a>Code
+</h4></div></div></div>
<p>
Preformatted code starts with a space or a tab. The code will be syntax
highlighted according to the current <a href="phrase.html#quickbook.syntax.phrase.source_mode" title="Source Mode">Source
@@ -493,9 +501,9 @@
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h4 class="title">
-<a name="quickbook.syntax.block.escape_back"></a><a href="block.html#quickbook.syntax.block.escape_back" title=" Escaping Back
- To QuickBook"> Escaping Back
- To QuickBook</a></h4></div></div></div>
+<a name="quickbook.syntax.block.escape_back"></a><a href="block.html#quickbook.syntax.block.escape_back" title="Escaping Back To QuickBook"> Escaping Back
+ To QuickBook</a>
+</h4></div></div></div>
<p>
Inside code, code blocks and inline code, QuickBook does not allow any
markup to avoid conflicts with the target syntax (e.g. c++). In case you
@@ -523,10 +531,11 @@
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h4 class="title">
-<a name="quickbook.syntax.block.preformatted"></a>Preformatted</h4></div></div></div>
+<a name="quickbook.syntax.block.preformatted"></a>Preformatted
+</h4></div></div></div>
<p>
Sometimes, you don't want some preformatted text to be parsed as C++. In
- such cases, use the <tt class="literal">[pre ... ]</tt> markup block.
+ such cases, use the <code class="literal">[pre ... ]</code> markup block.
</p>
<pre class="programlisting">[pre
@@ -543,21 +552,22 @@
level markup, pre (and Code) are the only ones that allow multiple newlines.
The markup above will generate:
</p>
-<pre class="programlisting">Some <span class="bold"><b>preformatted</b></span> text Some <span class="bold"><b>preformatted</b></span> text
+<pre class="programlisting">Some <span class="bold"><strong>preformatted</strong></span> text Some <span class="bold"><strong>preformatted</strong></span> text
- Some <span class="bold"><b>preformatted</b></span> text Some <span class="bold"><b>preformatted</b></span> text
+ Some <span class="bold"><strong>preformatted</strong></span> text Some <span class="bold"><strong>preformatted</strong></span> text
- Some <span class="bold"><b>preformatted</b></span> text Some <span class="bold"><b>preformatted</b></span> text
+ Some <span class="bold"><strong>preformatted</strong></span> text Some <span class="bold"><strong>preformatted</strong></span> text
</pre>
<p>
Notice that unlike Code, phrase markup such as font style is still permitted
- inside <tt class="literal">pre</tt> blocks.
+ inside <code class="literal">pre</code> blocks.
</p>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h4 class="title">
-<a name="quickbook.syntax.block.blockquote"></a>Blockquote</h4></div></div></div>
+<a name="quickbook.syntax.block.blockquote"></a>Blockquote
+</h4></div></div></div>
<pre class="programlisting">[:sometext...]
</pre>
<div class="blockquote"><blockquote class="blockquote">
@@ -572,7 +582,8 @@
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h4 class="title">
-<a name="quickbook.syntax.block.admonitions"></a>Admonitions</h4></div></div></div>
+<a name="quickbook.syntax.block.admonitions"></a>Admonitions
+</h4></div></div></div>
<pre class="programlisting">[note This is a note]
[tip This is a tip]
[important This is important]
@@ -587,7 +598,7 @@
<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 colspan="2" align="left" valign="top"><p>
+<tr><td align="left" valign="top"><p>
This is a note
</p></td></tr>
</table></div>
@@ -596,7 +607,7 @@
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Tip]" src="../../../../../../doc/html/images/tip.png"></td>
<th align="left">Tip</th>
</tr>
-<tr><td colspan="2" align="left" valign="top"><p>
+<tr><td align="left" valign="top"><p>
This is a tip
</p></td></tr>
</table></div>
@@ -605,7 +616,7 @@
<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 colspan="2" align="left" valign="top"><p>
+<tr><td align="left" valign="top"><p>
This is important
</p></td></tr>
</table></div>
@@ -614,7 +625,7 @@
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Caution]" src="../../../../../../doc/html/images/caution.png"></td>
<th align="left">Caution</th>
</tr>
-<tr><td colspan="2" align="left" valign="top"><p>
+<tr><td align="left" valign="top"><p>
This is a caution
</p></td></tr>
</table></div>
@@ -623,19 +634,20 @@
<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 colspan="2" align="left" valign="top"><p>
+<tr><td align="left" valign="top"><p>
This is a warning
</p></td></tr>
</table></div>
<p>
These are the only admonitions supported by DocBook.
- So, for example <tt class="literal">[information This is some information]</tt>
+ So, for example <code class="literal">[information This is some information]</code>
is unlikely to produce the desired effect.
</p>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h4 class="title">
-<a name="quickbook.syntax.block.headings"></a>Headings</h4></div></div></div>
+<a name="quickbook.syntax.block.headings"></a>Headings
+</h4></div></div></div>
<pre class="programlisting">[h1 Heading 1]
[h2 Heading 2]
[h3 Heading 3]
@@ -643,37 +655,37 @@
[h5 Heading 5]
[h6 Heading 6]
</pre>
-<a name="quickbook.syntax.block.headings.heading_1"></a><h1>
-<a name="id459656"></a>
+<a name="quickbook.syntax.block.headings.heading_1"></a><h2>
+<a name="id2617095"></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="id459680"></a>
- Heading 2
</h2>
-<a name="quickbook.syntax.block.headings.heading_3"></a><h3>
-<a name="id459704"></a>
- Heading 3
+<a name="quickbook.syntax.block.headings.heading_2"></a><h3>
+<a name="id2617115"></a>
+ Heading 2
</h3>
-<a name="quickbook.syntax.block.headings.heading_4"></a><h4>
-<a name="id459729"></a>
- Heading 4
+<a name="quickbook.syntax.block.headings.heading_3"></a><h4>
+<a name="id2617135"></a>
+ Heading 3
</h4>
-<a name="quickbook.syntax.block.headings.heading_5"></a><h5>
-<a name="id459754"></a>
- Heading 5
+<a name="quickbook.syntax.block.headings.heading_4"></a><h5>
+<a name="id2617156"></a>
+ Heading 4
</h5>
+<a name="quickbook.syntax.block.headings.heading_5"></a><h6>
+<a name="id2617177"></a>
+ Heading 5
+ </h6>
<a name="quickbook.syntax.block.headings.heading_6"></a><h5>
-<a name="id459779"></a>
+<a name="id2617197"></a>
<a href="block.html#quickbook.syntax.block.headings.heading_6">Heading 6</a>
</h5>
<p>
Headings 1-3 [h1 h2 and h3] will automatically have anchors with normalized
- names with <tt class="literal">name="section_id.normalized_header_text"</tt>
- (i.e. valid characters are <tt class="literal">a-z</tt>, <tt class="literal">A-Z</tt>,
- <tt class="literal">0-9</tt> and <tt class="literal">_</tt>. All non-valid characters
+ names with <code class="literal">name="section_id.normalized_header_text"</code>
+ (i.e. valid characters are <code class="literal">a-z</code>, <code class="literal">A-Z</code>,
+ <code class="literal">0-9</code> and <code class="literal">_</code>. All non-valid characters
are converted to underscore and all upper-case are converted to lower-case.
- For example: Heading 1 in section Section 2 will be normalized to <tt class="literal">section_2.heading_1</tt>).
+ For example: Heading 1 in section Section 2 will be normalized to <code class="literal">section_2.heading_1</code>).
You can use:
</p>
<pre class="programlisting">[link section_id.normalized_header_text The link text]
@@ -686,7 +698,8 @@
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h4 class="title">
-<a name="quickbook.syntax.block.generic_heading"></a>Generic Heading</h4></div></div></div>
+<a name="quickbook.syntax.block.generic_heading"></a>Generic Heading
+</h4></div></div></div>
<p>
In cases when you don't want to care about the heading level (1 to 6),
you can use the <span class="emphasis"><em>Generic Heading</em></span>:
@@ -733,7 +746,8 @@
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h4 class="title">
-<a name="quickbook.syntax.block.macros"></a>Macros</h4></div></div></div>
+<a name="quickbook.syntax.block.macros"></a>Macros
+</h4></div></div></div>
<pre class="programlisting">[def macro_identifier some text]
</pre>
<p>
@@ -757,19 +771,19 @@
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Tip]" src="../../../../../../doc/html/images/tip.png"></td>
<th align="left">Tip</th>
</tr>
-<tr><td colspan="2" align="left" valign="top"><p>
+<tr><td 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
+ underscores (e.g. <code class="literal">__spirit__</code>). 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>)
+ Links (URLS) and images are good candidates for macros. <span class="bold"><strong>1</strong></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">[@http://spirit.sourceforge.net Spirit]</tt>.
+ in one place near the top to make it easy to make changes. <span class="bold"><strong>2</strong></span>)
+ The syntax is not pretty. It's easier to read and write, e.g. <code class="literal">__spirit__</code>
+ than <code class="literal">[@http://spirit.sourceforge.net Spirit]</code>.
</p>
<p>
Some more examples:
@@ -795,15 +809,15 @@
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h4 class="title">
-<a name="quickbook.syntax.block.predefined_macros"></a><a href="block.html#quickbook.syntax.block.predefined_macros" title="Predefined
- Macros">Predefined
- Macros</a></h4></div></div></div>
+<a name="quickbook.syntax.block.predefined_macros"></a><a href="block.html#quickbook.syntax.block.predefined_macros" title="Predefined Macros">Predefined
+ Macros</a>
+</h4></div></div></div>
<p>
Quickbook has some predefined macros that you can already use.
</p>
<div class="table">
-<a name="id460235"></a><p class="title"><b>Table 3. Predefined Macros</b></p>
-<table class="table" summary="Predefined Macros">
+<a name="id2617610"></a><p class="title"><b>Table 3. Predefined Macros</b></p>
+<div class="table-contents"><table class="table" summary="Predefined Macros">
<colgroup>
<col>
<col>
@@ -840,7 +854,7 @@
</td>
<td>
<p>
- 2007-Nov-14
+ 2007-Dec-03
</p>
</td>
</tr>
@@ -857,7 +871,7 @@
</td>
<td>
<p>
- 06:19:55 PM
+ 08:26:04 PM
</p>
</td>
</tr>
@@ -874,17 +888,19 @@
</td>
<td>
<p>
- C:\dev\boost\tools\quickbook\doc\quickbook.qbk
+ /home/daniel/cpp/boost/branches/fix-links/tools/quickbook/doc/quickbook.qbk
</p>
</td>
</tr>
</tbody>
-</table>
+</table></div>
</div>
+<br class="table-break">
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h4 class="title">
-<a name="quickbook.syntax.block.templates"></a>Templates</h4></div></div></div>
+<a name="quickbook.syntax.block.templates"></a>Templates
+</h4></div></div></div>
<p>
Templates provide a more versatile text substitution mechanism. Templates
come in handy when you need to create parameterizable, multi-line, boilerplate
@@ -902,11 +918,11 @@
]
</pre>
-<a name="quickbook.syntax.block.templates.template_identifier"></a><h5>
-<a name="id460416"></a>
+<a name="quickbook.syntax.block.templates.template_identifier"></a><h6>
+<a name="id2617771"></a>
<a href="block.html#quickbook.syntax.block.templates.template_identifier">Template
Identifier</a>
- </h5>
+ </h6>
<p>
Template identifiers can either consist of:
</p>
@@ -920,11 +936,11 @@
A single character punctuation (a non-alphanumeric printable character)
</li>
</ul></div>
-<a name="quickbook.syntax.block.templates.formal_template_arguments"></a><h5>
-<a name="id460462"></a>
+<a name="quickbook.syntax.block.templates.formal_template_arguments"></a><h6>
+<a name="id2617812"></a>
<a href="block.html#quickbook.syntax.block.templates.formal_template_arguments">Formal
Template Arguments</a>
- </h5>
+ </h6>
<p>
Template formal arguments are identifiers consisting of an initial alphabetic
character or the underscore, followed by zero or more alphanumeric characters
@@ -933,18 +949,18 @@
<p>
A template formal argument temporarily hides a template of the same name
at the point where the <a href="block.html#quickbook.syntax.block.templates.template_expansion">template
- is expanded</a>. Note that the body of the <tt class="literal">person</tt>
- template above refers to <tt class="literal">name</tt> <tt class="literal">age</tt>
- and <tt class="literal">what</tt> as <tt class="literal">[name]</tt> <tt class="literal">[age]</tt>
- and <tt class="literal">[what]</tt>. <tt class="literal">name</tt> <tt class="literal">age</tt>
- and <tt class="literal">what</tt> are actually templates that exist in the duration
+ is expanded</a>. Note that the body of the <code class="literal">person</code>
+ template above refers to <code class="literal">name</code> <code class="literal">age</code>
+ and <code class="literal">what</code> as <code class="literal">[name]</code> <code class="literal">[age]</code>
+ and <code class="literal">[what]</code>. <code class="literal">name</code> <code class="literal">age</code>
+ and <code class="literal">what</code> are actually templates that exist in the duration
of the template call.
</p>
-<a name="quickbook.syntax.block.templates.template_body"></a><h5>
-<a name="id460581"></a>
+<a name="quickbook.syntax.block.templates.template_body"></a><h6>
+<a name="id2617918"></a>
<a href="block.html#quickbook.syntax.block.templates.template_body">Template
Body</a>
- </h5>
+ </h6>
<p>
The template body can be just about any QuickBook block or phrase. There
are actually two forms. Templates may be phrase or block level. Phrase
@@ -965,11 +981,11 @@
Phrase templates are typically expanded as part of phrases. Like macros,
block level elements are not allowed in phrase templates.
</p>
-<a name="quickbook.syntax.block.templates.template_expansion"></a><h5>
-<a name="id460640"></a>
+<a name="quickbook.syntax.block.templates.template_expansion"></a><h6>
+<a name="id2617977"></a>
<a href="block.html#quickbook.syntax.block.templates.template_expansion">Template
Expansion</a>
- </h5>
+ </h6>
<p>
You expand a template this way:
</p>
@@ -1002,7 +1018,7 @@
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Caution]" src="../../../../../../doc/html/images/caution.png"></td>
<th align="left">Caution</th>
</tr>
-<tr><td colspan="2" align="left" valign="top"><p>
+<tr><td 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.
@@ -1012,15 +1028,15 @@
</table></div>
<p>
Each actual argument can be a word, a text fragment or just about any
- QuickBook phrase. Arguments
- are separated by the double dot <tt class="literal">".."</tt> and terminated
+ QuickBook phrase. Arguments
+ are separated by the double dot <code class="literal">".."</code> and terminated
by the close parenthesis.
</p>
-<a name="quickbook.syntax.block.templates.nullary_templates"></a><h5>
-<a name="id460747"></a>
+<a name="quickbook.syntax.block.templates.nullary_templates"></a><h6>
+<a name="id2618073"></a>
<a href="block.html#quickbook.syntax.block.templates.nullary_templates">Nullary
Templates</a>
- </h5>
+ </h6>
<p>
Nullary templates look and act like simple macros. Example:
</p>
@@ -1035,7 +1051,7 @@
We have:
</p>
<p>
- Some squiggles...<span class="bold"><b>αβ</b></span>
+ Some squiggles...<span class="bold"><strong>αβ</strong></span>
</p>
<p>
The difference with macros are
@@ -1055,7 +1071,7 @@
</li>
</ul></div>
<p>
- The empty brackets after the template identifier (<tt class="literal">alpha[]</tt>)
+ The empty brackets after the template identifier (<code class="literal">alpha[]</code>)
indicates no arguments. If the template body does not look like a template
argument list, we can elide the empty brackets. Example:
</p>
@@ -1071,15 +1087,15 @@
We have:
</p>
<p>
- Here's a quote from Aristotle: <span class="bold"><b><span class="emphasis"><em>Education
- is the best provision for the journey to old age.</em></span></b></span>.
+ Here's a quote from Aristotle: <span class="bold"><strong><span class="emphasis"><em>Education
+ is the best provision for the journey to old age.</em></span></strong></span>.
</p>
<p>
The disadvantage is that you can't avoid the space between the template
- identifier, <tt class="computeroutput"><span class="identifier">aristotle_quote</span></tt>,
+ identifier, <code class="computeroutput"><span class="identifier">aristotle_quote</span></code>,
and the template body "Aristotle...". This space will be part
of the template body. If that space is unwanted, use empty brackets or
- use the space escape: "<tt class="computeroutput"><span class="special">\</span> </tt>".
+ use the space escape: "<code class="computeroutput"><span class="special">\</span> </code>".
Example:
</p>
<pre class="programlisting">[template tag\ _tag]
@@ -1093,26 +1109,26 @@
We have:
</p>
<p>
- <tt class="computeroutput"><span class="keyword">struct</span></tt> x_tag;
+ <code class="computeroutput"><span class="keyword">struct</span></code> x_tag;
</p>
<p>
You have a couple of ways to do it. I personally prefer the explicit empty
brackets, though.
</p>
-<a name="quickbook.syntax.block.templates.simple_arguments"></a><h5>
-<a name="id460981"></a>
+<a name="quickbook.syntax.block.templates.simple_arguments"></a><h6>
+<a name="id2618288"></a>
<a href="block.html#quickbook.syntax.block.templates.simple_arguments">Simple
Arguments</a>
- </h5>
+ </h6>
<p>
- As mentioned, arguments are separated by the double dot <tt class="literal">".."</tt>.
+ As mentioned, arguments are separated by the double dot <code class="literal">".."</code>.
If there are less arguments passed than expected, QuickBook attempts to
break the last argument into two or more arguments following this logic:
</p>
<div class="itemizedlist"><ul type="disc">
<li>
- Break the last argument into two, at the first space found (<tt class="literal">'',
- '\n', \t' or '\r'</tt>).
+ Break the last argument into two, at the first space found (<code class="literal">'',
+ '\n', \t' or '\r'</code>).
</li>
<li>
Repeat until there are enough arguments or if there are no more spaces
@@ -1133,8 +1149,8 @@
</p>
<p>
"w x y z" is initially treated as a single argument because we
- didn't supply any <tt class="literal">".."</tt> separators. However,
- since <tt class="literal">simple</tt> expects 4 arguments, "w x y z"
+ didn't supply any <code class="literal">".."</code> separators. However,
+ since <code class="literal">simple</code> expects 4 arguments, "w x y z"
is broken down iteratively (applying the logic above) until we have "w",
"x", "y" and "z".
</p>
@@ -1155,8 +1171,8 @@
</p>
<p>
It should be obvious now that for simple arguments with no spaces, we can
- get by without separating the arguments with <tt class="literal">".."</tt>
- separators. It is possible to combine <tt class="literal">".."</tt>
+ get by without separating the arguments with <code class="literal">".."</code>
+ separators. It is possible to combine <code class="literal">".."</code>
separators with the argument passing simplification presented above. Example:
</p>
<pre class="programlisting">[simple what do you think ..m a n?]
@@ -1167,11 +1183,11 @@
<p>
what do you think man?
</p>
-<a name="quickbook.syntax.block.templates.punctuation_templates"></a><h5>
-<a name="id461151"></a>
+<a name="quickbook.syntax.block.templates.punctuation_templates"></a><h6>
+<a name="id2618442"></a>
<a href="block.html#quickbook.syntax.block.templates.punctuation_templates">Punctuation
Templates</a>
- </h5>
+ </h6>
<p>
With templates, one of our objectives is to allow us to rewrite QuickBook
in QuickBook (as a qbk library). For that to happen, we need to accommodate
@@ -1195,7 +1211,8 @@
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h4 class="title">
-<a name="quickbook.syntax.block.blurbs"></a>Blurbs</h4></div></div></div>
+<a name="quickbook.syntax.block.blurbs"></a>Blurbs
+</h4></div></div></div>
<pre class="programlisting">[blurb :-) [*An eye catching advertisement or note...]
__spirit__ is an object-oriented recursive-descent parser generator framework
@@ -1208,9 +1225,10 @@
will generate this:
</p>
<div class="sidebar">
+<p class="title"><b></b></p>
<p>
- <span class="inlinemediaobject"><img src="../../images/smiley.png" alt="smiley"></span> <span class="bold"><b>An eye catching advertisement
- or note...</b></span>
+ <span class="inlinemediaobject"><img src="../../images/smiley.png" alt="smiley"></span> <span class="bold"><strong>An eye catching advertisement
+ or note...</strong></span>
</p>
<p>
<a href="http://spirit.sourceforge.net" target="_top">Spirit</a> is an object-oriented
@@ -1224,7 +1242,7 @@
<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 colspan="2" align="left" valign="top"><p>
+<tr><td align="left" valign="top"><p>
Prefer admonitions
wherever appropriate.
</p></td></tr>
@@ -1232,7 +1250,8 @@
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h4 class="title">
-<a name="quickbook.syntax.block.tables"></a>Tables</h4></div></div></div>
+<a name="quickbook.syntax.block.tables"></a>Tables
+</h4></div></div></div>
<pre class="programlisting">[table A Simple Table
[[Heading 1] [Heading 2] [Heading 3]]
[[R0-C0] [R0-C1] [R0-C2]]
@@ -1244,8 +1263,8 @@
will generate:
</p>
<div class="table">
-<a name="id461354"></a><p class="title"><b>Table 4. A Simple Table</b></p>
-<table class="table" summary="A Simple Table">
+<a name="id2618627"></a><p class="title"><b>Table 4. A Simple Table</b></p>
+<div class="table-contents"><table class="table" summary="A Simple Table">
<colgroup>
<col>
<col>
@@ -1321,11 +1340,11 @@
</td>
</tr>
</tbody>
-</table>
+</table></div>
</div>
-<p>
+<br class="table-break"><p>
The table title is optional. The first row of the table is automatically
- treated as the table header; that is, it is wrapped in <tt class="literal"><thead>...</thead></tt>
+ treated as the table header; that is, it is wrapped in <code class="literal"><thead>...</thead></code>
XML tags. Note that unlike the original QuickDoc, the columns are nested
in [ cells... ]. The syntax is free-format and allows big cells to be formatted
nicely. Example:
@@ -1355,8 +1374,8 @@
and thus:
</p>
<div class="table">
-<a name="id461518"></a><p class="title"><b>Table 5. Table with fat cells</b></p>
-<table class="table" summary="Table with fat cells">
+<a name="id2618774"></a><p class="title"><b>Table 5. Table with fat cells</b></p>
+<div class="table-contents"><table class="table" summary="Table with fat cells">
<colgroup>
<col>
<col>
@@ -1408,9 +1427,9 @@
</td>
</tr>
</tbody>
-</table>
+</table></div>
</div>
-<p>
+<br class="table-break"><p>
Here's how to have preformatted blocks of code in a table cell:
</p>
<pre class="programlisting">[table Table with code
@@ -1430,8 +1449,8 @@
]
</pre>
<div class="table">
-<a name="id461636"></a><p class="title"><b>Table 6. Table with code</b></p>
-<table class="table" summary="Table with code">
+<a name="id2618882"></a><p class="title"><b>Table 6. Table with code</b></p>
+<div class="table-contents"><table class="table" summary="Table with code">
<colgroup>
<col>
<col>
@@ -1471,12 +1490,14 @@
</p>
</td>
</tr></tbody>
-</table>
+</table></div>
</div>
+<br class="table-break">
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h4 class="title">
-<a name="quickbook.syntax.block.variable_lists"></a>Variable Lists</h4></div></div></div>
+<a name="quickbook.syntax.block.variable_lists"></a>Variable Lists
+</h4></div></div></div>
<pre class="programlisting">[variablelist A Variable List
[[term 1] [The definition of term 1]]
[[term 2] [The definition of term 2]]
@@ -1521,7 +1542,8 @@
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h4 class="title">
-<a name="quickbook.syntax.block.include"></a>Include</h4></div></div></div>
+<a name="quickbook.syntax.block.include"></a>Include
+</h4></div></div></div>
<p>
You can include one QuickBook file from another. The syntax is simply:
</p>
@@ -1541,7 +1563,7 @@
</li>
</ul></div>
<p>
- The <tt class="literal">[include]</tt> directive lets you specify a document
+ The <code class="literal">[include]</code> directive lets you specify a document
id to use for the included file. When this id is not explicitly specified,
the id defaults to the filename ("someother", in the example
above). You can specify the id like this:
@@ -1552,12 +1574,13 @@
All auto-generated anchors will use the document id as a unique prefix.
So for instance, if there is a top section in someother.qbk named "Intro",
the named anchor for that section will be "someid.intro", and
- you can link to it with <tt class="literal">[link someid.intro The Intro]</tt>.
+ you can link to it with <code class="literal">[link someid.intro The Intro]</code>.
</p>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h4 class="title">
-<a name="quickbook.syntax.block.import"></a>Import</h4></div></div></div>
+<a name="quickbook.syntax.block.import"></a>Import
+</h4></div></div></div>
<p>
When documenting code, you'd surely need to present code from actual source
files. While it is possible to copy some code and paste them in your QuickBook
@@ -1569,10 +1592,10 @@
<p>
QuickBook's import facility provides a nice solution.
</p>
-<a name="quickbook.syntax.block.import.example"></a><h5>
-<a name="id462059"></a>
+<a name="quickbook.syntax.block.import.example"></a><h6>
+<a name="id2619270"></a>
<a href="block.html#quickbook.syntax.block.import.example">Example</a>
- </h5>
+ </h6>
<p>
You can effortlessly import code snippets from source code into your QuickBook.
The following illustrates how this is done:
@@ -1589,8 +1612,8 @@
<p>
collects specially marked-up code snippets from stub.cpp
and places them in your QuickBook file as virtual templates. Each of the
- specially marked-up code snippets has a name (e.g. <tt class="computeroutput"><span class="identifier">foo</span></tt>
- and <tt class="computeroutput"><span class="identifier">bar</span></tt> in the example
+ specially marked-up code snippets has a name (e.g. <code class="computeroutput"><span class="identifier">foo</span></code>
+ and <code class="computeroutput"><span class="identifier">bar</span></code> in the example
above). This shall be the template identifier for that particular code
snippet. The second and third line above does the actual template expansion:
</p>
@@ -1603,7 +1626,7 @@
<p>
</p>
<p>
- This is the <span class="bold"><b><span class="emphasis"><em>foo</em></span></b></span>
+ This is the <span class="bold"><strong><span class="emphasis"><em>foo</em></span></strong></span>
function.
</p>
<p>
@@ -1643,7 +1666,7 @@
<p>
</p>
<p>
- This is the <span class="bold"><b><span class="emphasis"><em>bar</em></span></b></span>
+ This is the <span class="bold"><strong><span class="emphasis"><em>bar</em></span></strong></span>
function
</p>
<p>
@@ -1666,11 +1689,11 @@
</p>
<p>
</p>
-<a name="quickbook.syntax.block.import.code_snippet_markup"></a><h5>
-<a name="id462364"></a>
+<a name="quickbook.syntax.block.import.code_snippet_markup"></a><h6>
+<a name="id2619549"></a>
<a href="block.html#quickbook.syntax.block.import.code_snippet_markup">Code
Snippet Markup</a>
- </h5>
+ </h6>
<p>
Note how the code snippets in stub.cpp
get marked up. We use distinguishable comments following the form:
@@ -1682,16 +1705,16 @@
</span></pre>
<p>
The first comment line above initiates a named code-snippet. This prefix
- will not be visible in quickbook. The entire code-snippet in between <tt class="computeroutput"><span class="comment">//[id</span></tt> and <tt class="computeroutput"><span class="comment">//]</span></tt>
+ will not be visible in quickbook. The entire code-snippet in between <code class="computeroutput"><span class="comment">//[id</span></code> and <code class="computeroutput"><span class="comment">//]</span></code>
will be inserted as a template in quickbook with name <span class="emphasis"><em><span class="emphasis"><em>id</em></span></em></span>.
- The comment <tt class="computeroutput"><span class="comment">//]</span></tt> ends a code-snippet
+ The comment <code class="computeroutput"><span class="comment">//]</span></code> ends a code-snippet
This too will not be visible in quickbook.
</p>
-<a name="quickbook.syntax.block.import.special_comments"></a><h5>
-<a name="id462489"></a>
+<a name="quickbook.syntax.block.import.special_comments"></a><h6>
+<a name="id2619660"></a>
<a href="block.html#quickbook.syntax.block.import.special_comments">Special
Comments</a>
- </h5>
+ </h6>
<p>
Special comments of the form:
</p>
@@ -1735,10 +1758,10 @@
can be used to inhibit code from passing through to quickbook. All text
between the delimeters will simply be ignored.
</p>
-<a name="quickbook.syntax.block.import.callouts"></a><h5>
-<a name="id462669"></a>
+<a name="quickbook.syntax.block.import.callouts"></a><h6>
+<a name="id2619825"></a>
<a href="block.html#quickbook.syntax.block.import.callouts">Callouts</a>
- </h5>
+ </h6>
<p>
Special comments of the form:
</p>
@@ -1860,13 +1883,13 @@
<tr>
<td width="5%" valign="top" align="left">
<a name="quickbook4"></a>
</td>
-<td valign="top" align="left"><p> Get the <tt class="computeroutput"><span class="identifier">n</span></tt>
+<td valign="top" align="left"><p> Get the <code class="computeroutput"><span class="identifier">n</span></code>
member variable </p></td>
</tr>
<tr>
<td width="5%" valign="top" align="left">
<a name="quickbook5"></a>
</td>
-<td valign="top" align="left"><p> Set the <tt class="computeroutput"><span class="identifier">n</span></tt>
+<td valign="top" align="left"><p> Set the <code class="computeroutput"><span class="identifier">n</span></code>
member variable </p></td>
</tr>
</table></div>
Modified: branches/fix-links/tools/quickbook/doc/html/quickbook/syntax/comments.html
==============================================================================
--- branches/fix-links/tools/quickbook/doc/html/quickbook/syntax/comments.html (original)
+++ branches/fix-links/tools/quickbook/doc/html/quickbook/syntax/comments.html 2007-12-03 15:31:01 EST (Mon, 03 Dec 2007)
@@ -3,19 +3,19 @@
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Comments</title>
<link rel="stylesheet" href="../../../../../../doc/html/boostbook.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.66.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.72.0">
<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">
+<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%"><tr>
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td>
<td align="center">Home</td>
<td align="center">Libraries</td>
-<td align="center">People</td>
-<td align="center">FAQ</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
<td align="center">More</td>
</tr></table>
<hr>
@@ -24,7 +24,8 @@
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
-<a name="quickbook.syntax.comments"></a>Comments</h3></div></div></div>
+<a name="quickbook.syntax.comments"></a>Comments
+</h3></div></div></div>
<p>
Can be placed anywhere.
</p>
Modified: branches/fix-links/tools/quickbook/doc/html/quickbook/syntax/phrase.html
==============================================================================
--- branches/fix-links/tools/quickbook/doc/html/quickbook/syntax/phrase.html (original)
+++ branches/fix-links/tools/quickbook/doc/html/quickbook/syntax/phrase.html 2007-12-03 15:31:01 EST (Mon, 03 Dec 2007)
@@ -1,21 +1,21 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
-<title> Phrase Level Elements</title>
+<title>Phrase Level Elements</title>
<link rel="stylesheet" href="../../../../../../doc/html/boostbook.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.66.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.72.0">
<link rel="start" href="../../index.html" title="Quickbook 1.4">
-<link rel="up" href="../syntax.html" title=" Syntax Summary">
+<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">
+<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%"><tr>
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td>
<td align="center">Home</td>
<td align="center">Libraries</td>
-<td align="center">People</td>
-<td align="center">FAQ</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
<td align="center">More</td>
</tr></table>
<hr>
@@ -24,7 +24,8 @@
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
-<a name="quickbook.syntax.phrase"></a> Phrase Level Elements</h3></div></div></div>
+<a name="quickbook.syntax.phrase"></a> Phrase Level Elements
+</h3></div></div></div>
<div class="toc"><dl>
<dt><span class="section">Font Styles</span></dt>
<dt><span class="section">Replaceable</span></dt>
@@ -48,14 +49,15 @@
</dl></div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h4 class="title">
-<a name="quickbook.syntax.phrase.font_styles"></a>Font Styles</h4></div></div></div>
+<a name="quickbook.syntax.phrase.font_styles"></a>Font Styles
+</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"><b>bold</b></span>, <span class="underline">underline</span>, <tt class="literal">teletype</tt>, <span class="strikethrough">strikethrough</span>
+ <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>
</p>
<p>
Like all non-terminal phrase level elements, this can of course be nested:
@@ -66,12 +68,13 @@
will generate:
</p>
<p>
- <span class="bold"><b><span class="emphasis"><em>bold-italic</em></span></b></span>
+ <span class="bold"><strong><span class="emphasis"><em>bold-italic</em></span></strong></span>
</p>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h4 class="title">
-<a name="quickbook.syntax.phrase.replaceable"></a>Replaceable</h4></div></div></div>
+<a name="quickbook.syntax.phrase.replaceable"></a>Replaceable
+</h4></div></div></div>
<p>
When you want content that may or must be replaced by the user, use the
syntax:
@@ -82,14 +85,15 @@
This will generate:
</p>
<p>
- <i class="replaceable"><tt>
+ <em class="replaceable"><code>
replacement
- </tt></i>
+ </code></em>
</p>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h4 class="title">
-<a name="quickbook.syntax.phrase.quotations"></a>Quotations</h4></div></div></div>
+<a name="quickbook.syntax.phrase.quotations"></a>Quotations
+</h4></div></div></div>
<pre class="programlisting">["A question that sometimes drives me hazy: am I or are the others crazy?]--Einstein
</pre>
<p>
@@ -120,7 +124,8 @@
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h4 class="title">
-<a name="quickbook.syntax.phrase.simple_formatting"></a>Simple formatting</h4></div></div></div>
+<a name="quickbook.syntax.phrase.simple_formatting"></a>Simple formatting
+</h4></div></div></div>
<p>
Simple markup for formatting text, common in many applications, is now
supported:
@@ -131,12 +136,12 @@
will generate:
</p>
<p>
- <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="emphasis"><em>italic</em></span>, <span class="bold"><strong>bold</strong></span>, <span class="underline">underline</span>, <code class="literal">teletype</code>
</p>
<p>
Unlike QuickBook's standard formatting scheme, the rules for simpler alternatives
are much stricter
- <sup>[<a name="id455996" href="#ftn.id455996">1</a>]</sup>
+ <sup>[<a name="id2613736" href="#ftn.id2613736">1</a>]</sup>
.
</p>
<div class="itemizedlist"><ul type="disc">
@@ -166,14 +171,13 @@
</li>
<li>
A line starting with the star will be interpreted as an unordered list.
- See <a href="block.html#quickbook.syntax.block.lists.unordered_lists" title="Unordered
- lists">Unordered
+ See <a href="block.html#quickbook.syntax.block.lists.unordered_lists" title="Unordered lists">Unordered
lists</a>.
</li>
</ul></div>
<div class="table">
-<a name="id456079"></a><p class="title"><b>Table 1. More Formatting Samples</b></p>
-<table class="table" summary="More Formatting Samples">
+<a name="id2613816"></a><p class="title"><b>Table 1. More Formatting Samples</b></p>
+<div class="table-contents"><table class="table" summary="More Formatting Samples">
<colgroup>
<col>
<col>
@@ -194,31 +198,31 @@
<tr>
<td>
<p>
- <tt class="literal">*Bold*</tt>
+ <code class="literal">*Bold*</code>
</p>
</td>
<td>
<p>
- <span class="bold"><b>Bold</b></span>
+ <span class="bold"><strong>Bold</strong></span>
</p>
</td>
</tr>
<tr>
<td>
<p>
- <tt class="literal">*Is bold*</tt>
+ <code class="literal">*Is bold*</code>
</p>
</td>
<td>
<p>
- <span class="bold"><b>Is bold</b></span>
+ <span class="bold"><strong>Is bold</strong></span>
</p>
</td>
</tr>
<tr>
<td>
<p>
- <tt class="literal">* Not bold* *Not bold * * Not bold *</tt>
+ <code class="literal">* Not bold* *Not bold * * Not bold *</code>
</p>
</td>
<td>
@@ -230,7 +234,7 @@
<tr>
<td>
<p>
- <tt class="literal">This*Isn't*Bold (no bold)</tt>
+ <code class="literal">This*Isn't*Bold (no bold)</code>
</p>
</td>
<td>
@@ -242,31 +246,31 @@
<tr>
<td>
<p>
- <tt class="literal">(*Bold Inside*) (parenthesis not bold)</tt>
+ <code class="literal">(*Bold Inside*) (parenthesis not bold)</code>
</p>
</td>
<td>
<p>
- (<span class="bold"><b>Bold Inside</b></span>) (parenthesis not bold)
+ (<span class="bold"><strong>Bold Inside</strong></span>) (parenthesis not bold)
</p>
</td>
</tr>
<tr>
<td>
<p>
- <tt class="literal">*(Bold Outside)* (parenthesis bold)</tt>
+ <code class="literal">*(Bold Outside)* (parenthesis bold)</code>
</p>
</td>
<td>
<p>
- <span class="bold"><b>(Bold Outside)</b></span> (parenthesis bold)
+ <span class="bold"><strong>(Bold Outside)</strong></span> (parenthesis bold)
</p>
</td>
</tr>
<tr>
<td>
<p>
- <tt class="literal">3*4*5 = 60 (no bold)</tt>
+ <code class="literal">3*4*5 = 60 (no bold)</code>
</p>
</td>
<td>
@@ -278,7 +282,7 @@
<tr>
<td>
<p>
- <tt class="literal">3 * 4 * 5 = 60 (no bold)</tt>
+ <code class="literal">3 * 4 * 5 = 60 (no bold)</code>
</p>
</td>
<td>
@@ -290,79 +294,79 @@
<tr>
<td>
<p>
- <tt class="literal">3 *4* 5 = 60 (4 is bold)</tt>
+ <code class="literal">3 *4* 5 = 60 (4 is bold)</code>
</p>
</td>
<td>
<p>
- 3 <span class="bold"><b>4</b></span> 5 = 60 (4 is bold)
+ 3 <span class="bold"><strong>4</strong></span> 5 = 60 (4 is bold)
</p>
</td>
</tr>
<tr>
<td>
<p>
- <tt class="literal">*This is bold* this is not *but this is*</tt>
+ <code class="literal">*This is bold* this is not *but this is*</code>
</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>
+ <span class="bold"><strong>This is bold</strong></span> this is not <span class="bold"><strong>but this is</strong></span>
</p>
</td>
</tr>
<tr>
<td>
<p>
- <tt class="literal">*This is bold*.</tt>
+ <code class="literal">*This is bold*.</code>
</p>
</td>
<td>
<p>
- <span class="bold"><b>This is bold</b></span>.
+ <span class="bold"><strong>This is bold</strong></span>.
</p>
</td>
</tr>
<tr>
<td>
<p>
- <tt class="literal">*B*. (bold B)</tt>
+ <code class="literal">*B*. (bold B)</code>
</p>
</td>
<td>
<p>
- <span class="bold"><b>B</b></span>. (bold B)
+ <span class="bold"><strong>B</strong></span>. (bold B)
</p>
</td>
</tr>
<tr>
<td>
<p>
- <tt class="literal">['*Bold-Italic*]</tt>
+ <code class="literal">['*Bold-Italic*]</code>
</p>
</td>
<td>
<p>
- <span class="emphasis"><em><span class="bold"><b>Bold-Italic</b></span></em></span>
+ <span class="emphasis"><em><span class="bold"><strong>Bold-Italic</strong></span></em></span>
</p>
</td>
</tr>
<tr>
<td>
<p>
- <tt class="literal">*side-by*/-side/</tt>
+ <code class="literal">*side-by*/-side/</code>
</p>
</td>
<td>
<p>
- <span class="bold"><b>side-by</b></span><span class="emphasis"><em>-side</em></span>
+ <span class="bold"><strong>side-by</strong></span><span class="emphasis"><em>-side</em></span>
</p>
</td>
</tr>
</tbody>
-</table>
+</table></div>
</div>
-<p>
+<br class="table-break"><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:
@@ -373,8 +377,8 @@
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,
+ 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,
And one for the little boy who lives down the lane.
</p>
<p>
@@ -393,7 +397,8 @@
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h4 class="title">
-<a name="quickbook.syntax.phrase.inline_code"></a>Inline code</h4></div></div></div>
+<a name="quickbook.syntax.phrase.inline_code"></a>Inline code
+</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:
@@ -404,7 +409,7 @@
will generate:
</p>
<p>
- 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>
+ 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>
in it. The code will be syntax highlighted.
</p>
<div class="note"><table border="0" summary="Note">
@@ -412,23 +417,22 @@
<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 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>.
+<tr><td align="left" valign="top"><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>.
</p></td></tr>
</table></div>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h4 class="title">
-<a name="quickbook.syntax.phrase.code_blocks"></a>Code blocks</h4></div></div></div>
+<a name="quickbook.syntax.phrase.code_blocks"></a>Code blocks
+</h4></div></div></div>
<p>
Preformatted code simply starts with a space or a tab (See Code).
However, such a simple syntax cannot be used as phrase elements in lists
- (See <a href="block.html#quickbook.syntax.block.lists.ordered_lists" title="Ordered
- lists">Ordered
- lists</a> and <a href="block.html#quickbook.syntax.block.lists.unordered_lists" title="Unordered
- lists">Unordered
+ (See <a href="block.html#quickbook.syntax.block.lists.ordered_lists" title="Ordered lists">Ordered
+ lists</a> and <a href="block.html#quickbook.syntax.block.lists.unordered_lists" title="Unordered lists">Unordered
lists</a>), tables (See Tables),
etc. Inline code (see above) can. The problem is, inline code does not
allow formatting with newlines, spaces, and tabs. These are lost.
@@ -468,7 +472,8 @@
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h4 class="title">
-<a name="quickbook.syntax.phrase.source_mode"></a>Source Mode</h4></div></div></div>
+<a name="quickbook.syntax.phrase.source_mode"></a>Source Mode
+</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
@@ -477,8 +482,8 @@
section.
</p>
<p>
- 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
+ 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
example, this:
</p>
<pre class="programlisting">Python's [python] `import` is rather like C++'s [c++] `#include`. A
@@ -489,14 +494,14 @@
will generate:
</p>
<p>
- 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>.
+ 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>.
</p>
<div class="table">
-<a name="id457060"></a><p class="title"><b>Table 2. Supported Source Modes</b></p>
-<table class="table" summary="Supported Source Modes">
+<a name="id2614716"></a><p class="title"><b>Table 2. Supported Source Modes</b></p>
+<div class="table-contents"><table class="table" summary="Supported Source Modes">
<colgroup>
<col>
<col>
@@ -522,7 +527,7 @@
</td>
<td>
<p>
- <tt class="literal">[c++]</tt>
+ <code class="literal">[c++]</code>
</p>
</td>
</tr>
@@ -534,26 +539,27 @@
</td>
<td>
<p>
- <tt class="literal">[python]</tt>
+ <code class="literal">[python]</code>
</p>
</td>
</tr>
</tbody>
-</table>
+</table></div>
</div>
-<div class="note"><table border="0" summary="Note">
+<br class="table-break"><div class="note"><table border="0" summary="Note">
<tr>
<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 colspan="2" align="left" valign="top"><p>
+<tr><td align="left" valign="top"><p>
The source mode strings are lowercase.
</p></td></tr>
</table></div>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h4 class="title">
-<a name="quickbook.syntax.phrase.line_break"></a>line-break</h4></div></div></div>
+<a name="quickbook.syntax.phrase.line_break"></a>line-break
+</h4></div></div></div>
<pre class="programlisting">[br]
</pre>
<div class="warning"><table border="0" summary="Warning">
@@ -561,8 +567,8 @@
<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 colspan="2" align="left" valign="top"><p>
- <tt class="computeroutput"><span class="special">[</span><span class="identifier">br</span><span class="special">]</span></tt> is now deprecated. Blurbs,
+<tr><td align="left" valign="top"><p>
+ <code class="computeroutput"><span class="special">[</span><span class="identifier">br</span><span class="special">]</span></code> is now deprecated. Blurbs,
<a href="block.html#quickbook.syntax.block.admonitions" title="Admonitions">Admonitions</a>
and table cells (see Tables)
may now contain paragraphs.
@@ -571,27 +577,29 @@
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h4 class="title">
-<a name="quickbook.syntax.phrase.anchors"></a>Anchors</h4></div></div></div>
+<a name="quickbook.syntax.phrase.anchors"></a>Anchors
+</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 <tt class="literal">[link named_anchor
-Some link text]</tt>.
+ the document. You can then reference an anchor with <code class="literal">[link named_anchor
+Some link text]</code>.
See Anchor links,
<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>Links</h4></div></div></div>
+<a name="quickbook.syntax.phrase.links"></a>Links
+</h4></div></div></div>
<pre class="programlisting">[@http://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"><b>boost's</b></span>
+ <a href="http://www.boost.org" target="_top">this is <span class="bold"><strong>boost's</strong></span>
website....</a>
</p>
<p>
@@ -613,7 +621,8 @@
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h4 class="title">
-<a name="quickbook.syntax.phrase.anchor_links"></a>Anchor links</h4></div></div></div>
+<a name="quickbook.syntax.phrase.anchor_links"></a>Anchor links
+</h4></div></div></div>
<p>
You can link within a document using:
</p>
@@ -627,15 +636,16 @@
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h4 class="title">
-<a name="quickbook.syntax.phrase.refentry_links"></a>refentry links</h4></div></div></div>
+<a name="quickbook.syntax.phrase.refentry_links"></a>refentry links
+</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 <tt class="literal"><link linkend="xml.refentry">The
- link text</link></tt>.
+ This gets converted into <code class="literal"><link linkend="xml.refentry">The
+ link text</link></code>.
</p>
<p>
Like URLs, the link text is optional. If this is not present, the link
@@ -644,12 +654,13 @@
<pre class="programlisting">[link xml.refentry]
</pre>
<p>
- This gets converted into <tt class="literal"><link linkend="xml.refentry">xml.refentry</link></tt>.
+ This gets converted into <code class="literal"><link linkend="xml.refentry">xml.refentry</link></code>.
</p>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h4 class="title">
-<a name="quickbook.syntax.phrase.code_links"></a> Code Links</h4></div></div></div>
+<a name="quickbook.syntax.phrase.code_links"></a> Code Links
+</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:
@@ -675,7 +686,8 @@
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h4 class="title">
-<a name="quickbook.syntax.phrase.escape"></a>Escape</h4></div></div></div>
+<a name="quickbook.syntax.phrase.escape"></a>Escape
+</h4></div></div></div>
<p>
The escape mark-up is used when we don't want to do any processing.
</p>
@@ -692,31 +704,31 @@
'''
</pre>
<p>
- <span class="bold"><b>This is direct XML markup</b></span>
+ <span class="bold"><strong>This is direct XML markup</strong></span>
</p>
<div class="important"><table border="0" summary="Important">
<tr>
<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 colspan="2" align="left" valign="top"><p>
+<tr><td align="left" valign="top"><p>
Be careful when using the escape. The text must conform to BoostBook/DocBook syntax.
</p></td></tr>
</table></div>
</div>
<div class="section" lang="en">
<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>
+<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>
<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 <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>
+ 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>
</p>
<p>
- <tt class="computeroutput"><span class="special">\</span><span class="identifier">n</span></tt>
+ <code class="computeroutput"><span class="special">\</span><span class="identifier">n</span></code>
has a special meaning. It is used to generate line breaks.
</p>
<div class="warning"><table border="0" summary="Warning">
@@ -724,28 +736,30 @@
<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 colspan="2" align="left" valign="top"><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. Blurbs,
+<tr><td align="left" valign="top"><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. Blurbs,
<a href="block.html#quickbook.syntax.block.admonitions" title="Admonitions">Admonitions</a>
and table cells (see Tables)
may now contain paragraphs.
</p></td></tr>
</table></div>
<p>
- The escaped space: <tt class="computeroutput"><span class="special">\</span> </tt> also
+ The escaped space: <code class="computeroutput"><span class="special">\</span> </code> 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>Images</h4></div></div></div>
+<a name="quickbook.syntax.phrase.images"></a>Images
+</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>Footnotes</h4></div></div></div>
+<a name="quickbook.syntax.phrase.footnotes"></a>Footnotes
+</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>
@@ -754,21 +768,21 @@
</dl></div>
<p>
As of version 1.3, QuickBook supports footnotes. Just put the text of 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
+ 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
bottom of the current page. For example, this:
</p>
<pre class="programlisting">[footnote A sample footnote]
</pre>
<p>
will generate this
- <sup>[<a name="id457901" href="#ftn.id457901">2</a>]</sup>
+ <sup>[<a name="id2615512" href="#ftn.id2615512">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>
+<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>
<pre class="programlisting">__a_macro_identifier__
</pre>
<p>
@@ -777,9 +791,9 @@
</div>
<div class="section" lang="en">
<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>
+<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>
<pre class="programlisting">[a_template_identifier]
</pre>
<p>
@@ -790,9 +804,10 @@
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h4 class="title">
-<a name="quickbook.syntax.phrase.cond"></a> Conditional Generation</h4></div></div></div>
+<a name="quickbook.syntax.phrase.cond"></a> Conditional Generation
+</h4></div></div></div>
<p>
- Like C++ <tt class="computeroutput"><span class="comment">#ifdef</span></tt>, you can generate
+ Like C++ <code class="computeroutput"><span class="comment">#ifdef</span></code>, you can generate
phrases depending on the presence of a macro. Example:
</p>
<pre class="programlisting">[? __to_be__ To be or not to be]
@@ -814,22 +829,22 @@
</p>
<p>
Yes!
- <sup>[<a name="id458075" href="#ftn.id458075">3</a>]</sup>
+ <sup>[<a name="id2615668" href="#ftn.id2615668">3</a>]</sup>
</p>
</div>
<div class="footnotes">
<br><hr width="100" align="left">
-<div class="footnote"><p><sup>[<a name="ftn.id455996" href="#id455996">1</a>] </sup>
+<div class="footnote"><p><sup>[<a name="ftn.id2613736" href="#id2613736">1</a>] </sup>
Thanks to David Barrett, author of Qwiki,
for sharing these samples and teaching me these obscure formatting
rules. I wasn't sure at all if Spirit,
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.id457901" href="#id457901">2</a>] </sup>
+<div class="footnote"><p><sup>[<a name="ftn.id2615512" href="#id2615512">2</a>] </sup>
A sample footnote
</p></div>
-<div class="footnote"><p><sup>[<a name="ftn.id458075" href="#id458075">3</a>] </sup>
+<div class="footnote"><p><sup>[<a name="ftn.id2615668" href="#id2615668">3</a>] </sup>
Conditional Generation makes quickbook turing complete.
</p></div>
</div>
Boost-Commit list run by bdawes at acm.org, david.abrahams at rcn.com, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk