Boost-Commit :

Date view	Thread view	Subject view	Author view

Subject: [Boost-commit] svn:boost r48930 - in trunk/tools/quickbook/doc/html: . images quickbook quickbook/editors quickbook/install quickbook/syntax
From: daniel_james_at_[hidden]
Date: 2008-09-23 15:44:41

Next message: daniel_james_at_[hidden]: "[Boost-commit] svn:boost r48931 - branches/initializer-list"
Previous message: daniel_james_at_[hidden]: "[Boost-commit] svn:boost r48929 - in trunk: doc tools/quickbook/doc tools/quickbook/extra/katepart"

Author: danieljames
Date: 2008-09-23 15:44:39 EDT (Tue, 23 Sep 2008)
New Revision: 48930
URL: http://svn.boost.org/trac/boost/changeset/48930

Log:
Remove the prebuilt version of quickbook.
Removed:
   trunk/tools/quickbook/doc/html/images/alert.png
   trunk/tools/quickbook/doc/html/images/caution.png
   trunk/tools/quickbook/doc/html/images/home.png
   trunk/tools/quickbook/doc/html/images/important.png
   trunk/tools/quickbook/doc/html/images/next.png
   trunk/tools/quickbook/doc/html/images/note.png
   trunk/tools/quickbook/doc/html/images/prev.png
   trunk/tools/quickbook/doc/html/images/smiley.png
   trunk/tools/quickbook/doc/html/images/tip.png
   trunk/tools/quickbook/doc/html/images/up.png
   trunk/tools/quickbook/doc/html/images/warning.png
   trunk/tools/quickbook/doc/html/index.html
   trunk/tools/quickbook/doc/html/quickbook/change_log.html
   trunk/tools/quickbook/doc/html/quickbook/editors.html
   trunk/tools/quickbook/doc/html/quickbook/editors/kde_support.html
   trunk/tools/quickbook/doc/html/quickbook/editors/scite.html
   trunk/tools/quickbook/doc/html/quickbook/faq.html
   trunk/tools/quickbook/doc/html/quickbook/install.html
   trunk/tools/quickbook/doc/html/quickbook/install/linux.html
   trunk/tools/quickbook/doc/html/quickbook/install/macosx.html
   trunk/tools/quickbook/doc/html/quickbook/install/windows.html
   trunk/tools/quickbook/doc/html/quickbook/intro.html
   trunk/tools/quickbook/doc/html/quickbook/ref.html
   trunk/tools/quickbook/doc/html/quickbook/syntax.html
   trunk/tools/quickbook/doc/html/quickbook/syntax/block.html
   trunk/tools/quickbook/doc/html/quickbook/syntax/comments.html
   trunk/tools/quickbook/doc/html/quickbook/syntax/phrase.html

Deleted: trunk/tools/quickbook/doc/html/images/alert.png
==============================================================================
Binary file. No diff available.

Deleted: trunk/tools/quickbook/doc/html/images/caution.png
==============================================================================
Binary file. No diff available.

Deleted: trunk/tools/quickbook/doc/html/images/home.png
==============================================================================
Binary file. No diff available.

Deleted: trunk/tools/quickbook/doc/html/images/important.png
==============================================================================
Binary file. No diff available.

Deleted: trunk/tools/quickbook/doc/html/images/next.png
==============================================================================
Binary file. No diff available.

Deleted: trunk/tools/quickbook/doc/html/images/note.png
==============================================================================
Binary file. No diff available.

Deleted: trunk/tools/quickbook/doc/html/images/prev.png
==============================================================================
Binary file. No diff available.

Deleted: trunk/tools/quickbook/doc/html/images/smiley.png
==============================================================================
Binary file. No diff available.

Deleted: trunk/tools/quickbook/doc/html/images/tip.png
==============================================================================
Binary file. No diff available.

Deleted: trunk/tools/quickbook/doc/html/images/up.png
==============================================================================
Binary file. No diff available.

Deleted: trunk/tools/quickbook/doc/html/images/warning.png
==============================================================================
Binary file. No diff available.

Deleted: trunk/tools/quickbook/doc/html/index.html
==============================================================================
--- trunk/tools/quickbook/doc/html/index.html 2008-09-23 15:44:39 EDT (Tue, 23 Sep 2008)
+++ (empty file)
@@ -1,79 +0,0 @@
-<html>
-<head>
-<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
-<title>Quickbook 1.4</title>
-<link rel="stylesheet" href="../../../../doc/html/boostbook.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
-<link rel="start" href="index.html" title="Quickbook 1.4">
-<link rel="next" href="quickbook/intro.html" title="Introduction">
-</head>
-<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
-<table cellpadding="2" width="100%"><tr>
-<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td>
-<td align="center">Home</td>
-<td align="center">Libraries</td>
-<td align="center">People</td>
-<td align="center">FAQ</td>
-<td align="center">More</td>
-</tr></table>
-<hr>
-<div class="spirit-nav"><a accesskey="n" href="quickbook/intro.html"><img src="../../../../doc/html/images/next.png" alt="Next"></a></div>
-<div class="article" lang="en">
-<div class="titlepage">
-<div>
-<div><h2 class="title">
-<a name="quickbook"></a>Quickbook 1.4</h2></div>
-<div><div class="authorgroup">
-<div class="author"><h3 class="author">
-<span class="firstname">Joel</span> <span class="surname">de Guzman</span>
-</h3></div>
-<div class="author"><h3 class="author">
-<span class="firstname">Eric</span> <span class="surname">Niebler</span>
-</h3></div>
-</div></div>
-<div><p class="copyright">Copyright © 2002, 2004, 2006 Joel de Guzman,
- Eric Niebler</p></div>
-<div><div class="legalnotice">
-<a name="id4946499"></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>
-</div></div>
-</div>
-<hr>
-</div>
-<div class="toc">
-<p><b>Table of Contents</b></p>
-<dl>
-<dt><span class="section"> Introduction</span></dt>
-<dt><span class="section"> Change Log</span></dt>
-<dt><span class="section"> Syntax Summary</span></dt>
-<dd><dl>
-<dt><span class="section">Comments</span></dt>
-<dt><span class="section"> Phrase Level Elements</span></dt>
-<dt><span class="section"> Block Level Elements</span></dt>
-</dl></dd>
-<dt><span class="section"> Installation and configuration</span></dt>
-<dd><dl>
-<dt><span class="section"> Mac OS X</span></dt>
-<dt><span class="section"> Windows 2000, XP, 2003, Vista</span></dt>
-<dt><span class="section"> Debian, Ubuntu</span></dt>
-</dl></dd>
-<dt><span class="section"> Editor Support</span></dt>
-<dd><dl>
-<dt><span class="section"> Scintilla Text Editor</span></dt>
-<dt><span class="section">KDE Support</span></dt>
-</dl></dd>
-<dt><span class="section"> Frequently Asked Questions</span></dt>
-<dt><span class="section"> Quick Reference</span></dt>
-</dl>
-</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: July 29, 2008 at 05:49:54 GMT</small></p></td>
-<td align="right"><div class="copyright-footer"></div></td>
-</tr></table>
-<hr>
-<div class="spirit-nav"><a accesskey="n" href="quickbook/intro.html"><img src="../../../../doc/html/images/next.png" alt="Next"></a></div>
-</body>
-</html>

Deleted: trunk/tools/quickbook/doc/html/quickbook/change_log.html
==============================================================================
--- trunk/tools/quickbook/doc/html/quickbook/change_log.html 2008-09-23 15:44:39 EDT (Tue, 23 Sep 2008)
+++ (empty file)
@@ -1,168 +0,0 @@
-<html>
-<head>
-<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
-<title>Change Log</title>
-<link rel="stylesheet" href="../../../../../doc/html/boostbook.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
-<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">
-</head>
-<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
-<table cellpadding="2" width="100%"><tr>
-<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td>
-<td align="center">Home</td>
-<td align="center">Libraries</td>
-<td align="center">People</td>
-<td align="center">FAQ</td>
-<td align="center">More</td>
-</tr></table>
-<hr>
-<div class="spirit-nav">
-<a accesskey="p" href="intro.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="syntax.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
-</div>
-<div class="section" lang="en">
-<div class="titlepage"><div><div><h2 class="title" style="clear: both">
-<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="id4910849"></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].
- </li>
-<li>
- Better xml output (pretty layout). Check out the generated XML.
- </li>
-<li>
- Regression testing facility: to make sure your document will always be compatible
- (full backward compatibility) regardless of changes to QuickBook.
- </li>
-<li>
- Code cleanup and refactoring.
- </li>
-<li>
- Allow phrase markup in the doc-info.
- </li>
-<li>
- Preformatted code blocks via ``code`` (double ticks) allows code in tables
- and lists, for example.
- </li>
-<li>
- 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.
- </li>
-<li>
- Better (intuitive) paragraph termination. Some markups may terminate a paragraph.
- Example:
-<pre class="programlisting"><span class="special">[</span><span class="identifier">section</span> <span class="identifier">x</span><span class="special">]</span>
-<span class="identifier">blah</span><span class="special">...</span>
-<span class="special">[</span><span class="identifier">endsect</span><span class="special">]</span></pre>
-</li>
-<li>
- Fully qualified section and headers. Subsection names are concatenated to
- 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.
- </li>
-<li>
- [xinclude] fixes up the relative path to the target XML file when input_directory
- is not the same as the output_directory.
- </li>
-<li>
- Allow untitled tables.
- </li>
-<li>
- Allow phrase markups in section titles.
- </li>
-<li>
- Allow escaping back to QuickBook from code, code blocks and inline code.
- </li>
-<li>
- Footnotes, with the [footnote This is the footnote] syntax.
- </li>
-<li>
- Post-processor bug fix for escaped XML code that it does not recognize.
- </li>
-<li>
- Replaceable, with the [~replacement] syntax.
- </li>
-</ul></div>
-<a name="quickbook.change_log.version_1_4"></a><h4>
-<a name="id4912575"></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
- </li>
-<li>
- Code changes to allow full recursion (i.e. Collectors and push/pop functions)
- </li>
-<li>
- Various code cleanup/maintenance
- </li>
-<li>
- Templates!
- </li>
-<li>
- [conceptref] for referencing BoostBook <concept> entities.
- </li>
-<li>
- Allow escape of spaces. The escaped space is removed from the output. Syntax:
- <code class="computeroutput"><span class="special">\</span> </code>.
- </li>
-<li>
- Nested comments are now allowed.
- </li>
-<li>
- Quickbook blocks can nest inside comments.
- </li>
-<li>
-<a class="link" href="syntax/block.html#quickbook.syntax.block.import" title="Import">Import</a> facility.
- </li>
-<li>
- Callouts on imported code
- </li>
-<li>
- Simple markups can now span a whole block.
- </li>
-<li>
-<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>
-<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>
-<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>
-<td align="left"></td>
-<td align="right"><div class="copyright-footer">Copyright © 2002, 2004, 2006 Joel de Guzman,
- Eric Niebler<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>
-</div></td>
-</tr></table>
-<hr>
-<div class="spirit-nav">
-<a accesskey="p" href="intro.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="syntax.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
-</div>
-</body>
-</html>

Deleted: trunk/tools/quickbook/doc/html/quickbook/editors.html
==============================================================================
--- trunk/tools/quickbook/doc/html/quickbook/editors.html 2008-09-23 15:44:39 EDT (Tue, 23 Sep 2008)
+++ (empty file)
@@ -1,61 +0,0 @@
-<html>
-<head>
-<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
-<title>Editor Support</title>
-<link rel="stylesheet" href="../../../../../doc/html/boostbook.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
-<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">
-</head>
-<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
-<table cellpadding="2" width="100%"><tr>
-<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td>
-<td align="center">Home</td>
-<td align="center">Libraries</td>
-<td align="center">People</td>
-<td align="center">FAQ</td>
-<td align="center">More</td>
-</tr></table>
-<hr>
-<div class="spirit-nav">
-<a accesskey="p" href="install/linux.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="editors/scite.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
-</div>
-<div class="section" lang="en">
-<div class="titlepage"><div><div><h2 class="title" style="clear: both">
-<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>
-</dl></div>
-<p>
- 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.
- </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>
-</div>
-<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
-<td align="left"></td>
-<td align="right"><div class="copyright-footer">Copyright © 2002, 2004, 2006 Joel de Guzman,
- Eric Niebler<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>
-</div></td>
-</tr></table>
-<hr>
-<div class="spirit-nav">
-<a accesskey="p" href="install/linux.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="editors/scite.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
-</div>
-</body>
-</html>

