townforge/quickbook
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

added installation and configuration section

Browse Source 
[SVN r34496]
This commit is contained in:
Joel de Guzman 2006-07-10 11:03:48 +00:00
parent 84a9414f99
commit a934c1615a
8 changed files with 310 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc/html/index.html
View File

@ -32,7 +32,7 @@
<div><p class="copyright">Copyright © 2002, 2004, 2006 Joel de Guzman,
Eric Niebler</p></div>
<div><div class="legalnotice">
<a name="id442836"></a><p>
<a name="id372467"></a><p>
Distributed under the Boost Software License, Version 1.0. (See accompanying
file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
</p>
@ -51,12 +51,16 @@
<dt><span class="section"><a href="quickbook/syntax/phrase.html"> Phrase Level Elements</a></span></dt>
<dt><span class="section"><a href="quickbook/syntax/block.html"> Block Level Elements</a></span></dt>
</dl></dd>
<dt><span class="section"><a href="quickbook/installation_and_configuration.html">Installation
and configuration</a></span></dt>
<dd><dl><dt><span class="section"><a href="quickbook/installation_and_configuration/windows_2000__xp__2003__vista.html">Windows
2000, XP, 2003, Vista</a></span></dt></dl></dd>
<dt><span class="section"><a href="quickbook/ref.html"> Quick Reference</a></span></dt>
</dl>
</div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"><small><p>Last revised: June 07, 2006 at 04:18:50 GMT</p></small></td>
<td align="left"><small><p>Last revised: July 10, 2006 at 10:58:47 GMT</p></small></td>
<td align="right"><small></small></td>
</tr></table>
<hr>

2
doc/html/quickbook/change_log.html
View File

@ -26,7 +26,7 @@
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="quickbook.change_log"></a><a href="change_log.html" title=" Change Log"> Change Log</a></h2></div></div></div>
<a name="quickbook.change_log.version_1_3"></a><h3>
<a name="id372691"></a>
<a name="id374492"></a>
<a href="change_log.html#quickbook.change_log.version_1_3">Version 1.3</a>
</h3>
<div class="itemizedlist"><ul type="disc">

56
doc/html/quickbook/installation_and_configuration.html Normal file
View File

@ -0,0 +1,56 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Installation
and configuration</title>
<link rel="stylesheet" href="../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.66.1">
<link rel="start" href="../index.html" title="Quickbook 1.4">
<link rel="up" href="../index.html" title="Quickbook 1.4">
<link rel="prev" href="syntax/block.html" title=" Block Level Elements">
<link rel="next" href="installation_and_configuration/windows_2000__xp__2003__vista.html" title="Windows
2000, XP, 2003, Vista">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td>
<td align="center"><a href="../../../../../index.htm">Home</a></td>
<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="../../../../../people/people.htm">People</a></td>
<td align="center"><a href="../../../../../more/faq.htm">FAQ</a></td>
<td align="center"><a href="../../../../../more/index.htm">More</a></td>
</table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="syntax/block.html"><img src="../images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../images/home.png" alt="Home"></a><a accesskey="n" href="installation_and_configuration/windows_2000__xp__2003__vista.html"><img src="../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.installation_and_configuration"></a><a href="installation_and_configuration.html" title="Installation
and configuration">Installation
and configuration</a></h2></div></div></div>
<div class="toc"><dl><dt><span class="section"><a href="installation_and_configuration/windows_2000__xp__2003__vista.html">Windows
2000, XP, 2003, Vista</a></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 <tt class="computeroutput"><span class="identifier">bin</span></tt>
and <tt class="computeroutput"><span class="identifier">bin</span><span class="special">.</span><span class="identifier">v2</span></tt> directories generated by the build before
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"><small>Copyright © 2002, 2004, 2006 Joel de Guzman,
Eric Niebler</small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="syntax/block.html"><img src="../images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../images/home.png" alt="Home"></a><a accesskey="n" href="installation_and_configuration/windows_2000__xp__2003__vista.html"><img src="../images/next.png" alt="Next"></a>
</div>
</body>
</html>

129
doc/html/quickbook/installation_and_configuration/windows_2000__xp__2003__vista.html Normal file
View File

@ -0,0 +1,129 @@
<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="../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.66.1">
<link rel="start" href="../../index.html" title="Quickbook 1.4">
<link rel="up" href="../installation_and_configuration.html" title="Installation
and configuration">
<link rel="prev" href="../installation_and_configuration.html" title="Installation
and configuration">
<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%">
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td>
<td align="center"><a href="../../../../../../index.htm">Home</a></td>
<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="../../../../../../people/people.htm">People</a></td>
<td align="center"><a href="../../../../../../more/faq.htm">FAQ</a></td>
<td align="center"><a href="../../../../../../more/index.htm">More</a></td>
</table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../installation_and_configuration.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../installation_and_configuration.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="../ref.html"><img src="../../images/next.png" alt="Next"></a>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="quickbook.installation_and_configuration.windows_2000__xp__2003__vista"></a><a href="windows_2000__xp__2003__vista.html" title="Windows
2000, XP, 2003, Vista">Windows
2000, XP, 2003, Vista</a></h3></div></div></div>
<p class="blurb">
Section contributed by Julio M. Merino Vidal
</p>
<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 <tt class="computeroutput"><span class="identifier">xsltproc</span></tt>
for Windows. There are many ways to get this tool, but to keep things simple,
use the <a href="http://www.zlatkovic.com/pub/libxml/" target="_top">binary packages</a>
made by Igor Zlatkovic. At the very least, you need to download the following
packages: <tt class="computeroutput"><span class="identifier">iconv</span></tt>, <tt class="computeroutput"><span class="identifier">zlib</span></tt>, <tt class="computeroutput"><span class="identifier">libxml2</span></tt>
and <tt class="computeroutput"><span class="identifier">libxslt</span></tt>.
</li>
<li>
Unpack all these packages in the same directory so that you get unique
<tt class="computeroutput"><span class="identifier">bin</span></tt>, <tt class="computeroutput"><span class="identifier">include</span></tt>
and <tt class="computeroutput"><span class="identifier">lib</span></tt> directories within
the hierarchy. These instructions use <tt class="computeroutput"><span class="identifier">C</span><span class="special">:\</span><span class="identifier">Users</span><span class="special">\</span><span class="identifier">example</span><span class="special">\</span><span class="identifier">Documents</span><span class="special">\</span><span class="identifier">boost</span><span class="special">\</span><span class="identifier">xml</span></tt>
as the root for all files.
</li>
<li>
From the command line, go to the <tt class="computeroutput"><span class="identifier">bin</span></tt>
directory and launch <tt class="computeroutput"><span class="identifier">xsltproc</span><span class="special">.</span><span class="identifier">exe</span></tt>
to ensure it works. You should get usage information on screen.
</li>
<li>
Download <a href="http://www.docbook.org/xml/4.2/docbook-xml-4.2.zip" target="_top">Docbook
XML 4.2</a> and unpack it in the same directory used above. That is:
<tt class="computeroutput"><span class="identifier">C</span><span class="special">:\</span><span class="identifier">Users</span><span class="special">\</span><span class="identifier">example</span><span class="special">\</span><span class="identifier">Documents</span><span class="special">\</span><span class="identifier">boost</span><span class="special">\</span><span class="identifier">xml</span><span class="special">\</span><span class="identifier">docbook</span><span class="special">-</span><span class="identifier">xml</span></tt>.
</li>
<li>
Download the latest <a href="http://sourceforge.net/project/showfiles.php?group_id=21935&amp;package_id=16608" target="_top">Docbook
XSL</a> version and unpack it, again in the same directory used before.
To make things easier, rename the directory created during the extraction
to <tt class="computeroutput"><span class="identifier">docbook</span><span class="special">-</span><span class="identifier">xsl</span></tt> (bypassing the version name): <tt class="computeroutput"><span class="identifier">C</span><span class="special">:\</span><span class="identifier">Users</span><span class="special">\</span><span class="identifier">example</span><span class="special">\</span><span class="identifier">Documents</span><span class="special">\</span><span class="identifier">boost</span><span class="special">\</span><span class="identifier">xml</span><span class="special">\</span><span class="identifier">docbook</span><span class="special">-</span><span class="identifier">xsl</span></tt>.
</li>
<li>
Add the following to your <tt class="computeroutput"><span class="identifier">user</span><span class="special">-</span><span class="identifier">config</span><span class="special">.</span><span class="identifier">jam</span></tt>
file, which should live in your home directory (<tt class="computeroutput"><span class="special">%</span><span class="identifier">HOMEDRIVE</span><span class="special">%%</span><span class="identifier">HOMEPATH</span><span class="special">%</span></tt>).
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 (<tt class="computeroutput"><span class="identifier">BOOST_ROOT</span><span class="special">\</span><span class="identifier">tools</span><span class="special">\</span><span class="identifier">quickbook</span></tt>).
</li>
<li>
Build the utility by issuing <tt class="computeroutput"><span class="identifier">bjam</span> <span class="special">--</span><span class="identifier">v2</span></tt>.
</li>
<li>
Copy the resulting <tt class="computeroutput"><span class="identifier">quickbook</span><span class="special">.</span><span class="identifier">exe</span></tt>
binary (located under the <tt class="computeroutput"><span class="identifier">BOOST_ROOT</span><span class="special">\</span><span class="identifier">bin</span><span class="special">.</span><span class="identifier">v2</span></tt> hierarchy)
to a safe place. Following our previous example, you can install it into:
<tt class="computeroutput"><span class="identifier">C</span><span class="special">:\</span><span class="identifier">Users</span><span class="special">\</span><span class="identifier">example</span><span class="special">\</span><span class="identifier">Documents</span><span class="special">\</span><span class="identifier">boost</span><span class="special">\</span><span class="identifier">xml</span><span class="special">\</span><span class="identifier">bin</span></tt>.
</li>
<li>
Add the following to your <tt class="computeroutput"><span class="identifier">user</span><span class="special">-</span><span class="identifier">config</span><span class="special">.</span><span class="identifier">jam</span></tt>
file:
</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"><small>Copyright © 2002, 2004, 2006 Joel de Guzman,
Eric Niebler</small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../installation_and_configuration.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../installation_and_configuration.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="../ref.html"><img src="../../images/next.png" alt="Next"></a>
</div>
</body>
</html>

9
doc/html/quickbook/ref.html
View File

@ -6,7 +6,8 @@
<meta name="generator" content="DocBook XSL Stylesheets V1.66.1">
<link rel="start" href="../index.html" title="Quickbook 1.4">
<link rel="up" href="../index.html" title="Quickbook 1.4">
<link rel="prev" href="syntax/block.html" title=" Block Level Elements">
<link rel="prev" href="installation_and_configuration/windows_2000__xp__2003__vista.html" title="Windows
2000, XP, 2003, Vista">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
@ -19,14 +20,14 @@
</table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="syntax/block.html"><img src="../images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../images/home.png" alt="Home"></a>
<a accesskey="p" href="installation_and_configuration/windows_2000__xp__2003__vista.html"><img src="../images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../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 href="ref.html" title=" Quick Reference"> Quick Reference</a></h2></div></div></div>
<div class="informaltable">
<h4>
<a name="id447983"></a>
<a name="id448939"></a>
<span class="table-title">Syntax Compendium</span>
</h4>
<table class="table">
@ -321,7 +322,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="syntax/block.html"><img src="../images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../images/home.png" alt="Home"></a>
<a accesskey="p" href="installation_and_configuration/windows_2000__xp__2003__vista.html"><img src="../images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../images/home.png" alt="Home"></a>
</div>
</body>
</html>

45
doc/html/quickbook/syntax/block.html
View File

@ -7,7 +7,8 @@
<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="../ref.html" title=" Quick Reference">
<link rel="next" href="../installation_and_configuration.html" title="Installation
and configuration">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
@ -20,7 +21,7 @@
</table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="phrase.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../syntax.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="../ref.html"><img src="../../images/next.png" alt="Next"></a>
<a accesskey="p" href="phrase.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../syntax.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="../installation_and_configuration.html"><img src="../../images/next.png" alt="Next"></a>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
@ -632,27 +633,27 @@
[h6 Heading 6]
</pre>
<a name="quickbook.syntax.block.headings.heading_1"></a><h1>
<a name="id445889"></a>
<a name="id445898"></a>
<a href="block.html#quickbook.syntax.block.headings.heading_1">Heading 1</a>
</h1>
<a name="quickbook.syntax.block.headings.heading_2"></a><h2>
<a name="id445914"></a>
<a name="id445923"></a>
<a href="block.html#quickbook.syntax.block.headings.heading_2">Heading 2</a>
</h2>
<a name="quickbook.syntax.block.headings.heading_3"></a><h3>
<a name="id445938"></a>
<a name="id445947"></a>
<a href="block.html#quickbook.syntax.block.headings.heading_3">Heading 3</a>
</h3>
<a name="quickbook.syntax.block.headings.heading_4"></a><h4>
<a name="id445963"></a>
<a name="id445972"></a>
<a href="block.html#quickbook.syntax.block.headings.heading_4">Heading 4</a>
</h4>
<a name="quickbook.syntax.block.headings.heading_5"></a><h5>
<a name="id445988"></a>
<a name="id445997"></a>
<a href="block.html#quickbook.syntax.block.headings.heading_5">Heading 5</a>
</h5>
<a name="quickbook.syntax.block.headings.heading_6"></a><h5>
<a name="id446013"></a>
<a name="id446022"></a>
<a href="block.html#quickbook.syntax.block.headings.heading_6">Heading 6</a>
</h5>
<p>
@ -791,7 +792,7 @@ sf_logo
</p>
<div class="informaltable">
<h4>
<a name="id446452"></a>
<a name="id446454"></a>
<span class="table-title">Predefined Macros</span>
</h4>
<table class="table">
@ -809,12 +810,12 @@ sf_logo
<tr>
<td>__DATE__</td>
<td>Today's date</td>
<td>2006-Jun-07</td>
<td>2006-Jul-10</td>
</tr>
<tr>
<td>__TIME__</td>
<td>The current time</td>
<td>12:18:50 PM</td>
<td>06:58:47 PM</td>
</tr>
<tr>
<td>__FILENAME__</td>
@ -846,7 +847,7 @@ Hi, my name is [name]. I am [age] years old. I am a [what].
]
</pre>
<a name="quickbook.syntax.block.templates.template_identifier"></a><h5>
<a name="id446585"></a>
<a name="id446586"></a>
<a href="block.html#quickbook.syntax.block.templates.template_identifier">Template
Identifier</a>
</h5>
@ -864,7 +865,7 @@ Hi, my name is [name]. I am [age] years old. I am a [what].
</li>
</ul></div>
<a name="quickbook.syntax.block.templates.formal_template_arguments"></a><h5>
<a name="id446632"></a>
<a name="id446634"></a>
<a href="block.html#quickbook.syntax.block.templates.formal_template_arguments">Formal
Template Arguments</a>
</h5>
@ -884,7 +885,7 @@ Hi, my name is [name]. I am [age] years old. I am a [what].
of the template call.
</p>
<a name="quickbook.syntax.block.templates.template_body"></a><h5>
<a name="id446753"></a>
<a name="id446754"></a>
<a href="block.html#quickbook.syntax.block.templates.template_body">Template
Body</a>
</h5>
@ -909,7 +910,7 @@ replacement text...
block level elements are not allowed in phrase templates.
</p>
<a name="quickbook.syntax.block.templates.template_expansion"></a><h5>
<a name="id446808"></a>
<a name="id446809"></a>
<a href="block.html#quickbook.syntax.block.templates.template_expansion">Template
Expansion</a>
</h5>
@ -960,7 +961,7 @@ replacement text...
by the close parenthesis.
</p>
<a name="quickbook.syntax.block.templates.nullary_templates"></a><h5>
<a name="id446911"></a>
<a name="id446913"></a>
<a href="block.html#quickbook.syntax.block.templates.nullary_templates">Nullary
Templates</a>
</h5>
@ -1019,7 +1020,7 @@ for the journey to old age.]]]
is the best provision for the journey to old age.</em></span></b></span>.
</p>
<a name="quickbook.syntax.block.templates.simple_arguments"></a><h5>
<a name="id447055"></a>
<a name="id447057"></a>
<a href="block.html#quickbook.syntax.block.templates.simple_arguments">Simple
Arguments</a>
</h5>
@ -1087,7 +1088,7 @@ for the journey to old age.]]]
what do you think man?
</p>
<a name="quickbook.syntax.block.templates.punctuation_templates"></a><h5>
<a name="id447222"></a>
<a name="id447224"></a>
<a href="block.html#quickbook.syntax.block.templates.punctuation_templates">Punctuation
Templates</a>
</h5>
@ -1159,7 +1160,7 @@ for the journey to old age.]]]
</p>
<div class="informaltable">
<h4>
<a name="id447421"></a>
<a name="id447423"></a>
<span class="table-title">A Simple Table</span>
</h4>
<table class="table">
@ -1221,7 +1222,7 @@ for the journey to old age.]]]
</p>
<div class="informaltable">
<h4>
<a name="id447538"></a>
<a name="id447540"></a>
<span class="table-title">Table with fat cells</span>
</h4>
<table class="table">
@ -1270,7 +1271,7 @@ for the journey to old age.]]]
</pre>
<div class="informaltable">
<h4>
<a name="id447627"></a>
<a name="id447628"></a>
<span class="table-title">Table with code</span>
</h4>
<table class="table">
@ -1379,7 +1380,7 @@ for the journey to old age.]]]
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="phrase.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../syntax.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="../ref.html"><img src="../../images/next.png" alt="Next"></a>
<a accesskey="p" href="phrase.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../syntax.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="../installation_and_configuration.html"><img src="../../images/next.png" alt="Next"></a>
</div>
</body>
</html>

