ceph/src/boost/tools/auto_index/doc/Jamfile.v2

   1 # Copyright John Maddock 2005. Use, modification, and distribution are
   2 # subject to the Boost Software License, Version 1.0. (See accompanying
   3 # file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
   4
   5 using quickbook ;
   6 using auto-index ;
   7 import modules ;
   8
   9 path-constant images_location : html ;
  10
  11 xml auto_index : auto_index.qbk ;
  12
  13 boostbook standalone
  14     :
  15         auto_index
  16     :
  17         # Path for links to Boost:
  18         <xsl:param>boost.root=../../../..
  19         # Path for libraries index:
  20         <xsl:param>boost.libraries=$(boost-root)/libs/libraries.htm
  21
  22         # Some general style settings:
  23         <xsl:param>table.footnote.number.format=1
  24         <xsl:param>footnote.number.format=1
  25
  26         # HTML options first:
  27         # Use graphics not text for navigation:
  28         <xsl:param>navig.graphics=1
  29         # How far down we chunk nested sections, basically all of them:
  30         <xsl:param>chunk.section.depth=10
  31         # Don't put the first section on the same page as the TOC:
  32         <xsl:param>chunk.first.sections=1
  33         # How far down sections get TOC's
  34         <xsl:param>toc.section.depth=10
  35         # Max depth in each TOC:
  36         <xsl:param>toc.max.depth=4
  37         # How far down we go with TOC's
  38         <xsl:param>generate.section.toc.level=10
  39         # Index on type:
  40         <xsl:param>index.on.type=1
  41
  42         # PDF Options:
  43         # TOC Generation: this is needed for FOP-0.9 and later:
  44         <xsl:param>fop1.extensions=0
  45         <format>pdf:<xsl:param>xep.extensions=1
  46         # TOC generation: this is needed for FOP 0.2, but must not be set to zero for FOP-0.9!
  47         <format>pdf:<xsl:param>fop.extensions=0
  48         # No indent on body text:
  49         <format>pdf:<xsl:param>body.start.indent=0pt
  50         # Margin size:
  51         <format>pdf:<xsl:param>page.margin.inner=0.5in
  52         # Margin size:
  53         <format>pdf:<xsl:param>page.margin.outer=0.5in
  54         # Paper type = A4
  55         <format>pdf:<xsl:param>paper.type=A4
  56         # Yes, we want graphics for admonishments:
  57         <xsl:param>admon.graphics=1
  58         # Set this one for PDF generation *only*:
  59         # default pnd graphics are awful in PDF form,
  60         # better use SVG's instead:
  61         <format>pdf:<xsl:param>admon.graphics.extension=".svg"
  62         <format>pdf:<xsl:param>use.role.for.mediaobject=1
  63         <format>pdf:<xsl:param>preferred.mediaobject.role=print
  64         <format>pdf:<xsl:param>img.src.path=$(images_location)/
  65         <format>pdf:<xsl:param>admon.graphics.path=$(images_location)/images/
  66         <format>pdf:<xsl:param>draft.mode="no"
  67         # Choose indexing method (separately for html and pdf):
  68         <format>html:<auto-index-internal>on  # on (or off) to use internally generated indexes.
  69
  70         <format>pdf:<auto-index-internal>off # on (or off) to use internally generated indexes.
  71         :
  72         # Default build options, can be overridden on the command line.
  73         <auto-index>on # Turns on index (or off).
  74         # Turns on (or off) index-verbose for diagnostic info (using /bin auto-index-verbose folders).
  75         <auto-index-verbose>on
  76
  77         <xsl:param>index.on.type=1 # = 1 For the native stylesheets to generate multiple different indexes.
  78         # PDF native index support is probably better for PDFs as then you actually get page numbers.
  79
  80         <auto-index-script>autoindex.idx # Specifies the name of the script to load for mylibrary.
  81     ;
  82
  83 install pdf-install : standalone : <install-type>PDF <location>. <name>auto_index.pdf ;
  84
  85
  86