mirror of
https://github.com/boostorg/auto_index.git
synced 2025-05-11 13:34:10 +00:00
9e6986bdcd
Fix optional index inclusion in source. Fix tool to generate an error if no script file exists. Regenerate docs. [SVN r68994]
104 lines
4.0 KiB
Plaintext
104 lines
4.0 KiB
Plaintext
# Copyright John Maddock 2005. Use, modification, and distribution are
|
|
# subject to the Boost Software License, Version 1.0. (See accompanying
|
|
# file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
|
|
|
|
using quickbook ;
|
|
|
|
path-constant images_location : html ;
|
|
|
|
import modules ;
|
|
|
|
if --enable-index in [ modules.peek : ARGV ]
|
|
{
|
|
ECHO "Building the autoindex docs with automatic index generation enabled." ;
|
|
using auto-index ;
|
|
project : requirements
|
|
|
|
<auto-index>on # Turns on index (or off).
|
|
# Turns on (or off) index-verbose for diagnostic info (using /bin auto-index-verbose folders).
|
|
<auto-index-verbose>on
|
|
|
|
# Choose indexing method (separately for html and pdf):
|
|
<format>html:<auto-index-internal>on # on (or off) to use internally generated indexes.
|
|
|
|
<format>pdf:<auto-index-internal>off # on (or off) to use internally generated indexes.
|
|
<xsl:param>index.on.type=1 # = 1 For the native stylesheets to generate multiple different indexes.
|
|
# PDF native index support is probably better for PDFs as then you actually get page numbers.
|
|
|
|
<auto-index-script>autoindex.idx # Specifies the name of the script to load for mylibrary.
|
|
|
|
<quickbook-define>enable_index ;
|
|
}
|
|
else
|
|
{
|
|
ECHO "Building the autoindex docs with automatic index generation disabled. To get an auto-index, try building with --enable-index." ;
|
|
}
|
|
|
|
xml auto_index : auto_index.qbk ;
|
|
|
|
boostbook standalone
|
|
:
|
|
auto_index
|
|
:
|
|
# Path for links to Boost:
|
|
#<xsl:param>boost.root=../../../../../../../trunk
|
|
# Path for libraries index:
|
|
<xsl:param>boost.libraries=$(boost-root)/libs/libraries.htm
|
|
# Use the main Boost stylesheet:
|
|
<xsl:param>html.stylesheet=boostbook.css
|
|
|
|
# Some general style settings:
|
|
<xsl:param>table.footnote.number.format=1
|
|
<xsl:param>footnote.number.format=1
|
|
|
|
# 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
|
|
# Index on type:
|
|
<xsl:param>index.on.type=1
|
|
|
|
#<xsl:param>root.filename="sf_dist_and_tools"
|
|
#<xsl:param>graphicsize.extension=1
|
|
#<xsl:param>use.extensions=1
|
|
|
|
# PDF Options:
|
|
# TOC Generation: this is needed for FOP-0.9 and later:
|
|
<xsl:param>fop1.extensions=0
|
|
<format>pdf:<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!
|
|
<format>pdf:<xsl:param>fop.extensions=0
|
|
# No indent on body text:
|
|
<format>pdf:<xsl:param>body.start.indent=0pt
|
|
# Margin size:
|
|
<format>pdf:<xsl:param>page.margin.inner=0.5in
|
|
# Margin size:
|
|
<format>pdf:<xsl:param>page.margin.outer=0.5in
|
|
# Paper type = A4
|
|
<format>pdf:<xsl:param>paper.type=A4
|
|
# 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:
|
|
<format>pdf:<xsl:param>admon.graphics.extension=".svg"
|
|
<format>pdf:<xsl:param>use.role.for.mediaobject=1
|
|
<format>pdf:<xsl:param>preferred.mediaobject.role=print
|
|
<format>pdf:<xsl:param>img.src.path=$(images_location)/
|
|
<format>pdf:<xsl:param>admon.graphics.path=$(images_location)/images/
|
|
<format>pdf:<xsl:param>draft.mode="no"
|
|
;
|
|
|
|
install pdf-install : standalone : <install-type>PDF <location>. <name>auto_index.pdf ;
|
|
|
|
|