12
doc/html/quickbook/syntax/phrase.html
View File

@ -135,7 +135,7 @@ the true business precept.]
<p>
Unlike QuickBook's standard formatting scheme, the rules for simpler alternatives
are much stricter
<sup>[<a name="id372355" href="#ftn.id372355">1</a>]</sup>
<sup>[<a name="id373324" href="#ftn.id373324">1</a>]</sup>
.
</p>
<div class="itemizedlist"><ul type="disc">
@ -168,7 +168,7 @@ the true business precept.]
</ul></div>
<div class="informaltable">
<h4>
<a name="id372435"></a>
<a name="id373404"></a>
<span class="table-title">More Formatting Samples</span>
</h4>
<table class="table">
@ -354,7 +354,7 @@ C++ comment `// looks like this` whereas a Python comment [python]
</p>
<div class="informaltable">
<h4>
<a name="id443564"></a>
<a name="id443578"></a>
<span class="table-title">Supported Source Modes</span>
</h4>
<table class="table">
@ -578,7 +578,7 @@ escape (no processing/formatting)
</pre>
<p>
will generate this
<sup>[<a name="id444305" href="#ftn.id444305">2</a>]</sup>
<sup>[<a name="id444320" href="#ftn.id444320">2</a>]</sup>
.
</p>
<div class="section" lang="en">
@ -607,14 +607,14 @@ escape (no processing/formatting)
</div>
<div class="footnotes">
<br><hr width="100" align="left">
<div class="footnote"><p><sup>[<a name="ftn.id372355" href="#id372355">1</a>] </sup>
<div class="footnote"><p><sup>[<a name="ftn.id373324" href="#id373324">1</a>] </sup>
Thanks to David Barrett, author of <a href="http://quinthar.com/qwikiwiki/index.php?page=Home" target="_top">Qwiki</a>,
for sharing these samples and teaching me these obscure formatting
rules. I wasn't sure at all if <a href="http://spirit.sourceforge.net" target="_top">Spirit</a>,
being more or less a formal EBNF parser, can handle the context sensitivity
and ambiguity.
</p></div>
<div class="footnote"><p><sup>[<a name="ftn.id444305" href="#id444305">2</a>] </sup>
<div class="footnote"><p><sup>[<a name="ftn.id444320" href="#id444320">2</a>] </sup>
A sample footnote
</p></div>
</div>