Deleted: trunk/tools/quickbook/doc/html/quickbook/editors/kde_support.html
==============================================================================
--- trunk/tools/quickbook/doc/html/quickbook/editors/kde_support.html 2008-09-23 15:44:39 EDT (Tue, 23 Sep 2008)
+++ (empty file)
@@ -1,465 +0,0 @@
-<html>
-<head>
-<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
-<title>KDE Support</title>
-<link rel="stylesheet" href="../../../../../../doc/html/boostbook.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
-<link rel="start" href="../../index.html" title="Quickbook 1.4">
-<link rel="up" href="../editors.html" title="Editor Support">
-<link rel="prev" href="scite.html" title="Scintilla Text Editor">
-<link rel="next" href="../faq.html" title="Frequently Asked Questions">
-</head>
-<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
-<table cellpadding="2" width="100%"><tr>
-<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td>
-<td align="center">Home</td>
-<td align="center">Libraries</td>
-<td align="center">People</td>
-<td align="center">FAQ</td>
-<td align="center">More</td>
-</tr></table>
-<hr>
-<div class="spirit-nav">
-<a accesskey="p" href="scite.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../editors.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="../faq.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
-</div>
-<div class="section" lang="en">
-<div class="titlepage"><div><div><h3 class="title">
-<a name="quickbook.editors.kde_support"></a><a class="link" href="kde_support.html" title="KDE Support">KDE Support</a>
-</h3></div></div></div>
-<a name="quickbook.editors.kde_support.boost__hs__quickbook"></a><h5>
-<a name="id4963116"></a>
- <a class="link" href="kde_support.html#quickbook.editors.kde_support.boost__hs__quickbook">boost::hs::quickbook</a>
- </h5>
-<p>
- boost::hs::quickbook is a syntax highlighting designed to work with Katepart.
- It can be used in KWrite, Kate, Konqueror and KDevelop, and supports all
- the constructs of Quickbook 1.4 including tables, list, templates and macros.
- </p>
-<div class="variablelist">
-<p class="title"><b></b></p>
-<dl>
-<dt><span class="term">.qbk loaded in a text editor</span></dt>
-<dd><p>
- <span class="inlinemediaobject"><img src="../../images/extra/katepart/table.text.editor.png" alt="table.text.editor"></span>
- </p></dd>
-<dt><span class="term">.qbk loaded with boost::hs support</span></dt>
-<dd><p>
- <span class="inlinemediaobject"><img src="../../images/extra/katepart/table.boost.hs.png" alt="table.boost.hs"></span>
- </p></dd>
-</dl>
-</div>
-<p>
- <span class="bold"><strong>html generated from this .qbk file</strong></span>
- </p>
-<div class="table">
-<a name="id4963207"></a><p class="title"><b>Table 7. Code examples</b></p>
-<div class="table-contents"><table class="table" summary="Code examples">
-<colgroup>
-<col>
-<col>
-<col>
-</colgroup>
-<thead><tr>
-<th>
- <p>
- Name
- </p>
- </th>
-<th>
- <p>
- Code
- </p>
- </th>
-<th>
- <p>
- Description
- </p>
- </th>
-</tr></thead>
-<tbody>
-<tr>
-<td>
- <p>
- for loop
- </p>
- </td>
-<td>
- <p>
- <code class="computeroutput"> <span class="keyword">for</span><span class="special">(</span><span class="identifier">int</span> <span class="identifier">k</span><span class="special">=</span><span class="number">0</span><span class="special">;</span>
- <span class="identifier">k</span><span class="special"><</span><span class="number">10</span><span class="special">;</span> <span class="identifier">k</span><span class="special">++)</span> <span class="identifier">v</span><span class="special">+=</span><span class="identifier">k</span><span class="special">;</span> </code>
- </p>
- </td>
-<td>
- <p>
- Sums some numbers.
- </p>
- </td>
-</tr>
-<tr>
-<td>
- <p>
- while loop
- </p>
- </td>
-<td>
- <p>
- <code class="computeroutput"> <span class="special">{</span> <span class="identifier">int</span>
- <span class="identifier">k</span><span class="special">;</span>
- <span class="keyword">while</span><span class="special">(</span>
- <span class="identifier">k</span> <span class="special"><</span>
- <span class="number">10</span> <span class="special">)</span>
- <span class="special">{</span> <span class="identifier">v</span><span class="special">+=</span><span class="identifier">k</span><span class="special">;</span> <span class="identifier">k</span><span class="special">++</span> <span class="special">}</span> <span class="special">}</span> </code>
- </p>
- </td>
-<td>
- <p>
- Same effect.
- </p>
- </td>
-</tr>
-<tr>
-<td>
- <p>
- infinite loop
- </p>
- </td>
-<td>
- <p>
- <code class="computeroutput"> <span class="keyword">while</span><span class="special">(</span>
- <span class="identifier">true</span> <span class="special">)</span>
- <span class="special">{</span> <span class="identifier">v</span><span class="special">+=</span><span class="number">1</span><span class="special">;</span>
- <span class="special">}</span> </code>
- </p>
- </td>
-<td>
- <p>
- Not a good example.
- </p>
- </td>
-</tr>
-</tbody>
-</table></div>
-</div>
-<br class="table-break"><a name="quickbook.editors.kde_support.code_folding_"></a><h5>
-<a name="id4963573"></a>
- <a class="link" href="kde_support.html#quickbook.editors.kde_support.code_folding_">Code Folding
- </a>
- </h5>
-<p>
- boost::hs goes far beyond simple coloring. One useful thing you can get the
- editor to do is to mark regions. They appear in a small grey line and each
- region can be folded or unfolded independently.
- </p>
-<a name="quickbook.editors.kde_support.auto_comment___uncomment_"></a><h5>
-<a name="id4963602"></a>
- <a class="link" href="kde_support.html#quickbook.editors.kde_support.auto_comment___uncomment_">Auto
- Comment / Uncomment </a>
- </h5>
-<p>
- Another important feature is the possibility to auto-comment or uncomment
- some piece of code (<span class="emphasis"><em>Tools - Comment</em></span>). Commented regions
- can be uncommented simple calling the <span class="emphasis"><em>uncomment</em></span> command
- while being in it.
- </p>
-<a name="quickbook.editors.kde_support.styles_reference_"></a><h5>
-<a name="id4963639"></a>
- <a class="link" href="kde_support.html#quickbook.editors.kde_support.styles_reference_">Styles reference
- </a>
- </h5>
-<div class="informaltable"><table class="table">
-<colgroup>
-<col>
-<col>
-<col>
-</colgroup>
-<thead><tr>
-<th>
- <p>
- Name
- </p>
- </th>
-<th>
- <p>
- Style
- </p>
- </th>
-<th>
- <p>
- Description
- </p>
- </th>
-</tr></thead>
-<tbody>
-<tr>
-<td>
- <p>
- <span class="bold"><strong>plain text</strong></span>
- </p>
- </td>
-<td>
- <p>
- normal black
- </p>
- </td>
-<td>
- <p>
- Plain text at each level.
- </p>
- </td>
-</tr>
-<tr>
-<td>
- <p>
- <span class="bold"><strong>formatted text</strong></span>
- </p>
- </td>
-<td>
- <p>
- formatted black
- </p>
- </td>
-<td>
- <p>
- Bold, italic, underline and mixes. Teletype, replaceable, strikeout.
- </p>
- </td>
-</tr>
-<tr>
-<td>
- <p>
- <span class="bold"><strong>structure</strong></span>
- </p>
- </td>
-<td>
- <p>
- light blue
- </p>
- </td>
-<td>
- <p>
- All quickbook structures characters ([, ], [block-type, simple formating
- boundaries, lists keywords (*, #)
- </p>
- </td>
-</tr>
-<tr>
-<td>
- <p>
- <span class="bold"><strong>macros</strong></span>
- </p>
- </td>
-<td>
- <p>
- red
- </p>
- </td>
-<td>
- <p>
- Names in macro definitions, macros insertion if it is used the __xxx__
- proposed sintaxis.
- </p>
- </td>
-</tr>
-<tr>
-<td>
- <p>
- <span class="bold"><strong>templates</strong></span>
- </p>
- </td>
-<td>
- <p>
- red
- </p>
- </td>
-<td>
- <p>
- Names in template definitions
- </p>
- </td>
-</tr>
-<tr>
-<td>
- <p>
- <span class="bold"><strong>anchors</strong></span>
- </p>
- </td>
-<td>
- <p>
- red
- </p>
- </td>
-<td>
- <p>
- All the keywords that are used to link quickbooks together.
- </p>
- </td>
-</tr>
-<tr>
-<td>
- <p>
- <span class="bold"><strong>comments</strong></span>
- </p>
- </td>
-<td>
- <p>
- italic light gray
- </p>
- </td>
-<td>
- <p>
- Inside the commentaries.
- </p>
- </td>
-</tr>
-<tr>
-<td>
- <p>
- <span class="bold"><strong>tables</strong></span>
- </p>
- </td>
-<td>
- <p>
- HTML like
- </p>
- </td>
-<td>
- <p>
- Reveal the structure, bold title, higlighted HTML like columns titles.
- </p>
- </td>
-</tr>
-<tr>
-<td>
- <p>
- <span class="bold"><strong>variable lists</strong></span>
- </p>
- </td>
-<td>
- <p>
- HTML like
- </p>
- </td>
-<td>
- <p>
- Reveal the structure, bold title, bold HTML like items names.
- </p>
- </td>
-</tr>
-<tr>
-<td>
- <p>
- <span class="bold"><strong>c++ code</strong></span>
- </p>
- </td>
-<td>
- <p>
- cpp Kate syntax
- </p>
- </td>
-<td>
- <p>
- Code blocks and inline code.
- </p>
- </td>
-</tr>
-<tr>
-<td>
- <p>
- <span class="bold"><strong>paths</strong></span>
- </p>
- </td>
-<td>
- <p>
- green
- </p>
- </td>
-<td>
- <p>
- Image, files and web paths
- </p>
- </td>
-</tr>
-<tr>
-<td>
- <p>
- <span class="bold"><strong>IDE specific</strong></span>
- </p>
- </td>
-<td>
- <p>
- dark blue
- </p>
- </td>
-<td>
- <p>
- IDE commands
- </p>
- </td>
-</tr>
-</tbody>
-</table></div>
-<a name="quickbook.editors.kde_support.about_boost__hs"></a><h5>
-<a name="id4964040"></a>
- <a class="link" href="kde_support.html#quickbook.editors.kde_support.about_boost__hs">About boost::hs</a>
- </h5>
-<p>
- <span class="inlinemediaobject"><img src="../../images/extra/katepart/boost.hs.logo.png" alt="boost.hs.logo"></span>
- </p>
-<p>
- boost::hs::quickbook is a component of boost::hs, a syntax highlighting for
- C++, doxygen, Boost.Build jamfiles and QuickBook. boost::hs has his own page
- here.
- </p>
-<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 align="left" valign="top"><p>
- boost::hs::cpp support QuickBook code import comments style!
- </p></td></tr>
-</table></div>
-<a name="quickbook.editors.kde_support.installing_boost__hs"></a><h5>
-<a name="id4964100"></a>
- <a class="link" href="kde_support.html#quickbook.editors.kde_support.installing_boost__hs">Installing
- boost::hs</a>
- </h5>
-<p>
- There exist an ongoing effort to push boost::hs upstream to the KatePart
- project. In a few months KDE may have native Quickbook support! For the moment
- you must download and install it.
- </p>
-<p>
- You can download boost::hs from here.
- </p>
-<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 align="left" valign="top"><p>
- A copy of boost::hs::quickbook and boost::hs::cpp is available in <code class="computeroutput"><span class="identifier">boost</span><span class="special">/</span><span class="identifier">tools</span><span class="special">/</span><span class="identifier">quickbook</span><span class="special">/</span><span class="identifier">extra</span><span class="special">/</span><span class="identifier">katepart</span></code>.
- </p></td></tr>
-</table></div>
-<p>
- In order to install it you must copy the content in the folder <span class="bold"><strong>katepart/syntax/</strong></span> to the appropriate katepart syntax
- folder in your machine. In general this folder will be in <span class="bold"><strong>/usr/share/apps/katepart/syntax</strong></span>.
- A bash script named <span class="emphasis"><em>install.sh</em></span> is included that copy
- the files to this folder.
- </p>
-</div>
-<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
-<td align="left"></td>
-<td align="right"><div class="copyright-footer">Copyright © 2002, 2004, 2006 Joel de Guzman,
- Eric Niebler<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>
-</div></td>
-</tr></table>
-<hr>
-<div class="spirit-nav">
-<a accesskey="p" href="scite.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../editors.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="../faq.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
-</div>
-</body>
-</html>

Deleted: trunk/tools/quickbook/doc/html/quickbook/editors/scite.html
==============================================================================
--- trunk/tools/quickbook/doc/html/quickbook/editors/scite.html 2008-09-23 15:44:39 EDT (Tue, 23 Sep 2008)
+++ (empty file)
@@ -1,85 +0,0 @@
-<html>
-<head>
-<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
-<title>Scintilla Text Editor</title>
-<link rel="stylesheet" href="../../../../../../doc/html/boostbook.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
-<link rel="start" href="../../index.html" title="Quickbook 1.4">
-<link rel="up" href="../editors.html" title="Editor Support">
-<link rel="prev" href="../editors.html" title="Editor Support">
-<link rel="next" href="kde_support.html" title="KDE Support">
-</head>
-<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
-<table cellpadding="2" width="100%"><tr>
-<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td>
-<td align="center">Home</td>
-<td align="center">Libraries</td>
-<td align="center">People</td>
-<td align="center">FAQ</td>
-<td align="center">More</td>
-</tr></table>
-<hr>
-<div class="spirit-nav">
-<a accesskey="p" href="../editors.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../editors.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="kde_support.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
-</div>
-<div class="section" lang="en">
-<div class="titlepage"><div><div><h3 class="title">
-<a name="quickbook.editors.scite"></a><a class="link" href="scite.html" title="Scintilla Text Editor"> Scintilla Text Editor</a>
-</h3></div></div></div>
-<div class="blockquote"><blockquote class="blockquote">
-<p>
- </p>
-<p>
- <span class="emphasis"><em>Section contributed by Dean Michael Berris</em></span>
- </p>
-<p>
- </p>
-</blockquote></div>
-<p>
- The Scintilla Text Editor (SciTE) is a free source code editor for Win32
- and X. It uses the SCIntilla source code editing component.
- </p>
-<div class="sidebar">
-<p class="title"><b></b></p>
-<p>
- <span class="inlinemediaobject"><img src="../../images/tip.png" alt="tip"></span> SciTE can be downloaded from http://www.scintilla.org/SciTE.html
- </p>
-</div>
-<p>
- You can use the following settings to highlight quickbook tags when editing
- quickbook files.
- </p>
-<pre class="programlisting">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=]
-</pre>
-<div class="sidebar">
-<p class="title"><b></b></p>
-<p>
- <span class="inlinemediaobject"><img src="../../images/note.png" alt="note"></span> Thanks to Rene Rivera for the above SciTE settings.
- </p>
-</div>
-</div>
-<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
-<td align="left"></td>
-<td align="right"><div class="copyright-footer">Copyright © 2002, 2004, 2006 Joel de Guzman,
- Eric Niebler<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>
-</div></td>
-</tr></table>
-<hr>
-<div class="spirit-nav">
-<a accesskey="p" href="../editors.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../editors.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="kde_support.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
-</div>
-</body>
-</html>

Deleted: trunk/tools/quickbook/doc/html/quickbook/faq.html
==============================================================================
--- trunk/tools/quickbook/doc/html/quickbook/faq.html 2008-09-23 15:44:39 EDT (Tue, 23 Sep 2008)
+++ (empty file)
@@ -1,100 +0,0 @@
-<html>
-<head>
-<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
-<title>Frequently Asked Questions</title>
-<link rel="stylesheet" href="../../../../../doc/html/boostbook.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
-<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">
-</head>
-<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
-<table cellpadding="2" width="100%"><tr>
-<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td>
-<td align="center">Home</td>
-<td align="center">Libraries</td>
-<td align="center">People</td>
-<td align="center">FAQ</td>
-<td align="center">More</td>
-</tr></table>
-<hr>
-<div class="spirit-nav">
-<a accesskey="p" href="editors/kde_support.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="ref.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
-</div>
-<div class="section" lang="en">
-<div class="titlepage"><div><div><h2 class="title" style="clear: both">
-<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="id4964235"></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>
- </h4>
-<p>
- QuickBook can be used for non-Boost documentation with a little extra work.
- </p>
-<div class="blockquote"><blockquote class="blockquote">
-<p>
- </p>
-<p>
- <span class="emphasis"><em>Faq contributed by Michael Marcin</em></span>
- </p>
-<p>
- </p>
-</blockquote></div>
-<p>
- 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.
- </p>
-<p>
- For example:
- </p>
-<pre class="programlisting">using quickbook ;
-
-xml my_doc : my_doc.qbk ;
-
-boostbook standalone
- :
- my_doc
- :
- <xsl:param>boost.image.src<code class="literal">images/my_project_logo.png
- <xsl:param>boost.image.alt</code>"\"My Project\""
- <xsl:param>boost.image.w=100
- <xsl:param>boost.image.h=50
- <xsl:param>nav.layout=none
- ;
-</pre>
-<a name="quickbook.faq.is_there_an_easy_way_to_convert_boostbook_docs_to_quickbook_"></a><h4>
-<a name="id4964312"></a>
- <a class="link" href="faq.html#quickbook.faq.is_there_an_easy_way_to_convert_boostbook_docs_to_quickbook_">Is
- there an easy way to convert BoostBook docs to QuickBook?</a>
- </h4>
-<p>
- There's a stylesheet that allows Boostbook generated HTML to be viewed as quickbook
- source, see http://svn.boost.org/trac/boost/wiki/QuickbookSourceStylesheetProject,
- so it's then just a cut and paste job to convert the BoostBook to QuickBook
- (which IMO is a whole lot easier to edit and maintain).
- </p>
-<p>
- --John Maddock
- </p>
-</div>
-<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
-<td align="left"></td>
-<td align="right"><div class="copyright-footer">Copyright © 2002, 2004, 2006 Joel de Guzman,
- Eric Niebler<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>
-</div></td>
-</tr></table>
-<hr>
-<div class="spirit-nav">
-<a accesskey="p" href="editors/kde_support.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="ref.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
-</div>
-</body>
-</html>

Deleted: trunk/tools/quickbook/doc/html/quickbook/install.html
==============================================================================
--- trunk/tools/quickbook/doc/html/quickbook/install.html 2008-09-23 15:44:39 EDT (Tue, 23 Sep 2008)
+++ (empty file)
@@ -1,60 +0,0 @@
-<html>
-<head>
-<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
-<title>Installation and configuration</title>
-<link rel="stylesheet" href="../../../../../doc/html/boostbook.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
-<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">
-</head>
-<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
-<table cellpadding="2" width="100%"><tr>
-<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td>
-<td align="center">Home</td>
-<td align="center">Libraries</td>
-<td align="center">People</td>
-<td align="center">FAQ</td>
-<td align="center">More</td>
-</tr></table>
-<hr>
-<div class="spirit-nav">
-<a accesskey="p" href="syntax/block.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="install/macosx.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
-</div>
-<div class="section" lang="en">
-<div class="titlepage"><div><div><h2 class="title" style="clear: both">
-<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>
-<dt><span class="section"> Debian, Ubuntu</span></dt>
-</dl></div>
-<p>
- This section provides some guidelines on how to install and configure BoostBook
- and Quickbook under several operating systems.
- </p>
-<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 <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>
-<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
-<td align="left"></td>
-<td align="right"><div class="copyright-footer">Copyright © 2002, 2004, 2006 Joel de Guzman,
- Eric Niebler<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>
-</div></td>
-</tr></table>
-<hr>
-<div class="spirit-nav">
-<a accesskey="p" href="syntax/block.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="install/macosx.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
-</div>
-</body>
-</html>

Deleted: trunk/tools/quickbook/doc/html/quickbook/install/linux.html
==============================================================================
--- trunk/tools/quickbook/doc/html/quickbook/install/linux.html 2008-09-23 15:44:39 EDT (Tue, 23 Sep 2008)
+++ (empty file)
@@ -1,104 +0,0 @@
-<html>
-<head>
-<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
-<title>Debian, Ubuntu</title>
-<link rel="stylesheet" href="../../../../../../doc/html/boostbook.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
-<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">
-</head>
-<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
-<table cellpadding="2" width="100%"><tr>
-<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td>
-<td align="center">Home</td>
-<td align="center">Libraries</td>
-<td align="center">People</td>
-<td align="center">FAQ</td>
-<td align="center">More</td>
-</tr></table>
-<hr>
-<div class="spirit-nav">
-<a accesskey="p" href="windows.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../install.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="../editors.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
-</div>
-<div class="section" lang="en">
-<div class="titlepage"><div><div><h3 class="title">
-<a name="quickbook.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 <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 <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 <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 <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>
-<pre class="programlisting"><span class="identifier">using</span> <span class="identifier">xsltproc</span> <span class="special">;</span>
-
-<span class="identifier">using</span> <span class="identifier">boostbook</span>
- <span class="special">:</span> <span class="special">/</span><span class="identifier">usr</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="identifier">stylesheet</span><span class="special">/</span><span class="identifier">nwalsh</span>
- <span class="special">:</span> <span class="special">/</span><span class="identifier">usr</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="identifier">schema</span><span class="special">/</span><span class="identifier">dtd</span><span class="special">/</span><span class="number">4.2</span>
- <span class="special">;</span>
-
-<span class="comment"># Remove this line if you're not using doxygen
-</span><span class="identifier">using</span> <span class="identifier">doxygen</span> <span class="special">;</span>
-</pre>
-<p>
- 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:
- </p>
-<div class="orderedlist"><ol type="1">
-<li>
- 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 <code class="computeroutput"><span class="identifier">bjam</span>
- <span class="special">--</span><span class="identifier">v2</span></code>.
- </li>
-<li>
- 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 <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>
-<pre class="programlisting"><span class="identifier">using</span> <span class="identifier">quickbook</span>
- <span class="special">:</span> <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><span class="special">/</span><span class="identifier">quickbook</span>
- <span class="special">;</span>
-</pre>
-</div>
-<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
-<td align="left"></td>
-<td align="right"><div class="copyright-footer">Copyright © 2002, 2004, 2006 Joel de Guzman,
- Eric Niebler<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>
-</div></td>
-</tr></table>
-<hr>
-<div class="spirit-nav">
-<a accesskey="p" href="windows.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../install.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="../editors.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
-</div>
-</body>
-</html>

Deleted: trunk/tools/quickbook/doc/html/quickbook/install/macosx.html
==============================================================================
--- trunk/tools/quickbook/doc/html/quickbook/install/macosx.html 2008-09-23 15:44:39 EDT (Tue, 23 Sep 2008)
+++ (empty file)
@@ -1,156 +0,0 @@
-<html>
-<head>
-<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
-<title>Mac OS X</title>
-<link rel="stylesheet" href="../../../../../../doc/html/boostbook.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
-<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">
-</head>
-<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
-<table cellpadding="2" width="100%"><tr>
-<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td>
-<td align="center">Home</td>
-<td align="center">Libraries</td>
-<td align="center">People</td>
-<td align="center">FAQ</td>
-<td align="center">More</td>
-</tr></table>
-<hr>
-<div class="spirit-nav">
-<a accesskey="p" href="../install.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../install.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="windows.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
-</div>
-<div class="section" lang="en">
-<div class="titlepage"><div><div><h3 class="title">
-<a name="quickbook.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>
-<p>
- <span class="emphasis"><em>Section contributed by Julio M. Merino Vidal</em></span>
- </p>
-<p>
- </p>
-</blockquote></div>
-<p>
- The following instructions explain how to install Docbook XML, Docbook XSL
- and Doxygen in a Mac OS X system, how to configure Boost.Build v2 to recognize
- them and how to build and install Quickbook. They were taken from a 10.4
- (Tiger) machine so it is likely that they also apply to future versions;
- they may not work with older ones, though.
- </p>
-<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 <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 <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 <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.
- </p>
-<p>
- To get started:
- </p>
-<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 <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 <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 <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>
-</ol></div>
-<pre class="programlisting"><span class="keyword">using</span> <span class="identifier">xsltproc</span> <span class="special">;</span>
-
-<span class="keyword">using</span> <span class="identifier">boostbook</span>
- <span class="special">:</span> <span class="string">"/usr/local/share/xsl/docbook"</span>
- <span class="special">:</span> <span class="string">"/usr/local/share/xml/docbook/4.2"</span>
- <span class="special">;</span>
-</pre>
-<p>
- 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
- and install a system-wide Quickbook instead:
- </p>
-<div class="orderedlist"><ol type="1">
-<li>
- 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 <code class="computeroutput"><span class="identifier">bjam</span>
- <span class="special">--</span><span class="identifier">v2</span></code>.
- </li>
-<li>
- 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:
- <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 <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>
-<pre class="programlisting"><span class="keyword">using</span> <span class="identifier">quickbook</span>
- <span class="special">:</span> <span class="string">"/usr/local/bin/quickbook"</span> <span class="special">;</span>
- <span class="special">;</span>
-</pre>
-<p>
- Additionally, if you need to build documentation that uses Doxygen,
- you will need to install it too:
- </p>
-<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 (<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 <code class="computeroutput"><span class="identifier">Applications</span></code> folder to install it.
- </li>
-<li>
- 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>
-<pre class="programlisting"><span class="keyword">using</span> <span class="identifier">doxygen</span>
- <span class="special">:</span> <span class="special">/</span><span class="identifier">Applications</span><span class="special">/</span><span class="identifier">Doxygen</span><span class="special">.</span><span class="identifier">app</span><span class="special">/</span><span class="identifier">Contents</span><span class="special">/</span><span class="identifier">Resources</span><span class="special">/</span><span class="identifier">doxygen</span>
- <span class="special">;</span>
-</pre>
-<p>
- Alternatively, you may want to install all the prerequistes through a package
- system to avoid manual management of the installations. In that case, check
- out pkgsrc.
- </p>
-</div>
-<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
-<td align="left"></td>
-<td align="right"><div class="copyright-footer">Copyright © 2002, 2004, 2006 Joel de Guzman,
- Eric Niebler<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>
-</div></td>
-</tr></table>
-<hr>
-<div class="spirit-nav">
-<a accesskey="p" href="../install.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../install.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="windows.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
-</div>
-</body>
-</html>

Deleted: trunk/tools/quickbook/doc/html/quickbook/install/windows.html
==============================================================================
--- trunk/tools/quickbook/doc/html/quickbook/install/windows.html 2008-09-23 15:44:39 EDT (Tue, 23 Sep 2008)
+++ (empty file)
@@ -1,136 +0,0 @@
-<html>
-<head>
-<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
-<title>Windows 2000, XP, 2003, Vista</title>
-<link rel="stylesheet" href="../../../../../../doc/html/boostbook.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
-<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">
-</head>
-<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
-<table cellpadding="2" width="100%"><tr>
-<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td>
-<td align="center">Home</td>
-<td align="center">Libraries</td>
-<td align="center">People</td>
-<td align="center">FAQ</td>
-<td align="center">More</td>
-</tr></table>
-<hr>
-<div class="spirit-nav">
-<a accesskey="p" href="macosx.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../install.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="linux.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
-</div>
-<div class="section" lang="en">
-<div class="titlepage"><div><div><h3 class="title">
-<a name="quickbook.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">
-<p>
- </p>
-<p>
- <span class="emphasis"><em>Section contributed by Julio M. Merino Vidal</em></span>
- </p>
-<p>
- </p>
-</blockquote></div>
-<p>
- 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.
- </p>
-<div class="orderedlist"><ol type="1">
-<li>
- 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: <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
- <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 <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:
- <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 <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 <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>
-</ol></div>
-<pre class="programlisting"><span class="identifier">using</span> <span class="identifier">xsltproc</span>
- <span class="special">:</span> <span class="string">"C:/Users/example/Documents/boost/xml/bin/xsltproc.exe"</span>
- <span class="special">;</span>
-
-<span class="identifier">using</span> <span class="identifier">boostbook</span>
- <span class="special">:</span> <span class="string">"C:/Users/example/Documents/boost/xml/docbook-xsl"</span>
- <span class="special">:</span> <span class="string">"C:/Users/example/Documents/boost/xml/docbook-xml"</span>
- <span class="special">;</span>
-</pre>
-<p>
- 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:
- </p>
-<div class="orderedlist"><ol type="1">
-<li>
- 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 <code class="computeroutput"><span class="identifier">bjam</span>
- <span class="special">--</span><span class="identifier">v2</span></code>.
- </li>
-<li>
- 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:
- <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 <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>
-<pre class="programlisting"><span class="identifier">using</span> <span class="identifier">quickbook</span>
- <span class="special">:</span> <span class="string">"C:/Users/example/Documents/boost/xml/bin/quickbook.exe"</span>
- <span class="special">;</span>
-</pre>
-</div>
-<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
-<td align="left"></td>
-<td align="right"><div class="copyright-footer">Copyright © 2002, 2004, 2006 Joel de Guzman,
- Eric Niebler<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>
-</div></td>
-</tr></table>
-<hr>
-<div class="spirit-nav">
-<a accesskey="p" href="macosx.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../install.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="linux.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
-</div>
-</body>
-</html>

Deleted: trunk/tools/quickbook/doc/html/quickbook/intro.html
==============================================================================
--- trunk/tools/quickbook/doc/html/quickbook/intro.html 2008-09-23 15:44:39 EDT (Tue, 23 Sep 2008)
+++ (empty file)
@@ -1,115 +0,0 @@
-<html>
-<head>
-<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
-<title>Introduction</title>
-<link rel="stylesheet" href="../../../../../doc/html/boostbook.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
-<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">
-</head>
-<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
-<table cellpadding="2" width="100%"><tr>
-<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td>
-<td align="center">Home</td>
-<td align="center">Libraries</td>
-<td align="center">People</td>
-<td align="center">FAQ</td>
-<td align="center">More</td>
-</tr></table>
-<hr>
-<div class="spirit-nav">
-<a accesskey="p" href="../index.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="change_log.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
-</div>
-<div class="section" lang="en">
-<div class="titlepage"><div><div><h2 class="title" style="clear: both">
-<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"><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>
-<p>
- -- Terrence Parr, author ANTLR/PCCTS
- </p>
-<p>
- </p>
-</blockquote></div>
-<p>
- Well, QuickBook started as a weekend hack. It was originally intended to be
- a sample application using Spirit.
- What is it? What you are viewing now, this documentation, is autogenerated
- by QuickBook. These files were generated from one master:
- </p>
-<div class="blockquote"><blockquote class="blockquote">
-<p>
- </p>
-<p>
- quickbook.qbk
- </p>
-<p>
- </p>
-</blockquote></div>
-<p>
- 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
- BoostBook
- instead of HTML. The BoostBook
- documentation format is an extension of DocBook,
- an SGML or XML based format for describing documentation.
- </p>
-<p>
- 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.
- </p>
-<p>
- Features include:
- </p>
-<div class="itemizedlist"><ul type="disc">
-<li>
- generate BoostBook
- xml, to generate HTML, PostScript and PDF
- </li>
-<li>
- simple markup to link to Doxygen-generated entities
- </li>
-<li>
- macro system for simple text substitution
- </li>
-<li>
- simple markup for italics, bold, preformatted, blurbs, code samples, tables,
- URLs, anchors, images, etc.
- </li>
-<li>
- automatic syntax coloring of code samples
- </li>
-<li>
- CSS support
- </li>
-</ul></div>
-</div>
-<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
-<td align="left"></td>
-<td align="right"><div class="copyright-footer">Copyright © 2002, 2004, 2006 Joel de Guzman,
- Eric Niebler<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>
-</div></td>
-</tr></table>
-<hr>
-<div class="spirit-nav">
-<a accesskey="p" href="../index.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="change_log.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
-</div>
-</body>
-</html>

Deleted: trunk/tools/quickbook/doc/html/quickbook/ref.html
==============================================================================
--- trunk/tools/quickbook/doc/html/quickbook/ref.html 2008-09-23 15:44:39 EDT (Tue, 23 Sep 2008)
+++ (empty file)
@@ -1,958 +0,0 @@
-<html>
-<head>
-<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
-<title>Quick Reference</title>
-<link rel="stylesheet" href="../../../../../doc/html/boostbook.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
-<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">
-</head>
-<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
-<table cellpadding="2" width="100%"><tr>
-<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td>
-<td align="center">Home</td>
-<td align="center">Libraries</td>
-<td align="center">People</td>
-<td align="center">FAQ</td>
-<td align="center">More</td>
-</tr></table>
-<hr>
-<div class="spirit-nav">
-<a accesskey="p" href="faq.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/html/images/home.png" alt="Home"></a>
-</div>
-<div class="section" lang="en">
-<div class="titlepage"><div><div><h2 class="title" style="clear: both">
-<a name="quickbook.ref"></a><a class="link" href="ref.html" title="Quick Reference"> Quick Reference</a>
-</h2></div></div></div>
-<p>
- </p>
-<div class="table">
-<a name="id4964367"></a><p class="title"><b>Table 8. Syntax Compendium</b></p>
-<div class="table-contents"><table class="table" summary="Syntax Compendium">
-<colgroup>
-<col>
-<col>
-<col>
-</colgroup>
-<thead><tr>
-<th>
- <p>
- To do this...
- </p>
- </th>
-<th>
- <p>
- Use this...
- </p>
- </th>
-<th>
- <p>
- See this...
- </p>
- </th>
-</tr></thead>
-<tbody>
-<tr>
-<td>
- <p>
- comment
- </p>
- </td>
-<td>
- <p>
- <code class="literal">[/ some comment]</code>
- </p>
- </td>
-<td>
- <p>
- <a class="link" href="syntax/comments.html" title="Comments">Comments</a>
- </p>
- </td>
-</tr>
-<tr>
-<td>
- <p>
- <span class="emphasis"><em>italics</em></span>
- </p>
- </td>
-<td>
- <p>
- <code class="literal">['italics] or /italics/</code>
- </p>
- </td>
-<td>
- <p>
- <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>
-</tr>
-<tr>
-<td>
- <p>
- <span class="bold"><strong>bold</strong></span>
- </p>
- </td>
-<td>
- <p>
- <code class="literal">[*bold] or *bold*</code>
- </p>
- </td>
-<td>
- <p>
- <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>
-</tr>
-<tr>
-<td>
- <p>
- <span class="underline">underline</span>
- </p>
- </td>
-<td>
- <p>
- <code class="literal">[_underline] or _underline_</code>
- </p>
- </td>
-<td>
- <p>
- <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>
-</tr>
-<tr>
-<td>
- <p>
- <code class="literal">teletype</code>
- </p>
- </td>
-<td>
- <p>
- <code class="literal">[^teletype] or =teletype=</code>
- </p>
- </td>
-<td>
- <p>
- <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>
-</tr>
-<tr>
-<td>
- <p>
- <span class="strikethrough">strikethrough</span>
- </p>
- </td>
-<td>
- <p>
- <code class="literal">[-strikethrough]</code>
- </p>
- </td>
-<td>
- <p>
- <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>
-</tr>
-<tr>
-<td>
- <p>
- <em class="replaceable"><code>
- replaceable
- </code></em>
- </p>
- </td>
-<td>
- <p>
- <code class="literal">[~replaceable]</code>
- </p>
- </td>
-<td>
- <p>
- <a class="link" href="syntax/phrase.html#quickbook.syntax.phrase.replaceable" title="Replaceable">Replaceble</a>
- </p>
- </td>
-</tr>
-<tr>
-<td>
- <p>
- source mode
- </p>
- </td>
-<td>
- <p>
- <code class="literal">[c++]</code> or <code class="literal">[python]</code>
- </p>
- </td>
-<td>
- <p>
- <a class="link" href="syntax/phrase.html#quickbook.syntax.phrase.source_mode" title="Source Mode">Source Mode</a>
- </p>
- </td>
-</tr>
-<tr>
-<td>
- <p>
- inline code
- </p>
- </td>
-<td>
- <p>
- <code class="literal">`int main();`</code>
- </p>
- </td>
-<td>
- <p>
- <a class="link" href="syntax/phrase.html#quickbook.syntax.phrase.inline_code" title="Inline code">Inline code</a>
- </p>
- </td>
-</tr>
-<tr>
-<td>
- <p>
- code block
- </p>
- </td>
-<td>
- <p>
- <code class="literal">``int main();``</code>
- </p>
- </td>
-<td>
- <p>
- <a class="link" href="syntax/block.html#quickbook.syntax.block.code" title="Code">Code</a>
- </p>
- </td>
-</tr>
-<tr>
-<td>
- <p>
- code escape
- </p>
- </td>
-<td>
- <p>
- <code class="literal">``from c++ to QuickBook``</code>
- </p>
- </td>
-<td>
- <p>
- <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>
-<tr>
-<td>
- <p>
- line break
- </p>
- </td>
-<td>
- <p>
- <code class="literal">[br] or \n</code>
- </p>
- </td>
-<td>
- <p>
- <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>
-<tr>
-<td>
- <p>
- anchor
- </p>
- </td>
-<td>
- <p>
- <code class="literal">[#anchor]</code>
- </p>
- </td>
-<td>
- <p>
- <a class="link" href="syntax/phrase.html#quickbook.syntax.phrase.anchors" title="Anchors">Anchors</a>
- </p>
- </td>
-</tr>
-<tr>
-<td>
- <p>
- link
- </p>
- </td>
-<td>
- <p>
- <code class="literal">[@http://www.boost.org Boost]</code>
- </p>
- </td>
-<td>
- <p>
- <a class="link" href="syntax/phrase.html#quickbook.syntax.phrase.links" title="Links">Links</a>
- </p>
- </td>
-</tr>
-<tr>
-<td>
- <p>
- anchor link
- </p>
- </td>
-<td>
- <p>
- <code class="literal">[link section.anchor Link text]</code>
- </p>
- </td>
-<td>
- <p>
- <a class="link" href="syntax/phrase.html#quickbook.syntax.phrase.anchor_links" title="Anchor links">Anchor links</a>
- </p>
- </td>
-</tr>
-<tr>
-<td>
- <p>
- refentry link
- </p>
- </td>
-<td>
- <p>
- <code class="literal">[link xml.refentry Link text]</code>
- </p>
- </td>
-<td>
- <p>
- <a class="link" href="syntax/phrase.html#quickbook.syntax.phrase.refentry_links" title="refentry links">refentry links</a>
- </p>
- </td>
-</tr>
-<tr>
-<td>
- <p>
- function link
- </p>
- </td>
-<td>
- <p>
- <code class="literal">[funcref fully::qualified::function_name Link text]</code>
- </p>
- </td>
-<td>
- <p>
- <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>
-</tr>
-<tr>
-<td>
- <p>
- class link
- </p>
- </td>
-<td>
- <p>
- <code class="literal">[classref fully::qualified::class_name Link text]</code>
- </p>
- </td>
-<td>
- <p>
- <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>
-</tr>
-<tr>
-<td>
- <p>
- member link
- </p>
- </td>
-<td>
- <p>
- <code class="literal">[memberref fully::qualified::member_name Link text]</code>
- </p>
- </td>
-<td>
- <p>
- <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>
-</tr>
-<tr>
-<td>
- <p>
- enum link
- </p>
- </td>
-<td>
- <p>
- <code class="literal">[enumref fully::qualified::enum_name Link text]</code>
- </p>
- </td>
-<td>
- <p>
- <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>
-</tr>
-<tr>
-<td>
- <p>
- macro link
- </p>
- </td>
-<td>
- <p>
- <code class="literal">[macroref MACRO_NAME Link text]</code>
- </p>
- </td>
-<td>
- <p>
- <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>
-</tr>
-<tr>
-<td>
- <p>
- concept link
- </p>
- </td>
-<td>
- <p>
- <code class="literal">[conceptref ConceptName Link text]</code>
- </p>
- </td>
-<td>
- <p>
- <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>
-</tr>
-<tr>
-<td>
- <p>
- header link
- </p>
- </td>
-<td>
- <p>
- <code class="literal">[headerref path/to/header.hpp Link text]</code>
- </p>
- </td>
-<td>
- <p>
- <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>
-</tr>
-<tr>
-<td>
- <p>
- global link
- </p>
- </td>
-<td>
- <p>
- <code class="literal">[globalref fully::qualified::global Link text]</code>
- </p>
- </td>
-<td>
- <p>
- <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>
-</tr>
-<tr>
-<td>
- <p>
- escape
- </p>
- </td>
-<td>
- <p>
- <code class="literal">'''escaped text (no processing/formatting)'''</code>
- </p>
- </td>
-<td>
- <p>
- <a class="link" href="syntax/phrase.html#quickbook.syntax.phrase.escape" title="Escape">Escape</a>
- </p>
- </td>
-</tr>
-<tr>
-<td>
- <p>
- single char escape
- </p>
- </td>
-<td>
- <p>
- <code class="literal">\c</code>
- </p>
- </td>
-<td>
- <p>
- <a class="link" href="syntax/phrase.html#quickbook.syntax.phrase.single_char_escape" title="Single char escape">Single char
- escape</a>
- </p>
- </td>
-</tr>
-<tr>
-<td>
- <p>
- images
- </p>
- </td>
-<td>
- <p>
- <code class="literal">[$image.jpg]</code>
- </p>
- </td>
-<td>
- <p>
- <a class="link" href="syntax/phrase.html#quickbook.syntax.phrase.images" title="Images">Images</a>
- </p>
- </td>
-</tr>
-<tr>
-<td>
- <p>
- begin section
- </p>
- </td>
-<td>
- <p>
- <code class="literal">[section The Section Title]</code>
- </p>
- </td>
-<td>
- <p>
- <a class="link" href="syntax/block.html#quickbook.syntax.block.section" title="Section">Section</a>
- </p>
- </td>
-</tr>
-<tr>
-<td>
- <p>
- end section
- </p>
- </td>
-<td>
- <p>
- <code class="literal">[endsect]</code>
- </p>
- </td>
-<td>
- <p>
- <a class="link" href="syntax/block.html#quickbook.syntax.block.section" title="Section">Section</a>
- </p>
- </td>
-</tr>
-<tr>
-<td>
- <p>
- paragraph
- </p>
- </td>
-<td>
- <p>
- No markup. Paragraphs start left-flushed and are terminated by two or
- more newlines.
- </p>
- </td>
-<td>
- <p>
- <a class="link" href="syntax/block.html#quickbook.syntax.block.paragraphs" title="Paragraphs">Paragraphs</a>
- </p>
- </td>
-</tr>
-<tr>
-<td>
- <p>
- ordered list
- </p>
- </td>
-<td>
- <p>
-
-</p>
-<pre class="programlisting"># one
-# two
-# three
-</pre>
-<p>
- </p>
- </td>
-<td>
- <p>
- <a class="link" href="syntax/block.html#quickbook.syntax.block.lists.ordered_lists" title="Ordered lists">Ordered lists</a>
- </p>
- </td>
-</tr>
-<tr>
-<td>
- <p>
- unordered list
- </p>
- </td>
-<td>
- <p>
-
-</p>
-<pre class="programlisting">* one
-* two
-* three
-</pre>
-<p>
- </p>
- </td>
-<td>
- <p>
- <a class="link" href="syntax/block.html#quickbook.syntax.block.lists.unordered_lists" title="Unordered lists">Unordered
- lists</a>
- </p>
- </td>
-</tr>
-<tr>
-<td>
- <p>
- code
- </p>
- </td>
-<td>
- <p>
- No markup. Preformatted code starts with a space or a tab.
- </p>
- </td>
-<td>
- <p>
- <a class="link" href="syntax/block.html#quickbook.syntax.block.code" title="Code">Code</a>
- </p>
- </td>
-</tr>
-<tr>
-<td>
- <p>
- preformatted
- </p>
- </td>
-<td>
- <p>
- <code class="literal">[pre preformatted]</code>
- </p>
- </td>
-<td>
- <p>
- <a class="link" href="syntax/block.html#quickbook.syntax.block.preformatted" title="Preformatted">Preformatted</a>
- </p>
- </td>
-</tr>
-<tr>
-<td>
- <p>
- block quote
- </p>
- </td>
-<td>
- <p>
- <code class="literal">[:sometext...]</code>
- </p>
- </td>
-<td>
- <p>
- <a class="link" href="syntax/block.html#quickbook.syntax.block.blockquote" title="Blockquote">Blockquote</a>
- </p>
- </td>
-</tr>
-<tr>
-<td>
- <p>
- heading 1
- </p>
- </td>
-<td>
- <p>
- <code class="literal">[h1 Heading 1]</code>
- </p>
- </td>
-<td>
- <p>
- <a class="link" href="syntax/block.html#quickbook.syntax.block.headings" title="Headings">Heading</a>
- </p>
- </td>
-</tr>
-<tr>
-<td>
- <p>
- heading 2
- </p>
- </td>
-<td>
- <p>
- <code class="literal">[h2 Heading 2]</code>
- </p>
- </td>
-<td>
- <p>
- <a class="link" href="syntax/block.html#quickbook.syntax.block.headings" title="Headings">Heading</a>
- </p>
- </td>
-</tr>
-<tr>
-<td>
- <p>
- heading 3
- </p>
- </td>
-<td>
- <p>
- <code class="literal">[h3 Heading 3]</code>
- </p>
- </td>
-<td>
- <p>
- <a class="link" href="syntax/block.html#quickbook.syntax.block.headings" title="Headings">Heading</a>
- </p>
- </td>
-</tr>
-<tr>
-<td>
- <p>
- heading 4
- </p>
- </td>
-<td>
- <p>
- <code class="literal">[h4 Heading 4]</code>
- </p>
- </td>
-<td>
- <p>
- <a class="link" href="syntax/block.html#quickbook.syntax.block.headings" title="Headings">Heading</a>
- </p>
- </td>
-</tr>
-<tr>
-<td>
- <p>
- heading 5
- </p>
- </td>
-<td>
- <p>
- <code class="literal">[h5 Heading 5]</code>
- </p>
- </td>
-<td>
- <p>
- <a class="link" href="syntax/block.html#quickbook.syntax.block.headings" title="Headings">Heading</a>
- </p>
- </td>
-</tr>
-<tr>
-<td>
- <p>
- heading 6
- </p>
- </td>
-<td>
- <p>
- <code class="literal">[h6 Heading 6]</code>
- </p>
- </td>
-<td>
- <p>
- <a class="link" href="syntax/block.html#quickbook.syntax.block.headings" title="Headings">Heading</a>
- </p>
- </td>
-</tr>
-<tr>
-<td>
- <p>
- macro
- </p>
- </td>
-<td>
- <p>
- <code class="literal">[def macro_identifier some text]</code>
- </p>
- </td>
-<td>
- <p>
- <a class="link" href="syntax/block.html#quickbook.syntax.block.macros" title="Macros">Macros</a>
- </p>
- </td>
-</tr>
-<tr>
-<td>
- <p>
- template
- </p>
- </td>
-<td>
- <p>
- <code class="literal">[template[a b] [a] body [b]]</code>
- </p>
- </td>
-<td>
- <p>
- <a class="link" href="syntax/block.html#quickbook.syntax.block.templates" title="Templates">Templates</a>
- </p>
- </td>
-</tr>
-<tr>
-<td>
- <p>
- blurb
- </p>
- </td>
-<td>
- <p>
- <code class="literal">[blurb advertisement or note...]</code>
- </p>
- </td>
-<td>
- <p>
- <a class="link" href="syntax/block.html#quickbook.syntax.block.blurbs" title="Blurbs">Blurbs</a>
- </p>
- </td>
-</tr>
-<tr>
-<td>
- <p>
- admonition
- </p>
- </td>
-<td>
- <p>
- <code class="literal">[warning Warning text...]</code>
- </p>
- </td>
-<td>
- <p>
- <a class="link" href="syntax/block.html#quickbook.syntax.block.admonitions" title="Admonitions">Admonitions</a>
- </p>
- </td>
-</tr>
-<tr>
-<td>
- <p>
- table
- </p>
- </td>
-<td>
- <p>
-
-</p>
-<pre class="programlisting">[table Title
-[[a][b][c]]
-[[a][b][c]]
-]
-</pre>
-<p>
- </p>
- </td>
-<td>
- <p>
- <a class="link" href="syntax/block.html#quickbook.syntax.block.tables" title="Tables">Tables</a>
- </p>
- </td>
-</tr>
-<tr>
-<td>
- <p>
- variablelist
- </p>
- </td>
-<td>
- <p>
-
-</p>
-<pre class="programlisting">[variablelist Title
-[[a][b]]
-[[a][b]]
-]
-</pre>
-<p>
- </p>
- </td>
-<td>
- <p>
- <a class="link" href="syntax/block.html#quickbook.syntax.block.variable_lists" title="Variable Lists">Variable Lists</a>
- </p>
- </td>
-</tr>
-<tr>
-<td>
- <p>
- include
- </p>
- </td>
-<td>
- <p>
- <code class="literal">[include someother.qbk]</code>
- </p>
- </td>
-<td>
- <p>
- <a class="link" href="syntax/block.html#quickbook.syntax.block.include" title="Include">Include</a>
- </p>
- </td>
-</tr>
-<tr>
-<td>
- <p>
- conditional generation
- </p>
- </td>
-<td>
- <p>
- <code class="literal">[? symbol phrase]</code>
- </p>
- </td>
-<td>
- <p>
- <a class="link" href="syntax/phrase.html#quickbook.syntax.phrase.cond" title="Conditional Generation">Conditional Generation</a>
- </p>
- </td>
-</tr>
-</tbody>
-</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>
-<td align="right"><div class="copyright-footer">Copyright © 2002, 2004, 2006 Joel de Guzman,
- Eric Niebler<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>
-</div></td>
-</tr></table>
-<hr>
-<div class="spirit-nav">
-<a accesskey="p" href="faq.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/html/images/home.png" alt="Home"></a>
-</div>
-</body>
-</html>

Deleted: trunk/tools/quickbook/doc/html/quickbook/syntax.html
==============================================================================
--- trunk/tools/quickbook/doc/html/quickbook/syntax.html 2008-09-23 15:44:39 EDT (Tue, 23 Sep 2008)
+++ (empty file)
@@ -1,64 +0,0 @@
-<html>
-<head>
-<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
-<title>Syntax Summary</title>
-<link rel="stylesheet" href="../../../../../doc/html/boostbook.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
-<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="next" href="syntax/comments.html" title="Comments">
-</head>
-<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
-<table cellpadding="2" width="100%"><tr>
-<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td>
-<td align="center">Home</td>
-<td align="center">Libraries</td>
-<td align="center">People</td>
-<td align="center">FAQ</td>
-<td align="center">More</td>
-</tr></table>
-<hr>
-<div class="spirit-nav">
-<a accesskey="p" href="change_log.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="syntax/comments.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
-</div>
-<div class="section" lang="en">
-<div class="titlepage"><div><div><h2 class="title" style="clear: both">
-<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>
-<dt><span class="section"> Block Level Elements</span></dt>
-</dl></div>
-<p>
- 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.
- </p>
-<p>
- 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.
- </p>
-</div>
-<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
-<td align="left"></td>
-<td align="right"><div class="copyright-footer">Copyright © 2002, 2004, 2006 Joel de Guzman,
- Eric Niebler<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>
-</div></td>
-</tr></table>
-<hr>
-<div class="spirit-nav">
-<a accesskey="p" href="change_log.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="syntax/comments.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
-</div>
-</body>
-</html>

Deleted: trunk/tools/quickbook/doc/html/quickbook/syntax/block.html
==============================================================================
--- trunk/tools/quickbook/doc/html/quickbook/syntax/block.html 2008-09-23 15:44:39 EDT (Tue, 23 Sep 2008)
+++ (empty file)
@@ -1,1895 +0,0 @@
-<html>
-<head>
-<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
-<title>Block Level Elements</title>
-<link rel="stylesheet" href="../../../../../../doc/html/boostbook.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
-<link rel="start" href="../../index.html" title="Quickbook 1.4">
-<link rel="up" href="../syntax.html" title="Syntax Summary">
-<link rel="prev" href="phrase.html" title="Phrase Level Elements">
-<link rel="next" href="../install.html" title="Installation and configuration">
-</head>
-<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
-<table cellpadding="2" width="100%"><tr>
-<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td>
-<td align="center">Home</td>
-<td align="center">Libraries</td>
-<td align="center">People</td>
-<td align="center">FAQ</td>
-<td align="center">More</td>
-</tr></table>
-<hr>
-<div class="spirit-nav">
-<a accesskey="p" href="phrase.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../syntax.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="../install.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
-</div>
-<div class="section" lang="en">
-<div class="titlepage"><div><div><h3 class="title">
-<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>
-<dt><span class="section">xinclude</span></dt>
-<dt><span class="section">Paragraphs</span></dt>
-<dt><span class="section">Lists</span></dt>
-<dt><span class="section">Code</span></dt>
-<dt><span class="section"><a href="block.html#quickbook.syntax.block.escape_back"> Escaping Back
- To QuickBook</a></span></dt>
-<dt><span class="section">Preformatted</span></dt>
-<dt><span class="section">Blockquote</span></dt>
-<dt><span class="section">Admonitions</span></dt>
-<dt><span class="section">Headings</span></dt>
-<dt><span class="section">Generic Heading</span></dt>
-<dt><span class="section">Macros</span></dt>
-<dt><span class="section"><a href="block.html#quickbook.syntax.block.predefined_macros">Predefined
- Macros</a></span></dt>
-<dt><span class="section">Templates</span></dt>
-<dt><span class="section">Blurbs</span></dt>
-<dt><span class="section">Tables</span></dt>
-<dt><span class="section">Variable Lists</span></dt>
-<dt><span class="section">Include</span></dt>
-<dt><span class="section">Import</span></dt>
-</dl></div>
-<div class="section" lang="en">
-<div class="titlepage"><div><div><h4 class="title">
-<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:
- </p>
-<pre class="programlisting">[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]
-]
-</pre>
-<p>
- Where document-type is one of:
- </p>
-<div class="itemizedlist"><ul type="disc">
-<li>
- book
- </li>
-<li>
- article
- </li>
-<li>
- library
- </li>
-<li>
- chapter
- </li>
-<li>
- part
- </li>
-<li>
- appendix
- </li>
-<li>
- preface
- </li>
-<li>
- qandadiv
- </li>
-<li>
- qandaset
- </li>
-<li>
- reference
- </li>
-<li>
- set
- </li>
-</ul></div>
-<p>
- quickbook 1.3 declares the version of quickbook the document is written
- for. In its absence, version 1.1 is assumed.
- </p>
-<p>
- <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>
- <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><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>
-<pre class="programlisting">[section:id The Section Title]
-</pre>
-<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 <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".
- </p>
-<p>
- End a section with:
- </p>
-<pre class="programlisting">[endsect]
-</pre>
-<p>
- Sections can nest, and that results in a hierarchy in the table of contents.
- </p>
-</div>
-<div class="section" lang="en">
-<div class="titlepage"><div><div><h4 class="title">
-<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>
-<pre class="programlisting">[xinclude file.xml]
-</pre>
-<p>
- This is useful when file.xml has been generated by Doxygen and contains
- your reference section.
- </p>
-</div>
-<div class="section" lang="en">
-<div class="titlepage"><div><div><h4 class="title">
-<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
- 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.
- </p>
-<p>
- This is a new paragraph...
- </p>
-</div>
-<div class="section" lang="en">
-<div class="titlepage"><div><div><h4 class="title">
-<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>
-<dt><span class="section"><a href="block.html#quickbook.syntax.block.lists.list_hierarchies">List
- Hierarchies</a></span></dt>
-<dt><span class="section"><a href="block.html#quickbook.syntax.block.lists.long_list_lines">Long
- List Lines</a></span></dt>
-<dt><span class="section"><a href="block.html#quickbook.syntax.block.lists.unordered_lists">Unordered
- lists</a></span></dt>
-<dt><span class="section">Mixed lists</span></dt>
-</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 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
-</pre>
-<p>
- will generate:
- </p>
-<div class="orderedlist"><ol type="1">
-<li>
- One
- </li>
-<li>
- Two
- </li>
-<li>
- Three
- </li>
-</ol></div>
-</div>
-<div class="section" lang="en">
-<div class="titlepage"><div><div><h5 class="title">
-<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>
-<pre class="programlisting"># One
-# Two
-# Three
- # Three.a
- # Three.b
- # Three.c
-# Four
- # Four.a
- # Four.a.i
- # Four.a.ii
-# Five
-</pre>
-<p>
- will generate:
- </p>
-<div class="orderedlist"><ol type="1">
-<li>
- One
- </li>
-<li>
- Two
- </li>
-<li>
- Three
- <div class="orderedlist"><ol type="a">
-<li>
- Three.a
- </li>
-<li>
- Three.b
- </li>
-<li>
- Three.c
- </li>
-</ol></div>
-</li>
-<li>
- Fourth
- <div class="orderedlist"><ol type="a"><li>
- Four.a
- <div class="orderedlist"><ol type="i">
-<li>
- Four.a.i
- </li>
-<li>
- Four.a.ii
- </li>
-</ol></div>
-</li></ol></div>
-</li>
-<li>
- Five
- </li>
-</ol></div>
-</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 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>
-<pre class="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.
-</pre>
-<div class="orderedlist"><ol type="1">
-<li>
- A short item.
- </li>
-<li>
- 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.
- </li>
-<li>
- A short item.
- </li>
-</ol></div>
-</div>
-<div class="section" lang="en">
-<div class="titlepage"><div><div><h5 class="title">
-<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
-</pre>
-<p>
- will generate:
- </p>
-<div class="itemizedlist"><ul type="disc">
-<li>
- First
- </li>
-<li>
- Second
- </li>
-<li>
- Third
- </li>
-</ul></div>
-</div>
-<div class="section" lang="en">
-<div class="titlepage"><div><div><h5 class="title">
-<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>
-<pre class="programlisting"># One
-# Two
-# Three
- * Three.a
- * Three.b
- * Three.c
-# Four
-</pre>
-<p>
- will generate:
- </p>
-<div class="orderedlist"><ol type="1">
-<li>
- One
- </li>
-<li>
- Two
- </li>
-<li>
- Three
- <div class="itemizedlist"><ul type="disc">
-<li>
- Three.a
- </li>
-<li>
- Three.b
- </li>
-<li>
- Three.c
- </li>
-</ul></div>
-</li>
-<li>
- Four
- </li>
-</ol></div>
-<p>
- And...
- </p>
-<pre class="programlisting"># 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
-</pre>
-<p>
- will generate:
- </p>
-<div class="orderedlist"><ol type="1">
-<li>
- 1
- <div class="itemizedlist"><ul type="disc">
-<li>
- 1.a
- <div class="orderedlist"><ol type="a">
-<li>
- 1.a.1
- </li>
-<li>
- 1.a.2
- </li>
-</ol></div>
-</li>
-<li>
- 1.b
- </li>
-</ul></div>
-</li>
-<li>
- 2
- <div class="itemizedlist"><ul type="disc">
-<li>
- 2.a
- </li>
-<li>
- 2.b
- <div class="orderedlist"><ol type="a">
-<li>
- 2.b.1
- </li>
-<li>
- 2.b.2
- <div class="itemizedlist"><ul type="circle">
-<li>
- 2.b.2.a
- </li>
-<li>
- 2.b.2.b
- </li>
-</ul></div>
-</li>
-</ol></div>
-</li>
-</ul></div>
-</li>
-</ol></div>
-</div>
-</div>
-<div class="section" lang="en">
-<div class="titlepage"><div><div><h4 class="title">
-<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 class="link" href="phrase.html#quickbook.syntax.phrase.source_mode" title="Source Mode">Source
- Mode</a>:
- </p>
-<p>
- </p>
-<pre class="programlisting"><span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">iostream</span><span class="special">></span>
-
-<span class="keyword">int</span> <span class="identifier">main</span><span class="special">()</span>
-<span class="special">{</span>
- <span class="comment">// Sample code
-</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span> <span class="special"><<</span> <span class="string">"Hello, World\n"</span><span class="special">;</span>
- <span class="keyword">return</span> <span class="number">0</span><span class="special">;</span>
-<span class="special">}</span>
-</pre>
-<p>
- </p>
-<pre class="programlisting"><span class="keyword">import</span> <span class="identifier">cgi</span>
-
-<span class="keyword">def</span> <span class="identifier">cookForHtml</span><span class="special">(</span><span class="identifier">text</span><span class="special">):</span>
- <span class="string">'''"Cooks" the input text for HTML.'''</span>
-
- <span class="keyword">return</span> <span class="identifier">cgi</span><span class="special">.</span><span class="identifier">escape</span><span class="special">(</span><span class="identifier">text</span><span class="special">)</span>
-</pre>
-<p>
- </p>
-<p>
- Macros that are already defined are expanded in source code. Example:
- </p>
-<pre class="programlisting">[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__;
-</pre>
-<p>
- Generates:
- </p>
-<pre class="programlisting"><span class="keyword">using</span> boost<span class="special">::</span>array<span class="special">;</span>
-</pre>
-</div>
-<div class="section" lang="en">
-<div class="titlepage"><div><div><h4 class="title">
-<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
- need to switch back to QuickBook markup inside code, you can do so using
- a language specific <span class="emphasis"><em>escape-back</em></span> delimiter. In C++
- and Python, the delimiter is the double tick (back-quote): "``"
- and "``". Example:
- </p>
-<pre class="programlisting">void ``[@http://en.wikipedia.org/wiki/Foo#Foo.2C_Bar_and_Baz foo]``()
-{
-}
-</pre>
-<p>
- Will generate:
- </p>
-<pre class="programlisting"><span class="keyword">void</span> foo<span class="special">()</span>
-<span class="special">{</span>
-<span class="special">}</span>
-</pre>
-<p>
- When escaping from code to QuickBook, only phrase level markups are allowed.
- Block level markups like lists, tables etc. are not allowed.
- </p>
-</div>
-<div class="section" lang="en">
-<div class="titlepage"><div><div><h4 class="title">
-<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 <code class="literal">[pre ... ]</code> markup block.
- </p>
-<pre class="programlisting">[pre
-
- Some *preformatted* text Some *preformatted* text
-
- Some *preformatted* text Some *preformatted* text
-
- Some *preformatted* text Some *preformatted* text
-
-]
-</pre>
-<p>
- 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:
- </p>
-<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"><strong>preformatted</strong></span> text Some <span class="bold"><strong>preformatted</strong></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 <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><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">
-<p>
- </p>
-<p>
- Indents the paragraph. This applies to one paragraph only.
- </p>
-<p>
- </p>
-</blockquote></div>
-</div>
-<div class="section" lang="en">
-<div class="titlepage"><div><div><h4 class="title">
-<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]
-[caution This is a caution]
-[warning This is a warning]
-</pre>
-<p>
- generates DocBook admonitions:
- </p>
-<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 align="left" valign="top"><p>
- This is a note
- </p></td></tr>
-</table></div>
-<div class="tip"><table border="0" summary="Tip">
-<tr>
-<td rowspan="2" align="center" valign="top" width="25"><img alt="[Tip]" src="../../../../../../doc/html/images/tip.png"></td>
-<th align="left">Tip</th>
-</tr>
-<tr><td align="left" valign="top"><p>
- This is a tip
- </p></td></tr>
-</table></div>
-<div class="important"><table border="0" summary="Important">
-<tr>
-<td rowspan="2" align="center" valign="top" width="25"><img alt="[Important]" src="../../../../../../doc/html/images/important.png"></td>
-<th align="left">Important</th>
-</tr>
-<tr><td align="left" valign="top"><p>
- This is important
- </p></td></tr>
-</table></div>
-<div class="caution"><table border="0" summary="Caution">
-<tr>
-<td rowspan="2" align="center" valign="top" width="25"><img alt="[Caution]" src="../../../../../../doc/html/images/caution.png"></td>
-<th align="left">Caution</th>
-</tr>
-<tr><td align="left" valign="top"><p>
- This is a caution
- </p></td></tr>
-</table></div>
-<div class="warning"><table border="0" summary="Warning">
-<tr>
-<td rowspan="2" align="center" valign="top" width="25"><img alt="[Warning]" src="../../../../../../doc/html/images/warning.png"></td>
-<th align="left">Warning</th>
-</tr>
-<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 <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><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]
-[h4 Heading 4]
-[h5 Heading 5]
-[h6 Heading 6]
-</pre>
-<a name="quickbook.syntax.block.headings.heading_1"></a><h2>
-<a name="id4957165"></a>
- <a class="link" href="block.html#quickbook.syntax.block.headings.heading_1">Heading 1</a>
- </h2>
-<a name="quickbook.syntax.block.headings.heading_2"></a><h3>
-<a name="id4957186"></a>
- <a class="link" href="block.html#quickbook.syntax.block.headings.heading_2">Heading 2</a>
- </h3>
-<a name="quickbook.syntax.block.headings.heading_3"></a><h4>
-<a name="id4957206"></a>
- <a class="link" href="block.html#quickbook.syntax.block.headings.heading_3">Heading 3</a>
- </h4>
-<a name="quickbook.syntax.block.headings.heading_4"></a><h5>
-<a name="id4957227"></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="id4957248"></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="id4957268"></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 <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 <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 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><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>:
- </p>
-<pre class="programlisting">[heading Heading]
-</pre>
-<p>
- The <span class="emphasis"><em>Generic Heading</em></span> 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 <span class="emphasis"><em>h2</em></span>.
- </p>
-<p>
- 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:
- </p>
-<pre class="programlisting">[section A]
-[h2 X]
-[h2 Y]
-[h2 Z]
-[endsect]
-</pre>
-<p>
- 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:
- </p>
-<pre class="programlisting">[section A]
-[heading X]
-[heading Y]
-[heading Z]
-[endsect]
-</pre>
-<p>
- 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 <span class="emphasis"><em>section</em></span> and <span class="emphasis"><em>heading</em></span>, you
- have all you need. <span class="emphasis"><em>h1</em></span>..<span class="emphasis"><em>h6</em></span> becomes
- redundant. <span class="emphasis"><em>h1</em></span>..<span class="emphasis"><em>h6</em></span> might be deprecated
- in the future.
- </p>
-</div>
-<div class="section" lang="en">
-<div class="titlepage"><div><div><h4 class="title">
-<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>
- 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:
- </p>
-<pre class="programlisting">[def sf_logo [$http://sourceforge.net/sflogo.php?group_id=28447&type=1]]
-sf_logo
-</pre>
-<p>
- Now everywhere the sf_logo is placed, the picture will be inlined.
- </p>
-<p>
- <span class="inlinemediaobject"></span>
- </p>
-<div class="tip"><table border="0" summary="Tip">
-<tr>
-<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 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. <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"><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"><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:
- </p>
-<pre class="programlisting">[def :-) [$theme/smiley.png]]
-[def __spirit__ [@http://spirit.sourceforge.net Spirit]]
-</pre>
-<p>
- (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:
- </p>
-<pre class="programlisting">Hi __spirit__ :-)
-</pre>
-<p>
- will generate this:
- </p>
-<p>
- Hi Spirit <span class="inlinemediaobject"><img src="../../images/smiley.png" alt="smiley"></span>
- </p>
-</div>
-<div class="section" lang="en">
-<div class="titlepage"><div><div><h4 class="title">
-<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="id4957675"></a><p class="title"><b>Table 3. Predefined Macros</b></p>
-<div class="table-contents"><table class="table" summary="Predefined Macros">
-<colgroup>
-<col>
-<col>
-<col>
-</colgroup>
-<thead><tr>
-<th>
- <p>
- Macro
- </p>
- </th>
-<th>
- <p>
- Meaning
- </p>
- </th>
-<th>
- <p>
- Example
- </p>
- </th>
-</tr></thead>
-<tbody>
-<tr>
-<td>
- <p>
- __DATE__
- </p>
- </td>
-<td>
- <p>
- Today's date
- </p>
- </td>
-<td>
- <p>
- 2008-Jul-28
- </p>
- </td>
-</tr>
-<tr>
-<td>
- <p>
- __TIME__
- </p>
- </td>
-<td>
- <p>
- The current time
- </p>
- </td>
-<td>
- <p>
- 10:49:54 PM
- </p>
- </td>
-</tr>
-<tr>
-<td>
- <p>
- __FILENAME__
- </p>
- </td>
-<td>
- <p>
- Quickbook source filename
- </p>
- </td>
-<td>
- <p>
- C:\cygwin\home\ericne\boost\org\trunk\tools\quickbook\doc\quickbook.qbk
- </p>
- </td>
-</tr>
-</tbody>
-</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><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
- 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).
- </p>
-<p>
- Example template:
- </p>
-<pre class="programlisting">[template person[name age what]
-
-Hi, my name is [name]. I am [age] years old. I am a [what].
-
-]
-</pre>
-<a name="quickbook.syntax.block.templates.template_identifier"></a><h6>
-<a name="id4957835"></a>
- <a class="link" href="block.html#quickbook.syntax.block.templates.template_identifier">Template
- Identifier</a>
- </h6>
-<p>
- Template identifiers can either consist of:
- </p>
-<div class="itemizedlist"><ul type="disc">
-<li>
- 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.
- </li>
-<li>
- A single character punctuation (a non-alphanumeric printable character)
- </li>
-</ul></div>
-<a name="quickbook.syntax.block.templates.formal_template_arguments"></a><h6>
-<a name="id4957876"></a>
- <a class="link" href="block.html#quickbook.syntax.block.templates.formal_template_arguments">Formal
- Template Arguments</a>
- </h6>
-<p>
- 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.
- </p>
-<p>
- A template formal argument temporarily hides a template of the same name
- 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><h6>
-<a name="id4957984"></a>
- <a class="link" href="block.html#quickbook.syntax.block.templates.template_body">Template
- Body</a>
- </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
- templates are of the form:
- </p>
-<pre class="programlisting">[template sample[arg1 arg2...argN] replacement text... ]
-</pre>
-<p>
- Block templates are of the form:
- </p>
-<pre class="programlisting">[template sample[arg1 arg2...argN]
-replacement text...
-]
-</pre>
-<p>
- 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.
- </p>
-<a name="quickbook.syntax.block.templates.template_expansion"></a><h6>
-<a name="id4958041"></a>
- <a class="link" href="block.html#quickbook.syntax.block.templates.template_expansion">Template
- Expansion</a>
- </h6>
-<p>
- You expand a template this way:
- </p>
-<pre class="programlisting">[template_identifier arg1..arg2..arg3]
-</pre>
-<p>
- At template expansion, you supply the actual arguments. The template will
- be expanded with your supplied arguments. Example:
- </p>
-<pre class="programlisting">[person James Bond..39..Spy]
-[person Santa Clause..87..Big Red Fatso]
-</pre>
-<p>
- Which will expand to:
- </p>
-<p>
- </p>
-<p>
- Hi, my name is James Bond. I am 39 years old. I am a Spy.
- </p>
-<p>
- </p>
-<p>
- Hi, my name is Santa Clause. I am 87 years old. I am a Big Red Fatso.
- </p>
-<p>
- </p>
-<div class="caution"><table border="0" summary="Caution">
-<tr>
-<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 align="left" valign="top"><p>
- A word of caution: Templates are recursive. A template can call another
- template or even itself, directly or indirectly. There are no control
- structures in QuickBook (yet) so this will always mean infinite recursion.
- QuickBook can detect this situation and report an error if recursion
- exceeds a certain limit.
- </p></td></tr>
-</table></div>
-<p>
- Each actual argument can be a word, a text fragment or just about any
- <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><h6>
-<a name="id4958138"></a>
- <a class="link" href="block.html#quickbook.syntax.block.templates.nullary_templates">Nullary
- Templates</a>
- </h6>
-<p>
- Nullary templates look and act like simple macros. Example:
- </p>
-<pre class="programlisting">[template alpha[]'''&#945;''']
-[template beta[]'''&#946;''']
-</pre>
-<p>
- Expanding:
- </p>
-<pre class="programlisting">Some squigles...[*[alpha][beta]]</pre>
-<p>
- We have:
- </p>
-<p>
- 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 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.
- </li>
-<li>
- 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.
- </li>
-</ul></div>
-<p>
- 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>
-<pre class="programlisting">[template aristotle_quote Aristotle: [*['Education is the best provision
-for the journey to old age.]]]
-</pre>
-<p>
- Expanding:
- </p>
-<pre class="programlisting">Here's a quote from [aristotle_quote].
-</pre>
-<p>
- We have:
- </p>
-<p>
- 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, <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: "<code class="computeroutput"><span class="special">\</span> </code>".
- Example:
- </p>
-<pre class="programlisting">[template tag\ _tag]
-</pre>
-<p>
- Then expanding:
- </p>
-<pre class="programlisting">`struct` x[tag];
-</pre>
-<p>
- We have:
- </p>
-<p>
- <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><h6>
-<a name="id4958354"></a>
- <a class="link" href="block.html#quickbook.syntax.block.templates.simple_arguments">Simple
- Arguments</a>
- </h6>
-<p>
- 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 (<code class="literal">'',
- '\n', \t' or '\r'</code>).
- </li>
-<li>
- Repeat until there are enough arguments or if there are no more spaces
- found (in which case, an error is reported).
- </li>
-</ul></div>
-<p>
- For example:
- </p>
-<pre class="programlisting">[template simple[a b c d] [a][b][c][d]]
-[simple w x y z]
-</pre>
-<p>
- will produce:
- </p>
-<p>
- wxyz
- </p>
-<p>
- "w x y z" is initially treated as a single argument because we
- 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>
-<p>
- QuickBook only tries to get the arguments it needs. For example:
- </p>
-<pre class="programlisting">[simple w x y z trail]
-</pre>
-<p>
- will produce:
- </p>
-<p>
- wxyz trail
- </p>
-<p>
- The arguments being: "w", "x", "y" and "z
- trail".
- </p>
-<p>
- It should be obvious now that for simple arguments with no spaces, we can
- 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?]
-</pre>
-<p>
- will produce:
- </p>
-<p>
- what do you think man?
- </p>
-<a name="quickbook.syntax.block.templates.punctuation_templates"></a><h6>
-<a name="id4958508"></a>
- <a class="link" href="block.html#quickbook.syntax.block.templates.punctuation_templates">Punctuation
- Templates</a>
- </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 class="link" href="block.html#quickbook.syntax.block.templates.template_identifier">template
- identifiers</a>. Example:
- </p>
-<pre class="programlisting">[template ![bar] <hey>[bar]</hey>]
-</pre>
-<p>
- Now, expanding this:
- </p>
-<pre class="programlisting">[!baz]
-</pre>
-<p>
- We will have:
- </p>
-<pre class="programlisting"><hey>baz</hey>
-</pre>
-</div>
-<div class="section" lang="en">
-<div class="titlepage"><div><div><h4 class="title">
-<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
- implemented using template meta-programming techniques. Expression templates
- allow us to approximate the syntax of Extended Backus-Normal Form (EBNF)
- completely in C++.
-]
-</pre>
-<p>
- 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"><strong>An eye catching advertisement
- or note...</strong></span>
- </p>
-<p>
- 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++.
- </p>
-</div>
-<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 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><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]]
- [[R1-C0] [R1-C1] [R1-C2]]
- [[R2-C0] [R2-C1] [R2-C2]]
-]
-</pre>
-<p>
- will generate:
- </p>
-<div class="table">
-<a name="id4958692"></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>
-<col>
-</colgroup>
-<thead><tr>
-<th>
- <p>
- Heading 1
- </p>
- </th>
-<th>
- <p>
- Heading 2
- </p>
- </th>
-<th>
- <p>
- Heading 3
- </p>
- </th>
-</tr></thead>
-<tbody>
-<tr>
-<td>
- <p>
- R0-C0
- </p>
- </td>
-<td>
- <p>
- R0-C1
- </p>
- </td>
-<td>
- <p>
- R0-C2
- </p>
- </td>
-</tr>
-<tr>
-<td>
- <p>
- R2-C0
- </p>
- </td>
-<td>
- <p>
- R2-C1
- </p>
- </td>
-<td>
- <p>
- R2-C2
- </p>
- </td>
-</tr>
-<tr>
-<td>
- <p>
- R3-C0
- </p>
- </td>
-<td>
- <p>
- R3-C1
- </p>
- </td>
-<td>
- <p>
- R3-C2
- </p>
- </td>
-</tr>
-</tbody>
-</table></div>
-</div>
-<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 <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:
- </p>
-<pre class="programlisting">[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]
- ]
-]
-</pre>
-<p>
- and thus:
- </p>
-<div class="table">
-<a name="id4958841"></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>
-</colgroup>
-<thead><tr>
-<th>
- <p>
- Heading 1
- </p>
- </th>
-<th>
- <p>
- Heading 2
- </p>
- </th>
-</tr></thead>
-<tbody>
-<tr>
-<td>
- <p>
- Row 0, Col 0: a small cell
- </p>
- </td>
-<td>
- <p>
- Row 0, Col 1: a big fat cell with paragraphs
- </p>
- <p>
- Boost provides free peer-reviewed portable C++ source libraries.
- </p>
- <p>
- We emphasize libraries that work well with the C++ Standard Library.
- Boost libraries are intended to be widely useful, and usable across
- a broad spectrum of applications. The Boost license encourages both
- commercial and non-commercial use.
- </p>
- </td>
-</tr>
-<tr>
-<td>
- <p>
- Row 1, Col 0: a small cell
- </p>
- </td>
-<td>
- <p>
- Row 1, Col 1: a small cell
- </p>
- </td>
-</tr>
-</tbody>
-</table></div>
-</div>
-<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
- [[Comment] [Code]]
- [
- [My first program]
- [``
- #include <iostream>
-
- int main()
- {
- std::cout << "Hello, World!" << std::endl;
- return 0;
- }
- ``]
- ]
-]
-</pre>
-<div class="table">
-<a name="id4958948"></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>
-</colgroup>
-<thead><tr>
-<th>
- <p>
- Comment
- </p>
- </th>
-<th>
- <p>
- Code
- </p>
- </th>
-</tr></thead>
-<tbody><tr>
-<td>
- <p>
- My first program
- </p>
- </td>
-<td>
- <p>
-
-</p>
-<pre class="programlisting"><span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">iostream</span><span class="special">></span>
-
-<span class="keyword">int</span> <span class="identifier">main</span><span class="special">()</span>
-<span class="special">{</span>
- <span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span> <span class="special"><<</span> <span class="string">"Hello, World!"</span> <span class="special"><<</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">endl</span><span class="special">;</span>
- <span class="keyword">return</span> <span class="number">0</span><span class="special">;</span>
-<span class="special">}</span>
-</pre>
-<p>
- </p>
- </td>
-</tr></tbody>
-</table></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><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]]
- [[term 3] [
- The definition of term 3.
-
- Definitions may contain paragraphs.
- ]]
-]
-</pre>
-<p>
- will generate:
- </p>
-<div class="variablelist">
-<p class="title"><b>A Variable List</b></p>
-<dl>
-<dt><span class="term">term 1</span></dt>
-<dd><p>
- The definition of term 1
- </p></dd>
-<dt><span class="term">term 2</span></dt>
-<dd><p>
- The definition of term 2
- </p></dd>
-<dt><span class="term">term 3</span></dt>
-<dd>
-<p>
- The definition of term 3.
- </p>
-<p>
- Definitions may contain paragraphs.
- </p>
-</dd>
-</dl>
-</div>
-<p>
- 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".
- </p>
-</div>
-<div class="section" lang="en">
-<div class="titlepage"><div><div><h4 class="title">
-<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>
-<pre class="programlisting">[include someother.qbk]
-</pre>
-<p>
- The included file will be processed as if it had been cut and pasted into
- the current document, with the following exceptions:
- </p>
-<div class="itemizedlist"><ul type="disc">
-<li>
- The __FILENAME__ predefined macro will reflect the name of the file currently being
- processed.
- </li>
-<li>
- Any macros defined in the included file are scoped to that file.
- </li>
-</ul></div>
-<p>
- 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:
- </p>
-<pre class="programlisting">[include:someid someother.qbk]
-</pre>
-<p>
- 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 <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><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
- 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.
- </p>
-<p>
- QuickBook's import facility provides a nice solution.
- </p>
-<a name="quickbook.syntax.block.import.example"></a><h6>
-<a name="id4959336"></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:
- </p>
-<pre class="programlisting">[import ../test/stub.cpp]
-[foo]
-[bar]
-</pre>
-<p>
- The first line:
- </p>
-<pre class="programlisting">[import ../test/stub.cpp]
-</pre>
-<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. <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>
-<pre class="programlisting">[foo]
-[bar]
-</pre>
-<p>
- And the result is:
- </p>
-<p>
- </p>
-<p>
- This is the <span class="bold"><strong><span class="emphasis"><em>foo</em></span></strong></span>
- function.
- </p>
-<p>
- </p>
-<p>
- This description can have paragraphs...
- </p>
-<p>
- </p>
-<div class="itemizedlist"><ul type="disc">
-<li>
- lists
- </li>
-<li>
- etc.
- </li>
-</ul></div>
-<p>
- </p>
-<p>
- And any quickbook block markup.
- </p>
-<p>
- </p>
-<p>
-
-</p>
-<pre class="programlisting"><span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="identifier">foo</span><span class="special">()</span>
-<span class="special">{</span>
- <span class="comment">// return 'em, foo man!
-</span> <span class="keyword">return</span> <span class="string">"foo"</span><span class="special">;</span>
-<span class="special">}</span>
-</pre>
-<p>
- </p>
-<p>
- </p>
-<p>
- This is the <span class="bold"><strong><span class="emphasis"><em>bar</em></span></strong></span>
- function
- </p>
-<p>
- </p>
-<p>
-
-</p>
-<pre class="programlisting"><span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="identifier">bar</span><span class="special">()</span>
-<span class="special">{</span>
- <span class="comment">// return 'em, bar man!
-</span> <span class="keyword">return</span> <span class="string">"bar"</span><span class="special">;</span>
-<span class="special">}</span></pre>
-<p>
- </p>
-<p>
- </p>
-<p>
- Some trailing text here
- </p>
-<p>
- </p>
-<a name="quickbook.syntax.block.import.code_snippet_markup"></a><h6>
-<a name="id4959612"></a>
- <a class="link" href="block.html#quickbook.syntax.block.import.code_snippet_markup">Code
- Snippet Markup</a>
- </h6>
-<p>
- Note how the code snippets in stub.cpp
- get marked up. We use distinguishable comments following the form:
- </p>
-<pre class="programlisting"><span class="comment">//[id
-</span><span class="identifier">some</span> <span class="identifier">code</span> <span class="identifier">here</span>
-<span class="comment">//]
-</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 <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 <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><h6>
-<a name="id4959722"></a>
- <a class="link" href="block.html#quickbook.syntax.block.import.special_comments">Special
- Comments</a>
- </h6>
-<p>
- Special comments of the form:
- </p>
-<pre class="programlisting"><span class="comment">//` some [*quickbook] markup here
-</span></pre>
-<p>
- and:
- </p>
-<pre class="programlisting"><span class="comment">/*` some [*quickbook] markup here */</span>
-</pre>
-<p>
- will be parsed by QuickBook. This can contain quickbook <span class="emphasis"><em>blocks</em></span>
- (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.
- </p>
-<p>
- Special comments of the form:
- </p>
-<pre class="programlisting"><span class="comment">/*<- this C++ comment will be ignored ->*/</span>
-</pre>
-<p>
- or
- </p>
-<pre class="programlisting"><span class="comment">/*<-*/</span> <span class="string">"this c++ code will be ignored"</span> <span class="comment">/*->*/</span>
-</pre>
-<p>
- or
- </p>
-<pre class="programlisting"><span class="comment">//<-
-</span><span class="keyword">private</span><span class="special">:</span>
- <span class="keyword">int</span> <span class="identifier">some_member</span><span class="special">;</span>
-<span class="comment">//->
-</span></pre>
-<p>
- 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><h6>
-<a name="id4959882"></a>
- <a class="link" href="block.html#quickbook.syntax.block.import.callouts">Callouts</a>
- </h6>
-<p>
- Special comments of the form:
- </p>
-<pre class="programlisting"><span class="comment">/*< some [*quickbook] markup here >*/</span>
-</pre>
-<p>
- 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 Callouts
- for details. Example:
- </p>
-<p>
- </p>
-<p>
-
-</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 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 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>
- </p>
-<p>
- </p>
-<p>
- </p>
-<div class="calloutlist"><table border="0" summary="Callout list">
-<tr>
-<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"><p><a name="quickbook1"></a> </p></td>
-<td valign="top" align="left"><p> return 'em, foo-bar man! </p></td>
-</tr>
-</table></div>
-<p>
- </p>
-<p>
- </p>
-<p>
- This is the actual code:
- </p>
-<pre class="programlisting"><span class="comment">//[ foo_bar
-</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="comment">/*< The /Mythical/ FooBar.
- See [@http://en.wikipedia.org/wiki/Foobar Foobar for details] >*/</span>
-<span class="special">{</span>
- <span class="keyword">return</span> <span class="string">"foo-bar"</span><span class="special">;</span> <span class="comment">/*< return 'em, foo-bar man! >*/</span>
-<span class="special">}</span>
-<span class="comment">//]
-</span></pre>
-<p>
- The callouts bugs are placed exactly where the special callout comment
- is situated. It can be anywhere in the code. The bugs can be rather obtrusive,
- however. They get in the way of the clarity of the code. Another special
- callout comment style is available:
- </p>
-<pre class="programlisting"><span class="comment">/*<< some [*quickbook] markup here >>*/</span>
-</pre>
-<p>
- This is the line-oriented version of the callout. With this, the "bug"
- is placed at the very left of the code block, away from the actual code.
- By placing it at the far left, the code is rendered un-obscured. Example:
- </p>
-<p>
- </p>
-<p>
-
-</p>
-<pre class="programlisting"><span class="keyword">class</span> <span class="identifier">x</span>
-<span class="special">{</span>
-<span class="keyword">public</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 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 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 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>
-<span class="special">};</span>
-</pre>
-<p>
- </p>
-<p>
- </p>
-<p>
- </p>
-<div class="calloutlist"><table border="0" summary="Callout list">
-<tr>
-<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"><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"><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"><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>
-<p>
- </p>
-<p>
- </p>
-<p>
- See the actual code here: ../../test/stub.cpp
- </p>
-</div>
-</div>
-<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
-<td align="left"></td>
-<td align="right"><div class="copyright-footer">Copyright © 2002, 2004, 2006 Joel de Guzman,
- Eric Niebler<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>
-</div></td>
-</tr></table>
-<hr>
-<div class="spirit-nav">
-<a accesskey="p" href="phrase.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../syntax.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="../install.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
-</div>
-</body>
-</html>

Deleted: trunk/tools/quickbook/doc/html/quickbook/syntax/comments.html
==============================================================================
--- trunk/tools/quickbook/doc/html/quickbook/syntax/comments.html 2008-09-23 15:44:39 EDT (Tue, 23 Sep 2008)
+++ (empty file)
@@ -1,53 +0,0 @@
-<html>
-<head>
-<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
-<title>Comments</title>
-<link rel="stylesheet" href="../../../../../../doc/html/boostbook.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
-<link rel="start" href="../../index.html" title="Quickbook 1.4">
-<link rel="up" href="../syntax.html" title="Syntax Summary">
-<link rel="prev" href="../syntax.html" title="Syntax Summary">
-<link rel="next" href="phrase.html" title="Phrase Level Elements">
-</head>
-<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
-<table cellpadding="2" width="100%"><tr>
-<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td>
-<td align="center">Home</td>
-<td align="center">Libraries</td>
-<td align="center">People</td>
-<td align="center">FAQ</td>
-<td align="center">More</td>
-</tr></table>
-<hr>
-<div class="spirit-nav">
-<a accesskey="p" href="../syntax.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../syntax.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="phrase.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
-</div>
-<div class="section" lang="en">
-<div class="titlepage"><div><div><h3 class="title">
-<a name="quickbook.syntax.comments"></a><a class="link" href="comments.html" title="Comments">Comments</a>
-</h3></div></div></div>
-<p>
- Can be placed anywhere.
- </p>
-<pre class="programlisting">[/ comment (no output generated) ]
-</pre>
-<pre class="programlisting">[/ comments can be nested [/ some more here] ]
-</pre>
-<pre class="programlisting">[/ Quickbook blocks can nest inside comments. [*Comment this out too!] ]
-</pre>
-</div>
-<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
-<td align="left"></td>
-<td align="right"><div class="copyright-footer">Copyright © 2002, 2004, 2006 Joel de Guzman,
- Eric Niebler<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>
-</div></td>
-</tr></table>
-<hr>
-<div class="spirit-nav">
-<a accesskey="p" href="../syntax.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../syntax.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="phrase.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
-</div>
-</body>
-</html>

Deleted: trunk/tools/quickbook/doc/html/quickbook/syntax/phrase.html
==============================================================================
--- trunk/tools/quickbook/doc/html/quickbook/syntax/phrase.html 2008-09-23 15:44:39 EDT (Tue, 23 Sep 2008)
+++ (empty file)
@@ -1,866 +0,0 @@
-<html>
-<head>
-<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
-<title>Phrase Level Elements</title>
-<link rel="stylesheet" href="../../../../../../doc/html/boostbook.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
-<link rel="start" href="../../index.html" title="Quickbook 1.4">
-<link rel="up" href="../syntax.html" title="Syntax Summary">
-<link rel="prev" href="comments.html" title="Comments">
-<link rel="next" href="block.html" title="Block Level Elements">
-</head>
-<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
-<table cellpadding="2" width="100%"><tr>
-<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td>
-<td align="center">Home</td>
-<td align="center">Libraries</td>
-<td align="center">People</td>
-<td align="center">FAQ</td>
-<td align="center">More</td>
-</tr></table>
-<hr>
-<div class="spirit-nav">
-<a accesskey="p" href="comments.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../syntax.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="block.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
-</div>
-<div class="section" lang="en">
-<div class="titlepage"><div><div><h3 class="title">
-<a name="quickbook.syntax.phrase"></a><a 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>
-<dt><span class="section">Quotations</span></dt>
-<dt><span class="section">Simple formatting</span></dt>
-<dt><span class="section">Inline code</span></dt>
-<dt><span class="section">Code blocks</span></dt>
-<dt><span class="section">Source Mode</span></dt>
-<dt><span class="section">line-break</span></dt>
-<dt><span class="section">Anchors</span></dt>
-<dt><span class="section">Links</span></dt>
-<dt><span class="section">Anchor links</span></dt>
-<dt><span class="section">refentry links</span></dt>
-<dt><span class="section"> Code Links</span></dt>
-<dt><span class="section">Escape</span></dt>
-<dt><span class="section"><a href="phrase.html#quickbook.syntax.phrase.single_char_escape">Single
- char escape</a></span></dt>
-<dt><span class="section">Images</span></dt>
-<dt><span class="section">Footnotes</span></dt>
-<dt><span class="section"> Conditional Generation</span></dt>
-</dl></div>
-<div class="section" lang="en">
-<div class="titlepage"><div><div><h4 class="title">
-<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"><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:
- </p>
-<pre class="programlisting">[*['bold-italic]]
-</pre>
-<p>
- will generate:
- </p>
-<p>
- <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><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:
- </p>
-<pre class="programlisting">[~replacement]
-</pre>
-<p>
- This will generate:
- </p>
-<p>
- <em class="replaceable"><code>
- replacement
- </code></em>
- </p>
-</div>
-<div class="section" lang="en">
-<div class="titlepage"><div><div><h4 class="title">
-<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>
- will generate:
- </p>
-<p>
- “<span class="quote">A question that sometimes drives me hazy: am I or are the others
- crazy?</span>”--Einstein
- </p>
-<p>
- 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>).
- </p>
-<p>
- Like all phrase elements, quotations may be nested. Example:
- </p>
-<pre class="programlisting">["Here's the rule for bargains: ["Do other men, for they would do you.] That's
-the true business precept.]
-</pre>
-<p>
- will generate:
- </p>
-<p>
- “<span class="quote">Here's the rule for bargains: ‘<span class="quote">Do other men, for they would
- do you.</span>’ That's the true business precept.</span>”
- </p>
-</div>
-<div class="section" lang="en">
-<div class="titlepage"><div><div><h4 class="title">
-<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:
- </p>
-<pre class="programlisting">/italic/, *bold*, _underline_, =teletype=
-</pre>
-<p>
- will generate:
- </p>
-<p>
- <span class="emphasis"><em>italic</em></span>, <span class="bold"><strong>bold</strong></span>, <span class="underline">underline</span>, <code class="literal">teletype</code>
- </p>
-<p>
- Unlike QuickBook's standard formatting scheme, the rules for simpler alternatives
- are much stricter
- <sup>[<a name="id4913148" href="#ftn.id4913148" class="footnote">1</a>]</sup>
- .
- </p>
-<div class="itemizedlist"><ul type="disc">
-<li>
- Simple markups cannot nest. You can combine a simple markup with a nestable
- markup.
- </li>
-<li>
- Simple markups cannot contain any other form of quickbook markup.
- </li>
-<li>
- A non-space character must follow the leading markup
- </li>
-<li>
- A non-space character must precede the trailing markup
- </li>
-<li>
- A space or a punctuation must follow the trailing markup
- </li>
-<li>
- 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: ']'.
- </li>
-<li>
- A line starting with the star will be interpreted as an unordered list.
- 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="id4913229"></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>
-</colgroup>
-<thead><tr>
-<th>
- <p>
- Markup
- </p>
- </th>
-<th>
- <p>
- Result
- </p>
- </th>
-</tr></thead>
-<tbody>
-<tr>
-<td>
- <p>
- <code class="literal">*Bold*</code>
- </p>
- </td>
-<td>
- <p>
- <span class="bold"><strong>Bold</strong></span>
- </p>
- </td>
-</tr>
-<tr>
-<td>
- <p>
- <code class="literal">*Is bold*</code>
- </p>
- </td>
-<td>
- <p>
- <span class="bold"><strong>Is bold</strong></span>
- </p>
- </td>
-</tr>
-<tr>
-<td>
- <p>
- <code class="literal">* Not bold* *Not bold * * Not bold *</code>
- </p>
- </td>
-<td>
- <p>
- * Not bold* *Not bold * * Not bold *
- </p>
- </td>
-</tr>
-<tr>
-<td>
- <p>
- <code class="literal">This*Isn't*Bold (no bold)</code>
- </p>
- </td>
-<td>
- <p>
- This*Isn't*Bold (no bold)
- </p>
- </td>
-</tr>
-<tr>
-<td>
- <p>
- <code class="literal">(*Bold Inside*) (parenthesis not bold)</code>
- </p>
- </td>
-<td>
- <p>
- (<span class="bold"><strong>Bold Inside</strong></span>) (parenthesis not bold)
- </p>
- </td>
-</tr>
-<tr>
-<td>
- <p>
- <code class="literal">*(Bold Outside)* (parenthesis bold)</code>
- </p>
- </td>
-<td>
- <p>
- <span class="bold"><strong>(Bold Outside)</strong></span> (parenthesis bold)
- </p>
- </td>
-</tr>
-<tr>
-<td>
- <p>
- <code class="literal">3*4*5 = 60 (no bold)</code>
- </p>
- </td>
-<td>
- <p>
- 3*4*5 = 60 (no bold)
- </p>
- </td>
-</tr>
-<tr>
-<td>
- <p>
- <code class="literal">3 * 4 * 5 = 60 (no bold)</code>
- </p>
- </td>
-<td>
- <p>
- 3 * 4 * 5 = 60 (no bold)
- </p>
- </td>
-</tr>
-<tr>
-<td>
- <p>
- <code class="literal">3 *4* 5 = 60 (4 is bold)</code>
- </p>
- </td>
-<td>
- <p>
- 3 <span class="bold"><strong>4</strong></span> 5 = 60 (4 is bold)
- </p>
- </td>
-</tr>
-<tr>
-<td>
- <p>
- <code class="literal">*This is bold* this is not *but this is*</code>
- </p>
- </td>
-<td>
- <p>
- <span class="bold"><strong>This is bold</strong></span> this is not <span class="bold"><strong>but this is</strong></span>
- </p>
- </td>
-</tr>
-<tr>
-<td>
- <p>
- <code class="literal">*This is bold*.</code>
- </p>
- </td>
-<td>
- <p>
- <span class="bold"><strong>This is bold</strong></span>.
- </p>
- </td>
-</tr>
-<tr>
-<td>
- <p>
- <code class="literal">*B*. (bold B)</code>
- </p>
- </td>
-<td>
- <p>
- <span class="bold"><strong>B</strong></span>. (bold B)
- </p>
- </td>
-</tr>
-<tr>
-<td>
- <p>
- <code class="literal">['*Bold-Italic*]</code>
- </p>
- </td>
-<td>
- <p>
- <span class="emphasis"><em><span class="bold"><strong>Bold-Italic</strong></span></em></span>
- </p>
- </td>
-</tr>
-<tr>
-<td>
- <p>
- <code class="literal">*side-by*/-side/</code>
- </p>
- </td>
-<td>
- <p>
- <span class="bold"><strong>side-by</strong></span><span class="emphasis"><em>-side</em></span>
- </p>
- </td>
-</tr>
-</tbody>
-</table></div>
-</div>
-<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:
- </p>
-<pre class="programlisting">Baa baa black sheep, *have you any wool?
-Yes sir, yes sir, three bags full!*
-One for the master, one for the dame,
-And one for the little boy who lives down the lane.
-</pre>
-<p>
- Baa baa black sheep, <span class="bold"><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>
- But in the following paragraph, bold is not applied:
- </p>
-<pre class="programlisting">Baa baa black sheep, *have you any wool?
-Yes sir, yes sir, three bags full!
-One for the master, one for the dame,
-And one for the little boy who lives down the lane.
-</pre>
-<p>
- Baa baa black sheep, *have you any wool? Yes sir, yes sir, three bags full!
- One for the master, one for the dame, And one for the little boy who lives
- down the lane.
- </p>
-</div>
-<div class="section" lang="en">
-<div class="titlepage"><div><div><h4 class="title">
-<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:
- </p>
-<pre class="programlisting">This text has inlined code `int main() { return 0; }` in it.
-</pre>
-<p>
- will generate:
- </p>
-<p>
- This text has inlined code <code class="computeroutput"><span class="keyword">int</span> <span class="identifier">main</span><span class="special">()</span> <span class="special">{</span> <span class="keyword">return</span> <span class="number">0</span><span class="special">;</span> <span class="special">}</span></code>
- in it. The code will be syntax highlighted.
- </p>
-<div class="note"><table border="0" summary="Note">
-<tr>
-<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../../doc/html/images/note.png"></td>
-<th align="left">Note</th>
-</tr>
-<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><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 <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 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>
-<p>
- 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:
- </p>
-<pre class="programlisting">``
- #include <iostream>
-
- int main()
- {
- std::cout << "Hello, World!" << std::endl;
- return 0;
- }
-``
-</pre>
-<p>
- will generate:
- </p>
-<p>
-
-</p>
-<pre class="programlisting"><span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">iostream</span><span class="special">></span>
-
-<span class="keyword">int</span> <span class="identifier">main</span><span class="special">()</span>
-<span class="special">{</span>
- <span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span> <span class="special"><<</span> <span class="string">"Hello, World!"</span> <span class="special"><<</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">endl</span><span class="special">;</span>
- <span class="keyword">return</span> <span class="number">0</span><span class="special">;</span>
-<span class="special">}</span>
-</pre>
-<p>
- </p>
-</div>
-<div class="section" lang="en">
-<div class="titlepage"><div><div><h4 class="title">
-<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 <a class="link" href="block.html#quickbook.syntax.block.document" title="Document">Document</a>
- section.
- </p>
-<p>
- To change the source mode, use the <code class="literal">[source-mode]</code> markup,
- where <code class="literal">source-mode</code> is one of the supported modes. For
- example, this:
- </p>
-<pre class="programlisting">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`.
-</pre>
-<p>
- will generate:
- </p>
-<p>
- Python's <code class="computeroutput"><span class="keyword">import</span></code> is rather
- like C++'s <code class="computeroutput"><span class="preprocessor">#include</span></code>.
- A C++ comment <code class="computeroutput"><span class="comment">// looks like this</span></code>
- whereas a Python comment <code class="computeroutput"><span class="comment">#looks like this</span></code>.
- </p>
-<div class="table">
-<a name="id4904787"></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>
-</colgroup>
-<thead><tr>
-<th>
- <p>
- Mode
- </p>
- </th>
-<th>
- <p>
- Source Mode Markup
- </p>
- </th>
-</tr></thead>
-<tbody>
-<tr>
-<td>
- <p>
- C++
- </p>
- </td>
-<td>
- <p>
- <code class="literal">[c++]</code>
- </p>
- </td>
-</tr>
-<tr>
-<td>
- <p>
- Python
- </p>
- </td>
-<td>
- <p>
- <code class="literal">[python]</code>
- </p>
- </td>
-</tr>
-</tbody>
-</table></div>
-</div>
-<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 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><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">
-<tr>
-<td rowspan="2" align="center" valign="top" width="25"><img alt="[Warning]" src="../../../../../../doc/html/images/warning.png"></td>
-<th align="left">Warning</th>
-</tr>
-<tr><td align="left" valign="top"><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><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 <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><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"><strong>boost's</strong></span>
- website....</a>
- </p>
-<p>
- URL links where the link text is the link itself is common. Example:
- </p>
-<pre class="programlisting">see http://spirit.sourceforge.net/
-</pre>
-<p>
- so, when the text is absent in a link markup, the URL is assumed. Example:
- </p>
-<pre class="programlisting">see [@http://spirit.sourceforge.net/]
-</pre>
-<p>
- will generate:
- </p>
-<p>
- see http://spirit.sourceforge.net/
- </p>
-</div>
-<div class="section" lang="en">
-<div class="titlepage"><div><div><h4 class="title">
-<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 <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><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 <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
- text will automatically be the refentry. Example:
- </p>
-<pre class="programlisting">[link xml.refentry]
-</pre>
-<p>
- 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><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, global,
- or header in the reference section, you can use:
- </p>
-<pre class="programlisting">[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]
-[globalref fully::qualified::global The link text]
-</pre>
-<p>
- Again, the link text is optional. If this is not present, the link text
- will automatically be the function, class, member, enum, macro, concept,
- global, or header name. Example:
- </p>
-<pre class="programlisting">[classref boost::bar::baz]
-</pre>
-<p>
- would have "boost::bar::baz" as the link text.
- </p>
-</div>
-<div class="section" lang="en">
-<div class="titlepage"><div><div><h4 class="title">
-<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>
-<pre class="programlisting">'''
-escape (no processing/formatting)
-'''
-</pre>
-<p>
- Escaping allows us to pass XML markup to BoostBook
- or DocBook. For example:
- </p>
-<pre class="programlisting">'''
-<emphasis role="bold">This is direct XML markup</emphasis>
-'''
-</pre>
-<p>
- <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 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 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 <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>
- <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">
-<tr>
-<td rowspan="2" align="center" valign="top" width="25"><img alt="[Warning]" src="../../../../../../doc/html/images/warning.png"></td>
-<th align="left">Warning</th>
-</tr>
-<tr><td align="left" valign="top"><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: <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><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><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>
-<dt><span class="section"><a href="phrase.html#quickbook.syntax.phrase.footnotes.template_expansion">Template
- Expansion</a></span></dt>
-</dl></div>
-<p>
- As of version 1.3, QuickBook supports footnotes. Just put the text of the
- footnote in a <code class="computeroutput"><span class="special">[</span><span class="identifier">footnote</span><span class="special">]</span></code> block, and the text will be put at the
- bottom of the current page. For example, this:
- </p>
-<pre class="programlisting">[footnote A sample footnote]
-</pre>
-<p>
- will generate this
- <sup>[<a name="id4905586" href="#ftn.id4905586" 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 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 <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 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 <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><a class="link" href="phrase.html#quickbook.syntax.phrase.cond" title="Conditional Generation"> Conditional Generation</a>
-</h4></div></div></div>
-<p>
- 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]
-</pre>
-<p>
- </p>
-<p>
- Here, the phrase "To be or not to be" will only be generated
- if the macro symbol __to_be__ has been previously defined. The phrase above will
- not do anything since we haven't defined __to_be__. Now, let's define the symbol:
- </p>
-<pre class="programlisting">[def __to_be__]
-</pre>
-<p>
- And try again:
- </p>
-<p>
- To be or not to be
- </p>
-<p>
- Yes!
- <sup>[<a name="id4905742" href="#ftn.id4905742" class="footnote">3</a>]</sup>
- </p>
-</div>
-<div class="footnotes">
-<br><hr width="100" align="left">
-<div class="footnote"><p><sup>[<a name="ftn.id4913148" href="#id4913148" 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.id4905586" href="#id4905586" class="para">2</a>] </sup>
- A sample footnote
- </p></div>
-<div class="footnote"><p><sup>[<a name="ftn.id4905742" href="#id4905742" class="para">3</a>] </sup>
- Conditional Generation makes quickbook turing complete.
- </p></div>
-</div>
-</div>
-<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
-<td align="left"></td>
-<td align="right"><div class="copyright-footer">Copyright © 2002, 2004, 2006 Joel de Guzman,
- Eric Niebler<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>
-</div></td>
-</tr></table>
-<hr>
-<div class="spirit-nav">
-<a accesskey="p" href="comments.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../syntax.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="block.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
-</div>
-</body>
-</html>

Next message: daniel_james_at_[hidden]: "[Boost-commit] svn:boost r48931 - branches/initializer-list"
Previous message: daniel_james_at_[hidden]: "[Boost-commit] svn:boost r48929 - in trunk: doc tools/quickbook/doc tools/quickbook/extra/katepart"

Date view	Thread view	Subject view	Author view

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