Re: [Boost-bugs] [Boost C++ Libraries] #1205: Quickbook getting started

Subject: Re: [Boost-bugs] [Boost C++ Libraries] #1205: Quickbook getting started
From: Boost C++ Libraries (noreply_at_[hidden])
Date: 2010-02-06 20:54:09

#1205: Quickbook getting started
------------------------------+---------------------------------------------
 Reporter:  djowel            |       Owner:  djowel   
     Type:  Feature Requests  |      Status:  new      
Milestone:  To Be Determined  |   Component:  quickbook
  Version:  Boost 1.34.1      |    Severity:  Problem  
 Keywords:                    |  
------------------------------+---------------------------------------------

Comment(by mloskot <mateusz@…>):

 I suppose a simple Jamfile sample could do the job:

 {{{
 # Configuration of documentation build for 'mylib' as a part of Boost C++
 tree.

 # specify project id for mylib documentation
 project boost/libs/mylib/doc ;

 # import Quickbook
 import boostbook : boostbook ;
 using quickbook ;

 # specify location for custom images
 path-constant images_location : html ;

 # define target
 boostbook quickbook
     :
         mylib.qbk
     :
         <xsl:param>boost.root=../../../..
         <xsl:param>boost.libraries=../../../libraries.htm
         <xsl:param>html.stylesheet=../../../../doc/html/boostbook.css
         <xsl:param>chunk.section.depth=4
         <xsl:param>chunk.first.sections=1
         <xsl:param>toc.section.depth=3
         <xsl:param>toc.max.depth=3
         <xsl:param>generate.section.toc.level=4
 <format>pdf:<xsl:param>boost.url.prefix=http://www.boost.org/doc/libs/release/libs/mylib/doc/html

         <format>pdf:<xsl:param>img.src.path=$(images_location)/
     ;
 }}}

 Assuming it is ''boost/libs/mylib/doc/Jamfile'', enter
 ''boost/libs/mylib/doc'' directory and issue ''bjam'' command and you
 should similar output:

 {{{
 $ bjam
 ...found 28 targets...
 ...updating 6 targets...
 common.mkdir bin
 common.mkdir bin/gcc-4.4.1
 common.mkdir bin/gcc-4.4.1/debug
 quickbook.quickbook-to-boostbook bin/gcc-4.4.1/debug/mylib.xml
 Generating Output File: bin/gcc-4.4.1/debug/mylib.xml
 xslt-xsltproc bin/gcc-4.4.1/debug/mylib.docbook
 xslt-xsltproc-dir html/mylib_HTML.manifest
 Writing mylib_HTML.manifest
 ...updated 6 targets...
 }}}

-- 
Ticket URL: <https://svn.boost.org/trac/boost/ticket/1205#comment:1>
Boost C++ Libraries <http://www.boost.org/>
Boost provides free peer-reviewed portable C++ source libraries.