Cromwell Enage wrote:
> 1. The only job of the Quickbook executable is to
> convert *.qbk files to BoostBook XML, right? Is there
> no other output format for the moment?
Not at present. From Docbook XML you can generate PDF, PS, HTML, XHTML, man
pages, and HTMLHelp.
> 2. Let's say that the root file for all my MPL.Math
> documentation is BOOST_ROOT/libs/mpl/doc/src/math.qbk
> and that my Jamfile, which is located in
> BOOST_ROOT/libs/mpl/doc/, looks like this:
>
> ## start of file ##
>
> project boost/libs/mpl/doc ;
> import boostbook : boostbook ;
> using quickbook ;
>
> boostbook quickbook
> : src/math.qbk
> : <xsl:param>...
> ;
>
> ## end of file ##
>
> Other than the <xsl:param> stuff, is this Jamfile
> correct?
Yep.
> Where should I look to figure out what can
> go with <xsl:param> besides existing Jamfiles?
The ultimate reference is
http://docbook.sourceforge.net/release/xsl/current/doc/.
Here's one of my Jamfiles with comments: it includes most of the options
you're likely to want to tweek:
using quickbook ;
xml regex : regex.qbk ;
boostbook standalone
:
regex
:
# HTML options first:
# Use graphics not text for navigation:
<xsl:param>navig.graphics=1
# How far down we chunk nested sections, basically all of them:
<xsl:param>chunk.section.depth=10
# Don't put the first section on the same page as the TOC:
<xsl:param>chunk.first.sections=1
# How far down sections get TOC's
<xsl:param>toc.section.depth=10
# Max depth in each TOC:
<xsl:param>toc.max.depth=4
# How far down we go with TOC's
<xsl:param>generate.section.toc.level=10
# Path for links to Boost:
<xsl:param>boost.root=../../../..
# Path for libraries index:
<xsl:param>boost.libraries=../../../../libs/libraries.htm
# Use the main Boost stylesheet:
<xsl:param>html.stylesheet=../../../../doc/html/boostbook.css
# PDF Options:
# TOC Generation: this is needed for FOP-0.9 and later:
#<xsl:param>fop1.extensions=1
# Or enable this if you're using XEP:
<xsl:param>xep.extensions=1
# TOC generation: this is needed for FOP 0.2, but must not be set to
zero for FOP-0.9!
<xsl:param>fop.extensions=0
# No indent on body text:
<xsl:param>body.start.indent=0pt
# Margin size:
<xsl:param>page.margin.inner=0.5in
# Margin size:
<xsl:param>page.margin.outer=0.5in
# Yes, we want graphics for admonishments:
<xsl:param>admon.graphics=1
# Set this one for PDF generation *only*:
# default pnd graphics are awful in PDF form,
# better use SVG's instead:
#<xsl:param>admon.graphics.extension=".svg"
;
The most useful ones are:
# Path for links to Boost:
<xsl:param>boost.root=../../../..
# Path for libraries index:
<xsl:param>boost.libraries=../../../../libs/libraries.htm
# Use the main Boost stylesheet:
<xsl:param>html.stylesheet=../../../../doc/html/boostbook.css
As they let you use the existing images and stylesheets in doc/, not sure if
they work with full URL's to the Boost website though.
HTH, John.
-------------------------------------------------------------------------
This SF.net email is sponsored by DB2 Express
Download DB2 Express C - the FREE version of DB2 express and take
control of your XML. No limits. Just data. Click to get it now.
http://sourceforge.net/powerbar/db2/_______________________________________________
Boost-docs mailing list
[hidden email]
Unsubscribe and other administrative requests:
https://lists.sourceforge.net/lists/listinfo/boost-docs
Locked
