|
|
Boost-Commit : |
From: grafikrobot_at_[hidden]
Date: 2007-10-25 21:02:50
Author: grafik
Date: 2007-10-25 21:02:48 EDT (Thu, 25 Oct 2007)
New Revision: 40469
URL: http://svn.boost.org/trac/boost/changeset/40469
Log:
Merge search path for include & import from backend branch. And add corresponding support for <include> to BBv2 quickbook tool. Remove obsolete quickbook.xml file. (fixes #1263)
Removed:
trunk/tools/quickbook/doc/quickbook.xml
Text files modified:
trunk/tools/build/v2/tools/quickbook.jam | 3
trunk/tools/quickbook/detail/actions.cpp | 46 ++-
trunk/tools/quickbook/detail/actions.hpp | 1
trunk/tools/quickbook/detail/quickbook.cpp | 8
trunk/tools/quickbook/doc/html/index.html | 8
trunk/tools/quickbook/doc/html/quickbook/change_log.html | 47 ++-
trunk/tools/quickbook/doc/html/quickbook/editors.html | 18
trunk/tools/quickbook/doc/html/quickbook/faq.html | 21
trunk/tools/quickbook/doc/html/quickbook/install.html | 15
trunk/tools/quickbook/doc/html/quickbook/install/linux.html | 39 +-
trunk/tools/quickbook/doc/html/quickbook/install/macosx.html | 47 ++--
trunk/tools/quickbook/doc/html/quickbook/install/windows.html | 51 ++--
trunk/tools/quickbook/doc/html/quickbook/intro.html | 13
trunk/tools/quickbook/doc/html/quickbook/ref.html | 220 +++++++++---------
trunk/tools/quickbook/doc/html/quickbook/syntax.html | 9
trunk/tools/quickbook/doc/html/quickbook/syntax/block.html | 460 ++++++++++++++++++++-------------------
trunk/tools/quickbook/doc/html/quickbook/syntax/comments.html | 11
trunk/tools/quickbook/doc/html/quickbook/syntax/phrase.html | 271 ++++++++++++-----------
trunk/tools/quickbook/doc/quickbook.qbk | 2
19 files changed, 678 insertions(+), 612 deletions(-)
Modified: trunk/tools/build/v2/tools/quickbook.jam
==============================================================================
--- trunk/tools/build/v2/tools/quickbook.jam (original)
+++ trunk/tools/build/v2/tools/quickbook.jam 2007-10-25 21:02:48 EDT (Thu, 25 Oct 2007)
@@ -286,6 +286,7 @@
# <quickbook-binary-dependencies> targets to build QuickBook from sources.
toolset.flags quickbook.quickbook-to-boostbook QB-COMMAND <quickbook-binary> ;
toolset.flags quickbook.quickbook-to-boostbook QB-DEPENDENCIES <quickbook-binary-dependencies> ;
+toolset.flags quickbook.quickbook-to-boostbook INCLUDES <include> ;
rule quickbook-to-boostbook ( target : source : properties * )
{
@@ -296,7 +297,7 @@
actions quickbook-to-boostbook
{
- "$(QB-COMMAND)" --output-file=$(1) $(2)
+ "$(QB-COMMAND)" -I"$(INCLUDES)" --output-file=$(1) $(2)
}
# Declare a main target to convert a quickbook source into a boostbook
Modified: trunk/tools/quickbook/detail/actions.cpp
==============================================================================
--- trunk/tools/quickbook/detail/actions.cpp (original)
+++ trunk/tools/quickbook/detail/actions.cpp 2007-10-25 21:02:48 EDT (Thu, 25 Oct 2007)
@@ -987,17 +987,40 @@
boost::spirit::parse(first, last, g);
}
- void import_action::operator()(iterator first, iterator last) const
+ namespace
{
- fs::path path(std::string(first, last), fs::native);
-
- // check to see if the path is complete and if not, make it relative to the current path
- if (!path.is_complete())
+ fs::path include_search(fs::path const & current, std::string const & name)
{
- path = actions.filename.branch_path() / path;
- path.normalize();
+ fs::path path(name,fs::native);
+
+ // If the path is relative, try and resolve it.
+ if (!path.is_complete())
+ {
+ // See if it can be found locally first.
+ if (fs::exists(current / path))
+ {
+ return current / path;
+ }
+
+ // Search in each of the include path locations.
+ BOOST_FOREACH(std::string const & p, include_path)
+ {
+ fs::path full(p,fs::native);
+ full /= path;
+ if (fs::exists(full))
+ {
+ return full;
+ }
+ }
+ }
+
+ return path;
}
+ }
+ void import_action::operator()(iterator first, iterator last) const
+ {
+ fs::path path = include_search(actions.filename.branch_path(), std::string(first,last));
std::string ext = fs::extension(path);
std::vector<template_symbol> storage;
load_snippets(path.string(), storage, ext, actions.doc_id);
@@ -1020,16 +1043,9 @@
void include_action::operator()(iterator first, iterator last) const
{
- fs::path filein(std::string(first, last), fs::native);
+ fs::path filein = include_search(actions.filename.branch_path(), std::string(first,last));
std::string doc_type, doc_id, doc_dirname, doc_last_revision;
- // check to see if the path is complete and if not, make it relative to the current path
- if (!filein.is_complete())
- {
- filein = actions.filename.branch_path() / filein;
- filein.normalize();
- }
-
// swap the filenames
std::swap(actions.filename, filein);
Modified: trunk/tools/quickbook/detail/actions.hpp
==============================================================================
--- trunk/tools/quickbook/detail/actions.hpp (original)
+++ trunk/tools/quickbook/detail/actions.hpp 2007-10-25 21:02:48 EDT (Thu, 25 Oct 2007)
@@ -44,6 +44,7 @@
extern unsigned qbk_major_version;
extern unsigned qbk_minor_version;
extern unsigned qbk_version_n; // qbk_major_version * 100 + qbk_minor_version
+ extern std::vector<std::string> include_path;
// forward declarations
struct actions;
Modified: trunk/tools/quickbook/detail/quickbook.cpp
==============================================================================
--- trunk/tools/quickbook/detail/quickbook.cpp (original)
+++ trunk/tools/quickbook/detail/quickbook.cpp 2007-10-25 21:02:48 EDT (Thu, 25 Oct 2007)
@@ -21,6 +21,7 @@
#include <stdexcept>
#include <fstream>
#include <iostream>
+#include <vector>
#if (defined(BOOST_MSVC) && (BOOST_MSVC <= 1310))
#pragma warning(disable:4355)
@@ -39,6 +40,7 @@
unsigned qbk_minor_version = 0;
unsigned qbk_version_n = 0; // qbk_major_version * 100 + qbk_minor_version
bool ms_errors = false; // output errors/warnings as if for VS
+ std::vector<std::string> include_path;
///////////////////////////////////////////////////////////////////////////
//
@@ -164,6 +166,7 @@
("output-file", value<std::string>(), "output file")
("debug", "debug mode (for developers)")
("ms-errors", "use Microsoft Visual Studio style error & warn message format")
+ ("include-path,I", value< std::vector<std::string> >(), "include path")
;
positional_options_description p;
@@ -224,6 +227,11 @@
quickbook::current_gm_time = &gmt;
quickbook::debug_mode = false;
}
+
+ if (vm.count("include-path"))
+ {
+ quickbook::include_path = vm["include-path"].as< std::vector<std::string> >();
+ }
if (vm.count("input-file"))
{
Modified: trunk/tools/quickbook/doc/html/index.html
==============================================================================
--- trunk/tools/quickbook/doc/html/index.html (original)
+++ trunk/tools/quickbook/doc/html/index.html 2007-10-25 21:02:48 EDT (Thu, 25 Oct 2007)
@@ -3,9 +3,9 @@
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Quickbook 1.4</title>
<link rel="stylesheet" href="boostbook.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.66.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.73.1">
<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>
@@ -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="id455862"></a><p>
+<a name="id470078"></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: September 24, 2007 at 06:00:48 GMT</small></p></td>
+<td align="left"><p><small>Last revised: October 26, 2007 at 00:54:37 GMT</small></p></td>
<td align="right"><small></small></td>
</tr></table>
<hr>
Modified: trunk/tools/quickbook/doc/html/quickbook/change_log.html
==============================================================================
--- trunk/tools/quickbook/doc/html/quickbook/change_log.html (original)
+++ trunk/tools/quickbook/doc/html/quickbook/change_log.html 2007-10-25 21:02:48 EDT (Thu, 25 Oct 2007)
@@ -1,13 +1,13 @@
<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="../boostbook.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.66.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.73.1">
<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>
@@ -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="id385722"></a>
- Version 1.3
- </h3>
+<a name="quickbook.change_log"></a><a class="link" href="change_log.html" title="Change Log"> Change Log</a>
+</h2></div></div></div>
+<a name="quickbook.change_log.version_1_3"></a><h4>
+<a name="id473891"></a>
+ <a class="link" href="change_log.html#quickbook.change_log.version_1_3">Version 1.3</a>
+ </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="id386160"></a>
- Version 1.4
- </h3>
+<a name="quickbook.change_log.version_1_4"></a><h4>
+<a name="id518843"></a>
+ <a class="link" href="change_log.html#quickbook.change_log.version_1_4">Version 1.4</a>
+ </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.
@@ -124,7 +125,7 @@
Quickbook blocks can nest inside comments.
</li>
<li>
-Import facility.
+<a class="link" href="syntax/block.html#quickbook.syntax.block.import" title="Import">Import</a> facility.
</li>
<li>
Callouts on imported code
@@ -133,18 +134,22 @@
Simple markups can now span a whole block.
</li>
<li>
-Blurbs, Admonitions
- and table cells (see Tables)
+<a class="link" href="syntax/block.html#quickbook.syntax.block.blurbs" title="Blurbs">Blurbs</a>, <a class="link" href="syntax/block.html#quickbook.syntax.block.admonitions" title="Admonitions">Admonitions</a>
+ and table cells (see <a class="link" href="syntax/block.html#quickbook.syntax.block.tables" title="Tables">Tables</a>)
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.
+<a class="link" href="syntax/phrase.html#quickbook.syntax.phrase.cond" title="Conditional Generation">Conditional Generation</a>.
Ala C++ #ifdef.
</li>
+<li>
+ Searching of included and imported files in an extensible search path with
+ <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>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
Modified: trunk/tools/quickbook/doc/html/quickbook/editors.html
==============================================================================
--- trunk/tools/quickbook/doc/html/quickbook/editors.html (original)
+++ trunk/tools/quickbook/doc/html/quickbook/editors.html 2007-10-25 21:02:48 EDT (Thu, 25 Oct 2007)
@@ -1,13 +1,13 @@
<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="../boostbook.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.66.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.73.1">
<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>
@@ -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><a class="link" href="editors.html" title="Editor Support"> Editor Support</a>
+</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: trunk/tools/quickbook/doc/html/quickbook/faq.html
==============================================================================
--- trunk/tools/quickbook/doc/html/quickbook/faq.html (original)
+++ trunk/tools/quickbook/doc/html/quickbook/faq.html 2007-10-25 21:02:48 EDT (Thu, 25 Oct 2007)
@@ -1,13 +1,13 @@
<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="../boostbook.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.66.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.73.1">
<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>
@@ -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="id467544"></a>
- <a href="faq.html#quickbook.faq.can_i_use_quickbook_for_non_boost_documentation_">Can
+<a name="quickbook.faq"></a><a class="link" href="faq.html" title="Frequently Asked Questions"> Frequently Asked Questions</a>
+</h2></div></div></div>
+<a name="quickbook.faq.can_i_use_quickbook_for_non_boost_documentation_"></a><h4>
+<a name="id546772"></a>
+ <a class="link" 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,8 +61,8 @@
:
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
Modified: trunk/tools/quickbook/doc/html/quickbook/install.html
==============================================================================
--- trunk/tools/quickbook/doc/html/quickbook/install.html (original)
+++ trunk/tools/quickbook/doc/html/quickbook/install.html 2007-10-25 21:02:48 EDT (Thu, 25 Oct 2007)
@@ -1,13 +1,13 @@
<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="../boostbook.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.66.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.73.1">
<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>
@@ -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><a class="link" href="install.html" title="Installation and configuration"> Installation and configuration</a>
+</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: trunk/tools/quickbook/doc/html/quickbook/install/linux.html
==============================================================================
--- trunk/tools/quickbook/doc/html/quickbook/install/linux.html (original)
+++ trunk/tools/quickbook/doc/html/quickbook/install/linux.html 2007-10-25 21:02:48 EDT (Thu, 25 Oct 2007)
@@ -1,13 +1,13 @@
<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="../../boostbook.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.66.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.73.1">
<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>
@@ -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><a class="link" href="linux.html" title="Debian, Ubuntu"> Debian, Ubuntu</a>
+</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: trunk/tools/quickbook/doc/html/quickbook/install/macosx.html
==============================================================================
--- trunk/tools/quickbook/doc/html/quickbook/install/macosx.html (original)
+++ trunk/tools/quickbook/doc/html/quickbook/install/macosx.html 2007-10-25 21:02:48 EDT (Thu, 25 Oct 2007)
@@ -1,13 +1,13 @@
<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="../../boostbook.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.66.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.73.1">
<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>
@@ -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><a class="link" href="macosx.html" title="Mac OS X"> Mac OS X</a>
+</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: trunk/tools/quickbook/doc/html/quickbook/install/windows.html
==============================================================================
--- trunk/tools/quickbook/doc/html/quickbook/install/windows.html (original)
+++ trunk/tools/quickbook/doc/html/quickbook/install/windows.html 2007-10-25 21:02:48 EDT (Thu, 25 Oct 2007)
@@ -1,13 +1,13 @@
<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="../../boostbook.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.66.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.73.1">
<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>
@@ -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><a class="link" href="windows.html" title="Windows 2000, XP, 2003, Vista"> Windows 2000, XP, 2003, Vista</a>
+</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: trunk/tools/quickbook/doc/html/quickbook/intro.html
==============================================================================
--- trunk/tools/quickbook/doc/html/quickbook/intro.html (original)
+++ trunk/tools/quickbook/doc/html/quickbook/intro.html 2007-10-25 21:02:48 EDT (Thu, 25 Oct 2007)
@@ -1,13 +1,13 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
-<title> Introduction</title>
+<title>Introduction</title>
<link rel="stylesheet" href="../boostbook.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.66.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.73.1">
<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>
@@ -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><a class="link" href="intro.html" title="Introduction"> Introduction</a>
+</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: trunk/tools/quickbook/doc/html/quickbook/ref.html
==============================================================================
--- trunk/tools/quickbook/doc/html/quickbook/ref.html (original)
+++ trunk/tools/quickbook/doc/html/quickbook/ref.html 2007-10-25 21:02:48 EDT (Thu, 25 Oct 2007)
@@ -1,12 +1,12 @@
<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="../boostbook.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.66.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.73.1">
<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>
@@ -23,13 +23,14 @@
</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><a class="link" href="ref.html" title="Quick Reference"> Quick Reference</a>
+</h2></div></div></div>
<p>
[cpp]
</p>
<div class="table">
-<a name="id467642"></a><p class="title"><b>Table 8. Syntax Compendium</b></p>
-<table class="table" summary="Syntax Compendium">
+<a name="id546857"></a><p class="title"><b>Table 8. Syntax Compendium</b></p>
+<div class="table-contents"><table class="table" summary="Syntax Compendium">
<colgroup>
<col>
<col>
@@ -61,12 +62,12 @@
</td>
<td>
<p>
- <tt class="literal">[/ some comment]</tt>
+ <code class="literal">[/ some comment]</code>
</p>
</td>
<td>
<p>
- Comments
+ <a class="link" href="syntax/comments.html" title="Comments">Comments</a>
</p>
</td>
</tr>
@@ -78,13 +79,13 @@
</td>
<td>
<p>
- <tt class="literal">['italics] or /italics/</tt>
+ <code class="literal">['italics] or /italics/</code>
</p>
</td>
<td>
<p>
- Font Styles
- and <a href="syntax/phrase.html#quickbook.syntax.phrase.simple_formatting" title="Simple formatting">Simple
+ <a class="link" href="syntax/phrase.html#quickbook.syntax.phrase.font_styles" title="Font Styles">Font Styles</a>
+ and <a class="link" href="syntax/phrase.html#quickbook.syntax.phrase.simple_formatting" title="Simple formatting">Simple
formatting</a>
</p>
</td>
@@ -92,18 +93,18 @@
<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>
<p>
- Font Styles
- and <a href="syntax/phrase.html#quickbook.syntax.phrase.simple_formatting" title="Simple formatting">Simple
+ <a class="link" href="syntax/phrase.html#quickbook.syntax.phrase.font_styles" title="Font Styles">Font Styles</a>
+ and <a class="link" href="syntax/phrase.html#quickbook.syntax.phrase.simple_formatting" title="Simple formatting">Simple
formatting</a>
</p>
</td>
@@ -116,13 +117,13 @@
</td>
<td>
<p>
- <tt class="literal">[_underline] or _underline_</tt>
+ <code class="literal">[_underline] or _underline_</code>
</p>
</td>
<td>
<p>
- Font Styles
- and <a href="syntax/phrase.html#quickbook.syntax.phrase.simple_formatting" title="Simple formatting">Simple
+ <a class="link" href="syntax/phrase.html#quickbook.syntax.phrase.font_styles" title="Font Styles">Font Styles</a>
+ and <a class="link" href="syntax/phrase.html#quickbook.syntax.phrase.simple_formatting" title="Simple formatting">Simple
formatting</a>
</p>
</td>
@@ -130,18 +131,18 @@
<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>
<p>
- Font Styles
- and <a href="syntax/phrase.html#quickbook.syntax.phrase.simple_formatting" title="Simple formatting">Simple
+ <a class="link" href="syntax/phrase.html#quickbook.syntax.phrase.font_styles" title="Font Styles">Font Styles</a>
+ and <a class="link" href="syntax/phrase.html#quickbook.syntax.phrase.simple_formatting" title="Simple formatting">Simple
formatting</a>
</p>
</td>
@@ -154,13 +155,13 @@
</td>
<td>
<p>
- <tt class="literal">[-strikethrough]</tt>
+ <code class="literal">[-strikethrough]</code>
</p>
</td>
<td>
<p>
- Font Styles
- and <a href="syntax/phrase.html#quickbook.syntax.phrase.simple_formatting" title="Simple formatting">Simple
+ <a class="link" href="syntax/phrase.html#quickbook.syntax.phrase.font_styles" title="Font Styles">Font Styles</a>
+ and <a class="link" href="syntax/phrase.html#quickbook.syntax.phrase.simple_formatting" title="Simple formatting">Simple
formatting</a>
</p>
</td>
@@ -168,19 +169,19 @@
<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>
<p>
- Replaceble
+ <a class="link" href="syntax/phrase.html#quickbook.syntax.phrase.replaceable" title="Replaceable">Replaceble</a>
</p>
</td>
</tr>
@@ -192,12 +193,12 @@
</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>
<p>
- Source Mode
+ <a class="link" href="syntax/phrase.html#quickbook.syntax.phrase.source_mode" title="Source Mode">Source Mode</a>
</p>
</td>
</tr>
@@ -209,12 +210,12 @@
</td>
<td>
<p>
- <tt class="literal">`int main();`</tt>
+ <code class="literal">`int main();`</code>
</p>
</td>
<td>
<p>
- Inline code
+ <a class="link" href="syntax/phrase.html#quickbook.syntax.phrase.inline_code" title="Inline code">Inline code</a>
</p>
</td>
</tr>
@@ -226,12 +227,12 @@
</td>
<td>
<p>
- <tt class="literal">``int main();``</tt>
+ <code class="literal">``int main();``</code>
</p>
</td>
<td>
<p>
- Code
+ <a class="link" href="syntax/block.html#quickbook.syntax.block.code" title="Code">Code</a>
</p>
</td>
</tr>
@@ -243,13 +244,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>
+ <a class="link" href="syntax/block.html#quickbook.syntax.block.escape_back" title="Escaping Back To QuickBook">Escaping Back To QuickBook</a>
</p>
</td>
</tr>
@@ -261,13 +261,13 @@
</td>
<td>
<p>
- <tt class="literal">[br] or \n</tt>
+ <code class="literal">[br] or \n</code>
</p>
</td>
<td>
<p>
- line-break
- <span class="bold"><b>DEPRECATED</b></span>
+ <a class="link" href="syntax/phrase.html#quickbook.syntax.phrase.line_break" title="line-break">line-break</a>
+ <span class="bold"><strong>DEPRECATED</strong></span>
</p>
</td>
</tr>
@@ -279,12 +279,12 @@
</td>
<td>
<p>
- <tt class="literal">[#anchor]</tt>
+ <code class="literal">[#anchor]</code>
</p>
</td>
<td>
<p>
- Anchors
+ <a class="link" href="syntax/phrase.html#quickbook.syntax.phrase.anchors" title="Anchors">Anchors</a>
</p>
</td>
</tr>
@@ -296,12 +296,12 @@
</td>
<td>
<p>
- <tt class="literal">[@http://www.boost.org Boost]</tt>
+ <code class="literal">[@http://www.boost.org Boost]</code>
</p>
</td>
<td>
<p>
- Links
+ <a class="link" href="syntax/phrase.html#quickbook.syntax.phrase.links" title="Links">Links</a>
</p>
</td>
</tr>
@@ -313,12 +313,12 @@
</td>
<td>
<p>
- <tt class="literal">[link section.anchor Link text]</tt>
+ <code class="literal">[link section.anchor Link text]</code>
</p>
</td>
<td>
<p>
- Anchor links
+ <a class="link" href="syntax/phrase.html#quickbook.syntax.phrase.anchor_links" title="Anchor links">Anchor links</a>
</p>
</td>
</tr>
@@ -330,12 +330,12 @@
</td>
<td>
<p>
- <tt class="literal">[link xml.refentry Link text]</tt>
+ <code class="literal">[link xml.refentry Link text]</code>
</p>
</td>
<td>
<p>
- refentry links
+ <a class="link" href="syntax/phrase.html#quickbook.syntax.phrase.refentry_links" title="refentry links">refentry links</a>
</p>
</td>
</tr>
@@ -347,12 +347,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 class="link" href="syntax/phrase.html#quickbook.syntax.phrase.code_links" title="Code Links">function, class, member,
enum, macro, concept or header links</a>
</p>
</td>
@@ -365,12 +365,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 class="link" href="syntax/phrase.html#quickbook.syntax.phrase.code_links" title="Code Links">function, class, member,
enum, macro, concept or header links</a>
</p>
</td>
@@ -383,12 +383,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 class="link" href="syntax/phrase.html#quickbook.syntax.phrase.code_links" title="Code Links">function, class, member,
enum, macro, concept or header links</a>
</p>
</td>
@@ -401,12 +401,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 class="link" href="syntax/phrase.html#quickbook.syntax.phrase.code_links" title="Code Links">function, class, member,
enum, macro, concept or header links</a>
</p>
</td>
@@ -419,12 +419,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 class="link" href="syntax/phrase.html#quickbook.syntax.phrase.code_links" title="Code Links">function, class, member,
enum, macro, concept or header links</a>
</p>
</td>
@@ -437,12 +437,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 class="link" href="syntax/phrase.html#quickbook.syntax.phrase.code_links" title="Code Links">function, class, member,
enum, macro, concept or header links</a>
</p>
</td>
@@ -455,12 +455,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 class="link" href="syntax/phrase.html#quickbook.syntax.phrase.code_links" title="Code Links">function, class, member,
enum, macro, concept or header links</a>
</p>
</td>
@@ -473,12 +473,12 @@
</td>
<td>
<p>
- <tt class="literal">'''escaped text (no processing/formatting)'''</tt>
+ <code class="literal">'''escaped text (no processing/formatting)'''</code>
</p>
</td>
<td>
<p>
- Escape
+ <a class="link" href="syntax/phrase.html#quickbook.syntax.phrase.escape" title="Escape">Escape</a>
</p>
</td>
</tr>
@@ -490,13 +490,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 class="link" href="syntax/phrase.html#quickbook.syntax.phrase.single_char_escape" title="Single char escape">Single char
escape</a>
</p>
</td>
@@ -509,12 +508,12 @@
</td>
<td>
<p>
- <tt class="literal">[$image.jpg]</tt>
+ <code class="literal">[$image.jpg]</code>
</p>
</td>
<td>
<p>
- Images
+ <a class="link" href="syntax/phrase.html#quickbook.syntax.phrase.images" title="Images">Images</a>
</p>
</td>
</tr>
@@ -526,12 +525,12 @@
</td>
<td>
<p>
- <tt class="literal">[section The Section Title]</tt>
+ <code class="literal">[section The Section Title]</code>
</p>
</td>
<td>
<p>
- Section
+ <a class="link" href="syntax/block.html#quickbook.syntax.block.section" title="Section">Section</a>
</p>
</td>
</tr>
@@ -543,12 +542,12 @@
</td>
<td>
<p>
- <tt class="literal">[endsect]</tt>
+ <code class="literal">[endsect]</code>
</p>
</td>
<td>
<p>
- Section
+ <a class="link" href="syntax/block.html#quickbook.syntax.block.section" title="Section">Section</a>
</p>
</td>
</tr>
@@ -566,7 +565,7 @@
</td>
<td>
<p>
- Paragraphs
+ <a class="link" href="syntax/block.html#quickbook.syntax.block.paragraphs" title="Paragraphs">Paragraphs</a>
</p>
</td>
</tr>
@@ -589,8 +588,7 @@
</td>
<td>
<p>
- <a href="syntax/block.html#quickbook.syntax.block.lists.ordered_lists" title="Ordered
- lists">Ordered lists</a>
+ <a class="link" href="syntax/block.html#quickbook.syntax.block.lists.ordered_lists" title="Ordered lists">Ordered lists</a>
</p>
</td>
</tr>
@@ -613,8 +611,7 @@
</td>
<td>
<p>
- <a href="syntax/block.html#quickbook.syntax.block.lists.unordered_lists" title="Unordered
- lists">Unordered
+ <a class="link" href="syntax/block.html#quickbook.syntax.block.lists.unordered_lists" title="Unordered lists">Unordered
lists</a>
</p>
</td>
@@ -632,7 +629,7 @@
</td>
<td>
<p>
- Code
+ <a class="link" href="syntax/block.html#quickbook.syntax.block.code" title="Code">Code</a>
</p>
</td>
</tr>
@@ -644,12 +641,12 @@
</td>
<td>
<p>
- <tt class="literal">[pre preformatted]</tt>
+ <code class="literal">[pre preformatted]</code>
</p>
</td>
<td>
<p>
- Preformatted
+ <a class="link" href="syntax/block.html#quickbook.syntax.block.preformatted" title="Preformatted">Preformatted</a>
</p>
</td>
</tr>
@@ -661,12 +658,12 @@
</td>
<td>
<p>
- <tt class="literal">[:sometext...]</tt>
+ <code class="literal">[:sometext...]</code>
</p>
</td>
<td>
<p>
- Blockquote
+ <a class="link" href="syntax/block.html#quickbook.syntax.block.blockquote" title="Blockquote">Blockquote</a>
</p>
</td>
</tr>
@@ -678,12 +675,12 @@
</td>
<td>
<p>
- <tt class="literal">[h1 Heading 1]</tt>
+ <code class="literal">[h1 Heading 1]</code>
</p>
</td>
<td>
<p>
- Heading
+ <a class="link" href="syntax/block.html#quickbook.syntax.block.headings" title="Headings">Heading</a>
</p>
</td>
</tr>
@@ -695,12 +692,12 @@
</td>
<td>
<p>
- <tt class="literal">[h2 Heading 2]</tt>
+ <code class="literal">[h2 Heading 2]</code>
</p>
</td>
<td>
<p>
- Heading
+ <a class="link" href="syntax/block.html#quickbook.syntax.block.headings" title="Headings">Heading</a>
</p>
</td>
</tr>
@@ -712,12 +709,12 @@
</td>
<td>
<p>
- <tt class="literal">[h3 Heading 3]</tt>
+ <code class="literal">[h3 Heading 3]</code>
</p>
</td>
<td>
<p>
- Heading
+ <a class="link" href="syntax/block.html#quickbook.syntax.block.headings" title="Headings">Heading</a>
</p>
</td>
</tr>
@@ -729,12 +726,12 @@
</td>
<td>
<p>
- <tt class="literal">[h4 Heading 4]</tt>
+ <code class="literal">[h4 Heading 4]</code>
</p>
</td>
<td>
<p>
- Heading
+ <a class="link" href="syntax/block.html#quickbook.syntax.block.headings" title="Headings">Heading</a>
</p>
</td>
</tr>
@@ -746,12 +743,12 @@
</td>
<td>
<p>
- <tt class="literal">[h5 Heading 5]</tt>
+ <code class="literal">[h5 Heading 5]</code>
</p>
</td>
<td>
<p>
- Heading
+ <a class="link" href="syntax/block.html#quickbook.syntax.block.headings" title="Headings">Heading</a>
</p>
</td>
</tr>
@@ -763,12 +760,12 @@
</td>
<td>
<p>
- <tt class="literal">[h6 Heading 6]</tt>
+ <code class="literal">[h6 Heading 6]</code>
</p>
</td>
<td>
<p>
- Heading
+ <a class="link" href="syntax/block.html#quickbook.syntax.block.headings" title="Headings">Heading</a>
</p>
</td>
</tr>
@@ -780,12 +777,12 @@
</td>
<td>
<p>
- <tt class="literal">[def macro_identifier some text]</tt>
+ <code class="literal">[def macro_identifier some text]</code>
</p>
</td>
<td>
<p>
- Macros
+ <a class="link" href="syntax/block.html#quickbook.syntax.block.macros" title="Macros">Macros</a>
</p>
</td>
</tr>
@@ -797,12 +794,12 @@
</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>
<p>
- Templates
+ <a class="link" href="syntax/block.html#quickbook.syntax.block.templates" title="Templates">Templates</a>
</p>
</td>
</tr>
@@ -814,12 +811,12 @@
</td>
<td>
<p>
- <tt class="literal">[blurb advertisement or note...]</tt>
+ <code class="literal">[blurb advertisement or note...]</code>
</p>
</td>
<td>
<p>
- Blurbs
+ <a class="link" href="syntax/block.html#quickbook.syntax.block.blurbs" title="Blurbs">Blurbs</a>
</p>
</td>
</tr>
@@ -831,12 +828,12 @@
</td>
<td>
<p>
- <tt class="literal">[warning Warning text...]</tt>
+ <code class="literal">[warning Warning text...]</code>
</p>
</td>
<td>
<p>
- Admonitions
+ <a class="link" href="syntax/block.html#quickbook.syntax.block.admonitions" title="Admonitions">Admonitions</a>
</p>
</td>
</tr>
@@ -860,7 +857,7 @@
</td>
<td>
<p>
- Tables
+ <a class="link" href="syntax/block.html#quickbook.syntax.block.tables" title="Tables">Tables</a>
</p>
</td>
</tr>
@@ -884,7 +881,7 @@
</td>
<td>
<p>
- Variable Lists
+ <a class="link" href="syntax/block.html#quickbook.syntax.block.variable_lists" title="Variable Lists">Variable Lists</a>
</p>
</td>
</tr>
@@ -896,12 +893,12 @@
</td>
<td>
<p>
- <tt class="literal">[include someother.qbk]</tt>
+ <code class="literal">[include someother.qbk]</code>
</p>
</td>
<td>
<p>
- Include
+ <a class="link" href="syntax/block.html#quickbook.syntax.block.include" title="Include">Include</a>
</p>
</td>
</tr>
@@ -913,18 +910,19 @@
</td>
<td>
<p>
- <tt class="literal">[? symbol phrase]</tt>
+ <code class="literal">[? symbol phrase]</code>
</p>
</td>
<td>
<p>
- Conditional Generation
+ <a class="link" href="syntax/phrase.html#quickbook.syntax.phrase.cond" title="Conditional Generation">Conditional Generation</a>
</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: trunk/tools/quickbook/doc/html/quickbook/syntax.html
==============================================================================
--- trunk/tools/quickbook/doc/html/quickbook/syntax.html (original)
+++ trunk/tools/quickbook/doc/html/quickbook/syntax.html 2007-10-25 21:02:48 EDT (Thu, 25 Oct 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="../boostbook.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.66.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.73.1">
<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">
@@ -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><a class="link" href="syntax.html" title="Syntax Summary"> Syntax Summary</a>
+</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: trunk/tools/quickbook/doc/html/quickbook/syntax/block.html
==============================================================================
--- trunk/tools/quickbook/doc/html/quickbook/syntax/block.html (original)
+++ trunk/tools/quickbook/doc/html/quickbook/syntax/block.html 2007-10-25 21:02:48 EDT (Thu, 25 Oct 2007)
@@ -1,13 +1,13 @@
<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="../../boostbook.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.66.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.73.1">
<link rel="start" href="../../index.html" title="Quickbook 1.4">
-<link rel="up" href="../syntax.html" title=" Syntax Summary">
-<link rel="prev" href="phrase.html" title=" Phrase Level Elements">
-<link rel="next" href="../install.html" title=" Installation and configuration">
+<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>
@@ -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><a class="link" href="block.html" title="Block Level Elements"> Block Level Elements</a>
+</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><a class="link" href="block.html#quickbook.syntax.block.document" title="Document">Document</a>
+</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
- Source Mode.
- If the <tt class="literal">source-mode</tt> field is omitted, a default value
- of <tt class="literal">c++</tt> will be used.
+ <code class="literal">source-type</code> is a lowercase string setting the initial
+ <a class="link" href="phrase.html#quickbook.syntax.phrase.source_mode" title="Source Mode">Source Mode</a>.
+ 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><a class="link" href="block.html#quickbook.syntax.block.section" title="Section">Section</a>
+</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><a class="link" href="block.html#quickbook.syntax.block.xinclude" title="xinclude">xinclude</a>
+</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><a class="link" href="block.html#quickbook.syntax.block.paragraphs" title="Paragraphs">Paragraphs</a>
+</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><a class="link" href="block.html#quickbook.syntax.block.lists" title="Lists">Lists</a>
+</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 class="link" 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 class="link" 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 class="link" 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 class="link" 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><a class="link" href="block.html#quickbook.syntax.block.lists.mixed_lists" title="Mixed lists">Mixed lists</a>
+</h5></div></div></div>
<p>
Mixed lists (ordered and unordered) are supported. Example:
</p>
@@ -446,10 +453,11 @@
</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><a class="link" href="block.html#quickbook.syntax.block.code" title="Code">Code</a>
+</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
+ highlighted according to the current <a class="link" href="phrase.html#quickbook.syntax.phrase.source_mode" title="Source Mode">Source
Mode</a>:
</p>
<p>
@@ -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 class="link" 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><a class="link" href="block.html#quickbook.syntax.block.preformatted" title="Preformatted">Preformatted</a>
+</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><a class="link" href="block.html#quickbook.syntax.block.blockquote" title="Blockquote">Blockquote</a>
+</h4></div></div></div>
<pre class="programlisting">[:sometext...]
</pre>
<div class="blockquote"><blockquote class="blockquote">
@@ -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><a class="link" href="block.html#quickbook.syntax.block.admonitions" title="Admonitions">Admonitions</a>
+</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><a class="link" href="block.html#quickbook.syntax.block.headings" title="Headings">Headings</a>
+</h4></div></div></div>
<pre class="programlisting">[h1 Heading 1]
[h2 Heading 2]
[h3 Heading 3]
@@ -643,50 +655,51 @@
[h5 Heading 5]
[h6 Heading 6]
</pre>
-<a name="quickbook.syntax.block.headings.heading_1"></a><h1>
-<a name="id459550"></a>
- Heading 1
- </h1>
-<a name="quickbook.syntax.block.headings.heading_2"></a><h2>
-<a name="id459574"></a>
- Heading 2
+<a name="quickbook.syntax.block.headings.heading_1"></a><h2>
+<a name="id539768"></a>
+ <a class="link" href="block.html#quickbook.syntax.block.headings.heading_1">Heading 1</a>
</h2>
-<a name="quickbook.syntax.block.headings.heading_3"></a><h3>
-<a name="id459598"></a>
- Heading 3
+<a name="quickbook.syntax.block.headings.heading_2"></a><h3>
+<a name="id539788"></a>
+ <a class="link" href="block.html#quickbook.syntax.block.headings.heading_2">Heading 2</a>
</h3>
-<a name="quickbook.syntax.block.headings.heading_4"></a><h4>
-<a name="id459623"></a>
- Heading 4
+<a name="quickbook.syntax.block.headings.heading_3"></a><h4>
+<a name="id539807"></a>
+ <a class="link" href="block.html#quickbook.syntax.block.headings.heading_3">Heading 3</a>
</h4>
-<a name="quickbook.syntax.block.headings.heading_5"></a><h5>
-<a name="id459648"></a>
- Heading 5
+<a name="quickbook.syntax.block.headings.heading_4"></a><h5>
+<a name="id539827"></a>
+ <a class="link" href="block.html#quickbook.syntax.block.headings.heading_4">Heading 4</a>
</h5>
+<a name="quickbook.syntax.block.headings.heading_5"></a><h6>
+<a name="id539847"></a>
+ <a class="link" href="block.html#quickbook.syntax.block.headings.heading_5">Heading 5</a>
+ </h6>
<a name="quickbook.syntax.block.headings.heading_6"></a><h5>
-<a name="id459673"></a>
- Heading 6
+<a name="id539867"></a>
+ <a class="link" 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]
</pre>
<p>
- to link to them. See <a href="phrase.html#quickbook.syntax.phrase.anchor_links" title="Anchor links">Anchor
- links</a> and Section
+ to link to them. See <a class="link" href="phrase.html#quickbook.syntax.phrase.anchor_links" title="Anchor links">Anchor
+ links</a> and <a class="link" href="block.html#quickbook.syntax.block.section" title="Section">Section</a>
for more info.
</p>
</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><a class="link" href="block.html#quickbook.syntax.block.generic_heading" title="Generic Heading">Generic Heading</a>
+</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><a class="link" href="block.html#quickbook.syntax.block.macros" title="Macros">Macros</a>
+</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:
@@ -778,8 +792,8 @@
[def __spirit__ [@http://spirit.sourceforge.net Spirit]]
</pre>
<p>
- (See Images and
- Links)
+ (See <a class="link" href="phrase.html#quickbook.syntax.phrase.images" title="Images">Images</a> and
+ <a class="link" href="phrase.html#quickbook.syntax.phrase.links" title="Links">Links</a>)
</p>
<p>
Invoking these macros:
@@ -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 class="link" 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="id460123"></a><p class="title"><b>Table 3. Predefined Macros</b></p>
-<table class="table" summary="Predefined Macros">
+<a name="id540270"></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-Sep-24
+ 2007-Oct-25
</p>
</td>
</tr>
@@ -857,7 +871,7 @@
</td>
<td>
<p>
- 02:00:48 PM
+ 07:54:37 PM
</p>
</td>
</tr>
@@ -874,17 +888,19 @@
</td>
<td>
<p>
- C:\dev\boost\tools\quickbook\doc\quickbook.qbk
+ C:\DevRoots\Boost\boost\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><a class="link" href="block.html#quickbook.syntax.block.templates" title="Templates">Templates</a>
+</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="id460303"></a>
- <a href="block.html#quickbook.syntax.block.templates.template_identifier">Template
+<a name="quickbook.syntax.block.templates.template_identifier"></a><h6>
+<a name="id540434"></a>
+ <a class="link" 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="id460350"></a>
- <a href="block.html#quickbook.syntax.block.templates.formal_template_arguments">Formal
+<a name="quickbook.syntax.block.templates.formal_template_arguments"></a><h6>
+<a name="id540476"></a>
+ <a class="link" 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
@@ -932,19 +948,19 @@
</p>
<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
+ at the point where the <a class="link" href="block.html#quickbook.syntax.block.templates.template_expansion">template
+ 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="id460469"></a>
- <a href="block.html#quickbook.syntax.block.templates.template_body">Template
+<a name="quickbook.syntax.block.templates.template_body"></a><h6>
+<a name="id540580"></a>
+ <a class="link" 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="id460528"></a>
- <a href="block.html#quickbook.syntax.block.templates.template_expansion">Template
+<a name="quickbook.syntax.block.templates.template_expansion"></a><h6>
+<a name="id540629"></a>
+ <a class="link" 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
+ <a class="link" href="phrase.html" title="Phrase Level Elements">QuickBook phrase</a>. 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="id460634"></a>
- <a href="block.html#quickbook.syntax.block.templates.nullary_templates">Nullary
+<a name="quickbook.syntax.block.templates.nullary_templates"></a><h6>
+<a name="id540727"></a>
+ <a class="link" 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,14 +1051,14 @@
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
</p>
<div class="itemizedlist"><ul type="disc">
<li>
- The explicit <a href="block.html#quickbook.syntax.block.templates.template_expansion">template
+ The explicit <a class="link" href="block.html#quickbook.syntax.block.templates.template_expansion">template
expansion syntax</a>. This is an advantage because, now, we don't
have to use obscure naming conventions like double underscores (e.g.
__alpha__) to avoid unwanted macro replacement.
@@ -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="id385004"></a>
- <a href="block.html#quickbook.syntax.block.templates.simple_arguments">Simple
+<a name="quickbook.syntax.block.templates.simple_arguments"></a><h6>
+<a name="id540933"></a>
+ <a class="link" 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,17 +1183,17 @@
<p>
what do you think man?
</p>
-<a name="quickbook.syntax.block.templates.punctuation_templates"></a><h5>
-<a name="id461175"></a>
- <a href="block.html#quickbook.syntax.block.templates.punctuation_templates">Punctuation
+<a name="quickbook.syntax.block.templates.punctuation_templates"></a><h6>
+<a name="id541091"></a>
+ <a class="link" 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
single character punctuation templates which are fairly common in QuickBook.
You might have noticed that single character punctuations are allowed as
- <a href="block.html#quickbook.syntax.block.templates.template_identifier">template
+ <a class="link" href="block.html#quickbook.syntax.block.templates.template_identifier">template
identifiers</a>. Example:
</p>
<pre class="programlisting">[template ![bar] <hey>[bar]</hey>]
@@ -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><a class="link" href="block.html#quickbook.syntax.block.blurbs" title="Blurbs">Blurbs</a>
+</h4></div></div></div>
<pre class="programlisting">[blurb :-) [*An eye catching advertisement or note...]
__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,15 +1242,16 @@
<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>
- Prefer admonitions
+<tr><td align="left" valign="top"><p>
+ Prefer <a class="link" href="block.html#quickbook.syntax.block.admonitions" title="Admonitions">admonitions</a>
wherever appropriate.
</p></td></tr>
</table></div>
</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><a class="link" href="block.html#quickbook.syntax.block.tables" title="Tables">Tables</a>
+</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="id461378"></a><p class="title"><b>Table 4. A Simple Table</b></p>
-<table class="table" summary="A Simple Table">
+<a name="id541260"></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="id461542"></a><p class="title"><b>Table 5. Table with fat cells</b></p>
-<table class="table" summary="Table with fat cells">
+<a name="id541422"></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="id461660"></a><p class="title"><b>Table 6. Table with code</b></p>
-<table class="table" summary="Table with code">
+<a name="id541538"></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><a class="link" href="block.html#quickbook.syntax.block.variable_lists" title="Variable Lists">Variable Lists</a>
+</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><a class="link" href="block.html#quickbook.syntax.block.include" title="Include">Include</a>
+</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><a class="link" href="block.html#quickbook.syntax.block.import" title="Import">Import</a>
+</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="id462084"></a>
- Example
- </h5>
+<a name="quickbook.syntax.block.import.example"></a><h6>
+<a name="id541915"></a>
+ <a class="link" href="block.html#quickbook.syntax.block.import.example">Example</a>
+ </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,14 +1666,7 @@
<p>
</p>
<p>
- </p>
-<div class="calloutlist"><table border="0" summary="Callout list"></table></div>
-<p>
- </p>
-<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>
@@ -1669,17 +1685,15 @@
<p>
</p>
<p>
- Some trailing text here </p>
-<div class="calloutlist"><table border="0" summary="Callout list"></table></div>
-<p>
+ Some trailing text here
</p>
<p>
</p>
-<a name="quickbook.syntax.block.import.code_snippet_markup"></a><h5>
-<a name="id462396"></a>
- <a href="block.html#quickbook.syntax.block.import.code_snippet_markup">Code
+<a name="quickbook.syntax.block.import.code_snippet_markup"></a><h6>
+<a name="id542190"></a>
+ <a class="link" 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:
@@ -1691,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="id462522"></a>
- <a href="block.html#quickbook.syntax.block.import.special_comments">Special
+<a name="quickbook.syntax.block.import.special_comments"></a><h6>
+<a name="id542298"></a>
+ <a class="link" href="block.html#quickbook.syntax.block.import.special_comments">Special
Comments</a>
- </h5>
+ </h6>
<p>
Special comments of the form:
</p>
@@ -1744,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="id462702"></a>
- Callouts
- </h5>
+<a name="quickbook.syntax.block.import.callouts"></a><h6>
+<a name="id542459"></a>
+ <a class="link" href="block.html#quickbook.syntax.block.import.callouts">Callouts</a>
+ </h6>
<p>
Special comments of the form:
</p>
@@ -1766,9 +1780,9 @@
</p>
<pre class="programlisting">
-<span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="identifier">foo_bar</span><span class="special">()</span> <span class="callout_bug"><a name="quickbook0co" href="block.html#quickbook0"><img src="../../images/callouts/1.png" alt="1" border="0"></a></span>
+<span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="identifier">foo_bar</span><span class="special">()</span> <span class="callout_bug"><a class="co" name="quickbook0co" href="block.html#quickbook0"><img src="../../images/callouts/1.png" alt="1" border="0"></a></span>
<span class="special">{</span>
- <span class="keyword">return</span> <span class="string">"foo-bar"</span><span class="special">;</span> <span class="callout_bug"><a name="quickbook1co" href="block.html#quickbook1"><img src="../../images/callouts/2.png" alt="2" border="0"></a></span>
+ <span class="keyword">return</span> <span class="string">"foo-bar"</span><span class="special">;</span> <span class="callout_bug"><a class="co" name="quickbook1co" href="block.html#quickbook1"><img src="../../images/callouts/2.png" alt="2" border="0"></a></span>
<span class="special">}</span>
</pre>
<p>
@@ -1779,14 +1793,12 @@
</p>
<div class="calloutlist"><table border="0" summary="Callout list">
<tr>
-<td width="5%" valign="top" align="left">
-<a name="quickbook0"></a>
</td>
+<td width="5%" valign="top" align="left"><p><a name="quickbook0"></a> </p></td>
<td valign="top" align="left"><p> The <span class="emphasis"><em>Mythical</em></span> FooBar. See <a href="http://en.wikipedia.org/wiki/Foobar" target="_top">Foobar
for details</a> </p></td>
</tr>
<tr>
-<td width="5%" valign="top" align="left">
-<a name="quickbook1"></a>
</td>
+<td width="5%" valign="top" align="left"><p><a name="quickbook1"></a> </p></td>
<td valign="top" align="left"><p> return 'em, foo-bar man! </p></td>
</tr>
</table></div>
@@ -1830,20 +1842,20 @@
<span class="special">{</span>
<span class="keyword">public</span><span class="special">:</span>
- <span class="line_callout_bug"><a name="quickbook2co" href="block.html#quickbook2"><img src="../../images/callouts/1.png" alt="1" border="0"></a></span><span class="identifier">x</span><span class="special">()</span> <span class="special">:</span> <span class="identifier">n</span><span class="special">(</span><span class="number">0</span><span class="special">)</span>
+ <span class="line_callout_bug"><a class="co" name="quickbook2co" href="block.html#quickbook2"><img src="../../images/callouts/1.png" alt="1" border="0"></a></span><span class="identifier">x</span><span class="special">()</span> <span class="special">:</span> <span class="identifier">n</span><span class="special">(</span><span class="number">0</span><span class="special">)</span>
<span class="special">{</span>
<span class="special">}</span>
- <span class="line_callout_bug"><a name="quickbook3co" href="block.html#quickbook3"><img src="../../images/callouts/2.png" alt="2" border="0"></a></span><span class="special">~</span><span class="identifier">x</span><span class="special">()</span>
+ <span class="line_callout_bug"><a class="co" name="quickbook3co" href="block.html#quickbook3"><img src="../../images/callouts/2.png" alt="2" border="0"></a></span><span class="special">~</span><span class="identifier">x</span><span class="special">()</span>
<span class="special">{</span>
<span class="special">}</span>
- <span class="line_callout_bug"><a name="quickbook4co" href="block.html#quickbook4"><img src="../../images/callouts/3.png" alt="3" border="0"></a></span><span class="keyword">int</span> <span class="identifier">get</span><span class="special">()</span> <span class="keyword">const</span>
+ <span class="line_callout_bug"><a class="co" name="quickbook4co" href="block.html#quickbook4"><img src="../../images/callouts/3.png" alt="3" border="0"></a></span><span class="keyword">int</span> <span class="identifier">get</span><span class="special">()</span> <span class="keyword">const</span>
<span class="special">{</span>
<span class="keyword">return</span> <span class="identifier">n</span><span class="special">;</span>
<span class="special">}</span>
- <span class="line_callout_bug"><a name="quickbook5co" href="block.html#quickbook5"><img src="../../images/callouts/4.png" alt="4" border="0"></a></span><span class="keyword">void</span> <span class="identifier">set</span><span class="special">(</span><span class="keyword">int</span> <span class="identifier">n_</span><span class="special">)</span>
+ <span class="line_callout_bug"><a class="co" name="quickbook5co" href="block.html#quickbook5"><img src="../../images/callouts/4.png" alt="4" border="0"></a></span><span class="keyword">void</span> <span class="identifier">set</span><span class="special">(</span><span class="keyword">int</span> <span class="identifier">n_</span><span class="special">)</span>
<span class="special">{</span>
<span class="identifier">n</span> <span class="special">=</span> <span class="identifier">n_</span><span class="special">;</span>
<span class="special">}</span>
@@ -1857,25 +1869,21 @@
</p>
<div class="calloutlist"><table border="0" summary="Callout list">
<tr>
-<td width="5%" valign="top" align="left">
-<a name="quickbook2"></a> </td>
+<td width="5%" valign="top" align="left"><p><a name="quickbook2"></a> </p></td>
<td valign="top" align="left"><p> Constructor </p></td>
</tr>
<tr>
-<td width="5%" valign="top" align="left">
-<a name="quickbook3"></a> </td>
+<td width="5%" valign="top" align="left"><p><a name="quickbook3"></a> </p></td>
<td valign="top" align="left"><p> Destructor </p></td>
</tr>
<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 width="5%" valign="top" align="left"><p><a name="quickbook4"></a> </p></td>
+<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 width="5%" valign="top" align="left"><p><a name="quickbook5"></a> </p></td>
+<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: trunk/tools/quickbook/doc/html/quickbook/syntax/comments.html
==============================================================================
--- trunk/tools/quickbook/doc/html/quickbook/syntax/comments.html (original)
+++ trunk/tools/quickbook/doc/html/quickbook/syntax/comments.html 2007-10-25 21:02:48 EDT (Thu, 25 Oct 2007)
@@ -3,11 +3,11 @@
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Comments</title>
<link rel="stylesheet" href="../../boostbook.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.66.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.73.1">
<link rel="start" href="../../index.html" title="Quickbook 1.4">
-<link rel="up" href="../syntax.html" title=" Syntax Summary">
-<link rel="prev" href="../syntax.html" title=" Syntax Summary">
-<link rel="next" href="phrase.html" title=" Phrase Level Elements">
+<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>
@@ -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><a class="link" href="comments.html" title="Comments">Comments</a>
+</h3></div></div></div>
<p>
Can be placed anywhere.
</p>
Modified: trunk/tools/quickbook/doc/html/quickbook/syntax/phrase.html
==============================================================================
--- trunk/tools/quickbook/doc/html/quickbook/syntax/phrase.html (original)
+++ trunk/tools/quickbook/doc/html/quickbook/syntax/phrase.html 2007-10-25 21:02:48 EDT (Thu, 25 Oct 2007)
@@ -1,13 +1,13 @@
<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="../../boostbook.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.66.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.73.1">
<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>
@@ -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><a class="link" href="phrase.html" title="Phrase Level Elements"> Phrase Level Elements</a>
+</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><a class="link" href="phrase.html#quickbook.syntax.phrase.font_styles" title="Font Styles">Font Styles</a>
+</h4></div></div></div>
<pre class="programlisting">['italic], [*bold], [_underline], [^teletype], [-strikethrough]
</pre>
<p>
will generate:
</p>
<p>
- <span class="emphasis"><em>italic</em></span>, <span class="bold"><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><a class="link" href="phrase.html#quickbook.syntax.phrase.replaceable" title="Replaceable">Replaceable</a>
+</h4></div></div></div>
<p>
When you want content that may or must be replaced by the user, use the
syntax:
@@ -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><a class="link" href="phrase.html#quickbook.syntax.phrase.quotations" title="Quotations">Quotations</a>
+</h4></div></div></div>
<pre class="programlisting">["A question that sometimes drives me hazy: am I or are the others crazy?]--Einstein
</pre>
<p>
@@ -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><a class="link" href="phrase.html#quickbook.syntax.phrase.simple_formatting" title="Simple formatting">Simple formatting</a>
+</h4></div></div></div>
<p>
Simple markup for formatting text, common in many applications, is now
supported:
@@ -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="id455892" href="#ftn.id455892">1</a>]</sup>
+ <sup>[<a name="id465946" href="#ftn.id465946" class="footnote">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 class="link" href="block.html#quickbook.syntax.block.lists.unordered_lists" title="Unordered lists">Unordered
lists</a>.
</li>
</ul></div>
<div class="table">
-<a name="id455974"></a><p class="title"><b>Table 1. More Formatting Samples</b></p>
-<table class="table" summary="More Formatting Samples">
+<a name="id466022"></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><a class="link" href="phrase.html#quickbook.syntax.phrase.inline_code" title="Inline code">Inline code</a>
+</h4></div></div></div>
<p>
Inlining code in paragraphs is quite common when writing C++ documentation.
We provide a very simple markup for this. For example, this:
@@ -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,24 +417,23 @@
<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><a class="link" href="phrase.html#quickbook.syntax.phrase.code_blocks" title="Code blocks">Code blocks</a>
+</h4></div></div></div>
<p>
- Preformatted code simply starts with a space or a tab (See Code).
+ Preformatted code simply starts with a space or a tab (See <a class="link" href="block.html#quickbook.syntax.block.code" title="Code">Code</a>).
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
- lists</a>), tables (See Tables),
+ (See <a class="link" href="block.html#quickbook.syntax.block.lists.ordered_lists" title="Ordered lists">Ordered
+ lists</a> and <a class="link" href="block.html#quickbook.syntax.block.lists.unordered_lists" title="Unordered lists">Unordered
+ lists</a>), tables (See <a class="link" href="block.html#quickbook.syntax.block.tables" title="Tables">Tables</a>),
etc. Inline code (see above) can. The problem is, inline code does not
allow formatting with newlines, spaces, and tabs. These are lost.
</p>
@@ -468,17 +472,18 @@
</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><a class="link" href="phrase.html#quickbook.syntax.phrase.source_mode" title="Source Mode">Source Mode</a>
+</h4></div></div></div>
<p>
If a document contains more than one type of source code then the source
mode may be changed dynamically as the document is processed. All QuickBook
documents are initially in C++ mode by default, though an alternative initial
- value may be set in the Document
+ value may be set in the <a class="link" href="block.html#quickbook.syntax.block.document" title="Document">Document</a>
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="id456956"></a><p class="title"><b>Table 2. Supported Source Modes</b></p>
-<table class="table" summary="Supported Source Modes">
+<a name="id537489"></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><a class="link" href="phrase.html#quickbook.syntax.phrase.line_break" title="line-break">line-break</a>
+</h4></div></div></div>
<pre class="programlisting">[br]
</pre>
<div class="warning"><table border="0" summary="Warning">
@@ -561,37 +567,39 @@
<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,
- Admonitions
- and table cells (see Tables)
+<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. <a class="link" href="block.html#quickbook.syntax.block.blurbs" title="Blurbs">Blurbs</a>,
+ <a class="link" href="block.html#quickbook.syntax.block.admonitions" title="Admonitions">Admonitions</a>
+ and table cells (see <a class="link" href="block.html#quickbook.syntax.block.tables" title="Tables">Tables</a>)
may now contain paragraphs.
</p></td></tr>
</table></div>
</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><a class="link" href="phrase.html#quickbook.syntax.phrase.anchors" title="Anchors">Anchors</a>
+</h4></div></div></div>
<pre class="programlisting">[#named_anchor]
</pre>
<p>
A named anchor is a hook that can be referenced by a link elsewhere in
- the document. You can then reference an anchor with <tt class="literal">[link named_anchor
-Some link text]</tt>.
- See Anchor links,
- Section and Heading.
+ the document. You can then reference an anchor with <code class="literal">[link named_anchor
+Some link text]</code>.
+ See <a class="link" href="phrase.html#quickbook.syntax.phrase.anchor_links" title="Anchor links">Anchor links</a>,
+ <a class="link" href="block.html#quickbook.syntax.block.section" title="Section">Section</a> and <a class="link" 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><a class="link" href="phrase.html#quickbook.syntax.phrase.links" title="Links">Links</a>
+</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,29 +621,31 @@
</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><a class="link" href="phrase.html#quickbook.syntax.phrase.anchor_links" title="Anchor links">Anchor links</a>
+</h4></div></div></div>
<p>
You can link within a document using:
</p>
<pre class="programlisting">[link section_id.normalized_header_text The link text]
</pre>
<p>
- See sections Section
- and Heading for
+ See sections <a class="link" href="block.html#quickbook.syntax.block.section" title="Section">Section</a>
+ and <a class="link" href="block.html#quickbook.syntax.block.headings" title="Headings">Heading</a> for
more info.
</p>
</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><a class="link" href="phrase.html#quickbook.syntax.phrase.refentry_links" title="refentry links">refentry links</a>
+</h4></div></div></div>
<p>
In addition, you can link internally to an XML refentry like:
</p>
<pre class="programlisting">[link xml.refentry The link text]
</pre>
<p>
- This gets converted into <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><a class="link" href="phrase.html#quickbook.syntax.phrase.code_links" title="Code Links"> Code Links</a>
+</h4></div></div></div>
<p>
If you want to link to a function, class, member, enum, concept or header
in the reference section, you can use:
@@ -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><a class="link" href="phrase.html#quickbook.syntax.phrase.escape" title="Escape">Escape</a>
+</h4></div></div></div>
<p>
The escape mark-up is used when we don't want to do any processing.
</p>
@@ -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 class="link" 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,
- Admonitions
- and table cells (see Tables)
+<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. <a class="link" href="block.html#quickbook.syntax.block.blurbs" title="Blurbs">Blurbs</a>,
+ <a class="link" href="block.html#quickbook.syntax.block.admonitions" title="Admonitions">Admonitions</a>
+ and table cells (see <a class="link" href="block.html#quickbook.syntax.block.tables" title="Tables">Tables</a>)
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><a class="link" href="phrase.html#quickbook.syntax.phrase.images" title="Images">Images</a>
+</h4></div></div></div>
<pre class="programlisting">[$image.jpg]
</pre>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h4 class="title">
-<a name="quickbook.syntax.phrase.footnotes"></a>Footnotes</h4></div></div></div>
+<a name="quickbook.syntax.phrase.footnotes"></a><a class="link" href="phrase.html#quickbook.syntax.phrase.footnotes" title="Footnotes">Footnotes</a>
+</h4></div></div></div>
<div class="toc"><dl>
<dt><span class="section"><a href="phrase.html#quickbook.syntax.phrase.footnotes.macro_expansion">Macro
Expansion</a></span></dt>
@@ -754,45 +768,46 @@
</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="id457797" href="#ftn.id457797">2</a>]</sup>
+ <sup>[<a name="id538234" href="#ftn.id538234" class="footnote">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 class="link" 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>
- See Macros for details.
+ See <a class="link" href="block.html#quickbook.syntax.block.macros" title="Macros">Macros</a> for details.
</p>
</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 class="link" 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>
- See Templates
+ See <a class="link" href="block.html#quickbook.syntax.block.templates" title="Templates">Templates</a>
for details.
</p>
</div>
</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><a class="link" href="phrase.html#quickbook.syntax.phrase.cond" title="Conditional Generation"> Conditional Generation</a>
+</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="id457969" href="#ftn.id457969">3</a>]</sup>
+ <sup>[<a name="id538375" href="#ftn.id538375" class="footnote">3</a>]</sup>
</p>
</div>
<div class="footnotes">
<br><hr width="100" align="left">
-<div class="footnote"><p><sup>[<a name="ftn.id455892" href="#id455892">1</a>] </sup>
+<div class="footnote"><p><sup>[<a name="ftn.id465946" href="#id465946" class="para">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.id457797" href="#id457797">2</a>] </sup>
+<div class="footnote"><p><sup>[<a name="ftn.id538234" href="#id538234" class="para">2</a>] </sup>
A sample footnote
</p></div>
-<div class="footnote"><p><sup>[<a name="ftn.id457969" href="#id457969">3</a>] </sup>
+<div class="footnote"><p><sup>[<a name="ftn.id538375" href="#id538375" class="para">3</a>] </sup>
Conditional Generation makes quickbook turing complete.
</p></div>
</div>
Modified: trunk/tools/quickbook/doc/quickbook.qbk
==============================================================================
--- trunk/tools/quickbook/doc/quickbook.qbk (original)
+++ trunk/tools/quickbook/doc/quickbook.qbk 2007-10-25 21:02:48 EDT (Thu, 25 Oct 2007)
@@ -162,6 +162,8 @@
contain paragraphs.
* `\n` and `[br]` are now deprecated.
* __cond__. Ala C++ #ifdef.
+* Searching of included and imported files in an extensible search path with
+ `--include-path` (`-I`) option.
[endsect]
Deleted: trunk/tools/quickbook/doc/quickbook.xml
==============================================================================
--- trunk/tools/quickbook/doc/quickbook.xml 2007-10-25 21:02:48 EDT (Thu, 25 Oct 2007)
+++ (empty file)
@@ -1,3714 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE library PUBLIC "-//Boost//DTD BoostBook XML V1.0//EN" "http://www.boost.org/tools/boostbook/dtd/boostbook.dtd">
-<article id="quickbook" name="Quickbook" dirname="quickbook" last-revision="$Date$"
- xmlns:xi="http://www.w3.org/2001/XInclude">
- <articleinfo>
- <author>
- <firstname>Joel</firstname> <surname>de Guzman</surname>
- </author>
- <author>
- <firstname>Eric</firstname> <surname>Niebler</surname>
- </author>
- <copyright>
- <year>2002</year> <year>2004</year> <year>2006</year> <holder>Joel de Guzman,
- Eric Niebler</holder>
- </copyright>
- <legalnotice>
- <para>
- Distributed under the Boost Software License, Version 1.0. (See accompanying
- file LICENSE_1_0.txt or copy at <ulink url="http://www.boost.org/LICENSE_1_0.txt">http://www.boost.org/LICENSE_1_0.txt>)
- </para>
- </legalnotice>
- <articlepurpose>
- <emphasis>WikiWiki</emphasis> style documentation tool
- </articlepurpose>
- </articleinfo>
- <title>Quickbook 1.4</title>
- <section id="quickbook.intro">
- <title><link linkend="quickbook.intro"> Introduction</link></title>
- <blockquote>
- <para>
- <para>
- <emphasis role="bold"><emphasis><quote>Why program by hand in five days
- what you can spend five years of your life automating?</quote></emphasis></emphasis>
- </para>
- <para>
- -- Terrence Parr, author ANTLR/PCCTS
- </para>
- </para>
- </blockquote>
- <para>
- Well, QuickBook started as a weekend hack. It was originally intended to be
- a sample application using <ulink url="http://spirit.sourceforge.net">Spirit</ulink>.
- What is it? What you are viewing now, this documentation, is autogenerated
- by QuickBook. These files were generated from one master:
- </para>
- <blockquote>
- <para>
- <para>
- <ulink url="../quickbook.qbk">quickbook.qbk</ulink>
- </para>
- </para>
- </blockquote>
- <para>
- Originally named QuickDoc, this funky tool that never dies evolved into a funkier
- tool thanks to Eric Niebler who resurrected the project making it generate
- <ulink url="http://www.boost.org/doc/html/boostbook.html">BoostBook</ulink>
- instead of HTML. The <ulink url="http://www.boost.org/doc/html/boostbook.html">BoostBook</ulink>
- documentation format is an extension of <ulink url="http://www.docbook.org/">DocBook</ulink>,
- an SGML or XML based format for describing documentation.
- </para>
- <para>
- QuickBook is a WikiWiki style documentation tool geared towards C++ documentation
- using simple rules and markup for simple formatting tasks. QuickBook extends
- the WikiWiki concept. Like the WikiWiki, QuickBook documents are simple text
- files. A single QuickBook document can generate a fully linked set of nice
- HTML and PostScript/PDF documents complete with images and syntax- colorized
- source code.
- </para>
- <para>
- Features include:
- </para>
- <itemizedlist>
- <listitem>
- generate <ulink url="http://www.boost.org/doc/html/boostbook.html">BoostBook</ulink>
- xml, to generate HTML, PostScript and PDF
- </listitem>
- <listitem>
- simple markup to link to Doxygen-generated entities
- </listitem>
- <listitem>
- macro system for simple text substitution
- </listitem>
- <listitem>
- simple markup for italics, bold, preformatted, blurbs, code samples, tables,
- URLs, anchors, images, etc.
- </listitem>
- <listitem>
- automatic syntax coloring of code samples
- </listitem>
- <listitem>
- CSS support
- </listitem>
- </itemizedlist>
- </section>
- <section id="quickbook.change_log">
- <title><link linkend="quickbook.change_log"> Change Log</link></title> <anchor
- id="quickbook.change_log.version_1_3"/>
- <bridgehead renderas="sect3">
- <link linkend="quickbook.change_log.version_1_3">Version 1.3</link>
- </bridgehead>
- <itemizedlist>
- <listitem>
- Quickbook file inclusion [include].
- </listitem>
- <listitem>
- Better xml output (pretty layout). Check out the generated XML.
- </listitem>
- <listitem>
- Regression testing facility: to make sure your document will always be compatible
- (full backward compatibility) regardless of changes to QuickBook.
- </listitem>
- <listitem>
- Code cleanup and refactoring.
- </listitem>
- <listitem>
- Allow phrase markup in the doc-info.
- </listitem>
- <listitem>
- Preformatted code blocks via ``code`` (double ticks) allows code in tables
- and lists, for example.
- </listitem>
- <listitem>
- Quickbook versioning; allows full backward compatibility. You have to add
- [quickbook 1.3] to the doc-info header to enable the new features. Without
- this, QuickBook will assume that the document is a pre-1.3 document.
- </listitem>
- <listitem>
- Better (intuitive) paragraph termination. Some markups may terminate a paragraph.
- Example:
-<programlisting>
-<phrase role="special">[</phrase><phrase role="identifier">section</phrase> <phrase role="identifier">x</phrase><phrase role="special">]</phrase>
-<phrase role="identifier">blah</phrase><phrase role="special">...</phrase>
-<phrase role="special">[</phrase><phrase role="identifier">endsect</phrase><phrase role="special">]</phrase></programlisting>
- </listitem>
- <listitem>
- Fully qualified section and headers. Subsection names are concatenated to
- the ID to avoid clashing. Example: <code><phrase role="identifier">doc_name</phrase><phrase
- role="special">.</phrase><phrase role="identifier">sect_name</phrase><phrase
- role="special">.</phrase><phrase role="identifier">sub_sect_name</phrase><phrase
- role="special">.</phrase><phrase role="identifier">sub_sub_sect_name</phrase></code>
- </listitem>
- <listitem>
- Better &nbsp; and whitespace handling in code snippets.
- </listitem>
- <listitem>
- [xinclude] fixes up the relative path to the target XML file when input_directory
- is not the same as the output_directory.
- </listitem>
- <listitem>
- Allow untitled tables.
- </listitem>
- <listitem>
- Allow phrase markups in section titles.
- </listitem>
- <listitem>
- Allow escaping back to QuickBook from code, code blocks and inline code.
- </listitem>
- <listitem>
- Footnotes, with the [footnote This is the footnote] syntax.
- </listitem>
- <listitem>
- Post-processor bug fix for escaped XML code that it does not recognize.
- </listitem>
- <listitem>
- Replaceable, with the [~replacement] syntax.
- </listitem>
- <listitem>
- Generic Headers
- </listitem>
- <listitem>
- Code changes to allow full recursion (i.e. Collectors and push/pop functions)
- </listitem>
- <listitem>
- Various code cleanup/maintenance
- </listitem>
- <listitem>
- Templates!
- </listitem>
- <listitem>
- [conceptref] for referencing BoostBook <concept> entities.
- </listitem>
- <listitem>
- Allow escape of spaces. The escaped space is removed from the output. Syntax:
- <code><phrase role="special">\</phrase> </code>.
- </listitem>
- <listitem>
- Nested comments are now allowed.
- </listitem>
- <listitem>
- Quickbook blocks can nest inside comments.
- </listitem>
- <listitem>
- <link linkend="quickbook.syntax.block.import">Import</link> facility.
- </listitem>
- <listitem>
- Callouts on imported code
- </listitem>
- <listitem>
- Simple markups can now span a whole block.
- </listitem>
- <listitem>
- <link linkend="quickbook.syntax.block.blurbs">Blurbs</link>, <link linkend="quickbook.syntax.block.admonitions">Admonitions</link>
- and table cells (see <link linkend="quickbook.syntax.block.tables">Tables</link>)
- may now contain paragraphs.
- </listitem>
- <listitem>
- <code><phrase role="special">\</phrase><phrase role="identifier">n</phrase></code>
- and <code><phrase role="special">[</phrase><phrase role="identifier">br</phrase><phrase
- role="special">]</phrase></code> are now deprecated.
- </listitem>
- </itemizedlist>
- </section>
- <section id="quickbook.syntax">
- <title><link linkend="quickbook.syntax"> Syntax Summary</link></title>
- <para>
- A QuickBook document is composed of one or more blocks. An example of a block
- is the paragraph or a C++ code snippet. Some blocks have special mark-ups.
- Blocks, except code snippets which have their own grammar (C++ or Python),
- are composed of one or more phrases. A phrase can be a simple contiguous run
- of characters. Phrases can have special mark-ups. Marked up phrases can recursively
- contain other phrases, but cannot contain blocks. A terminal is a self contained
- block-level or phrase-level element that does not nest anything.
- </para>
- <para>
- Blocks, in general, are delimited by two end-of-lines (the block terminator).
- Phrases in each block cannot contain a block terminator. This way, syntax errors
- such as un-matched closing brackets do not go haywire and corrupt anything
- past a single block.
- </para>
- <section id="quickbook.syntax.comments">
- <title><link linkend="quickbook.syntax.comments">Comments</link></title>
- <para>
- Can be placed anywhere.
- </para>
-
-<programlisting><!--quickbook-escape-prefix-->[/ comment (no output generated) ]<!--quickbook-escape-postfix-->
-</programlisting>
-
-<programlisting><!--quickbook-escape-prefix-->[/ comments can be nested [/ some more here] ]<!--quickbook-escape-postfix-->
-</programlisting>
-
-<programlisting><!--quickbook-escape-prefix-->[/ Quickbook blocks can nest inside comments. [*Comment this out too!] ]<!--quickbook-escape-postfix-->
-</programlisting>
- </section>
- <section id="quickbook.syntax.phrase">
- <title><link linkend="quickbook.syntax.phrase"> Phrase Level Elements</link></title>
- <section id="quickbook.syntax.phrase.font_styles">
- <title><link linkend="quickbook.syntax.phrase.font_styles">Font Styles</link></title>
-
-<programlisting><!--quickbook-escape-prefix-->['italic], [*bold], [_underline], [^teletype], [-strikethrough]
-<!--quickbook-escape-postfix--></programlisting>
- <para>
- will generate:
- </para>
- <para>
- <emphasis>italic</emphasis>, <emphasis role="bold">bold</emphasis>, <emphasis
- role="underline">underline</emphasis>, <literal>teletype</literal>, <emphasis
- role="strikethrough">strikethrough</emphasis>
- </para>
- <para>
- Like all non-terminal phrase level elements, this can of course be nested:
- </para>
-
-<programlisting><!--quickbook-escape-prefix-->[*['bold-italic]]
-<!--quickbook-escape-postfix--></programlisting>
- <para>
- will generate:
- </para>
- <para>
- <emphasis role="bold"><emphasis>bold-italic</emphasis></emphasis>
- </para>
- </section>
- <section id="quickbook.syntax.phrase.replaceable">
- <title><link linkend="quickbook.syntax.phrase.replaceable">Replaceable</link></title>
- <para>
- When you want content that may or must be replaced by the user, use the
- syntax:
- </para>
-
-<programlisting><!--quickbook-escape-prefix-->[~replacement]
-<!--quickbook-escape-postfix--></programlisting>
- <para>
- This will generate:
- </para>
- <para>
- <replaceable>
- replacement
- </replaceable>
- </para>
- </section>
- <section id="quickbook.syntax.phrase.quotations">
- <title><link linkend="quickbook.syntax.phrase.quotations">Quotations</link></title>
-
-<programlisting><!--quickbook-escape-prefix-->["A question that sometimes drives me hazy: am I or are the others crazy?]--Einstein
-<!--quickbook-escape-postfix--></programlisting>
- <para>
- will generate:
- </para>
- <para>
- <quote>A question that sometimes drives me hazy: am I or are the others
- crazy?</quote>--Einstein
- </para>
- <para>
- Note the proper left and right quote marks. Also, while you can simply
- use ordinary quote marks like "quoted", our quotation, above,
- will generate correct DocBook quotations (e.g. <quote>quoted</quote>).
- </para>
- <para>
- Like all phrase elements, quotations may be nested. Example:
- </para>
-
-<programlisting><!--quickbook-escape-prefix-->["Here's the rule for bargains: ["Do other men, for they would do you.] That's
-the true business precept.]
-<!--quickbook-escape-postfix--></programlisting>
- <para>
- will generate:
- </para>
- <para>
- <quote>Here's the rule for bargains: <quote>Do other men, for they would
- do you.</quote> That's the true business precept.</quote>
- </para>
- </section>
- <section id="quickbook.syntax.phrase.simple_formatting">
- <title><link linkend="quickbook.syntax.phrase.simple_formatting">Simple formatting</link></title>
- <para>
- Simple markup for formatting text, common in many applications, is now
- supported:
- </para>
-
-<programlisting><!--quickbook-escape-prefix-->/italic/, *bold*, _underline_, =teletype=
-<!--quickbook-escape-postfix--></programlisting>
- <para>
- will generate:
- </para>
- <para>
- <emphasis>italic</emphasis>, <emphasis role="bold">bold</emphasis>, <emphasis
- role="underline">underline</emphasis>, <literal>teletype</literal>
- </para>
- <para>
- Unlike QuickBook's standard formatting scheme, the rules for simpler alternatives
- are much stricter
- <footnote>
- <para>
- Thanks to David Barrett, author of <ulink url="http://quinthar.com/qwikiwiki/index.php?page=Home">Qwiki</ulink>,
- for sharing these samples and teaching me these obscure formatting
- rules. I wasn't sure at all if <ulink url="http://spirit.sourceforge.net">Spirit</ulink>,
- being more or less a formal EBNF parser, can handle the context sensitivity
- and ambiguity.
- </para>
- </footnote>
- .
- </para>
- <itemizedlist>
- <listitem>
- Simple markups cannot nest. You can combine a simple markup with a nestable
- markup.
- </listitem>
- <listitem>
- Simple markups cannot contain any other form of quickbook markup.
- </listitem>
- <listitem>
- A non-space character must follow the leading markup
- </listitem>
- <listitem>
- A non-space character must precede the trailing markup
- </listitem>
- <listitem>
- A space or a punctuation must follow the trailing markup
- </listitem>
- <listitem>
- If the matching markup cannot be found within a block, the formatting
- will not be applied. This is to ensure that un-matched formatting markups,
- which can be a common mistake, does not corrupt anything past a single
- block. We do not want the rest of the document to be rendered bold just
- because we forgot a trailing '*'. A single block is terminated by two
- end of lines or the close bracket: ']'.
- </listitem>
- <listitem>
- A line starting with the star will be interpreted as an unordered list.
- See <link linkend="quickbook.syntax.block.lists.unordered_lists">Unordered
- lists</link>.
- </listitem>
- </itemizedlist>
- <table frame="all"> <title>More Formatting Samples</title>
- <tgroup cols="2">
- <thead>
- <row>
- <entry>
- <para>
- Markup
- </para>
- </entry><entry>
- <para>
- Result
- </para>
- </entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>
- <para>
- <literal>*Bold*</literal>
- </para>
- </entry><entry>
- <para>
- <emphasis role="bold">Bold</emphasis>
- </para>
- </entry>
- </row>
- <row>
- <entry>
- <para>
- <literal>*Is bold*</literal>
- </para>
- </entry><entry>
- <para>
- <emphasis role="bold">Is bold</emphasis>
- </para>
- </entry>
- </row>
- <row>
- <entry>
- <para>
- <literal>* Not bold* *Not bold * * Not bold *</literal>
- </para>
- </entry><entry>
- <para>
- * Not bold* *Not bold * * Not bold *
- </para>
- </entry>
- </row>
- <row>
- <entry>
- <para>
- <literal>This*Isn't*Bold (no bold)</literal>
- </para>
- </entry><entry>
- <para>
- This*Isn't*Bold (no bold)
- </para>
- </entry>
- </row>
- <row>
- <entry>
- <para>
- <literal>(*Bold Inside*) (parenthesis not bold)</literal>
- </para>
- </entry><entry>
- <para>
- (<emphasis role="bold">Bold Inside</emphasis>) (parenthesis not bold)
- </para>
- </entry>
- </row>
- <row>
- <entry>
- <para>
- <literal>*(Bold Outside)* (parenthesis bold)</literal>
- </para>
- </entry><entry>
- <para>
- <emphasis role="bold">(Bold Outside)</emphasis> (parenthesis bold)
- </para>
- </entry>
- </row>
- <row>
- <entry>
- <para>
- <literal>3*4*5 = 60 (no bold)</literal>
- </para>
- </entry><entry>
- <para>
- 3*4*5 = 60 (no bold)
- </para>
- </entry>
- </row>
- <row>
- <entry>
- <para>
- <literal>3 * 4 * 5 = 60 (no bold)</literal>
- </para>
- </entry><entry>
- <para>
- 3 * 4 * 5 = 60 (no bold)
- </para>
- </entry>
- </row>
- <row>
- <entry>
- <para>
- <literal>3 *4* 5 = 60 (4 is bold)</literal>
- </para>
- </entry><entry>
- <para>
- 3 <emphasis role="bold">4</emphasis> 5 = 60 (4 is bold)
- </para>
- </entry>
- </row>
- <row>
- <entry>
- <para>
- <literal>*This is bold* this is not *but this is*</literal>
- </para>
- </entry><entry>
- <para>
- <emphasis role="bold">This is bold</emphasis> this is not <emphasis
- role="bold">but this is</emphasis>
- </para>
- </entry>
- </row>
- <row>
- <entry>
- <para>
- <literal>*This is bold*.</literal>
- </para>
- </entry><entry>
- <para>
- <emphasis role="bold">This is bold</emphasis>.
- </para>
- </entry>
- </row>
- <row>
- <entry>
- <para>
- <literal>*B*. (bold B)</literal>
- </para>
- </entry><entry>
- <para>
- <emphasis role="bold">B</emphasis>. (bold B)
- </para>
- </entry>
- </row>
- <row>
- <entry>
- <para>
- <literal>['*Bold-Italic*]</literal>
- </para>
- </entry><entry>
- <para>
- <emphasis><emphasis role="bold">Bold-Italic</emphasis></emphasis>
- </para>
- </entry>
- </row>
- <row>
- <entry>
- <para>
- <literal>*side-by*/-side/</literal>
- </para>
- </entry><entry>
- <para>
- <emphasis role="bold">side-by</emphasis><emphasis>-side</emphasis>
- </para>
- </entry>
- </row>
- </tbody>
- </tgroup>
- </table>
- <para>
- 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:
- </para>
-
-<programlisting><!--quickbook-escape-prefix-->Baa baa black sheep, *have you any wool?
-Yes sir, yes sir, three bags full!*
-One for the master, one for the dame,
-And one for the little boy who lives down the lane.
-<!--quickbook-escape-postfix--></programlisting>
- <para>
- Baa baa black sheep, <emphasis role="bold">have you any wool? Yes sir,
- yes sir, three bags full!</emphasis> One for the master, one for the dame,
- And one for the little boy who lives down the lane.
- </para>
- <para>
- But in the following paragraph, bold is not applied:
- </para>
-
-<programlisting><!--quickbook-escape-prefix-->Baa baa black sheep, *have you any wool?
-Yes sir, yes sir, three bags full!
-One for the master, one for the dame,
-And one for the little boy who lives down the lane.
-<!--quickbook-escape-postfix--></programlisting>
- <para>
- Baa baa black sheep, *have you any wool? Yes sir, yes sir, three bags full!
- One for the master, one for the dame, And one for the little boy who lives
- down the lane.
- </para>
- </section>
- <section id="quickbook.syntax.phrase.inline_code">
- <title><link linkend="quickbook.syntax.phrase.inline_code">Inline code</link></title>
- <para>
- Inlining code in paragraphs is quite common when writing C++ documentation.
- We provide a very simple markup for this. For example, this:
- </para>
-
-<programlisting><!--quickbook-escape-prefix-->This text has inlined code `int main() { return 0; }` in it.
-<!--quickbook-escape-postfix--></programlisting>
- <para>
- will generate:
- </para>
- <para>
- This text has inlined code <code><phrase role="keyword">int</phrase> <phrase
- role="identifier">main</phrase><phrase role="special">()</phrase> <phrase
- role="special">{</phrase> <phrase role="keyword">return</phrase> <phrase
- role="number">0</phrase><phrase role="special">;</phrase> <phrase role="special">}</phrase></code>
- in it. The code will be syntax highlighted.
- </para>
- <note>
- <para>
- <para>
- We simply enclose the code with the tick: <literal>"`"</literal>, not
- the single quote: <code><phrase role="string">"'"</phrase></code>.
- Note too that <literal>`some code`</literal> is preferred over <literal>[^some code]</literal>.
- </para>
- </para>
- </note>
- </section>
- <section id="quickbook.syntax.phrase.code_blocks">
- <title><link linkend="quickbook.syntax.phrase.code_blocks">Code blocks</link></title>
- <para>
- Preformatted code simply starts with a space or a tab (See <link linkend="quickbook.syntax.block.code">Code</link>).
- However, such a simple syntax cannot be used as phrase elements in lists
- (See <link linkend="quickbook.syntax.block.lists.ordered_lists">Ordered
- lists</link> and <link linkend="quickbook.syntax.block.lists.unordered_lists">Unordered
- lists</link>), tables (See <link linkend="quickbook.syntax.block.tables">Tables</link>),
- etc. Inline code (see above) can. The problem is, inline code does not
- allow formatting with newlines, spaces, and tabs. These are lost.
- </para>
- <para>
- We provide a phrase level markup that is a mix between the two. By using
- the double-tick, instead of the single-tick, we are telling QuickBook to
- use preformatted blocks of code. Example:
- </para>
-
-<programlisting>``
- #include <iostream>
-
- int main()
- {
- std::cout << "Hello, World!" << std::endl;
- return 0;
- }
-``
-</programlisting>
- <para>
- will generate:
- </para>
- <para>
-
-<programlisting>
-<phrase role="preprocessor">#include</phrase> <phrase role="special"><</phrase><phrase role="identifier">iostream</phrase><phrase role="special">></phrase>
-
-<phrase role="keyword">int</phrase> <phrase role="identifier">main</phrase><phrase role="special">()</phrase>
-<phrase role="special">{</phrase>
- <phrase role="identifier">std</phrase><phrase role="special">::</phrase><phrase role="identifier">cout</phrase> <phrase role="special"><<</phrase> <phrase role="string">"Hello, World!"</phrase> <phrase role="special"><<</phrase> <phrase role="identifier">std</phrase><phrase role="special">::</phrase><phrase role="identifier">endl</phrase><phrase role="special">;</phrase>
- <phrase role="keyword">return</phrase> <phrase role="number">0</phrase><phrase role="special">;</phrase>
-<phrase role="special">}</phrase>
-</programlisting>
- </para>
- </section>
- <section id="quickbook.syntax.phrase.source_mode">
- <title><link linkend="quickbook.syntax.phrase.source_mode">Source Mode</link></title>
- <para>
- 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
- documents are initially in C++ mode by default, though an alternative initial
- value may be set in the <link linkend="quickbook.syntax.block.document">Document</link>
- section.
- </para>
- <para>
- To change the source mode, use the <literal>[source-mode]</literal> markup,
- where <literal>source-mode</literal> is one of the supported modes. For
- example, this:
- </para>
-
-<programlisting><!--quickbook-escape-prefix-->Python's [python] `import` is rather like C++'s [c++] `#include`. A
-C++ comment `// looks like this` whereas a Python comment [python]
-`# looks like this`.
-<!--quickbook-escape-postfix--></programlisting>
- <para>
- will generate:
- </para>
- <para>
- Python's <code><phrase role="keyword">import</phrase></code> is rather
- like C++'s <code><phrase role="preprocessor">#include</phrase></code>.
- A C++ comment <code><phrase role="comment">// looks like this</phrase></code>
- whereas a Python comment <code><phrase role="comment">#looks like this</phrase></code>.
- </para>
- <table frame="all"> <title>Supported Source Modes</title>
- <tgroup cols="2">
- <thead>
- <row>
- <entry>
- <para>
- Mode
- </para>
- </entry><entry>
- <para>
- Source Mode Markup
- </para>
- </entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>
- <para>
- C++
- </para>
- </entry><entry>
- <para>
- <literal>[c++]</literal>
- </para>
- </entry>
- </row>
- <row>
- <entry>
- <para>
- Python
- </para>
- </entry><entry>
- <para>
- <literal>[python]</literal>
- </para>
- </entry>
- </row>
- </tbody>
- </tgroup>
- </table>
- <note>
- <para>
- <para>
- The source mode strings are lowercase.
- </para>
- </para>
- </note>
- </section>
- <section id="quickbook.syntax.phrase.line_break">
- <title><link linkend="quickbook.syntax.phrase.line_break">line-break</link></title>
-
-<programlisting><!--quickbook-escape-prefix-->[br]
-<!--quickbook-escape-postfix--></programlisting>
- <warning>
- <para>
- <para>
- <code><phrase role="special">[</phrase><phrase role="identifier">br</phrase><phrase
- role="special">]</phrase></code> is now deprecated. <link linkend="quickbook.syntax.block.blurbs">Blurbs</link>,
- <link linkend="quickbook.syntax.block.admonitions">Admonitions</link>
- and table cells (see <link linkend="quickbook.syntax.block.tables">Tables</link>)
- may now contain paragraphs.
- </para>
- </para>
- </warning>
- </section>
- <section id="quickbook.syntax.phrase.anchors">
- <title><link linkend="quickbook.syntax.phrase.anchors">Anchors</link></title>
-
-<programlisting><!--quickbook-escape-prefix-->[#named_anchor]
-<!--quickbook-escape-postfix--></programlisting>
- <para>
- A named anchor is a hook that can be referenced by a link elsewhere in
- the document. You can then reference an anchor with <literal>[link named_anchor
-Some link text]</literal>.
- See <link linkend="quickbook.syntax.phrase.anchor_links">Anchor links</link>,
- <link linkend="quickbook.syntax.block.section">Section</link> and <link
- linkend="quickbook.syntax.block.headings">Heading</link>.
- </para>
- </section>
- <section id="quickbook.syntax.phrase.links">
- <title><link linkend="quickbook.syntax.phrase.links">Links</link></title>
-
-<programlisting><!--quickbook-escape-prefix-->[@http://www.boost.org this is [*boost's] website....]
-<!--quickbook-escape-postfix--></programlisting>
- <para>
- will generate:
- </para>
- <para>
- <ulink url="http://www.boost.org">this is <emphasis role="bold">boost's</emphasis>
- website....</ulink>
- </para>
- <para>
- URL links where the link text is the link itself is common. Example:
- </para>
-
-<programlisting><!--quickbook-escape-prefix-->see http://spirit.sourceforge.net/
-<!--quickbook-escape-postfix--></programlisting>
- <para>
- so, when the text is absent in a link markup, the URL is assumed. Example:
- </para>
-
-<programlisting>see <!--quickbook-escape-prefix-->[@http://spirit.sourceforge.net/]<!--quickbook-escape-postfix-->
-</programlisting>
- <para>
- will generate:
- </para>
- <para>
- see <ulink url="http://spirit.sourceforge.net/">http://spirit.sourceforge.net/>
- </para>
- </section>
- <section id="quickbook.syntax.phrase.anchor_links">
- <title><link linkend="quickbook.syntax.phrase.anchor_links">Anchor links</link></title>
- <para>
- You can link within a document using:
- </para>
-
-<programlisting><!--quickbook-escape-prefix-->[link section_id.normalized_header_text The link text]
-<!--quickbook-escape-postfix--></programlisting>
- <para>
- See sections <link linkend="quickbook.syntax.block.section">Section</link>
- and <link linkend="quickbook.syntax.block.headings">Heading</link> for
- more info.
- </para>
- </section>
- <section id="quickbook.syntax.phrase.refentry_links">
- <title><link linkend="quickbook.syntax.phrase.refentry_links">refentry links</link></title>
- <para>
- In addition, you can link internally to an XML refentry like:
- </para>
-
-<programlisting><!--quickbook-escape-prefix-->[link xml.refentry The link text]
-<!--quickbook-escape-postfix--></programlisting>
- <para>
- This gets converted into <literal><link linkend="xml.refentry">The
- link text</link></literal>.
- </para>
- <para>
- Like URLs, the link text is optional. If this is not present, the link
- text will automatically be the refentry. Example:
- </para>
-
-<programlisting><!--quickbook-escape-prefix-->[link xml.refentry]
-<!--quickbook-escape-postfix--></programlisting>
- <para>
- This gets converted into <literal><link linkend="xml.refentry">xml.refentry</link></literal>.
- </para>
- </section>
- <section id="quickbook.syntax.phrase.code_links">
- <title><link linkend="quickbook.syntax.phrase.code_links"> Code Links</link></title>
- <para>
- If you want to link to a function, class, member, enum, concept or header
- in the reference section, you can use:
- </para>
-
-<programlisting><!--quickbook-escape-prefix-->[funcref fully::qualified::function_name The link text]
-[classref fully::qualified::class_name The link text]
-[memberref fully::qualified::member_name The link text]
-[enumref fully::qualified::enum_name The link text]
-[macroref MACRO_NAME The link text]
-[conceptref ConceptName The link text]
-[headerref path/to/header.hpp The link text]
-<!--quickbook-escape-postfix--></programlisting>
- <para>
- Again, the link text is optional. If this is not present, the link text
- will automatically be the function, class, member, enum, macro, concept
- or header. Example:
- </para>
-
-<programlisting><!--quickbook-escape-prefix-->[classref boost::bar::baz]
-<!--quickbook-escape-postfix--></programlisting>
- <para>
- would have "boost::bar::baz" as the link text.
- </para>
- </section>
- <section id="quickbook.syntax.phrase.escape">
- <title><link linkend="quickbook.syntax.phrase.escape">Escape</link></title>
- <para>
- The escape mark-up is used when we don't want to do any processing.
- </para>
-
-<programlisting>'''
-escape (no processing/formatting)
-'''
-</programlisting>
- <para>
- Escaping allows us to pass XML markup to <ulink url="http://www.boost.org/doc/html/boostbook.html">BoostBook</ulink>
- or <ulink url="http://www.docbook.org/">DocBook</ulink>. For example:
- </para>
-
-<programlisting>'''
-<emphasis role="bold">This is direct XML markup</emphasis>
-'''
-</programlisting>
- <para>
- <emphasis role="bold">This is direct XML markup</emphasis>
- </para>
- <important>
- <para>
- <para>
- Be careful when using the escape. The text must conform to <ulink url="http://www.boost.org/doc/html/boostbook.html">BoostBook</ulink>/<ulink
- url="http://www.docbook.org/">DocBook</ulink> syntax.
- </para>
- </para>
- </important>
- </section>
- <section id="quickbook.syntax.phrase.single_char_escape">
- <title><link linkend="quickbook.syntax.phrase.single_char_escape">Single
- char escape</link></title>
- <para>
- The backslash may be used to escape a single punctuation character. The
- punctuation immediately after the backslash is passed without any processing.
- This is useful when we need to escape QuickBook punctuations such as <code><phrase
- role="special">[</phrase></code> and <code><phrase role="special">]</phrase></code>.
- For example, how do you escape the triple quote? Simple: <literal>\'\'\'</literal>
- </para>
- <para>
- <code><phrase role="special">\</phrase><phrase role="identifier">n</phrase></code>
- has a special meaning. It is used to generate line breaks.
- </para>
- <warning>
- <para>
- <para>
- <code><phrase role="special">\</phrase><phrase role="identifier">n</phrase></code>
- and <code><phrase role="special">[</phrase><phrase role="identifier">br</phrase><phrase
- role="special">]</phrase></code> are now deprecated. <link linkend="quickbook.syntax.block.blurbs">Blurbs</link>,
- <link linkend="quickbook.syntax.block.admonitions">Admonitions</link>
- and table cells (see <link linkend="quickbook.syntax.block.tables">Tables</link>)
- may now contain paragraphs.
- </para>
- </para>
- </warning>
- <para>
- The escaped space: <code><phrase role="special">\</phrase> </code> also
- has a special meaning. The escaped space is removed from the output.
- </para>
- </section>
- <section id="quickbook.syntax.phrase.images">
- <title><link linkend="quickbook.syntax.phrase.images">Images</link></title>
-
-<programlisting><!--quickbook-escape-prefix-->[$image.jpg]
-<!--quickbook-escape-postfix--></programlisting>
- </section>
- <section id="quickbook.syntax.phrase.footnotes">
- <title><link linkend="quickbook.syntax.phrase.footnotes">Footnotes</link></title>
- <para>
- As of version 1.3, QuickBook supports footnotes. Just put the text of the
- footnote in a <code><phrase role="special">[</phrase><phrase role="identifier">footnote</phrase><phrase
- role="special">]</phrase></code> block, and the text will be put at the
- bottom of the current page. For example, this:
- </para>
-
-<programlisting><!--quickbook-escape-prefix-->[footnote A sample footnote]
-<!--quickbook-escape-postfix--></programlisting>
- <para>
- will generate this
- <footnote>
- <para>
- A sample footnote
- </para>
- </footnote>
- .
- </para>
- <section id="quickbook.syntax.phrase.footnotes.macro_expansion">
- <title><link linkend="quickbook.syntax.phrase.footnotes.macro_expansion">Macro
- Expansion</link></title>
-<programlisting><!--quickbook-escape-prefix-->__a_macro_identifier__
-<!--quickbook-escape-postfix--></programlisting>
- <para>
- See <link linkend="quickbook.syntax.block.macros">Macros</link> for details.
- </para>
- </section>
- <section id="quickbook.syntax.phrase.footnotes.template_expansion">
- <title><link linkend="quickbook.syntax.phrase.footnotes.template_expansion">Template
- Expansion</link></title>
-<programlisting><!--quickbook-escape-prefix-->[a_template_identifier]
-<!--quickbook-escape-postfix--></programlisting>
- <para>
- See <link linkend="quickbook.syntax.block.templates">Templates</link>
- for details.
- </para>
- </section>
- </section>
- </section>
- <section id="quickbook.syntax.block">
- <title><link linkend="quickbook.syntax.block"> Block Level Elements</link></title>
- <section id="quickbook.syntax.block.document">
- <title><link linkend="quickbook.syntax.block.document">Document</link></title>
- <para>
- Every document must begin with a Document Info section, which should look
- like this:
- </para>
-
-<programlisting><!--quickbook-escape-prefix-->[document-type The Document Title
- [quickbook 1.3]
- [version 1.0]
- [id the_document_name]
- [dirname the_document_dir]
- [copyright 2000 2002 2003 Joe Blow, Jane Doe]
- [purpose The document's reason for being]
- [category The document's category]
- [authors [Blow, Joe], [Doe, Jane]]
- [license The document's license]
- [source-mode source-type]
-]
-<!--quickbook-escape-postfix--></programlisting>
- <para>
- Where document-type is one of:
- </para>
- <itemizedlist>
- <listitem>
- book
- </listitem>
- <listitem>
- article
- </listitem>
- <listitem>
- library
- </listitem>
- <listitem>
- chapter
- </listitem>
- <listitem>
- part
- </listitem>
- <listitem>
- appendix
- </listitem>
- <listitem>
- preface
- </listitem>
- <listitem>
- qandadiv
- </listitem>
- <listitem>
- qandaset
- </listitem>
- <listitem>
- reference
- </listitem>
- <listitem>
- set
- </listitem>
- </itemizedlist>
- <para>
- quickbook 1.3 declares the version of quickbook the document is written
- for. In its absence, version 1.1 is assumed.
- </para>
- <para>
- <literal>version</literal>, <literal>id</literal>, <literal>dirname</literal>,
- <literal>copyright</literal>, <literal>purpose</literal>, <literal>category</literal>,
- <literal>authors</literal>, <literal>license</literal>, <literal>last-revision</literal>
- and <literal>source-mode</literal> are optional information.
- </para>
- <para>
- <literal>source-type</literal> is a lowercase string setting the initial
- <link linkend="quickbook.syntax.phrase.source_mode">Source Mode</link>.
- If the <literal>source-mode</literal> field is omitted, a default value
- of <literal>c++</literal> will be used.
- </para>
- </section>
- <section id="quickbook.syntax.block.section">
- <title><link linkend="quickbook.syntax.block.section">Section</link></title>
- <para>
- Starting a new section is accomplished with:
- </para>
-
-<programlisting><!--quickbook-escape-prefix-->[section:id The Section Title]
-<!--quickbook-escape-postfix--></programlisting>
- <para>
- where <emphasis>id</emphasis> 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 <literal>a-Z</literal>,
- <literal>A-Z</literal>, <literal>0-9</literal> and <literal>_</literal>.
- 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".
- </para>
- <para>
- End a section with:
- </para>
-
-<programlisting><!--quickbook-escape-prefix-->[endsect]
-<!--quickbook-escape-postfix--></programlisting>
- <para>
- Sections can nest, and that results in a hierarchy in the table of contents.
- </para>
- </section>
- <section id="quickbook.syntax.block.xinclude">
- <title><link linkend="quickbook.syntax.block.xinclude">xinclude</link></title>
- <para>
- You can include another XML file with:
- </para>
-
-<programlisting><!--quickbook-escape-prefix-->[xinclude file.xml]
-<!--quickbook-escape-postfix--></programlisting>
- <para>
- This is useful when file.xml has been generated by Doxygen and contains
- your reference section.
- </para>
- </section>
- <section id="quickbook.syntax.block.paragraphs">
- <title><link linkend="quickbook.syntax.block.paragraphs">Paragraphs</link></title>
- <para>
- Paragraphs start left-flushed and are terminated by two or more newlines.
- No markup is needed for paragraphs. QuickBook automatically detects paragraphs
- from the context. Block markups [section, endsect, h1, h2, h3, h4, h5,
- h6, blurb, (block-quote) ':', pre, def, table and include ] may also terminate
- a paragraph.
- </para>
- </section>
- <section id="quickbook.syntax.block.lists">
- <title><link linkend="quickbook.syntax.block.lists">Lists</link></title>
- <section id="quickbook.syntax.block.lists.ordered_lists">
- <title><link linkend="quickbook.syntax.block.lists.ordered_lists">Ordered
- lists</link></title>
-<programlisting># One
-# Two
-# Three
-</programlisting>
- <para>
- will generate:
- </para>
- <orderedlist>
- <listitem>
- One
- </listitem>
- <listitem>
- Two
- </listitem>
- <listitem>
- Three
- </listitem>
- </orderedlist>
- </section>
- <section id="quickbook.syntax.block.lists.list_hierarchies">
- <title><link linkend="quickbook.syntax.block.lists.list_hierarchies">List
- Hierarchies</link></title>
- <para>
- List hierarchies are supported. Example:
- </para>
-
-<programlisting># One
-# Two
-# Three
- # Three.a
- # Three.b
- # Three.c
-# Four
- # Four.a
- # Four.a.i
- # Four.a.ii
-# Five
-</programlisting>
- <para>
- will generate:
- </para>
- <orderedlist>
- <listitem>
- One
- </listitem>
- <listitem>
- Two
- </listitem>
- <listitem>
- Three
- <orderedlist>
- <listitem>
- Three.a
- </listitem>
- <listitem>
- Three.b
- </listitem>
- <listitem>
- Three.c
- </listitem>
- </orderedlist>
- </listitem>
- <listitem>
- Fourth
- <orderedlist>
- <listitem>
- Four.a
- <orderedlist>
- <listitem>
- Four.a.i
- </listitem>
- <listitem>
- Four.a.ii
- </listitem>
- </orderedlist>
- </listitem>
- </orderedlist>
- </listitem>
- <listitem>
- Five
- </listitem>
- </orderedlist>
- </section>
- <section id="quickbook.syntax.block.lists.long_list_lines">
- <title><link linkend="quickbook.syntax.block.lists.long_list_lines">Long
- List Lines</link></title>
- <para>
- Long lines will be wrapped appropriately. Example:
- </para>
-
-<programlisting># A short item.
-# A very long item. A very long item. A very long item.
- A very long item. A very long item. A very long item.
- A very long item. A very long item. A very long item.
- A very long item. A very long item. A very long item.
- A very long item. A very long item. A very long item.
-# A short item.
-</programlisting>
- <orderedlist>
- <listitem>
- A short item.
- </listitem>
- <listitem>
- A very long item. A very long item. A very long item. A very long item.
- A very long item. A very long item. A very long item. A very long item.
- A very long item. A very long item. A very long item. A very long item.
- A very long item. A very long item. A very long item.
- </listitem>
- <listitem>
- A short item.
- </listitem>
- </orderedlist>
- </section>
- <section id="quickbook.syntax.block.lists.unordered_lists">
- <title><link linkend="quickbook.syntax.block.lists.unordered_lists">Unordered
- lists</link></title>
-<programlisting><!--quickbook-escape-prefix-->* First
-* Second
-* Third
-<!--quickbook-escape-postfix--></programlisting>
- <para>
- will generate:
- </para>
- <itemizedlist>
- <listitem>
- First
- </listitem>
- <listitem>
- Second
- </listitem>
- <listitem>
- Third
- </listitem>
- </itemizedlist>
- </section>
- <section id="quickbook.syntax.block.lists.mixed_lists">
- <title><link linkend="quickbook.syntax.block.lists.mixed_lists">Mixed lists</link></title>
- <para>
- Mixed lists (ordered and unordered) are supported. Example:
- </para>
-
-<programlisting><!--quickbook-escape-prefix--># One
-# Two
-# Three
- * Three.a
- * Three.b
- * Three.c
-# Four
-<!--quickbook-escape-postfix--></programlisting>
- <para>
- will generate:
- </para>
- <orderedlist>
- <listitem>
- One
- </listitem>
- <listitem>
- Two
- </listitem>
- <listitem>
- Three
- <itemizedlist>
- <listitem>
- Three.a
- </listitem>
- <listitem>
- Three.b
- </listitem>
- <listitem>
- Three.c
- </listitem>
- </itemizedlist>
- </listitem>
- <listitem>
- Four
- </listitem>
- </orderedlist>
- <para>
- And...
- </para>
-
-<programlisting><!--quickbook-escape-prefix--># 1
- * 1.a
- # 1.a.1
- # 1.a.2
- * 1.b
-# 2
- * 2.a
- * 2.b
- # 2.b.1
- # 2.b.2
- * 2.b.2.a
- * 2.b.2.b
-<!--quickbook-escape-postfix--></programlisting>
- <para>
- will generate:
- </para>
- <orderedlist>
- <listitem>
- 1
- <itemizedlist>
- <listitem>
- 1.a
- <orderedlist>
- <listitem>
- 1.a.1
- </listitem>
- <listitem>
- 1.a.2
- </listitem>
- </orderedlist>
- </listitem>
- <listitem>
- 1.b
- </listitem>
- </itemizedlist>
- </listitem>
- <listitem>
- 2
- <itemizedlist>
- <listitem>
- 2.a
- </listitem>
- <listitem>
- 2.b
- <orderedlist>
- <listitem>
- 2.b.1
- </listitem>
- <listitem>
- 2.b.2
- <itemizedlist>
- <listitem>
- 2.b.2.a
- </listitem>
- <listitem>
- 2.b.2.b
- </listitem>
- </itemizedlist>
- </listitem>
- </orderedlist>
- </listitem>
- </itemizedlist>
- </listitem>
- </orderedlist>
- </section>
- </section>
- <section id="quickbook.syntax.block.code">
- <title><link linkend="quickbook.syntax.block.code">Code</link></title>
- <para>
- Preformatted code starts with a space or a tab. The code will be syntax
- highlighted according to the current <link linkend="quickbook.syntax.phrase.source_mode">Source
- Mode</link>:
- </para>
- <para>
- </para>
-
-<programlisting>
-<phrase role="preprocessor">#include</phrase> <phrase role="special"><</phrase><phrase role="identifier">iostream</phrase><phrase role="special">></phrase>
-
-<phrase role="keyword">int</phrase> <phrase role="identifier">main</phrase><phrase role="special">()</phrase>
-<phrase role="special">{</phrase>
- <phrase role="comment">// Sample code
-</phrase> <phrase role="identifier">std</phrase><phrase role="special">::</phrase><phrase role="identifier">cout</phrase> <phrase role="special"><<</phrase> <phrase role="string">"Hello, World\n"</phrase><phrase role="special">;</phrase>
- <phrase role="keyword">return</phrase> <phrase role="number">0</phrase><phrase role="special">;</phrase>
-<phrase role="special">}</phrase>
-</programlisting>
- <para>
- </para>
-
-<programlisting>
-<phrase role="keyword">import</phrase> <phrase role="identifier">cgi</phrase>
-
-<phrase role="keyword">def</phrase> <phrase role="identifier">cookForHtml</phrase><phrase role="special">(</phrase><phrase role="identifier">text</phrase><phrase role="special">):</phrase>
- <phrase role="string">'''"Cooks" the input text for HTML.'''</phrase>
-
- <phrase role="keyword">return</phrase> <phrase role="identifier">cgi</phrase><phrase role="special">.</phrase><phrase role="identifier">escape</phrase><phrase role="special">(</phrase><phrase role="identifier">text</phrase><phrase role="special">)</phrase>
-</programlisting>
- <para>
- </para>
- <para>
- Macros that are already defined are expanded in source code. Example:
- </para>
-
-<programlisting><!--quickbook-escape-prefix-->[def __array__ [@http://www.boost.org/doc/html/array/reference.html array]]
-[def __boost__ [@http://www.boost.org/libs/libraries.htm boost]]
-
- using __boost__::__array__;
-<!--quickbook-escape-postfix--></programlisting>
- <para>
- Generates:
- </para>
-
-<programlisting>
-<phrase role="keyword">using</phrase> <ulink url="http://www.boost.org/libs/libraries.htm">boost</ulink><phrase role="special">::</phrase><ulink url="http://www.boost.org/doc/html/array/reference.html">array</ulink><phrase role="special">;</phrase>
-</programlisting>
- </section>
- <section id="quickbook.syntax.block.escape_back">
- <title><link linkend="quickbook.syntax.block.escape_back"> Escaping Back
- To QuickBook</link></title>
- <para>
- 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
- need to switch back to QuickBook markup inside code, you can do so using
- a language specific <emphasis>escape-back</emphasis> delimiter. In C++
- and Python, the delimiter is the double tick (back-quote): "``"
- and "``". Example:
- </para>
-
-<programlisting><!--quickbook-escape-prefix-->void ``[@http://en.wikipedia.org/wiki/Foo#Foo.2C_Bar_and_Baz foo]``()
-{
-}
-<!--quickbook-escape-postfix--></programlisting>
- <para>
- Will generate:
- </para>
-
-<programlisting>
-<phrase role="keyword">void</phrase> <ulink url="http://en.wikipedia.org/wiki/Foo#Foo.2C_Bar_and_Baz">foo</ulink><phrase role="special">()</phrase>
-<phrase role="special">{</phrase>
-<phrase role="special">}</phrase>
-</programlisting>
- <para>
- When escaping from code to QuickBook, only phrase level markups are allowed.
- Block level markups like lists, tables etc. are not allowed.
- </para>
- </section>
- <section id="quickbook.syntax.block.preformatted">
- <title><link linkend="quickbook.syntax.block.preformatted">Preformatted</link></title>
- <para>
- Sometimes, you don't want some preformatted text to be parsed as C++. In
- such cases, use the <literal>[pre ... ]</literal> markup block.
- </para>
-
-<programlisting><!--quickbook-escape-prefix-->[pre
-
- Some *preformatted* text Some *preformatted* text
-
- Some *preformatted* text Some *preformatted* text
-
- Some *preformatted* text Some *preformatted* text
-
-]
-<!--quickbook-escape-postfix--></programlisting>
- <para>
- Spaces, tabs and newlines are rendered as-is. Unlike all quickbook block
- level markup, pre (and Code) are the only ones that allow multiple newlines.
- The markup above will generate:
- </para>
-
-<programlisting>Some <emphasis role="bold">preformatted</emphasis> text Some <emphasis role="bold">preformatted</emphasis> text
-
- Some <emphasis role="bold">preformatted</emphasis> text Some <emphasis role="bold">preformatted</emphasis> text
-
- Some <emphasis role="bold">preformatted</emphasis> text Some <emphasis role="bold">preformatted</emphasis> text
-
-</programlisting>
- <para>
- Notice that unlike Code, phrase markup such as font style is still permitted
- inside <literal>pre</literal> blocks.
- </para>
- </section>
- <section id="quickbook.syntax.block.blockquote">
- <title><link linkend="quickbook.syntax.block.blockquote">Blockquote</link></title>
-
-<programlisting><!--quickbook-escape-prefix-->[:sometext...]<!--quickbook-escape-postfix-->
-</programlisting>
- <blockquote>
- <para>
- <para>
- Indents the paragraph. This applies to one paragraph only.
- </para>
- </para>
- </blockquote>
- </section>
- <section id="quickbook.syntax.block.admonitions">
- <title><link linkend="quickbook.syntax.block.admonitions">Admonitions</link></title>
-
-<programlisting><!--quickbook-escape-prefix-->[note This is a note]
-[tip This is a tip]
-[important This is important]
-[caution This is a caution]
-[warning This is a warning]
-<!--quickbook-escape-postfix--></programlisting>
- <para>
- generates <ulink url="http://www.docbook.org/">DocBook</ulink> admonitions:
- </para>
- <note>
- <para>
- <para>
- This is a note
- </para>
- </para>
- </note>
- <tip>
- <para>
- <para>
- This is a tip
- </para>
- </para>
- </tip>
- <important>
- <para>
- <para>
- This is important
- </para>
- </para>
- </important>
- <caution>
- <para>
- <para>
- This is a caution
- </para>
- </para>
- </caution>
- <warning>
- <para>
- <para>
- This is a warning
- </para>
- </para>
- </warning>
- <para>
- These are the only admonitions supported by <ulink url="http://www.docbook.org/">DocBook</ulink>.
- So, for example <literal>[information This is some information]</literal>
- is unlikely to produce the desired effect.
- </para>
- </section>
- <section id="quickbook.syntax.block.headings">
- <title><link linkend="quickbook.syntax.block.headings">Headings</link></title>
-
-<programlisting><!--quickbook-escape-prefix-->[h1 Heading 1]
-[h2 Heading 2]
-[h3 Heading 3]
-[h4 Heading 4]
-[h5 Heading 5]
-[h6 Heading 6]
-<!--quickbook-escape-postfix--></programlisting>
- <anchor id="quickbook.syntax.block.headings.heading_1"/>
- <bridgehead renderas="sect1">
- <link linkend="quickbook.syntax.block.headings.heading_1">Heading 1</link>
- </bridgehead>
- <anchor id="quickbook.syntax.block.headings.heading_2"/>
- <bridgehead renderas="sect2">
- <link linkend="quickbook.syntax.block.headings.heading_2">Heading 2</link>
- </bridgehead>
- <anchor id="quickbook.syntax.block.headings.heading_3"/>
- <bridgehead renderas="sect3">
- <link linkend="quickbook.syntax.block.headings.heading_3">Heading 3</link>
- </bridgehead>
- <anchor id="quickbook.syntax.block.headings.heading_4"/>
- <bridgehead renderas="sect4">
- <link linkend="quickbook.syntax.block.headings.heading_4">Heading 4</link>
- </bridgehead>
- <anchor id="quickbook.syntax.block.headings.heading_5"/>
- <bridgehead renderas="sect5">
- <link linkend="quickbook.syntax.block.headings.heading_5">Heading 5</link>
- </bridgehead>
- <anchor id="quickbook.syntax.block.headings.heading_6"/>
- <bridgehead renderas="sect6">
- <link linkend="quickbook.syntax.block.headings.heading_6">Heading 6</link>
- </bridgehead>
- <para>
- Headings 1-3 [h1 h2 and h3] will automatically have anchors with normalized
- names with <literal>name="section_id.normalized_header_text"</literal>
- (i.e. valid characters are <literal>a-z</literal>, <literal>A-Z</literal>,
- <literal>0-9</literal> and <literal>_</literal>. 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 <literal>section_2.heading_1</literal>).
- You can use:
- </para>
-
-<programlisting><!--quickbook-escape-prefix-->[link section_id.normalized_header_text The link text]
-<!--quickbook-escape-postfix--></programlisting>
- <para>
- to link to them. See <link linkend="quickbook.syntax.phrase.anchor_links">Anchor
- links</link> and <link linkend="quickbook.syntax.block.section">Section</link>
- for more info.
- </para>
- </section>
- <section id="quickbook.syntax.block.generic_heading">
- <title><link linkend="quickbook.syntax.block.generic_heading">Generic Heading</link></title>
- <para>
- In cases when you don't want to care about the heading level (1 to 6),
- you can use the <emphasis>Generic Heading</emphasis>:
- </para>
-
-<programlisting><!--quickbook-escape-prefix-->[heading Heading]
-<!--quickbook-escape-postfix--></programlisting>
- <para>
- The <emphasis>Generic Heading</emphasis> assumes the level, plus one, of
- the innermost section where it is placed. For example, if it is placed
- in the outermost section, then, it assumes <emphasis>h2</emphasis>.
- </para>
- <para>
- Headings are often used as an alternative to sections. It is used particularly
- if you do not want to start a new section. In many cases, however, headings
- in a particular section is just flat. Example:
- </para>
-
-<programlisting><!--quickbook-escape-prefix-->[section A]
-[h2 X]
-[h2 Y]
-[h2 Z]
-[endsect]
-<!--quickbook-escape-postfix--></programlisting>
- <para>
- Here we use h2 assuming that section A is the outermost level. If it is
- placed in an inner level, you'll have to use h3, h4, etc. depending on
- where the section is. In general, it is the section level plus one. It
- is rather tedious, however, to scan the section level everytime. If you
- rewrite the example above as shown below, this will be automatic:
- </para>
-
-<programlisting><!--quickbook-escape-prefix-->[section A]
-[heading X]
-[heading Y]
-[heading Z]
-[endsect]
-<!--quickbook-escape-postfix--></programlisting>
- <para>
- They work well regardless where you place them. You can rearrange sections
- at will without any extra work to ensure correct heading levels. In fact,
- with <emphasis>section</emphasis> and <emphasis>heading</emphasis>, you
- have all you need. <emphasis>h1</emphasis>..<emphasis>h6</emphasis> becomes
- redundant. <emphasis>h1</emphasis>..<emphasis>h6</emphasis> might be deprecated
- in the future.
- </para>
- </section>
- <section id="quickbook.syntax.block.macros">
- <title><link linkend="quickbook.syntax.block.macros">Macros</link></title>
-
-<programlisting><!--quickbook-escape-prefix-->[def macro_identifier some text]
-<!--quickbook-escape-postfix--></programlisting>
- <para>
- When a macro is defined, the identifier replaces the text anywhere in the
- file, in paragraphs, in markups, etc. macro_identifier is a string of non-
- white space characters except ']'. A macro may not follow an alphabetic
- character or the underscore. The replacement text can be any phrase (even
- marked up). Example:
- </para>
-
-<programlisting><!--quickbook-escape-prefix-->[def sf_logo [$http://sourceforge.net/sflogo.php?group_id=28447&type=1]]
-sf_logo
-<!--quickbook-escape-postfix--></programlisting>
- <para>
- Now everywhere the sf_logo is placed, the picture will be inlined.
- </para>
- <para>
- <inlinemediaobject><imageobject><imagedata fileref="http://sourceforge.net/sflogo.php?group_id=28447&type=1"></imagedata></imageobject>
- <textobject>
- <phrase>sflogo</phrase>
- </textobject>
- </inlinemediaobject>
- </para>
- <tip>
- <para>
- <para>
- 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. <literal>__spirit__</literal>). The reason is
- to avoid unwanted macro replacement.
- </para>
- </para>
- </tip>
- <para>
- Links (URLS) and images are good candidates for macros. <emphasis role="bold">1</emphasis>)
- 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. <emphasis role="bold">2</emphasis>)
- The syntax is not pretty. It's easier to read and write, e.g. <literal>__spirit__</literal>
- than <literal>[@http://spirit.sourceforge.net Spirit]</literal>.
- </para>
- <para>
- Some more examples:
- </para>
-
-<programlisting><!--quickbook-escape-prefix-->[def :-) [$theme/smiley.png]]
-[def __spirit__ [@http://spirit.sourceforge.net Spirit]]
-<!--quickbook-escape-postfix--></programlisting>
- <para>
- (See <link linkend="quickbook.syntax.phrase.images">Images</link> and
- <link linkend="quickbook.syntax.phrase.links">Links</link>)
- </para>
- <para>
- Invoking these macros:
- </para>
-
-<programlisting><!--quickbook-escape-prefix-->Hi __spirit__ :-)
-<!--quickbook-escape-postfix--></programlisting>
- <para>
- will generate this:
- </para>
- <para>
- Hi <ulink url="http://spirit.sourceforge.net">Spirit</ulink> <inlinemediaobject><imageobject><imagedata
- fileref="images/smiley.png"></imagedata></imageobject>
- <textobject>
- <phrase>smiley</phrase>
- </textobject>
- </inlinemediaobject>
- </para>
- </section>
- <section id="quickbook.syntax.block.predefined_macros">
- <title><link linkend="quickbook.syntax.block.predefined_macros">Predefined
- Macros</link></title>
- <para>
- Quickbook has some predefined macros that you can already use.
- </para>
- <table frame="all"> <title>Predefined Macros</title>
- <tgroup cols="3">
- <thead>
- <row>
- <entry>
- <para>
- Macro
- </para>
- </entry><entry>
- <para>
- Meaning
- </para>
- </entry><entry>
- <para>
- Example
- </para>
- </entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>
- <para>
- __DATE__
- </para>
- </entry><entry>
- <para>
- Today's date
- </para>
- </entry><entry>
- <para>
- 2007-Feb-27
- </para>
- </entry>
- </row>
- <row>
- <entry>
- <para>
- __TIME__
- </para>
- </entry><entry>
- <para>
- The current time
- </para>
- </entry><entry>
- <para>
- 11:13:46 PM
- </para>
- </entry>
- </row>
- <row>
- <entry>
- <para>
- __FILENAME__
- </para>
- </entry><entry>
- <para>
- Quickbook source filename
- </para>
- </entry><entry>
- <para>
- C:\dev\boost\tools\quickbook\doc\quickbook.qbk
- </para>
- </entry>
- </row>
- </tbody>
- </tgroup>
- </table>
- </section>
- <section id="quickbook.syntax.block.templates">
- <title><link linkend="quickbook.syntax.block.templates">Templates</link></title>
- <para>
- Templates provide a more versatile text substitution mechanism. Templates
- come in handy when you need to create parameterizable, multi-line, boilerplate
- text that you specify once and expand many times. Templates accept one
- or more arguments. These arguments act like place-holders for text replacement.
- Unlike simple macros, which are limited to phrase level markup, templates
- can contain block level markup (e.g. paragraphs, code blocks and tables).
- </para>
- <para>
- Example template:
- </para>
-
-<programlisting><!--quickbook-escape-prefix-->[template person[name age what]
-
-Hi, my name is [name]. I am [age] years old. I am a [what].
-
-]
-<!--quickbook-escape-postfix--></programlisting>
- <anchor id="quickbook.syntax.block.templates.template_identifier"/>
- <bridgehead renderas="sect5">
- <link linkend="quickbook.syntax.block.templates.template_identifier">Template
- Identifier</link>
- </bridgehead>
- <para>
- Template identifiers can either consist of:
- </para>
- <itemizedlist>
- <listitem>
- An initial alphabetic character or the underscore, followed by zero or
- more alphanumeric characters or the underscore. This is similar to your
- typical C/C++ identifier.
- </listitem>
- <listitem>
- A single character punctuation (a non-alphanumeric printable character)
- </listitem>
- </itemizedlist>
- <anchor id="quickbook.syntax.block.templates.formal_template_arguments"/>
- <bridgehead renderas="sect5">
- <link linkend="quickbook.syntax.block.templates.formal_template_arguments">Formal
- Template Arguments</link>
- </bridgehead>
- <para>
- Template formal arguments are identifiers consisting of an initial alphabetic
- character or the underscore, followed by zero or more alphanumeric characters
- or the underscore. This is similar to your typical C/C++ identifier.
- </para>
- <para>
- A template formal argument temporarily hides a template of the same name
- at the point where the <link linkend="quickbook.syntax.block.templates.template_expansion">template
- is expanded</link>. Note that the body of the <literal>person</literal>
- template above refers to <literal>name</literal> <literal>age</literal>
- and <literal>what</literal> as <literal>[name]</literal> <literal>[age]</literal>
- and <literal>[what]</literal>. <literal>name</literal> <literal>age</literal>
- and <literal>what</literal> are actually templates that exist in the duration
- of the template call.
- </para>
- <anchor id="quickbook.syntax.block.templates.template_body"/>
- <bridgehead renderas="sect5">
- <link linkend="quickbook.syntax.block.templates.template_body">Template
- Body</link>
- </bridgehead>
- <para>
- 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
- templates are of the form:
- </para>
-
-<programlisting><!--quickbook-escape-prefix-->[template sample[arg1 arg2...argN] replacement text... ]
-<!--quickbook-escape-postfix--></programlisting>
- <para>
- Block templates are of the form:
- </para>
-
-<programlisting><!--quickbook-escape-prefix-->[template sample[arg1 arg2...argN]
-replacement text...
-]
-<!--quickbook-escape-postfix--></programlisting>
- <para>
- The basic rule is as follows: if a newline immediately follows the argument
- list, then it is a block template, otherwise, it is a phrase template.
- Phrase templates are typically expanded as part of phrases. Like macros,
- block level elements are not allowed in phrase templates.
- </para>
- <anchor id="quickbook.syntax.block.templates.template_expansion"/>
- <bridgehead renderas="sect5">
- <link linkend="quickbook.syntax.block.templates.template_expansion">Template
- Expansion</link>
- </bridgehead>
- <para>
- You expand a template this way:
- </para>
-
-<programlisting><!--quickbook-escape-prefix-->[template_identifier arg1..arg2..arg3]
-<!--quickbook-escape-postfix--></programlisting>
- <para>
- At template expansion, you supply the actual arguments. The template will
- be expanded with your supplied arguments. Example:
- </para>
-
-<programlisting><!--quickbook-escape-prefix-->[person James Bond..39..Spy]
-[person Santa Clause..87..Big Red Fatso]
-<!--quickbook-escape-postfix--></programlisting>
- <para>
- Which will expand to:
- </para>
- <para>
- <para>
- Hi, my name is James Bond. I am 39 years old. I am a Spy.
- </para>
- <para>
- Hi, my name is Santa Clause. I am 87 years old. I am a Big Red Fatso.
- </para>
- </para>
- <caution>
- <para>
- <para>
- A word of caution: Templates are recursive. A template can call another
- template or even itself, directly or indirectly. There are no control
- structures in QuickBook (yet) so this will always mean infinite recursion.
- QuickBook can detect this situation and report an error if recursion
- exceeds a certain limit.
- </para>
- </para>
- </caution>
- <para>
- Each actual argument can be a word, a text fragment or just about any
- <link linkend="quickbook.syntax.phrase">QuickBook phrase</link>. Arguments
- are separated by the double dot <literal>".."</literal> and terminated
- by the close parenthesis.
- </para>
- <anchor id="quickbook.syntax.block.templates.nullary_templates"/>
- <bridgehead renderas="sect5">
- <link linkend="quickbook.syntax.block.templates.nullary_templates">Nullary
- Templates</link>
- </bridgehead>
- <para>
- Nullary templates look and act like simple macros. Example:
- </para>
-
-<programlisting><!--quickbook-escape-prefix-->[template alpha[]'''&#945;''']
-[template beta[]'''&#946;''']
-<!--quickbook-escape-postfix--></programlisting>
- <para>
- Expanding:
- </para>
-
-<programlisting><!--quickbook-escape-prefix-->Some squigles...[*[alpha][beta]]<!--quickbook-escape-postfix--></programlisting>
- <para>
- We have:
- </para>
- <para>
- Some squiggles...<emphasis role="bold">αβ</emphasis>
- </para>
- <para>
- The difference with macros are
- </para>
- <itemizedlist>
- <listitem>
- The explicit <link linkend="quickbook.syntax.block.templates.template_expansion">template
- expansion syntax</link>. This is an advantage because, now, we don't
- have to use obscure naming conventions like double underscores (e.g.
- __alpha__) to avoid unwanted macro replacement.
- </listitem>
- <listitem>
- The template is expanded at the point where it is invoked. A macro is
- expanded immediately at its point of declaration. This is subtle and
- can cause a slight difference in behavior especially if you refer to
- other macros and templates in the body.
- </listitem>
- </itemizedlist>
- <para>
- The empty brackets after the template identifier (<literal>alpha[]</literal>)
- indicates no arguments. If the template body does not look like a template
- argument list, we can elide the empty brackets. Example:
- </para>
-
-<programlisting><!--quickbook-escape-prefix-->[template aristotle_quote Aristotle: [*['Education is the best provision
-for the journey to old age.]]]
-<!--quickbook-escape-postfix--></programlisting>
- <para>
- Expanding:
- </para>
-
-<programlisting><!--quickbook-escape-prefix-->Here's a quote from [aristotle_quote].
-<!--quickbook-escape-postfix--></programlisting>
- <para>
- We have:
- </para>
- <para>
- Here's a quote from Aristotle: <emphasis role="bold"><emphasis>Education
- is the best provision for the journey to old age.</emphasis></emphasis>.
- </para>
- <para>
- The disadvantage is that you can't avoid the space between the template
- identifier, <code><phrase role="identifier">aristotle_quote</phrase></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: "<code><phrase role="special">\</phrase> </code>".
- Example:
- </para>
-
-<programlisting><!--quickbook-escape-prefix-->[template tag\ _tag]
-<!--quickbook-escape-postfix--></programlisting>
- <para>
- Then expanding:
- </para>
-
-<programlisting><!--quickbook-escape-prefix-->`struct` x[tag];
-<!--quickbook-escape-postfix--></programlisting>
- <para>
- We have:
- </para>
- <para>
- <code><phrase role="keyword">struct</phrase></code> x_tag;
- </para>
- <para>
- You have a couple of ways to do it. I personally prefer the explicit empty
- brackets, though.
- </para>
- <anchor id="quickbook.syntax.block.templates.simple_arguments"/>
- <bridgehead renderas="sect5">
- <link linkend="quickbook.syntax.block.templates.simple_arguments">Simple
- Arguments</link>
- </bridgehead>
- <para>
- As mentioned, arguments are separated by the double dot <literal>".."</literal>.
- If there are less arguments passed than expected, QuickBook attempts to
- break the last argument into two or more arguments following this logic:
- </para>
- <itemizedlist>
- <listitem>
- Break the last argument into two, at the first space found (<literal>'',
- '\n', \t' or '\r'</literal>).
- </listitem>
- <listitem>
- Repeat until there are enough arguments or if there are no more spaces
- found (in which case, an error is reported).
- </listitem>
- </itemizedlist>
- <para>
- For example:
- </para>
-
-<programlisting><!--quickbook-escape-prefix-->[template simple[a b c d] [a][b][c][d]]
-[simple w x y z]
-<!--quickbook-escape-postfix--></programlisting>
- <para>
- will produce:
- </para>
- <para>
- wxyz
- </para>
- <para>
- "w x y z" is initially treated as a single argument because we
- didn't supply any <literal>".."</literal> separators. However,
- since <literal>simple</literal> expects 4 arguments, "w x y z"
- is broken down iteratively (applying the logic above) until we have "w",
- "x", "y" and "z".
- </para>
- <para>
- QuickBook only tries to get the arguments it needs. For example:
- </para>
-
-<programlisting><!--quickbook-escape-prefix-->[simple w x y z trail]
-<!--quickbook-escape-postfix--></programlisting>
- <para>
- will produce:
- </para>
- <para>
- wxyz trail
- </para>
- <para>
- The arguments being: "w", "x", "y" and "z
- trail".
- </para>
- <para>
- It should be obvious now that for simple arguments with no spaces, we can
- get by without separating the arguments with <literal>".."</literal>
- separators. It is possible to combine <literal>".."</literal>
- separators with the argument passing simplification presented above. Example:
- </para>
-
-<programlisting><!--quickbook-escape-prefix-->[simple what do you think ..m a n?]
-<!--quickbook-escape-postfix--></programlisting>
- <para>
- will produce:
- </para>
- <para>
- what do you think man?
- </para>
- <anchor id="quickbook.syntax.block.templates.punctuation_templates"/>
- <bridgehead renderas="sect5">
- <link linkend="quickbook.syntax.block.templates.punctuation_templates">Punctuation
- Templates</link>
- </bridgehead>
- <para>
- 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
- single character punctuation templates which are fairly common in QuickBook.
- You might have noticed that single character punctuations are allowed as
- <link linkend="quickbook.syntax.block.templates.template_identifier">template
- identifiers</link>. Example:
- </para>
-
-<programlisting><!--quickbook-escape-prefix-->[template ![bar] <!--quickbook-escape-postfix--><hey><!--quickbook-escape-prefix-->[bar]<!--quickbook-escape-postfix--></hey><!--quickbook-escape-prefix-->]
-<!--quickbook-escape-postfix--></programlisting>
- <para>
- Now, expanding this:
- </para>
-
-<programlisting><!--quickbook-escape-prefix-->[!baz]
-<!--quickbook-escape-postfix--></programlisting>
- <para>
- We will have:
- </para>
-
-<programlisting><hey>baz</hey>
-</programlisting>
- </section>
- <section id="quickbook.syntax.block.blurbs">
- <title><link linkend="quickbook.syntax.block.blurbs">Blurbs</link></title>
-
-<programlisting><!--quickbook-escape-prefix-->[blurb :-) [*An eye catching advertisement or note...]
-
- __spirit__ is an object-oriented recursive-descent parser generator framework
- implemented using template meta-programming techniques. Expression templates
- allow us to approximate the syntax of Extended Backus-Normal Form (EBNF)
- completely in C++.
-]
-<!--quickbook-escape-postfix--></programlisting>
- <para>
- will generate this:
- </para>
- <sidebar role="blurb">
- <para>
- <inlinemediaobject><imageobject><imagedata fileref="images/smiley.png"></imagedata></imageobject>
- <textobject>
- <phrase>smiley</phrase>
- </textobject>
- </inlinemediaobject> <emphasis role="bold">An eye catching advertisement
- or note...</emphasis>
- </para>
- <para>
- <ulink url="http://spirit.sourceforge.net">Spirit</ulink> is an object-oriented
- recursive-descent parser generator framework implemented using template
- meta-programming techniques. Expression templates allow us to approximate
- the syntax of Extended Backus-Normal Form (EBNF) completely in C++.
- </para>
- </sidebar>
- <note>
- <para>
- <para>
- Prefer <link linkend="quickbook.syntax.block.admonitions">admonitions</link>
- wherever appropriate.
- </para>
- </para>
- </note>
- </section>
- <section id="quickbook.syntax.block.tables">
- <title><link linkend="quickbook.syntax.block.tables">Tables</link></title>
-
-<programlisting><!--quickbook-escape-prefix-->[table A Simple Table
- [[Heading 1] [Heading 2] [Heading 3]]
- [[R0-C0] [R0-C1] [R0-C2]]
- [[R1-C0] [R1-C1] [R1-C2]]
- [[R2-C0] [R2-C1] [R2-C2]]
-]
-<!--quickbook-escape-postfix--></programlisting>
- <para>
- will generate:
- </para>
- <table frame="all"> <title>A Simple Table</title>
- <tgroup cols="3">
- <thead>
- <row>
- <entry>
- <para>
- Heading 1
- </para>
- </entry><entry>
- <para>
- Heading 2
- </para>
- </entry><entry>
- <para>
- Heading 3
- </para>
- </entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>
- <para>
- R0-C0
- </para>
- </entry><entry>
- <para>
- R0-C1
- </para>
- </entry><entry>
- <para>
- R0-C2
- </para>
- </entry>
- </row>
- <row>
- <entry>
- <para>
- R2-C0
- </para>
- </entry><entry>
- <para>
- R2-C1
- </para>
- </entry><entry>
- <para>
- R2-C2
- </para>
- </entry>
- </row>
- <row>
- <entry>
- <para>
- R3-C0
- </para>
- </entry><entry>
- <para>
- R3-C1
- </para>
- </entry><entry>
- <para>
- R3-C2
- </para>
- </entry>
- </row>
- </tbody>
- </tgroup>
- </table>
- <para>
- The table title is optional. The first row of the table is automatically
- treated as the table header; that is, it is wrapped in <literal><thead>...</thead></literal>
- 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:
- </para>
-
-<programlisting><!--quickbook-escape-prefix-->[table Table with fat cells
- [[Heading 1] [Heading 2]]
- [
- [Row 0, Col 0: a small cell]
- [
- Row 0, Col 1: a big fat cell with paragraphs
-
- Boost provides free peer-reviewed portable C++ source libraries.
-
- We emphasize libraries that work well with the C++ Standard Library.
- Boost libraries are intended to be widely useful, and usable across
- a broad spectrum of applications. The Boost license encourages both
- commercial and non-commercial use.
- ]
- ]
- [
- [Row 1, Col 0: a small cell]
- [Row 1, Col 1: a small cell]
- ]
-]
-<!--quickbook-escape-postfix--></programlisting>
- <para>
- and thus:
- </para>
- <table frame="all"> <title>Table with fat cells</title>
- <tgroup cols="2">
- <thead>
- <row>
- <entry>
- <para>
- Heading 1
- </para>
- </entry><entry>
- <para>
- Heading 2
- </para>
- </entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>
- <para>
- Row 0, Col 0: a small cell
- </para>
- </entry><entry>
- <para>
- Row 0, Col 1: a big fat cell with paragraphs
- </para>
- <para>
- Boost provides free peer-reviewed portable C++ source libraries.
- </para>
- <para>
- We emphasize libraries that work well with the C++ Standard Library.
- Boost libraries are intended to be widely useful, and usable across
- a broad spectrum of applications. The Boost license encourages both
- commercial and non-commercial use.
- </para>
- </entry>
- </row>
- <row>
- <entry>
- <para>
- Row 1, Col 0: a small cell
- </para>
- </entry><entry>
- <para>
- Row 1, Col 1: a small cell
- </para>
- </entry>
- </row>
- </tbody>
- </tgroup>
- </table>
- <para>
- Here's how to have preformatted blocks of code in a table cell:
- </para>
-
-<programlisting><!--quickbook-escape-prefix-->[table Table with code
- [[Comment] [Code]]
- [
- [My first program]
- [<!--quickbook-escape-postfix-->``
- #include <iostream>
-
- int main()
- {
- std::cout << "Hello, World!" << std::endl;
- return 0;
- }
- ``<!--quickbook-escape-prefix-->]
- ]
-]
-<!--quickbook-escape-postfix--></programlisting>
- <table frame="all"> <title>Table with code</title>
- <tgroup cols="2">
- <thead>
- <row>
- <entry>
- <para>
- Comment
- </para>
- </entry><entry>
- <para>
- Code
- </para>
- </entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>
- <para>
- My first program
- </para>
- </entry><entry>
- <para>
-
-<programlisting>
-<phrase role="preprocessor">#include</phrase> <phrase role="special"><</phrase><phrase role="identifier">iostream</phrase><phrase role="special">></phrase>
-
-<phrase role="keyword">int</phrase> <phrase role="identifier">main</phrase><phrase role="special">()</phrase>
-<phrase role="special">{</phrase>
- <phrase role="identifier">std</phrase><phrase role="special">::</phrase><phrase role="identifier">cout</phrase> <phrase role="special"><<</phrase> <phrase role="string">"Hello, World!"</phrase> <phrase role="special"><<</phrase> <phrase role="identifier">std</phrase><phrase role="special">::</phrase><phrase role="identifier">endl</phrase><phrase role="special">;</phrase>
- <phrase role="keyword">return</phrase> <phrase role="number">0</phrase><phrase role="special">;</phrase>
-<phrase role="special">}</phrase>
-</programlisting>
- </para>
- </entry>
- </row>
- </tbody>
- </tgroup>
- </table>
- </section>
- <section id="quickbook.syntax.block.variable_lists">
- <title><link linkend="quickbook.syntax.block.variable_lists">Variable Lists</link></title>
-
-<programlisting><!--quickbook-escape-prefix-->[variablelist A Variable List
- [[term 1] [The definition of term 1]]
- [[term 2] [The definition of term 2]]
- [[term 3] [The definition of term 3]]
-]
-<!--quickbook-escape-postfix--></programlisting>
- <para>
- will generate:
- </para>
- <variablelist>
- <title>A Variable List</title> <varlistentry><term>term 1</term>
- <listitem>
- The definition of term 1
- </listitem>
- </varlistentry> <varlistentry><term>term 2</term>
- <listitem>
- The definition of term 2
- </listitem>
- </varlistentry> <varlistentry><term>term 3</term>
- <listitem>
- The definition of term 3
- </listitem>
- </varlistentry>
- </variablelist>
- <para>
- The rules for variable lists are the same as for tables, except that only
- 2 "columns" are allowed. The first column contains the terms,
- and the second column contains the definitions. Those familiar with HTML
- will recognize this as a "definition list".
- </para>
- </section>
- <section id="quickbook.syntax.block.include">
- <title><link linkend="quickbook.syntax.block.include">Include</link></title>
- <para>
- You can include one QuickBook file from another. The syntax is simply:
- </para>
-
-<programlisting><!--quickbook-escape-prefix-->[include someother.qbk]
-<!--quickbook-escape-postfix--></programlisting>
- <para>
- The included file will be processed as if it had been cut and pasted into
- the current document, with the following exceptions:
- </para>
- <itemizedlist>
- <listitem>
- The __FILENAME__ predefined macro will reflect the name of the file currently being
- processed.
- </listitem>
- <listitem>
- Any macros defined in the included file are scoped to that file.
- </listitem>
- </itemizedlist>
- <para>
- The <literal>[include]</literal> 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:
- </para>
-
-<programlisting><!--quickbook-escape-prefix-->[include:someid someother.qbk]
-<!--quickbook-escape-postfix--></programlisting>
- <para>
- 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 <literal>[link someid.intro The Intro]</literal>.
- </para>
- </section>
- <section id="quickbook.syntax.block.import">
- <title><link linkend="quickbook.syntax.block.import">Import</link></title>
- <para>
- 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
- file, doing so is error prone and the extracted code in the documentation
- tends to get out of sync with the actual code as the code evolves. The
- problem, as always, is that once documentation is written, the tendency
- is for the docs to languish in the archives without maintenance.
- </para>
- <para>
- QuickBook's import facility provides a nice solution.
- </para>
- <anchor id="quickbook.syntax.block.import.example"/>
- <bridgehead renderas="sect5">
- <link linkend="quickbook.syntax.block.import.example">Example</link>
- </bridgehead>
- <para>
- You can effortlessly import code snippets from source code into your QuickBook.
- The following illustrates how this is done:
- </para>
-
-<programlisting><!--quickbook-escape-prefix-->[import ../test/stub.cpp]
-[foo]
-[bar]
-<!--quickbook-escape-postfix--></programlisting>
- <para>
- The first line:
- </para>
-
-<programlisting><!--quickbook-escape-prefix-->[import ../test/stub.cpp]
-<!--quickbook-escape-postfix--></programlisting>
- <para>
- collects specially marked-up code snippets from <ulink url="../../test/stub.cpp">stub.cpp</ulink>
- and places them in your QuickBook file as virtual templates. Each of the
- specially marked-up code snippets has a name (e.g. <code><phrase role="identifier">foo</phrase></code>
- and <code><phrase role="identifier">bar</phrase></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:
- </para>
-
-<programlisting><!--quickbook-escape-prefix-->[foo]
-[bar]
-<!--quickbook-escape-postfix--></programlisting>
- <para>
- And the result is:
- </para>
- <para>
- This is the <emphasis role="bold"><emphasis>foo</emphasis></emphasis> function.
-
-<programlisting>
-<phrase role="identifier">std</phrase><phrase role="special">::</phrase><phrase role="identifier">string</phrase> <phrase role="identifier">foo</phrase><phrase role="special">()</phrase>
-<phrase role="special">{</phrase>
- <phrase role="comment">// return 'em, foo man!
-</phrase> <phrase role="keyword">return</phrase> <phrase role="string">"foo"</phrase><phrase role="special">;</phrase>
-<phrase role="special">}</phrase>
-</programlisting>
- <calloutlist></calloutlist>
-This is the <emphasis role="bold"><emphasis>bar</emphasis></emphasis> function
-
-<programlisting>
-<phrase role="identifier">std</phrase><phrase role="special">::</phrase><phrase role="identifier">string</phrase> <phrase role="identifier">bar</phrase><phrase role="special">()</phrase>
-<phrase role="special">{</phrase>
- <phrase role="comment">// return 'em, bar man!
-</phrase> <phrase role="keyword">return</phrase> <phrase role="string">"bar"</phrase><phrase role="special">;</phrase>
-<phrase role="special">}</phrase>
-</programlisting>
- <calloutlist></calloutlist>
- </para>
- <anchor id="quickbook.syntax.block.import.code_snippet_markup"/>
- <bridgehead renderas="sect5">
- <link linkend="quickbook.syntax.block.import.code_snippet_markup">Code
- Snippet Markup</link>
- </bridgehead>
- <para>
- Note how the code snippets in <ulink url="../../test/stub.cpp">stub.cpp</ulink>
- get marked up. We use distinguishable comments following the form:
- </para>
-
-<programlisting>
-<phrase role="comment">//[id
-</phrase><phrase role="identifier">some</phrase> <phrase role="identifier">code</phrase> <phrase role="identifier">here</phrase>
-<phrase role="comment">//]
-</phrase></programlisting>
- <para>
- The first comment line above initiates a named code-snippet. This prefix
- will not be visible in quickbook. The entire code-snippet in between <code><phrase
- role="comment">//[id</phrase></code> and <code><phrase role="comment">//]</phrase></code>
- will be inserted as a template in quickbook with name <emphasis><emphasis>id</emphasis></emphasis>.
- The comment <code><phrase role="comment">//]</phrase></code> ends a code-snippet
- This too will not be visible in quickbook.
- </para>
- <anchor id="quickbook.syntax.block.import.special_comments"/>
- <bridgehead renderas="sect5">
- <link linkend="quickbook.syntax.block.import.special_comments">Special
- Comments</link>
- </bridgehead>
- <para>
- Special comments of the form:
- </para>
-
-<programlisting>
-<phrase role="comment">//` some [*quickbook] markup here
-</phrase></programlisting>
- <para>
- and:
- </para>
-
-<programlisting>
-<phrase role="comment">/*` some [*quickbook] markup here */</phrase>
-</programlisting>
- <para>
- will be parsed by QuickBook. This can contain quickbook <emphasis>blocks</emphasis>
- (e.g. sections, paragraphs, tables, etc). In the first case, the initial
- slash-slash, tick and white-space shall be ignored. In the second, the
- initial slash-star-tick and the final star-slash shall be ignored.
- </para>
- <anchor id="quickbook.syntax.block.import.callouts"/>
- <bridgehead renderas="sect5">
- <link linkend="quickbook.syntax.block.import.callouts">Callouts</link>
- </bridgehead>
- <para>
- Special comments of the form:
- </para>
-
-<programlisting>
-<phrase role="comment">/*< some [*quickbook] markup here >*/</phrase>
-</programlisting>
- <para>
- will be regarded as callouts. These will be collected, numbered and rendered
- as a "callout bug" (a small icon with a number). After the whole
- snippet is parsed, the callout list is generated. See <ulink url="http://www.docbook.org/tdg/en/html/callout.html">Callouts</ulink>
- for details. Example:
- </para>
- <para>
- <para>
-
-<programlisting>
-<phrase role="identifier">std</phrase><phrase role="special">::</phrase><phrase role="identifier">string</phrase> <phrase role="identifier">foo_bar</phrase><phrase role="special">()</phrase> <!--quickbook-escape-prefix--><co id="quickbook0co" linkends="quickbook0" /><!--quickbook-escape-postfix-->
-<phrase role="special">{</phrase>
- <phrase role="keyword">return</phrase> <phrase role="string">"foo-bar"</phrase><phrase role="special">;</phrase> <!--quickbook-escape-prefix--><co id="quickbook1co" linkends="quickbook1" /><!--quickbook-escape-postfix-->
-<phrase role="special">}</phrase>
-</programlisting>
- </para>
- <para>
- <calloutlist><callout arearefs="quickbook0co" id="quickbook0"><para> The <emphasis role="bold">Mythical</emphasis> FooBar. See <ulink url="http://en.wikipedia.org/wiki/Foobar">Foobar
- for details</ulink> </para></callout><callout arearefs="quickbook1co" id="quickbook1"><para> return 'em, foo-bar man! </para></callout></calloutlist>
- </para>
- </para>
- <para>
- Checkout <ulink url="../../test/stub.cpp">stub.cpp</ulink> to see the actual
- code.
- </para>
- </section>
- </section>
- </section>
- <section id="quickbook.install">
- <title><link linkend="quickbook.install"> Installation and configuration</link></title>
- <para>
- This section provides some guidelines on how to install and configure BoostBook
- and Quickbook under several operating systems.
- </para>
- <para>
- 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 <code><phrase role="identifier">bin</phrase></code>
- and <code><phrase role="identifier">bin</phrase><phrase role="special">.</phrase><phrase
- role="identifier">v2</phrase></code> directories generated by the build before
- trying again. Otherwise your configuration fixes will not take any effect.
- </para>
- <section id="quickbook.install.windows">
- <title><link linkend="quickbook.install.windows"> Windows 2000, XP, 2003, Vista</link></title>
- <para>
- </para>
- <blockquote>
- <para>
- <para>
- <emphasis>Section contributed by Julio M. Merino Vidal</emphasis>
- </para>
- </para>
- </blockquote>
- <para>
- The following instructions apply to any Windows system based on Windows 2000,
- including Windows XP, Windows 2003 Server and Windows Vista. The paths shown
- below are taken from a Windows Vista machine; you will need to adjust them
- to match your system in case you are running an older version.
- </para>
- <orderedlist>
- <listitem>
- First of all you need to have a copy of <code><phrase role="identifier">xsltproc</phrase></code>
- for Windows. There are many ways to get this tool, but to keep things simple,
- use the <ulink url="http://www.zlatkovic.com/pub/libxml/">binary packages</ulink>
- made by Igor Zlatkovic. At the very least, you need to download the following
- packages: <code><phrase role="identifier">iconv</phrase></code>, <code><phrase
- role="identifier">zlib</phrase></code>, <code><phrase role="identifier">libxml2</phrase></code>
- and <code><phrase role="identifier">libxslt</phrase></code>.
- </listitem>
- <listitem>
- Unpack all these packages in the same directory so that you get unique
- <code><phrase role="identifier">bin</phrase></code>, <code><phrase role="identifier">include</phrase></code>
- and <code><phrase role="identifier">lib</phrase></code> directories within
- the hierarchy. These instructions use <code><phrase role="identifier">C</phrase><phrase
- role="special">:\</phrase><phrase role="identifier">Users</phrase><phrase
- role="special">\</phrase><phrase role="identifier">example</phrase><phrase
- role="special">\</phrase><phrase role="identifier">Documents</phrase><phrase
- role="special">\</phrase><phrase role="identifier">boost</phrase><phrase
- role="special">\</phrase><phrase role="identifier">xml</phrase></code>
- as the root for all files.
- </listitem>
- <listitem>
- From the command line, go to the <code><phrase role="identifier">bin</phrase></code>
- directory and launch <code><phrase role="identifier">xsltproc</phrase><phrase
- role="special">.</phrase><phrase role="identifier">exe</phrase></code>
- to ensure it works. You should get usage information on screen.
- </listitem>
- <listitem>
- Download <ulink url="http://www.docbook.org/xml/4.2/docbook-xml-4.2.zip">Docbook
- XML 4.2</ulink> and unpack it in the same directory used above. That is:
- <code><phrase role="identifier">C</phrase><phrase role="special">:\</phrase><phrase
- role="identifier">Users</phrase><phrase role="special">\</phrase><phrase
- role="identifier">example</phrase><phrase role="special">\</phrase><phrase
- role="identifier">Documents</phrase><phrase role="special">\</phrase><phrase
- role="identifier">boost</phrase><phrase role="special">\</phrase><phrase
- role="identifier">xml</phrase><phrase role="special">\</phrase><phrase
- role="identifier">docbook</phrase><phrase role="special">-</phrase><phrase
- role="identifier">xml</phrase></code>.
- </listitem>
- <listitem>
- Download the latest <ulink url="http://sourceforge.net/project/showfiles.php?group_id=21935&package_id=16608">Docbook
- XSL</ulink> version and unpack it, again in the same directory used before.
- To make things easier, rename the directory created during the extraction
- to <code><phrase role="identifier">docbook</phrase><phrase role="special">-</phrase><phrase
- role="identifier">xsl</phrase></code> (bypassing the version name): <code><phrase
- role="identifier">C</phrase><phrase role="special">:\</phrase><phrase role="identifier">Users</phrase><phrase
- role="special">\</phrase><phrase role="identifier">example</phrase><phrase
- role="special">\</phrase><phrase role="identifier">Documents</phrase><phrase
- role="special">\</phrase><phrase role="identifier">boost</phrase><phrase
- role="special">\</phrase><phrase role="identifier">xml</phrase><phrase
- role="special">\</phrase><phrase role="identifier">docbook</phrase><phrase
- role="special">-</phrase><phrase role="identifier">xsl</phrase></code>.
- </listitem>
- <listitem>
- Add the following to your <code><phrase role="identifier">user</phrase><phrase
- role="special">-</phrase><phrase role="identifier">config</phrase><phrase
- role="special">.</phrase><phrase role="identifier">jam</phrase></code>
- file, which should live in your home directory (<code><phrase role="special">%</phrase><phrase
- role="identifier">HOMEDRIVE</phrase><phrase role="special">%%</phrase><phrase
- role="identifier">HOMEPATH</phrase><phrase role="special">%</phrase></code>).
- You must already have it somewhere or otherwise you could not be building
- Boost (i.e. missing tools configuration).
- </listitem>
- </orderedlist>
-
-<programlisting>
-<phrase role="identifier">using</phrase> <phrase role="identifier">xsltproc</phrase>
- <phrase role="special">:</phrase> <phrase role="string">"C:/Users/example/Documents/boost/xml/bin/xsltproc.exe"</phrase>
- <phrase role="special">;</phrase>
-
-<phrase role="identifier">using</phrase> <phrase role="identifier">boostbook</phrase>
- <phrase role="special">:</phrase> <phrase role="string">"C:/Users/example/Documents/boost/xml/docbook-xsl"</phrase>
- <phrase role="special">:</phrase> <phrase role="string">"C:/Users/example/Documents/boost/xml/docbook-xml"</phrase>
- <phrase role="special">;</phrase>
-</programlisting>
- <para>
- The above steps are enough to get a functional BoostBook setup. Quickbook
- will be automatically built when needed. If you want to avoid these rebuilds:
- </para>
- <orderedlist>
- <listitem>
- Go to Quickbook's source directory (<code><phrase role="identifier">BOOST_ROOT</phrase><phrase
- role="special">\</phrase><phrase role="identifier">tools</phrase><phrase
- role="special">\</phrase><phrase role="identifier">quickbook</phrase></code>).
- </listitem>
- <listitem>
- Build the utility by issuing <code><phrase role="identifier">bjam</phrase>
- <phrase role="special">--</phrase><phrase role="identifier">v2</phrase></code>.
- </listitem>
- <listitem>
- Copy the resulting <code><phrase role="identifier">quickbook</phrase><phrase
- role="special">.</phrase><phrase role="identifier">exe</phrase></code>
- binary (located under the <code><phrase role="identifier">BOOST_ROOT</phrase><phrase
- role="special">\</phrase><phrase role="identifier">bin</phrase><phrase
- role="special">.</phrase><phrase role="identifier">v2</phrase></code> hierarchy)
- to a safe place. Following our previous example, you can install it into:
- <code><phrase role="identifier">C</phrase><phrase role="special">:\</phrase><phrase
- role="identifier">Users</phrase><phrase role="special">\</phrase><phrase
- role="identifier">example</phrase><phrase role="special">\</phrase><phrase
- role="identifier">Documents</phrase><phrase role="special">\</phrase><phrase
- role="identifier">boost</phrase><phrase role="special">\</phrase><phrase
- role="identifier">xml</phrase><phrase role="special">\</phrase><phrase
- role="identifier">bin</phrase></code>.
- </listitem>
- <listitem>
- Add the following to your <code><phrase role="identifier">user</phrase><phrase
- role="special">-</phrase><phrase role="identifier">config</phrase><phrase
- role="special">.</phrase><phrase role="identifier">jam</phrase></code>
- file:
- </listitem>
- </orderedlist>
-
-<programlisting>
-<phrase role="identifier">using</phrase> <phrase role="identifier">quickbook</phrase>
- <phrase role="special">:</phrase> <phrase role="string">"C:/Users/example/Documents/boost/xml/bin/quickbook.exe"</phrase>
- <phrase role="special">;</phrase>
-</programlisting>
- </section>
- <section id="quickbook.install.linux">
- <title><link linkend="quickbook.install.linux"> Debian, Ubuntu</link></title>
- <para>
- 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.
- </para>
- <para>
- First install the <code><phrase role="identifier">bjam</phrase></code>,
- <code><phrase role="identifier">xsltproc</phrase></code>, <code><phrase role="identifier">docbook</phrase><phrase
- role="special">-</phrase><phrase role="identifier">xsl</phrase></code> and
- <code><phrase role="identifier">docbook</phrase><phrase role="special">-</phrase><phrase
- role="identifier">xml</phrase></code> packages. For example, using <code><phrase
- role="identifier">apt</phrase><phrase role="special">-</phrase><phrase role="identifier">get</phrase></code>:
- </para>
-
-<programlisting>
-<phrase role="identifier">sudo</phrase> <phrase role="identifier">apt</phrase><phrase role="special">-</phrase><phrase role="identifier">get</phrase> <phrase role="identifier">install</phrase> <phrase role="identifier">xsltprc</phrase> <phrase role="identifier">docbook</phrase><phrase role="special">-</phrase><phrase role="identifier">xsl</phrase> <phrase role="identifier">docbook</phrase><phrase role="special">-</phrase><phrase role="identifier">xml</phrase>
-</programlisting>
- <para>
- If you're planning on building boost's documentation, you'll also need to
- install the <code><phrase role="identifier">doxygen</phrase></code> package
- as well.
- </para>
- <para>
- Next, we need to configure Boost Build to compile BoostBook files. Add the
- following to your <code><phrase role="identifier">user</phrase><phrase role="special">-</phrase><phrase
- role="identifier">config</phrase><phrase role="special">.</phrase><phrase
- role="identifier">jam</phrase></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 <code><phrase role="identifier">user</phrase><phrase
- role="special">-</phrase><phrase role="identifier">config</phrase><phrase
- role="special">.</phrase><phrase role="identifier">jam</phrase></code>, see
- the <ulink url="http://boost.org/boost-build2/doc/html/bbv2/advanced/configuration.html">Boost
- Build documentation</ulink>.
- </para>
-
-<programlisting>
-<phrase role="identifier">using</phrase> <phrase role="identifier">xsltproc</phrase> <phrase role="special">;</phrase>
-
-<phrase role="identifier">using</phrase> <phrase role="identifier">boostbook</phrase>
- <phrase role="special">:</phrase> <phrase role="special">/</phrase><phrase role="identifier">usr</phrase><phrase role="special">/</phrase><phrase role="identifier">share</phrase><phrase role="special">/</phrase><phrase role="identifier">xml</phrase><phrase role="special">/</phrase><phrase role="identifier">docbook</phrase><phrase role="special">/</phrase><phrase role="identifier">stylesheet</phrase><phrase role="special">/</phrase><phrase role="identifier">nwalsh</phrase>
- <phrase role="special">:</phrase> <phrase role="special">/</phrase><phrase role="identifier">usr</phrase><phrase role="special">/</phrase><phrase role="identifier">share</phrase><phrase role="special">/</phrase><phrase role="identifier">xml</phrase><phrase role="special">/</phrase><phrase role="identifier">docbook</phrase><phrase role="special">/</phrase><phrase role="identifier">schema</phrase><phrase role="special">/</phrase><phrase role="identifier">dtd</phrase><phrase role="special">/</phrase><phrase role="number">4.2</phrase>
- <phrase role="special">;</phrase>
-
-<phrase role="comment"># Remove this line if you're not using doxygen
-</phrase><phrase role="identifier">using</phrase> <phrase role="identifier">doxygen</phrase> <phrase role="special">;</phrase>
-</programlisting>
- <para>
- The above steps are enough to get a functional BoostBook setup. Quickbook
- will be automatically built when needed. If you want to avoid these rebuilds:
- </para>
- <orderedlist>
- <listitem>
- Go to Quickbook's source directory (<code><phrase role="identifier">BOOST_ROOT</phrase><phrase
- role="special">/</phrase><phrase role="identifier">tools</phrase><phrase
- role="special">/</phrase><phrase role="identifier">quickbook</phrase></code>).
- </listitem>
- <listitem>
- Build the utility by issuing <code><phrase role="identifier">bjam</phrase>
- <phrase role="special">--</phrase><phrase role="identifier">v2</phrase></code>.
- </listitem>
- <listitem>
- Copy the resulting <code><phrase role="identifier">quickbook</phrase></code>
- binary (located under the <code><phrase role="identifier">BOOST_ROOT</phrase><phrase
- role="special">/</phrase><phrase role="identifier">bin</phrase><phrase
- role="special">.</phrase><phrase role="identifier">v2</phrase></code> hierarchy)
- to a safe place. The traditional location is <code><phrase role="special">/</phrase><phrase
- role="identifier">usr</phrase><phrase role="special">/</phrase><phrase
- role="identifier">local</phrase><phrase role="special">/</phrase><phrase
- role="identifier">bin</phrase></code>.
- </listitem>
- <listitem>
- Add the following to your <code><phrase role="identifier">user</phrase><phrase
- role="special">-</phrase><phrase role="identifier">config</phrase><phrase
- role="special">.</phrase><phrase role="identifier">jam</phrase></code>
- file, using the full path of the quickbook executable:
- </listitem>
- </orderedlist>
-
-<programlisting>
-<phrase role="identifier">using</phrase> <phrase role="identifier">quickbook</phrase>
- <phrase role="special">:</phrase> <phrase role="special">/</phrase><phrase role="identifier">usr</phrase><phrase role="special">/</phrase><phrase role="identifier">local</phrase><phrase role="special">/</phrase><phrase role="identifier">bin</phrase><phrase role="special">/</phrase><phrase role="identifier">quickbook</phrase>
- <phrase role="special">;</phrase>
-</programlisting>
- </section>
- </section>
- <section id="quickbook.editors">
- <title><link linkend="quickbook.editors"> Editor Support</link></title>
- <para>
- Editing quickbook files is usually done with text editors both simple and powerful.
- The following sections list the settings for some editors which can help make
- editing quickbook files a bit easier.
- </para>
- <sidebar role="blurb">
- <para>
- <inlinemediaobject><imageobject><imagedata fileref="images/note.png"></imagedata></imageobject>
- <textobject>
- <phrase>note</phrase>
- </textobject>
- </inlinemediaobject> You may submit your settings, tips, and suggestions to
- the authors, or through the <ulink url="https://lists.sourceforge.net/lists/listinfo/boost-">docs
- Boost Docs mailing list</ulink>.
- </para>
- </sidebar>
- <section id="quickbook.editors.scite">
- <title><link linkend="quickbook.editors.scite"> Scintilla Text Editor</link></title>
- <blockquote>
- <para>
- <para>
- <emphasis>Section contributed by Dean Michael Berris</emphasis>
- </para>
- </para>
- </blockquote>
- <para>
- The Scintilla Text Editor (SciTE) is a free source code editor for Win32
- and X. It uses the SCIntilla source code editing component.
- </para>
- <sidebar role="blurb">
- <para>
- <inlinemediaobject><imageobject><imagedata fileref="images/tip.png"></imagedata></imageobject>
- <textobject>
- <phrase>tip</phrase>
- </textobject>
- </inlinemediaobject> SciTE can be downloaded from <ulink url="http://www.scintilla.org/SciTE.html">http://www.scintilla.org/SciTE.html>
- </para>
- </sidebar>
- <para>
- You can use the following settings to highlight quickbook tags when editing
- quickbook files.
- </para>
-
-<programlisting><!--quickbook-escape-prefix-->qbk=*.qbk
-lexer.*.qbk=props
-use.tabs.$(qbk)=0
-tab.size.$(qbk)=4
-indent.size.$(qbk)=4
-style.props.32=$(font.base)
-comment.stream.start.props=[/
-comment.stream.end.props=]
-comment.box.start.props=[/
-comment.box.middle.props=
-comment.box.end.props=]
-<!--quickbook-escape-postfix--></programlisting>
- <sidebar role="blurb">
- <para>
- <inlinemediaobject><imageobject><imagedata fileref="images/note.png"></imagedata></imageobject>
- <textobject>
- <phrase>note</phrase>
- </textobject>
- </inlinemediaobject> Thanks to Rene Rivera for the above SciTE settings.
- </para>
- </sidebar>
- </section>
- </section>
- <section id="quickbook.faq">
- <title><link linkend="quickbook.faq"> Frequently Asked Questions</link></title>
- <anchor id="quickbook.faq.can_i_use_quickbook_for_non_boost_documentation_"/>
- <bridgehead renderas="sect3">
- <link linkend="quickbook.faq.can_i_use_quickbook_for_non_boost_documentation_">Can
- I use QuickBook for non-Boost documentation?</link>
- </bridgehead>
- <para>
- QuickBook can be used for non-Boost documentation with a little extra work.
- </para>
- <blockquote>
- <para>
- <para>
- <emphasis>Faq contributed by Michael Marcin</emphasis>
- </para>
- </para>
- </blockquote>
- <para>
- When building HTML documentation with BoostBook a Boost C++ Libraries header
- is added to the files. When using QuickBook to document projects outside of
- Boost this is not desirable. This behavior can be overridden at the BoostBook
- level by specifying some XSLT options. When using Boost Build version 2 (BBv2)
- this can be achieved by adding parameters to the BoostBook target declaration.
- </para>
- <para>
- For example:
- </para>
-
-<programlisting>using quickbook ;
-
-xml my_doc : my_doc.qbk ;
-
-boostbook standalone
- :
- my_doc
- :
- <xsl:param>boost.image.src<literal>images/my_project_logo.png
- <xsl:param>boost.image.alt</literal>"\"My Project\""
- <xsl:param>boost.image.w=100
- <xsl:param>boost.image.h=50
- <xsl:param>nav.layout=none
- ;
-</programlisting>
- </section>
- <section id="quickbook.ref">
- <title><link linkend="quickbook.ref"> Quick Reference</link></title>
- <para>
- [cpp]
- </para>
- <table frame="all"> <title>Syntax Compendium</title>
- <tgroup cols="3">
- <thead>
- <row>
- <entry>
- <para>
- To do this...
- </para>
- </entry><entry>
- <para>
- Use this...
- </para>
- </entry><entry>
- <para>
- See this...
- </para>
- </entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>
- <para>
- comment
- </para>
- </entry><entry>
- <para>
- <literal>[/ some comment]</literal>
- </para>
- </entry><entry>
- <para>
- <link linkend="quickbook.syntax.comments">Comments</link>
- </para>
- </entry>
- </row>
- <row>
- <entry>
- <para>
- <emphasis>italics</emphasis>
- </para>
- </entry><entry>
- <para>
- <literal>['italics] or /italics/</literal>
- </para>
- </entry><entry>
- <para>
- <link linkend="quickbook.syntax.phrase.font_styles">Font Styles</link>
- and <link linkend="quickbook.syntax.phrase.simple_formatting">Simple
- formatting</link>
- </para>
- </entry>
- </row>
- <row>
- <entry>
- <para>
- <emphasis role="bold">bold</emphasis>
- </para>
- </entry><entry>
- <para>
- <literal>[*bold] or *bold*</literal>
- </para>
- </entry><entry>
- <para>
- <link linkend="quickbook.syntax.phrase.font_styles">Font Styles</link>
- and <link linkend="quickbook.syntax.phrase.simple_formatting">Simple
- formatting</link>
- </para>
- </entry>
- </row>
- <row>
- <entry>
- <para>
- <emphasis role="underline">underline</emphasis>
- </para>
- </entry><entry>
- <para>
- <literal>[_underline] or _underline_</literal>
- </para>
- </entry><entry>
- <para>
- <link linkend="quickbook.syntax.phrase.font_styles">Font Styles</link>
- and <link linkend="quickbook.syntax.phrase.simple_formatting">Simple
- formatting</link>
- </para>
- </entry>
- </row>
- <row>
- <entry>
- <para>
- <literal>teletype</literal>
- </para>
- </entry><entry>
- <para>
- <literal>[^teletype] or =teletype=</literal>
- </para>
- </entry><entry>
- <para>
- <link linkend="quickbook.syntax.phrase.font_styles">Font Styles</link>
- and <link linkend="quickbook.syntax.phrase.simple_formatting">Simple
- formatting</link>
- </para>
- </entry>
- </row>
- <row>
- <entry>
- <para>
- <emphasis role="strikethrough">strikethrough</emphasis>
- </para>
- </entry><entry>
- <para>
- <literal>[-strikethrough]</literal>
- </para>
- </entry><entry>
- <para>
- <link linkend="quickbook.syntax.phrase.font_styles">Font Styles</link>
- and <link linkend="quickbook.syntax.phrase.simple_formatting">Simple
- formatting</link>
- </para>
- </entry>
- </row>
- <row>
- <entry>
- <para>
- <replaceable>
- replaceable
- </replaceable>
- </para>
- </entry><entry>
- <para>
- <literal>[~replaceable]</literal>
- </para>
- </entry><entry>
- <para>
- <link linkend="quickbook.syntax.phrase.replaceable">Replaceble</link>
- </para>
- </entry>
- </row>
- <row>
- <entry>
- <para>
- source mode
- </para>
- </entry><entry>
- <para>
- <literal>[c++]</literal> or <literal>[python]</literal>
- </para>
- </entry><entry>
- <para>
- <link linkend="quickbook.syntax.phrase.source_mode">Source Mode</link>
- </para>
- </entry>
- </row>
- <row>
- <entry>
- <para>
- inline code
- </para>
- </entry><entry>
- <para>
- <literal>`int main();`</literal>
- </para>
- </entry><entry>
- <para>
- <link linkend="quickbook.syntax.phrase.inline_code">Inline code</link>
- </para>
- </entry>
- </row>
- <row>
- <entry>
- <para>
- code block
- </para>
- </entry><entry>
- <para>
- <literal>``int main();``</literal>
- </para>
- </entry><entry>
- <para>
- <link linkend="quickbook.syntax.block.code">Code</link>
- </para>
- </entry>
- </row>
- <row>
- <entry>
- <para>
- code escape
- </para>
- </entry><entry>
- <para>
- <literal>``from c++ to QuickBook``</literal>
- </para>
- </entry><entry>
- <para>
- <link linkend="quickbook.syntax.block.escape_back">Escaping Back To QuickBook</link>
- </para>
- </entry>
- </row>
- <row>
- <entry>
- <para>
- line break
- </para>
- </entry><entry>
- <para>
- <literal>[br] or \n</literal>
- </para>
- </entry><entry>
- <para>
- <link linkend="quickbook.syntax.phrase.line_break">line-break</link>
- <emphasis role="bold">DEPRECATED</emphasis>
- </para>
- </entry>
- </row>
- <row>
- <entry>
- <para>
- anchor
- </para>
- </entry><entry>
- <para>
- <literal>[#anchor]</literal>
- </para>
- </entry><entry>
- <para>
- <link linkend="quickbook.syntax.phrase.anchors">Anchors</link>
- </para>
- </entry>
- </row>
- <row>
- <entry>
- <para>
- link
- </para>
- </entry><entry>
- <para>
- <literal>[@http://www.boost.org Boost]</literal>
- </para>
- </entry><entry>
- <para>
- <link linkend="quickbook.syntax.phrase.links">Links</link>
- </para>
- </entry>
- </row>
- <row>
- <entry>
- <para>
- anchor link
- </para>
- </entry><entry>
- <para>
- <literal>[link section.anchor Link text]</literal>
- </para>
- </entry><entry>
- <para>
- <link linkend="quickbook.syntax.phrase.anchor_links">Anchor links</link>
- </para>
- </entry>
- </row>
- <row>
- <entry>
- <para>
- refentry link
- </para>
- </entry><entry>
- <para>
- <literal>[link xml.refentry Link text]</literal>
- </para>
- </entry><entry>
- <para>
- <link linkend="quickbook.syntax.phrase.refentry_links">refentry links</link>
- </para>
- </entry>
- </row>
- <row>
- <entry>
- <para>
- function link
- </para>
- </entry><entry>
- <para>
- <literal>[funcref fully::qualified::function_name Link text]</literal>
- </para>
- </entry><entry>
- <para>
- <link linkend="quickbook.syntax.phrase.code_links">function, class, member,
- enum, macro, concept or header links</link>
- </para>
- </entry>
- </row>
- <row>
- <entry>
- <para>
- class link
- </para>
- </entry><entry>
- <para>
- <literal>[classref fully::qualified::class_name Link text]</literal>
- </para>
- </entry><entry>
- <para>
- <link linkend="quickbook.syntax.phrase.code_links">function, class, member,
- enum, macro, concept or header links</link>
- </para>
- </entry>
- </row>
- <row>
- <entry>
- <para>
- member link
- </para>
- </entry><entry>
- <para>
- <literal>[memberref fully::qualified::member_name Link text]</literal>
- </para>
- </entry><entry>
- <para>
- <link linkend="quickbook.syntax.phrase.code_links">function, class, member,
- enum, macro, concept or header links</link>
- </para>
- </entry>
- </row>
- <row>
- <entry>
- <para>
- enum link
- </para>
- </entry><entry>
- <para>
- <literal>[enumref fully::qualified::enum_name Link text]</literal>
- </para>
- </entry><entry>
- <para>
- <link linkend="quickbook.syntax.phrase.code_links">function, class, member,
- enum, macro, concept or header links</link>
- </para>
- </entry>
- </row>
- <row>
- <entry>
- <para>
- macro link
- </para>
- </entry><entry>
- <para>
- <literal>[macroref MACRO_NAME Link text]</literal>
- </para>
- </entry><entry>
- <para>
- <link linkend="quickbook.syntax.phrase.code_links">function, class, member,
- enum, macro, concept or header links</link>
- </para>
- </entry>
- </row>
- <row>
- <entry>
- <para>
- concept link
- </para>
- </entry><entry>
- <para>
- <literal>[conceptref ConceptName Link text]</literal>
- </para>
- </entry><entry>
- <para>
- <link linkend="quickbook.syntax.phrase.code_links">function, class, member,
- enum, macro, concept or header links</link>
- </para>
- </entry>
- </row>
- <row>
- <entry>
- <para>
- header link
- </para>
- </entry><entry>
- <para>
- <literal>[headerref path/to/header.hpp Link text]</literal>
- </para>
- </entry><entry>
- <para>
- <link linkend="quickbook.syntax.phrase.code_links">function, class, member,
- enum, macro, concept or header links</link>
- </para>
- </entry>
- </row>
- <row>
- <entry>
- <para>
- escape
- </para>
- </entry><entry>
- <para>
- <literal>'''escaped text (no processing/formatting)'''</literal>
- </para>
- </entry><entry>
- <para>
- <link linkend="quickbook.syntax.phrase.escape">Escape</link>
- </para>
- </entry>
- </row>
- <row>
- <entry>
- <para>
- single char escape
- </para>
- </entry><entry>
- <para>
- <literal>\c</literal>
- </para>
- </entry><entry>
- <para>
- <link linkend="quickbook.syntax.phrase.single_char_escape">Single char
- escape</link>
- </para>
- </entry>
- </row>
- <row>
- <entry>
- <para>
- images
- </para>
- </entry><entry>
- <para>
- <literal>[$image.jpg]</literal>
- </para>
- </entry><entry>
- <para>
- <link linkend="quickbook.syntax.phrase.images">Images</link>
- </para>
- </entry>
- </row>
- <row>
- <entry>
- <para>
- begin section
- </para>
- </entry><entry>
- <para>
- <literal>[section The Section Title]</literal>
- </para>
- </entry><entry>
- <para>
- <link linkend="quickbook.syntax.block.section">Section</link>
- </para>
- </entry>
- </row>
- <row>
- <entry>
- <para>
- end section
- </para>
- </entry><entry>
- <para>
- <literal>[endsect]</literal>
- </para>
- </entry><entry>
- <para>
- <link linkend="quickbook.syntax.block.section">Section</link>
- </para>
- </entry>
- </row>
- <row>
- <entry>
- <para>
- paragraph
- </para>
- </entry><entry>
- <para>
- No markup. Paragraphs start left-flushed and are terminated by two or
- more newlines.
- </para>
- </entry><entry>
- <para>
- <link linkend="quickbook.syntax.block.paragraphs">Paragraphs</link>
- </para>
- </entry>
- </row>
- <row>
- <entry>
- <para>
- ordered list
- </para>
- </entry><entry>
- <para>
-
-<programlisting><!--quickbook-escape-prefix--># one
-# two
-# three
-<!--quickbook-escape-postfix--></programlisting>
- </para>
- </entry><entry>
- <para>
- <link linkend="quickbook.syntax.block.lists.ordered_lists">Ordered lists</link>
- </para>
- </entry>
- </row>
- <row>
- <entry>
- <para>
- unordered list
- </para>
- </entry><entry>
- <para>
-
-<programlisting><!--quickbook-escape-prefix-->* one
-* two
-* three
-<!--quickbook-escape-postfix--></programlisting>
- </para>
- </entry><entry>
- <para>
- <link linkend="quickbook.syntax.block.lists.unordered_lists">Unordered
- lists</link>
- </para>
- </entry>
- </row>
- <row>
- <entry>
- <para>
- code
- </para>
- </entry><entry>
- <para>
- No markup. Preformatted code starts with a space or a tab.
- </para>
- </entry><entry>
- <para>
- <link linkend="quickbook.syntax.block.code">Code</link>
- </para>
- </entry>
- </row>
- <row>
- <entry>
- <para>
- preformatted
- </para>
- </entry><entry>
- <para>
- <literal>[pre preformatted]</literal>
- </para>
- </entry><entry>
- <para>
- <link linkend="quickbook.syntax.block.preformatted">Preformatted</link>
- </para>
- </entry>
- </row>
- <row>
- <entry>
- <para>
- block quote
- </para>
- </entry><entry>
- <para>
- <literal>[:sometext...]</literal>
- </para>
- </entry><entry>
- <para>
- <link linkend="quickbook.syntax.block.blockquote">Blockquote</link>
- </para>
- </entry>
- </row>
- <row>
- <entry>
- <para>
- heading 1
- </para>
- </entry><entry>
- <para>
- <literal>[h1 Heading 1]</literal>
- </para>
- </entry><entry>
- <para>
- <link linkend="quickbook.syntax.block.headings">Heading</link>
- </para>
- </entry>
- </row>
- <row>
- <entry>
- <para>
- heading 2
- </para>
- </entry><entry>
- <para>
- <literal>[h2 Heading 2]</literal>
- </para>
- </entry><entry>
- <para>
- <link linkend="quickbook.syntax.block.headings">Heading</link>
- </para>
- </entry>
- </row>
- <row>
- <entry>
- <para>
- heading 3
- </para>
- </entry><entry>
- <para>
- <literal>[h3 Heading 3]</literal>
- </para>
- </entry><entry>
- <para>
- <link linkend="quickbook.syntax.block.headings">Heading</link>
- </para>
- </entry>
- </row>
- <row>
- <entry>
- <para>
- heading 4
- </para>
- </entry><entry>
- <para>
- <literal>[h4 Heading 4]</literal>
- </para>
- </entry><entry>
- <para>
- <link linkend="quickbook.syntax.block.headings">Heading</link>
- </para>
- </entry>
- </row>
- <row>
- <entry>
- <para>
- heading 5
- </para>
- </entry><entry>
- <para>
- <literal>[h5 Heading 5]</literal>
- </para>
- </entry><entry>
- <para>
- <link linkend="quickbook.syntax.block.headings">Heading</link>
- </para>
- </entry>
- </row>
- <row>
- <entry>
- <para>
- heading 6
- </para>
- </entry><entry>
- <para>
- <literal>[h6 Heading 6]</literal>
- </para>
- </entry><entry>
- <para>
- <link linkend="quickbook.syntax.block.headings">Heading</link>
- </para>
- </entry>
- </row>
- <row>
- <entry>
- <para>
- macro
- </para>
- </entry><entry>
- <para>
- <literal>[def macro_identifier some text]</literal>
- </para>
- </entry><entry>
- <para>
- <link linkend="quickbook.syntax.block.macros">Macros</link>
- </para>
- </entry>
- </row>
- <row>
- <entry>
- <para>
- template
- </para>
- </entry><entry>
- <para>
- <literal>[template[a b] [a] body [b]]</literal>
- </para>
- </entry><entry>
- <para>
- <link linkend="quickbook.syntax.block.templates">Templates</link>
- </para>
- </entry>
- </row>
- <row>
- <entry>
- <para>
- blurb
- </para>
- </entry><entry>
- <para>
- <literal>[blurb advertisement or note...]</literal>
- </para>
- </entry><entry>
- <para>
- <link linkend="quickbook.syntax.block.blurbs">Blurbs</link>
- </para>
- </entry>
- </row>
- <row>
- <entry>
- <para>
- admonition
- </para>
- </entry><entry>
- <para>
- <literal>[warning Warning text...]</literal>
- </para>
- </entry><entry>
- <para>
- <link linkend="quickbook.syntax.block.admonitions">Admonitions</link>
- </para>
- </entry>
- </row>
- <row>
- <entry>
- <para>
- table
- </para>
- </entry><entry>
- <para>
-
-<programlisting><!--quickbook-escape-prefix-->[table Title
-[[a][b][c]]
-[[a][b][c]]
-]
-<!--quickbook-escape-postfix--></programlisting>
- </para>
- </entry><entry>
- <para>
- <link linkend="quickbook.syntax.block.tables">Tables</link>
- </para>
- </entry>
- </row>
- <row>
- <entry>
- <para>
- variablelist
- </para>
- </entry><entry>
- <para>
-
-<programlisting><!--quickbook-escape-prefix-->[variablelist Title
-[[a][b]]
-[[a][b]]
-]
-<!--quickbook-escape-postfix--></programlisting>
- </para>
- </entry><entry>
- <para>
- <link linkend="quickbook.syntax.block.variable_lists">Variable Lists</link>
- </para>
- </entry>
- </row>
- <row>
- <entry>
- <para>
- include
- </para>
- </entry><entry>
- <para>
- <literal>[include someother.qbk]</literal>
- </para>
- </entry><entry>
- <para>
- <link linkend="quickbook.syntax.block.include">Include</link>
- </para>
- </entry>
- </row>
- </tbody>
- </tgroup>
- </table>
- </section>
-</article>
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