$Id: param.xweb,v 1.3 2001/10/12 13:06:44 nwalsh Exp $
Copyright © 1999, 2000, 2001 Norman Walsh
Table of Contents
This is technical reference documentation for the DocBook XSL Stylesheets; it documents (some of) the parameters, templates, and other elements of the stylesheets.
This reference describes each of the HTML Stylesheet parameters. These are the “easily customizable” parts of the stylesheet. If you want to specify an alternate value for one or more of these parameters, you can do so in a “driver” stylesheet.
For example, if you want to change the html.stylesheet to reference.css, you might create a driver stylesheet like this:
<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
version='1.0'>
<xsl:import href="http://docbook.sourceforge.net/release/xsl/snapshot/html/docbook.xsl"/>
<xsl:param name="html.stylesheet">reference.css</xsl:param>
</xsl:stylesheet>Naturally, you have to change the href attribute on <xsl:import> to point to docbook.xsl on your system. (Or chunk.xsl, if you're using chunking.)
This is not intended to be “user” documentation. It is provided for developers writing customization layers for the stylesheets, and for anyone who's interested in “how it works”.
Although I am trying to be thorough, this documentation is known to be incomplete. Don't forget to read the source, too :-)
Table of Contents
admon.graphics.extension — Extension for admonition graphics
Default[ '.png' ]
Sets the extension to use on admonition graphics.
admon.graphics.path — Path to admonition graphics
Default[ images/ ]
Sets the path, probably relative to the directory where the HTML files are created, to the admonition graphics.
Table of Contents
callout.defaultcolumn — Indicates what column callouts appear in by default
Default[ '60' ]
If a callout does not identify a column (for example, if it uses the linerange unit), it will appear in the default column.
callout.graphics.extension — Extension for callout graphics
Default[ '.png' ]
Sets the extension to use on callout graphics.
callout.graphics.number.limit — Number of the largest callout graphic
Default[ '10' ]
If callout.graphics is non-zero, graphics are used to represent callout numbers. The value of callout.graphics.number.limit is the largest number for which a graphic exists. If the callout number exceeds this limit, the default presentation "(nnn)" will always be used.
callout.graphics.path — Path to callout graphics
Default[ 'images/callouts/' ]
Sets the path, probably relative to the directory where the HTML files are created, to the callout graphics.
callout.graphics — Use graphics for callouts?
Default[ '1' ]
If non-zero, callouts are presented with graphics (e.g., reverse-video circled numbers instead of "(1)", "(2)", etc.). Default graphics are provided in the distribution.
callout.list.table — Present callout lists using a table?
Default[ '1' ]
The default presentation of CalloutLists uses an HTML DL. Some browsers don't align DLs very well if callout.graphics are used. With this option turned on, CalloutLists are presented in an HTML TABLE, which usually results in better alignment of the callout number with the callout description.
callout.unicode.font — Specify a font for Unicode glyphs
Default[ 'ZapfDingbats' ]
The name of the font to specify around Unicode callout glyphs. If set to the empty string, no font change will occur.
callout.unicode.number.limit — Number of the largest callout graphic
Default[ '10' ]
If callout.graphics is non-zero, graphics are used to represent callout numbers. The value of callout.graphics.number.limit is the largest number for which a graphic exists. If the callout number exceeds this limit, the default presentation "(nnn)" will always be used.
callout.unicode.start.character — First Unicode character to use, decimal value.
Default[ 10102 ]
If callout.graphics is non-zero, graphics are used to represent callout numbers. The value of callout.graphics.number.limit is the largest number for which a graphic exists. If the callout number exceeds this limit, the default presentation "(nnn)" will always be used.
Table of Contents
ebnf.table.bgcolor — Background color for EBNF tables
Default[ '#F5DCB3' ]
Sets the background color for EBNF tables. No bgcolor attribute is output if ebnf.table.bgcolor is set to the null string. The default value matches the value used in recent online versions of the W3C's XML Spec productions.
Table of Contents
annotate.toc — Annotate the Table of Contents?
Default[ 1 ]
If true, TOCs will be annotated. At present, this just means that the RefPurpose of RefEntry TOC entries will be displayed.
autotoc.label.separator — Separator between labels and titles in the ToC
Default[ '. ' ]
FIXME:
generate.component.toc — Should TOCs be genereated in components (Chapters, Appendixes, etc.)?
Default[ 1 ]
If true (non-zero), they are.
generate.division.toc — Should TOCs be genereated in divisions (Books, Parts, etc.)?
Default[ 1 ]
If true (non-zero), they are.
generate.qandadiv.toc — Is a Table of Contents created for QandADivs?
Default[ 0 ]
If true (non-zero), a ToC is constructed for QandADivs.
generate.qandaset.toc — Is a Table of Contents created for QandASets?
Default[ 1 ]
If true (non-zero), a ToC is constructed for QandASets.
generate.section.toc — Generate TOCs inside Sections?
Default[ 1 ]
If non-zero, a Table of Contents will be generated inside section elements. Note that generate.section.toc.level may suppress some section TOCs.
generate.section.toc.level — Control depth of TOC generation in sections
Default[ 0 ]
The generate.section.toc.level parameter controls the depth of section in which TOCs will be generated. Note that this is related to, but not the same as toc.section.depth, which controls the depth to which TOC entries will be generated in a given TOC.
If, for example, generate.section.toc.level is 3, TOCs will be generated in first, second, and third level sections, but not in fourth level sections.
toc.list.type — Type of HTML list element to use for Tables of Contents
Default[ dl ]
When an automatically generated Table of Contents (or List of Titles) is produced, this HTML element will be used to make the list.
Table of Contents
saxon.callouts — Enable the callout extension
Default[ '1' ]
The callouts extension processes areaset elements in ProgramListingCO and other text-based callout elements.
saxon.linenumbering — Enable the line numbering extension
Default[ '1' ]
If true, verbatim environments (elements that have the format='linespecific' notation attribute: address, literallayout, programlisting, screen, synopsis) that specify line numbering will have, surprise, line numbers.
saxon.tablecolumns — Enable the table columns extension function
Default[ '1' ]
The table columns extension function adjusts the widths of table columns in the HTML result to more accurately reflect the specifications in the CALS table.
linenumbering.everyNth — Indicate which lines should be numbered
Default[ '5' ]
If line numbering is enabled, everyNth line will be numbered.
linenumbering.extension — Enable the line numbering extension
Default[ '1' ]
If true, verbatim environments (elements that have the format='linespecific' notation attribute: address, literallayout, programlisting, screen, synopsis) that specify line numbering will have, surprise, line numbers.
linenumbering.separator — Specify a separator between line numbers and lines
Default[ ' ' ]
The separator is inserted between line numbers and lines in the verbatim environment.
linenumbering.width — Indicates the width of line numbers
Default[ '3' ]
If line numbering is enabled, line numbers will appear right justified in a field "width" characters wide.
tablecolumns.extension — Enable the table columns extension function
Default[ '1' ]
The table columns extension function adjusts the widths of table columns in the HTML result to more accurately reflect the specifications in the CALS table.
Table of Contents
chapter.autolabel — Are chapters automatically enumerated?
Default[ 1 ]
If true (non-zero), unlabeled chapters will be enumerated.
appendix.autolabel — Are Appendixes automatically enumerated?
Default[ 1 ]
If true (non-zero), unlabeled appendixes will be enumerated.
part.autolabel — Are parts and references enumerated?
Default[ 1 ]
If true (non-zero), unlabeled parts and references will be enumerated.
preface.autolabel — Are prefaces enumerated?
Default[ 0 ]
If true (non-zero), unlabeled prefaces will be enumerated.
qandadiv.autolabel — Are divisions in QAndASets enumerated?
Default[ 1 ]
If true (non-zero), unlabeled qandadivs will be enumerated.
section.autolabel — Are sections enumerated?
Default[ 0 ]
If true (non-zero), unlabeled sections will be enumerated.
Table of Contents
html.base — An HTML base URI
Default[ Empty string ]
If html.base is set, it is used for the BASE element in the HEAD of the HTML documents. This is useful for dynamically served HTML where the base URI needs to be shifted.
html.stylesheet.type — The type of the stylesheet used in the generated HTML
Default[ text/css ]
The type of the stylesheet to place in the HTML link tag.
html.stylesheet — Name of the stylesheet to use in the generated HTML
Default[ '' ]
The name of the stylesheet to place in the HTML LINK tag, or the empty string to suppress the stylesheet LINK.
use.id.as.filename — Use ID value of chunk elements as the filename?
Default[ '0' ]
If use.id.as.filename is non-zero, the filename of chunk elements that have IDs will be derived from the ID value.
using.chunker — Will the output be chunked?
Default[ 0 ]
In addition to providing chunking, the chunker can cleanup a number of XML to HTML issues. If the chunker is not being used, the stylesheets try to avoid producing results that will not appear properly in browsers.
css.decoration — Enable CSS decoration of elements
Default[ 1 ]
If css.decoration is turned on, then HTML elements produced by the stylesheet may be decorated with STYLE attributes. For example, the LI tags produced for list items may include a fragment of CSS in the STYLE attribute which sets the CSS property "list-style-type".
spacing.paras — Insert additional <p> elements for spacing?
Default[ '0' ]
When non-zero, additional, empty paragraphs are inserted in several contexts (for example, around informal figures), to create a more pleasing visual appearance in many browsers.
emphasis.propagates.style — Pass emphasis role attribute through to HTML?
Default[ 1 ]
If true, the role attribute of emphasis elements will be passed through to the HTML as a class attribute on a span that surrounds the emphasis.
phrase.propagates.style — Pass phrase role attribute through to HTML?
Default[ 1 ]
If true, the role attribute of phrase elements will be passed through to the HTML as a class attribute on a span that surrounds the phrase.
stylesheet.result.type — Identifies the output format of this stylesheet
Default[ 'html' ]
The Saxon extension functions need to know if the output format is HTML ('html') or XSL Formatting Objects ('fo'). This variable answers that question. Valid settings are 'html' or 'fo'.
Table of Contents
use.id.function — Use the XPath id() function to find link targets?
Default[ '1' ]
If 1, the stylesheets use the id() function to find the targets of cross reference elements. This is more efficient, but only works if your XSLT processor implements the id() function, naturally.
THIS PARAMETER IS NOT SUPPORTED. IT IS ALWAYS ASSUMED TO BE 1. SEE xref.xsl IF YOU NEED TO TURN IT OFF.
rootid — Specify the root element to format
Default[ '' ]
If rootid is specified, it must be the value of an ID that occurs in the document being formatted. The entire document will be loaded and parsed, but formatting will begin at the element identified, rather than at the root. For example, this allows you to process only chapter 4 of a book.
Because the entire document is available to the processor, automatic numbering, cross references, and other dependencies are correctly resolved.
Table of Contents
inherit.keywords — Inherit keywords from ancestor elements?
Default[ '1' ]
If inherit.keywords is non-zero, the keyword META for each HTML HEAD element will include all of the keywords from ancestral elements. Otherwise, only the keywords from the current section will be used.
make.single.year.ranges — Print single-year ranges (e.g., 1998-1999)
Default[ 0 ]
If non-zero, year ranges that span a single year will be printed in range notation (1998-1999) instead of discrete notation (1998, 1999).
make.year.ranges — Collate copyright years into ranges?
Default[ 0 ]
If non-zero, copyright years will be collated into ranges.
Table of Contents
funcsynopsis.decoration — Decorate elements of a FuncSynopsis?
Default[ 1 ]
If true (non-zero), elements of the FuncSynopsis will be decorated (e.g. bold or italic). The decoration is controlled by functions that can be redefined in a customization layer.
funcsynopsis.style — What style of 'FuncSynopsis' should be generated?
Default[ kr ]
If funcsynopsis.style is ansi, ANSI-style function synopses are generated for a funcsynopsis, otherwise K&R-style function synopses are generated.
function.parens — Generate parens after a function?
Default[ 0 ]
If not 0, the formatting of a <function> element will include generated parenthesis.
refentry.generate.name — Output NAME header before 'RefName'(s)?
Default[ 1 ]
If true (non-zero), a "NAME" section title is output before the list of 'RefName's.
refentry.xref.manvolnum — Output manvolnum as part of refentry cross-reference?
Default[ 1 ]
if true (non-zero), the manvolnum is used when cross-referencing refentrys, either with xref or citerefentry.
Table of Contents
default.table.width — The default width of tables
Default[ '' ]
If specified, this value will be used for the WIDTH attribute on tables that do not specify an alternate width (with the dbhtml processing instruction).
nominal.table.width — The (absolute) nominal width of tables
Default[ '6in' ]
In order to convert CALS column widths into HTML column widths, it is sometimes necessary to have an absolute table width to use for conversion of mixed absolute and relative widths. This value must be an absolute length (not a percentag).
Table of Contents
Table of Contents
link.mailto.url — Mailto URL for the LINK REL=made HTML HEAD element
Default[ Empty string ]
If not the empty string, this address will be used for the REL=made LINK element in the HTML HEAD.