ceph/src/boost/tools/quickbook/doc/faq.qbk

   1 [/
   2     Copyright 2002,2004,2006 Joel de Guzman, Eric Niebler
   3     Copyright 2010-2011 Daniel James
   4
   5     Distributed under the Boost Software License, Version 1.0.
   6     (See accompanying file LICENSE_1_0.txt or copy at
   7     http://www.boost.org/LICENSE_1_0.txt)
   8 ]
   9
  10 [chapter Frequently Asked Questions
  11     [quickbook 1.6]
  12     [compatibility-mode 1.5]
  13     [id quickbook.faq]
  14     [source-mode teletype]
  15 ]
  16
  17 [heading Can I use QuickBook for non-Boost documentation?]
  18
  19 QuickBook can be used for non-Boost documentation with a little extra work.
  20
  21 [:['Faq contributed by Michael Marcin]]
  22
  23 When building HTML documentation with BoostBook a Boost C++ Libraries header
  24 is added to the files. When using QuickBook to document projects outside of
  25 Boost this is not desirable. This behavior can be overridden at the BoostBook
  26 level by specifying some XSLT options. When using Boost Build version 2 (BBv2)
  27 this can be achieved by adding parameters to the BoostBook target declaration.
  28
  29 For example:
  30 [pre
  31 using quickbook ;
  32
  33 xml my_doc : my_doc.qbk ;
  34
  35 boostbook standalone
  36     :
  37         my_doc
  38     :
  39         <xsl:param>boost.image.src\=images/my_project_logo.png
  40         <xsl:param>boost.image.alt\="\\"My Project\\""
  41         <xsl:param>boost.image.w=100
  42         <xsl:param>boost.image.h=50
  43         <xsl:param>nav.layout=none
  44     ;
  45 ]
  46
  47 [heading Is there an easy way to convert BoostBook docs to QuickBook?]
  48
  49 There's a stylesheet that allows Boostbook generated HTML to be viewed
  50 as quickbook source, see
  51 [@http://svn.boost.org/trac/boost/wiki/QuickbookSourceStylesheetProject],
  52 so it's then just a cut and paste job to convert the BoostBook to
  53 QuickBook (which IMO is a whole lot easier to edit and maintain).
  54
  55 --John Maddock