84
doc/quickbook.qbk
View File

@ -1477,6 +1477,90 @@ it with [^\[link someid.intro The Intro\]].
[endsect]
[endsect]
[endsect]
[section Installation and configuration]
This section provides some guidelines on how to install and configure
BoostBook and Quickbook under several operating systems.
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 `bin` and `bin.v2` directories generated
by the build before trying again. Otherwise your configuration fixes will
not take any effect.
[section Windows 2000, XP, 2003, Vista]
[blurb Section contributed by Julio M. Merino Vidal]
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.
# First of all you need to have a copy of `xsltproc` for Windows. There
are many ways to get this tool, but to keep things simple, use the
[@http://www.zlatkovic.com/pub/libxml/ binary packages] made by Igor
Zlatkovic. At the very least, you need to download the following
packages: `iconv`, `zlib`, `libxml2` and `libxslt`.
# Unpack all these packages in the same directory so that you get unique
`bin`, `include` and `lib` directories within the hierarchy. These
instructions use `C:\Users\example\Documents\boost\xml` as the root for
all files.
# From the command line, go to the `bin` directory and launch
`xsltproc.exe` to ensure it works. You should get usage information on
screen.
# Download [@http://www.docbook.org/xml/4.2/docbook-xml-4.2.zip Docbook XML
4.2] and unpack it in the same directory used above. That is:
`C:\Users\example\Documents\boost\xml\docbook-xml`.
# Download the latest
[@http://sourceforge.net/project/showfiles.php?group_id=21935&package_id=16608
Docbook XSL] version and unpack it, again in the same directory
used before. To make things easier, rename the directory created
during the extraction to `docbook-xsl` (bypassing the version name):
`C:\Users\example\Documents\boost\xml\docbook-xsl`.
# Add the following to your `user-config.jam` file, which should live in
your home directory (`%HOMEDRIVE%%HOMEPATH%`). You must already have it
somewhere or otherwise you could not be building Boost (i.e. missing
tools configuration).
using xsltproc
: "C:/Users/example/Documents/boost/xml/bin/xsltproc.exe"
;
using boostbook
: "C:/Users/example/Documents/boost/xml/docbook-xsl"
: "C:/Users/example/Documents/boost/xml/docbook-xml"
;
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:
# Go to Quickbook's source directory (`BOOST_ROOT\tools\quickbook`).
# Build the utility by issuing `bjam --v2`.
# Copy the resulting `quickbook.exe` binary (located under the
`BOOST_ROOT\bin.v2` hierarchy) to a safe place. Following our previous
example, you can install it into:
`C:\Users\example\Documents\boost\xml\bin`.
# Add the following to your `user-config.jam` file:
using quickbook
: "C:/Users/example/Documents/boost/xml/bin/quickbook.exe"
;
[endsect]
[endsect]
[section:ref Quick Reference]
[table Syntax Compendium