$Id: param.xweb 7679 2008-02-17 13:26:47Z xmldoc $ Walsh Norman 1999 2000 2001 2002 2003 2004 2005 2006 2007 Norman Walsh This is reference documentation for all user-configurable parameters in the DocBook XSL HTML stylesheets (for generating HTML output). admon.graphics.extension string admon.graphics.extension Filename extension for admonition graphics <xsl:param name="admon.graphics.extension">.png</xsl:param> Sets the filename extension to use on admonition graphics. admon.graphics.path string admon.graphics.path Path to admonition graphics <xsl:param name="admon.graphics.path">images/</xsl:param> Sets the path to the directory containing the admonition graphics (caution.png, important.png etc). This location is normally relative to the output html directory. See base.dir admon.graphics boolean admon.graphics Use graphics in admonitions? <xsl:param name="admon.graphics" select="0"></xsl:param> If true (non-zero), admonitions are presented in an alternate style that uses a graphic. Default graphics are provided in the distribution. admon.textlabel boolean admon.textlabel Use text label in admonitions? <xsl:param name="admon.textlabel" select="1"></xsl:param> If true (non-zero), admonitions are presented with a generated text label such as Note or Warning in the appropriate language. If zero, such labels are turned off, but any title child of the admonition element are still output. The default value is 1. admon.style string admon.style Specifies the CSS style attribute that should be added to admonitions. <xsl:param name="admon.style"> <xsl:text>margin-left: 0.5in; margin-right: 0.5in;</xsl:text> </xsl:param> Specifies the value of the CSS style attribute that should be added to admonitions. callout.defaultcolumn integer callout.defaultcolumn Indicates what column callouts appear in by default <xsl:param name="callout.defaultcolumn">60</xsl:param> 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 string callout.graphics.extension Filename extension for callout graphics <xsl:param name="callout.graphics.extension">.png</xsl:param> Sets the filename extension to use on callout graphics. The Docbook XSL distribution provides callout graphics in the following formats: SVG (extension: .svg) PNG (extension: .png) GIF (extension: .gif) callout.graphics.number.limit integer callout.graphics.number.limit Number of the largest callout graphic <xsl:param name="callout.graphics.number.limit">15</xsl:param> If callout.graphics is non-zero, graphics are used to represent callout numbers instead of plain text. 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 "(plain text instead of a graphic)" will be used. callout.graphics.path string callout.graphics.path Path to callout graphics <xsl:param name="callout.graphics.path">images/callouts/</xsl:param> Sets the path to the directory holding the callout graphics. his location is normally relative to the output html directory. see base.dir. Always terminate the directory with / since the graphic file is appended to this string, hence needs the separator. callout.graphics boolean callout.graphics Use graphics for callouts? <xsl:param name="callout.graphics" select="1"></xsl:param> 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 boolean callout.list.table Present callout lists using a table? <xsl:param name="callout.list.table" select="1"></xsl:param> 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.number.limit integer callout.unicode.number.limit Number of the largest unicode callout character <xsl:param name="callout.unicode.number.limit">10</xsl:param> If callout.unicode is non-zero, unicode characters are used to represent callout numbers. The value of callout.unicode.number.limit is the largest number for which a unicode character exists. If the callout number exceeds this limit, the default presentation "(nnn)" will always be used. callout.unicode.start.character integer callout.unicode.start.character First Unicode character to use, decimal value. <xsl:param name="callout.unicode.start.character">10102</xsl:param> If callout.graphics is zero and callout.unicode is non-zero, unicode characters are used to represent callout numbers. The value of callout.unicode.start.character is the decimal unicode value used for callout number one. Currently, only 10102 is supported in the stylesheets for this parameter. callout.unicode boolean callout.unicode Use Unicode characters rather than images for callouts. <xsl:param name="callout.unicode" select="0"></xsl:param> The stylesheets can use either an image of the numbers one to ten, or the single Unicode character which represents the numeral, in white on a black background. Use this to select the Unicode character option. callouts.extension boolean callouts.extension Enable the callout extension <xsl:param name="callouts.extension" select="1"></xsl:param> The callouts extension processes areaset elements in ProgramListingCO and other text-based callout elements. ebnf.table.bgcolor color ebnf.table.bgcolor Background color for EBNF tables <xsl:param name="ebnf.table.bgcolor">#F5DCB3</xsl:param> Sets the background color for EBNF tables (a pale brown). No bgcolor attribute is output if ebnf.table.bgcolor is set to the null string. ebnf.table.border boolean ebnf.table.border Selects border on EBNF tables <xsl:param name="ebnf.table.border" select="1"></xsl:param> Selects the border on EBNF tables. If non-zero, the tables have borders, otherwise they don't. ebnf.assignment rtf ebnf.assignment The EBNF production assignment operator <xsl:param name="ebnf.assignment"> <code>::=</code> </xsl:param> The ebnf.assignment parameter determines what text is used to show assignment in productions in productionsets. While ::= is common, so are several other operators. ebnf.statement.terminator rtf ebnf.statement.terminator Punctuation that ends an EBNF statement. <xsl:param name="ebnf.statement.terminator"></xsl:param> The ebnf.statement.terminator parameter determines what text is used to terminate each production in productionset. Some notations end each statement with a period. annotate.toc boolean annotate.toc Annotate the Table of Contents? <xsl:param name="annotate.toc" select="1"></xsl:param> If true, TOCs will be annotated. At present, this just means that the RefPurpose of RefEntry TOC entries will be displayed. autotoc.label.separator string autotoc.label.separator Separator between labels and titles in the ToC <xsl:param name="autotoc.label.separator">. </xsl:param> String used to separate labels and titles in a table of contents. autotoc.label.in.hyperlink boolean autotoc.label.in.hyperlink Include label in hyperlinked titles in TOC? <xsl:param name="autotoc.label.in.hyperlink" select="1"></xsl:param> If the value of autotoc.label.in.hyperlink is non-zero, labels are included in hyperlinked titles in the TOC. If it is instead zero, labels are still displayed prior to the hyperlinked titles, but are not hyperlinked along with the titles. process.source.toc boolean process.source.toc Process a non-empty toc element if it occurs in a source document? <xsl:param name="process.source.toc" select="0"></xsl:param> Specifies that the contents of a non-empty "hard-coded" toc element in a source document are processed to generate a TOC in output. This parameter has no effect on automated generation of TOCs. An automated TOC may still be generated along with the "hard-coded" TOC. To suppress automated TOC generation, adjust the value of the generate.toc paramameter. The process.source.toc parameter also has no effect if the toc element is empty; handling for empty toc is controlled by the process.empty.source.toc parameter. process.empty.source.toc boolean process.empty.source.toc Generate automated TOC if toc element occurs in a source document? <xsl:param name="process.empty.source.toc" select="0"></xsl:param> Specifies that if an empty toc element is found in a source document, an automated TOC is generated at this point in the document. Depending on what the value of the generate.toc parameter is, setting this parameter to 1 could result in generation of duplicate automated TOCs. So the process.empty.source.toc is primarily useful as an "override": by placing an empty toc in your document and setting this parameter to 1, you can force a TOC to be generated even if generate.toc says not to. bridgehead.in.toc boolean bridgehead.in.toc Should bridgehead elements appear in the TOC? <xsl:param name="bridgehead.in.toc" select="0"></xsl:param> If non-zero, bridgeheads appear in the TOC. Note that this option is not fully supported and may be removed in a future version of the stylesheets. simplesect.in.toc boolean simplesect.in.toc Should simplesect elements appear in the TOC? <xsl:param name="simplesect.in.toc" select="0"></xsl:param> If non-zero, simplesects will be included in the TOC. manual.toc string manual.toc An explicit TOC to be used for the TOC <xsl:param name="manual.toc"></xsl:param> The manual.toc identifies an explicit TOC that will be used for building the printed TOC. toc.list.type list dl ul ol toc.list.type Type of HTML list element to use for Tables of Contents <xsl:param name="toc.list.type">dl</xsl:param> When an automatically generated Table of Contents (or List of Titles) is produced, this HTML element will be used to make the list. toc.section.depth integer toc.section.depth How deep should recursive sections appear in the TOC? <xsl:param name="toc.section.depth">2</xsl:param> Specifies the depth to which recursive sections should appear in the TOC. toc.max.depth integer toc.max.depth How many levels should be created for each TOC? <xsl:param name="toc.max.depth">8</xsl:param> Specifies the maximal depth of TOC on all levels. generate.toc table generate.toc Control generation of ToCs and LoTs <xsl:param name="generate.toc"> appendix toc,title article/appendix nop article toc,title book toc,title,figure,table,example,equation chapter toc,title part toc,title preface toc,title qandadiv toc qandaset toc reference toc,title sect1 toc sect2 toc sect3 toc sect4 toc sect5 toc section toc set toc,title </xsl:param> This parameter has a structured value. It is a table of space-delimited path/value pairs. Each path identifies some element in the source document using a restricted subset of XPath (only the implicit child axis, no wildcards, no predicates). Paths can be either relative or absolute. When processing a particular element, the stylesheets consult this table to determine if a ToC (or LoT(s)) should be generated. For example, consider the entry: book toc,figure This indicates that whenever a book is formatted, a Table Of Contents and a List of Figures should be generated. Similarly, /chapter toc indicates that whenever a document that has a root of chapter is formatted, a Table of Contents should be generated. The entry chapter would match all chapters, but /chapter matches only chapter document elements. Generally, the longest match wins. So, for example, if you want to distinguish articles in books from articles in parts, you could use these two entries: book/article toc,figure part/article toc Note that an article in a part can never match a book/article, so if you want nothing to be generated for articles in parts, you can simply leave that rule out. If you want to leave the rule in, to make it explicit that you're turning something off, use the value nop. For example, the following entry disables ToCs and LoTs for articles: article nop Do not simply leave the word article in the file without a matching value. That'd be just begging the silly little path/value parser to get confused. Section ToCs are further controlled by the generate.section.toc.level parameter. For a given section level to have a ToC, it must have both an entry in generate.toc and be within the range enabled by generate.section.toc.level. generate.section.toc.level integer generate.section.toc.level Control depth of TOC generation in sections <xsl:param name="generate.section.toc.level" select="0"></xsl:param> 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. generate.index boolean generate.index Do you want an index? <xsl:param name="generate.index" select="1"></xsl:param> Specify if an index should be generated. index.method list basic kosek kimber index.method Select method used to group index entries in an index <xsl:param name="index.method">basic</xsl:param> This parameter lets you select which method to use for sorting and grouping index entries in an index. Indexes in Latin-based languages that have accented characters typically sort together accented words and unaccented words. Thus Á (U+00C1 LATIN CAPITAL LETTER A WITH ACUTE) would sort together with A (U+0041 LATIN CAPITAL LETTER A), so both would appear in the A section of the index. Languages using other alphabets (such as Russian, which is written in the Cyrillic alphabet) and languages using ideographic chararacters (such as Japanese) require grouping specific to the languages and alphabets. The default indexing method is limited. It can group accented characters in Latin-based languages only. It cannot handle non-Latin alphabets or ideographic languages. The other indexing methods require extensions of one type or another, and do not work with all XSLT processors, which is why they are not used by default. The three choices for indexing method are: basic (default) Sort and groups words based only on the Latin alphabet. Words with accented Latin letters will group and sort with their respective primary letter, but words in non-Latin alphabets will be put in the Symbols section of the index. kosek This method sorts and groups words based on letter groups configured in the DocBook locale file for the given language. See, for example, the French locale file common/fr.xml. This method requires that the XSLT processor supports the EXSLT extensions (most do). It also requires support for using user-defined functions in xsl:key (xsltproc does not). This method is suitable for any language for which you can list all the individual characters that should appear in each letter group in an index. It is probably not practical to use it for ideographic languages such as Chinese that have hundreds or thousands of characters. To use the kosek method, you must: Use a processor that supports its extensions, such as Saxon 6 or Xalan (xsltproc and Saxon 8 do not). Set the index.method parameter's value to kosek. Import the appropriate index extensions stylesheet module fo/autoidx-kosek.xsl or html/autoidx-kosek.xsl into your customization. kimber This method uses extensions to the Saxon processor to implement sophisticated indexing processes. It uses its own configuration file, which can include information for any number of languages. Each language's configuration can group words using one of two processes. In the enumerated process similar to that used in the kosek method, you indicate the groupings character-by-character. In the between-key process, you specify the break-points in the sort order that should start a new group. The latter configuration is useful for ideographic languages such as Chinese, Japanese, and Korean. You can also define your own collation algorithms and how you want mixed Latin-alphabet words sorted. For a whitepaper describing the extensions, see: http://www.innodata-isogen.com/knowledge_center/white_papers/back_of_book_for_xsl_fo.pdf. To download the extension library, see http://www.innodata-isogen.com/knowledge_center/tools_downloads/i18nsupport. To use the kimber method, you must: Use Saxon (version 6 or 8) as your XSLT processor. Install and configure the Innodata Isogen library, using the documentation that comes with it. Set the index.method parameter's value to kimber. Import the appropriate index extensions stylesheet module fo/autoidx-kimber.xsl or html/autoidx-kimber.xsl into your customization. index.on.type boolean index.on.type Select indexterms based on type attribute value <xsl:param name="index.on.type" select="0"></xsl:param> If non-zero, then an index element that has a type attribute value will contain only those indexterm elements with a matching type attribute value. If an index has no type attribute or it is blank, then the index will contain all indexterms in the current scope. If index.on.type is zero, then the type attribute has no effect on selecting indexterms for an index. For those using DocBook version 4.2 or earlier, the type attribute is not available for index terms. However, you can achieve the same effect by using the role attribute in the same manner on indexterm and index, and setting the stylesheet parameter index.on.role to a nonzero value. index.on.role boolean index.on.role Select indexterms based on role value <xsl:param name="index.on.role" select="0"></xsl:param> If non-zero, then an index element that has a role attribute value will contain only those indexterm elements with a matching role value. If an index has no role attribute or it is blank, then the index will contain all indexterms in the current scope. If index.on.role is zero, then the role attribute has no effect on selecting indexterms for an index. If you are using DocBook version 4.3 or later, you should use the type attribute instead of role on indexterm and index, and set the index.on.type to a nonzero value. index.prefer.titleabbrev boolean index.prefer.titleabbrev Should abbreviated titles be used as back references? <xsl:param name="index.prefer.titleabbrev" select="0"></xsl:param> If non-zero, and if a titleabbrev is defined, the abbreviated title is used as the link text of a back reference in the index. index.term.separator string index.term.separator Override for punctuation separating an index term from its list of page references in an index <xsl:param name="index.term.separator"></xsl:param> This parameter permits you to override the text to insert between the end of an index term and its list of page references. Typically that might be a comma and a space. Because this text may be locale dependent, this parameter's value is normally taken from a gentext template named 'term-separator' in the context 'index' in the stylesheet locale file for the language of the current document. This parameter can be used to override the gentext string, and would typically be used on the command line. This parameter would apply to all languages. So this text string can be customized in two ways. You can reset the default gentext string using the local.l10n.xml parameter, or you can fill in the content for this normally empty override parameter. The content can be a simple string, or it can be something more complex such as a call-template. For fo output, it could be an fo:leader element to provide space of a specific length, or a dot leader. index.number.separator string index.number.separator Override for punctuation separating page numbers in index <xsl:param name="index.number.separator"></xsl:param> This parameter permits you to override the text to insert between page references in a formatted index entry. Typically that would be a comma and a space. Because this text may be locale dependent, this parameter's value is normally taken from a gentext template named 'number-separator' in the context 'index' in the stylesheet locale file for the language of the current document. This parameter can be used to override the gentext string, and would typically be used on the command line. This parameter would apply to all languages. So this text string can be customized in two ways. You can reset the default gentext string using the local.l10n.xml parameter, or you can override the gentext with the content of this parameter. The content can be a simple string, or it can be something more complex such as a call-template. In HTML index output, section title references are used instead of page number references. This punctuation appears between such section titles in an HTML index. index.range.separator string index.range.separator Override for punctuation separating the two numbers in a page range in index <xsl:param name="index.range.separator"></xsl:param> This parameter permits you to override the text to insert between the two numbers of a page range in an index. This parameter is only used by those XSL-FO processors that support an extension for generating such page ranges (such as XEP). Because this text may be locale dependent, this parameter's value is normally taken from a gentext template named 'range-separator' in the context 'index' in the stylesheet locale file for the language of the current document. This parameter can be used to override the gentext string, and would typically be used on the command line. This parameter would apply to all languages. So this text string can be customized in two ways. You can reset the default gentext string using the local.l10n.xml parameter, or you can override the gentext with the content of this parameter. The content can be a simple string, or it can be something more complex such as a call-template. In HTML index output, section title references are used instead of page number references. So there are no page ranges and this parameter has no effect. linenumbering.everyNth integer linenumbering.everyNth Indicate which lines should be numbered <xsl:param name="linenumbering.everyNth">5</xsl:param> If line numbering is enabled, everyNth line will be numbered. Note that numbering is one based, not zero based. linenumbering.extension boolean linenumbering.extension Enable the line numbering extension <xsl:param name="linenumbering.extension" select="1"></xsl:param> If non-zero, verbatim environments (address, literallayout, programlisting, screen, synopsis) that specify line numbering will have line numbers. linenumbering.separator string linenumbering.separator Specify a separator between line numbers and lines <xsl:param name="linenumbering.separator"><xsl:text> </xsl:text></xsl:param> The separator is inserted between line numbers and lines in the verbatim environment. The default value is a single white space. Note the interaction with linenumbering.width linenumbering.width integer linenumbering.width Indicates the width of line numbers <xsl:param name="linenumbering.width">3</xsl:param> If line numbering is enabled, line numbers will appear right justified in a field "width" characters wide. tablecolumns.extension boolean tablecolumns.extension Enable the table columns extension function <xsl:param name="tablecolumns.extension" select="1"></xsl:param> 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. textinsert.extension boolean textinsert.extension Enables the textinsert extension element <xsl:param name="textinsert.extension" select="1"></xsl:param> The textinsert extension element inserts the contents of a file into the result tree (as text). To use the textinsert extension element, you must use either Saxon or Xalan as your XSLT processor (it doesn’t work with xsltproc), along with either the DocBook Saxon extensions or DocBook Xalan extensions (for more information about those extensions, see DocBook Saxon Extensions and DocBook Xalan Extensions), and you must set both the use.extensions and textinsert.extension parameters to 1. As an alternative to using the textinsert element, consider using an Xinclude element with the parse="text" attribute and value specified, as detailed in Using XInclude for text inclusions. You can also use the dbhtml-include href processing instruction to insert external files — both files containing plain text and files with markup content (including HTML content). For how-to documentation on inserting contents of external code files and other text files into output, see External code files. For guidelines on inserting contents of HTML files into output, see Inserting external HTML code. textdata.default.encoding string textdata.default.encoding Default encoding of external text files which are included using textdata element <xsl:param name="textdata.default.encoding"></xsl:param> Specifies the encoding of any external text files included using textdata element. This value is used only when you do not specify encoding by the appropriate attribute directly on textdata. An empty string is interpreted as the system default encoding. graphicsize.extension boolean graphicsize.extension Enable the getWidth()/getDepth() extension functions <xsl:param name="graphicsize.extension" select="1"></xsl:param> If non-zero (and if use.extensions is non-zero and if you're using a processor that supports extension functions), the getWidth and getDepth functions will be used to extract image sizes from graphics. graphicsize.use.img.src.path boolean graphicsize.use.img.src.path Prepend img.src.path before filenames passed to extension functions <xsl:param name="graphicsize.use.img.src.path" select="0"></xsl:param> If non-zero img.src.path parameter will be appended before filenames passed to extension functions for measuring image dimensions. use.extensions boolean use.extensions Enable extensions <xsl:param name="use.extensions" select="0"></xsl:param> If non-zero, extensions may be used. Each extension is further controlled by its own parameter. But if use.extensions is zero, no extensions will be used. chapter.autolabel list 0none 11,2,3... AA,B,C... aa,b,c... ii,ii,iii... II,II,III... chapter.autolabel Specifies the labeling format for Chapter titles <xsl:param name="chapter.autolabel" select="1"></xsl:param> If non-zero, then chapters will be numbered using the parameter value as the number format if the value matches one of the following: 1 or arabic Arabic numeration (1, 2, 3 ...). A or upperalpha Uppercase letter numeration (A, B, C ...). a or loweralpha Lowercase letter numeration (a, b, c ...). I or upperroman Uppercase roman numeration (I, II, III ...). i or lowerroman Lowercase roman letter numeration (i, ii, iii ...). Any nonzero value other than the above will generate the default number format (arabic). appendix.autolabel list 0none 11,2,3... AA,B,C... aa,b,c... ii,ii,iii... II,II,III... appendix.autolabel Specifies the labeling format for Appendix titles <xsl:param name="appendix.autolabel">A</xsl:param> If non-zero, then appendices will be numbered using the parameter value as the number format if the value matches one of the following: 1 or arabic Arabic numeration (1, 2, 3 ...). A or upperalpha Uppercase letter numeration (A, B, C ...). a or loweralpha Lowercase letter numeration (a, b, c ...). I or upperroman Uppercase roman numeration (I, II, III ...). i or lowerroman Lowercase roman letter numeration (i, ii, iii ...). Any nonzero value other than the above will generate the default number format (upperalpha). part.autolabel list 0none 11,2,3... AA,B,C... aa,b,c... ii,ii,iii... II,II,III... part.autolabel Specifies the labeling format for Part titles <xsl:param name="part.autolabel">I</xsl:param> If non-zero, then parts will be numbered using the parameter value as the number format if the value matches one of the following: 1 or arabic Arabic numeration (1, 2, 3 ...). A or upperalpha Uppercase letter numeration (A, B, C ...). a or loweralpha Lowercase letter numeration (a, b, c ...). I or upperroman Uppercase roman numeration (I, II, III ...). i or lowerroman Lowercase roman letter numeration (i, ii, iii ...). Any nonzero value other than the above will generate the default number format (upperroman). reference.autolabel list 0none 11,2,3... AA,B,C... aa,b,c... ii,ii,iii... II,II,III... reference.autolabel Specifies the labeling format for Reference titles <xsl:param name="reference.autolabel">I</xsl:param> If non-zero, references will be numbered using the parameter value as the number format if the value matches one of the following: 1 or arabic Arabic numeration (1, 2, 3 ...). A or upperalpha Uppercase letter numeration (A, B, C ...). a or loweralpha Lowercase letter numeration (a, b, c ...). I or upperroman Uppercase roman numeration (I, II, III ...). i or lowerroman Lowercase roman letter numeration (i, ii, iii ...). Any non-zero value other than the above will generate the default number format (upperroman). preface.autolabel list 0none 11,2,3... AA,B,C... aa,b,c... ii,ii,iii... II,II,III... preface.autolabel Specifices the labeling format for Preface titles <xsl:param name="preface.autolabel" select="0"></xsl:param> If non-zero then prefaces will be numbered using the parameter value as the number format if the value matches one of the following: 1 or arabic Arabic numeration (1, 2, 3 ...). A or upperalpha Uppercase letter numeration (A, B, C ...). a or loweralpha Lowercase letter numeration (a, b, c ...). I or upperroman Uppercase roman numeration (I, II, III ...). i or lowerroman Lowercase roman letter numeration (i, ii, iii ...). Any nonzero value other than the above will generate the default number format (arabic). qandadiv.autolabel boolean qandadiv.autolabel Are divisions in QAndASets enumerated? <xsl:param name="qandadiv.autolabel" select="1"></xsl:param> If non-zero, unlabeled qandadivs will be enumerated. section.autolabel boolean section.autolabel Are sections enumerated? <xsl:param name="section.autolabel" select="0"></xsl:param> If true (non-zero), unlabeled sections will be enumerated. section.autolabel.max.depth integer section.autolabel.max.depth The deepest level of sections that are numbered. <xsl:param name="section.autolabel.max.depth">8</xsl:param> When section numbering is turned on by the section.autolabel parameter, then this parameter controls the depth of section nesting that is numbered. Sections nested to a level deeper than this value will not be numbered. section.label.includes.component.label boolean section.label.includes.component.label Do section labels include the component label? <xsl:param name="section.label.includes.component.label" select="0"></xsl:param> If non-zero, section labels are prefixed with the label of the component that contains them. label.from.part boolean label.from.part Renumber components in each part? <xsl:param name="label.from.part" select="0"></xsl:param> If label.from.part is non-zero, then numbering of components — preface, chapter, appendix, and reference (when reference occurs at the component level) — is re-started within each part. If label.from.part is zero (the default), numbering of components is not re-started within each part; instead, components are numbered sequentially throughout each book, regardless of whether or not they occur within part instances. component.label.includes.part.label boolean component.label.includes.part.label Do component labels include the part label? <xsl:param name="component.label.includes.part.label" select="0"></xsl:param> If non-zero, number labels for chapter, appendix, and other component elements are prefixed with the label of the part element that contains them. So you might see Chapter II.3 instead of Chapter 3. Also, the labels for formal elements such as table and figure will include the part label. If there is no part element container, then no prefix is generated. This feature is most useful when the label.from.part parameter is turned on. In that case, there would be more than one chapter 1, and the extra part label prefix will identify each chapter unambiguously. html.base uri html.base An HTML base URI <xsl:param name="html.base"></xsl:param> If html.base is set, it is used for the base element in the head of the html documents. The parameter specifies the base URL for all relative URLs in the document. This is useful for dynamically served html where the base URI needs to be shifted. html.stylesheet.type string html.stylesheet.type The type of the stylesheet used in the generated HTML <xsl:param name="html.stylesheet.type">text/css</xsl:param> The type of the stylesheet to place in the HTML link tag. html.stylesheet string html.stylesheet Name of the stylesheet(s) to use in the generated HTML <xsl:param name="html.stylesheet"></xsl:param> The html.stylesheet parameter is either empty, indicating that no stylesheet link tag should be generated in the html output, or it is a list of one or more stylesheet files. Multiple stylesheets are space-delimited. If you need to reference a stylesheet URI that includes a space, encode it with %20. A separate html link element will be generated for each stylesheet in the order they are listed in the parameter. css.decoration boolean css.decoration Enable CSS decoration of elements <xsl:param name="css.decoration" select="1"></xsl:param> If non-zero, 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 boolean spacing.paras Insert additional <p> elements for spacing? <xsl:param name="spacing.paras" select="0"></xsl:param> 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 boolean emphasis.propagates.style Pass emphasis role attribute through to HTML? <xsl:param name="emphasis.propagates.style" select="1"></xsl:param> If non-zero, the role attribute of emphasis elements will be passed through to the HTML as a class attribute on a span that surrounds the emphasis. para.propagates.style boolean para.propagates.style Pass para role attribute through to HTML? <xsl:param name="para.propagates.style" select="1"></xsl:param> If true, the role attribute of para elements will be passed through to the HTML as a class attribute on the p generated for the paragraph. phrase.propagates.style boolean phrase.propagates.style Pass phrase role attribute through to HTML? <xsl:param name="phrase.propagates.style" select="1"></xsl:param> If non-zero, the role attribute of phrase elements will be passed through to the HTML as a class attribute on a span that surrounds the phrase. entry.propagates.style boolean entry.propagates.style Pass entry role attribute through to HTML? <xsl:param name="entry.propagates.style" select="1"></xsl:param> If true, the role attribute of entry elements will be passed through to the HTML as a class attribute on the td or th generated for the table cell. html.longdesc boolean html.longdesc Should longdesc URIs be created? <xsl:param name="html.longdesc" select="1"></xsl:param> If non-zero, HTML files will be created for the longdesc attribute. These files are created from the textobjects in mediaobjects and inlinemediaobject. html.longdesc.link boolean html.longdesc.link Should a link to the longdesc be included in the HTML? <xsl:param name="html.longdesc.link" select="$html.longdesc"></xsl:param> If non-zero, links will be created to the HTML files created for the longdesc attribute. It makes no sense to enable this option without also enabling the html.longdesc parameter. make.valid.html boolean make.valid.html Attempt to make sure the HTML output is valid HTML <xsl:param name="make.valid.html" select="0"></xsl:param> If make.valid.html is true, the stylesheets take extra effort to ensure that the resulting HTML is valid. This may mean that some para tags are translated into HTML divs or that other substitutions occur. This parameter is different from html.cleanup because it changes the resulting markup; it does not use extension functions to manipulate result-tree-fragments and is therefore applicable to any XSLT processor. html.cleanup boolean html.cleanup Attempt to clean up the resulting HTML? <xsl:param name="html.cleanup" select="1"></xsl:param> If non-zero, and if the EXSLT extensions are supported by your processor, the resulting HTML will be cleaned up. This improves the chances that the resulting HTML will be valid. It may also improve the formatting of some elements. This parameter is different from make.valid.html because it uses extension functions to manipulate result-tree-fragments. html.append string html.append Specifies content to append to HTML output <xsl:param name="html.append"></xsl:param> Specifies content to append to the end of HTML files output by the html/docbook.xsl stylesheet, after the closing <html> tag. You probably don’t want to set any value for this parameter; but if you do, the only value it should ever be set to is a newline character: 
 or 
 draft.mode list no yes maybe draft.mode Select draft mode <xsl:param name="draft.mode">maybe</xsl:param> Selects draft mode. If draft.mode is yes, the entire document will be treated as a draft. If it is no, the entire document will be treated as a final copy. If it is maybe, individual sections will be treated as draft or final independently, depending on how their status attribute is set. draft.watermark.image uri draft.watermark.image The URI of the image to be used for draft watermarks <xsl:param name="draft.watermark.image">http://docbook.sourceforge.net/release/images/draft.png</xsl:param> The image to be used for draft watermarks. generate.id.attributes boolean generate.id.attributes Generate ID attributes on container elements? <xsl:param name="generate.id.attributes" select="0"></xsl:param> If non-zero, the HTML stylesheet will generate ID attributes on containers. For example, the markup: <section id="foo"><title>Some Title</title> <para>Some para.</para> </section> might produce: <div class="section" id="foo"> <h2>Some Title</h2> <p>Some para.</p> </div> The alternative is to generate anchors: <div class="section"> <h2><a name="foo"></a>Some Title</h2> <p>Some para.</p> </div> Because the name attribute of the a element and the id attribute of other tags are both of type ID, producing both generates invalid documents. As of version 1.50, you can use this switch to control which type of identifier is generated. For backwards-compatibility, generating a anchors is preferred. Note: at present, this switch is incompletely implemented. Disabling ID attributes will suppress them, but enabling ID attributes will not suppress the anchors. generate.meta.abstract boolean generate.meta.abstract Generate HTML META element from abstract? <xsl:param name="generate.meta.abstract" select="1"></xsl:param> If non-zero, document abstracts will be reproduced in the HTML head, with >meta name="description" content="..." rootid string rootid Specify the root element to format <xsl:param name="rootid"></xsl:param> If rootid is not empty, 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. suppress.navigation boolean suppress.navigation Disable header and footer navigation <xsl:param name="suppress.navigation" select="0"></xsl:param> If non-zero, header and footer navigation will be suppressed. suppress.header.navigation boolean suppress.header.navigation Disable header navigation <xsl:param name="suppress.header.navigation" select="0"></xsl:param> If non-zero, header navigation will be suppressed. suppress.footer.navigation boolean suppress.footer.navigation Disable footer navigation <xsl:param name="suppress.footer.navigation">0</xsl:param> If non-zero, footer navigation will be suppressed. header.rule boolean header.rule Rule under headers? <xsl:param name="header.rule" select="1"></xsl:param> If non-zero, a rule will be drawn below the page headers. footer.rule boolean footer.rule Rule over footers? <xsl:param name="footer.rule" select="1"></xsl:param> If non-zero, a rule will be drawn above the page footers. id.warnings boolean id.warnings Should warnings be generated for titled elements without IDs? <xsl:param name="id.warnings" select="0"></xsl:param> If non-zero, the stylesheet will issue a warning for any element (other than the root element) which has a title but does not have an ID. inherit.keywords boolean inherit.keywords Inherit keywords from ancestor elements? <xsl:param name="inherit.keywords" select="1"></xsl:param> If inherit.keywords is non-zero, the keyword meta for each HTML head element will include all of the keywords from ancestor elements. Otherwise, only the keywords from the current section will be used. make.single.year.ranges boolean make.single.year.ranges Print single-year ranges (e.g., 1998-1999) <xsl:param name="make.single.year.ranges" select="0"></xsl:param> 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 boolean make.year.ranges Collate copyright years into ranges? <xsl:param name="make.year.ranges" select="0"></xsl:param> If non-zero, multiple copyright year elements will be collated into ranges. This works only if each year number is put into a separate year element. The copyright element permits multiple year elements. The stylesheet will not successfully parse a complex year element such as <year>2001,2002,2003</year> into a range. author.othername.in.middle boolean author.othername.in.middle Is othername in author a middle name? <xsl:param name="author.othername.in.middle" select="1"></xsl:param> If non-zero, the othername of an author appears between the firstname and surname. Otherwise, othername is suppressed. blurb.on.titlepage.enabled boolean blurb.on.titlepage.enabled Display personblurb and authorblurb on title pages? <xsl:param name="blurb.on.titlepage.enabled" select="0"></xsl:param> If non-zero, output from authorblurb and personblurb elements is displayed on title pages. If zero (the default), output from those elements is suppressed on title pages (unless you are using a titlepage customization that causes them to be included). contrib.inline.enabled boolean contrib.inline.enabled Display contrib output inline? <xsl:param name="contrib.inline.enabled">1</xsl:param> If non-zero (the default), output of the contrib element is displayed as inline content rather than as block content. editedby.enabled boolean editedby.enabled Display “Edited by” heading above editor name? <xsl:param name="editedby.enabled">1</xsl:param> If non-zero, a localized Edited by heading is displayed above editor names in output of the editor element. abstract.notitle.enabled boolean abstract.notitle.enabled Suppress display of abstract titles? <xsl:param name="abstract.notitle.enabled" select="0"></xsl:param> If non-zero, in output of the abstract element on titlepages, display of the abstract title is suppressed. othercredit.like.author.enabled boolean othercredit.like.author.enabled Display othercredit in same style as author? <xsl:param name="othercredit.like.author.enabled">0</xsl:param> If non-zero, output of the othercredit element on titlepages is displayed in the same style as author and editor output. If zero then othercredit output is displayed using a style different than that of author and editor. generate.legalnotice.link boolean generate.legalnotice.link Write legalnotice to separate chunk and generate link? <xsl:param name="generate.legalnotice.link" select="0"></xsl:param> If the value of generate.legalnotice.link is non-zero, the stylesheet: writes the contents of legalnotice to a separate HTML file inserts a hyperlink to the legalnotice file adds (in the HTML head) either a single link or element or multiple link elements (depending on the value of the html.head.legalnotice.link.multiple parameter), with the value or values derived from the html.head.legalnotice.link.types parameter Otherwise, if generate.legalnotice.link is zero, legalnotice contents are rendered on the title page. The name of the separate HTML file is computed as follows: If a filename is given by the dbhtml filename processing instruction, that filename is used. If the legalnotice has an id/xml:id attribute, and if use.id.as.filename != 0, the filename is the concatenation of the id value and the value of the html.ext parameter. If the legalnotice does not have an id/xml:id attribute, or if use.id.as.filename = 0, the filename is the concatenation of "ln-", auto-generated id value, and html.ext value. generate.revhistory.link boolean generate.revhistory.link Write revhistory to separate chunk and generate link? <xsl:param name="generate.revhistory.link" select="0"></xsl:param> If non-zero, the contents of revhistory are written to a separate HTML file and a link to the file is generated. Otherwise, revhistory contents are rendered on the title page. The name of the separate HTML file is computed as follows: If a filename is given by the dbhtml filename processing instruction, that filename is used. If the revhistory has an id/xml:id attribute, and if use.id.as.filename != 0, the filename is the concatenation of the id value and the value of the html.ext parameter. If the revhistory does not have an id/xml:id attribute, or if use.id.as.filename = 0, the filename is the concatenation of "rh-", auto-generated id value, and html.ext value. html.head.legalnotice.link.types string html.head.legalnotice.link.types Specifies link types for legalnotice link in html head <xsl:param name="html.head.legalnotice.link.types">copyright</xsl:param> The value of html.head.legalnotice.link.types is a space-separated list of link types, as described in Section 6.12 of the HTML 4.01 specification. If the value of the generate.legalnotice.link parameter is non-zero, then the stylesheet generates (in the head section of the HTML source) either a single HTML link element or, if the value of the html.head.legalnotice.link.multiple is non-zero, one link element for each link type specified. Each link has the following attributes: a rel attribute whose value is derived from the value of html.head.legalnotice.link.types an href attribute whose value is set to the URL of the file containing the legalnotice a title attribute whose value is set to the title of the corresponding legalnotice (or a title programatically determined by the stylesheet) For example: <link rel="license" href="ln-id2524073.html" title="Legal Notice"> In an ideal world, the default value of html.head.legalnotice.link.types would probably be “license”, since the content of the DocBook legalnotice is typically license information, not copyright information. However, the default value is “copyright” for pragmatic reasons: because that’s among the set of “recognized link types” listed in Section 6.12 of the HTML 4.01 specification, and because certain browsers and browser extensions are preconfigured to recognize that value. html.head.legalnotice.link.multiple boolean html.head.legalnotice.link.multiple Generate multiple link instances in html head for legalnotice? <xsl:param name="html.head.legalnotice.link.multiple" select="1"></xsl:param> If html.head.legalnotice.link.multiple is non-zero and the value of html.head.legalnotice.link.types contains multiple link types, then the stylesheet generates (in the head section of the HTML source) one link element for each link type specified. For example, if the value of html.head.legalnotice.link.types is “copyright license”: <link rel="copyright" href="ln-id2524073.html" title="Legal Notice"> <link rel="license" href="ln-id2524073.html" title="Legal Notice"> Otherwise, the stylesheet generates generates a single link instance; for example: <link rel="copyright license" href="ln-id2524073.html" title="Legal Notice"> funcsynopsis.decoration boolean funcsynopsis.decoration Decorate elements of a funcsynopsis? <xsl:param name="funcsynopsis.decoration" select="1"></xsl:param> If non-zero, elements of the funcsynopsis will be decorated (e.g. rendered as bold or italic text). The decoration is controlled by templates that can be redefined in a customization layer. funcsynopsis.style list ansi kr funcsynopsis.style What style of funcsynopsis should be generated? <xsl:param name="funcsynopsis.style">kr</xsl:param> If funcsynopsis.style is ansi, ANSI-style function synopses are generated for a funcsynopsis, otherwise K&R-style function synopses are generated. function.parens boolean function.parens Generate parens after a function? <xsl:param name="function.parens" select="0"></xsl:param> If non-zero, the formatting of a function element will include generated parentheses. refentry.generate.name boolean refentry.generate.name Output NAME header before 'RefName'(s)? <xsl:param name="refentry.generate.name" select="1"></xsl:param> If non-zero, a "NAME" section title is output before the list of 'RefName's. This parameter and refentry.generate.title are mutually exclusive. This means that if you change this parameter to zero, you should set refentry.generate.title to non-zero unless you want get quite strange output. refentry.generate.title boolean refentry.generate.title Output title before 'RefName'(s)? <xsl:param name="refentry.generate.title" select="0"></xsl:param> If non-zero, the reference page title or first name is output before the list of 'RefName's. This parameter and refentry.generate.name are mutually exclusive. This means that if you change this parameter to non-zero, you should set refentry.generate.name to zero unless you want get quite strange output. refentry.xref.manvolnum boolean refentry.xref.manvolnum Output manvolnum as part of refentry cross-reference? <xsl:param name="refentry.xref.manvolnum" select="1"></xsl:param> if non-zero, the manvolnum is used when cross-referencing refentrys, either with xref or citerefentry. citerefentry.link boolean citerefentry.link Generate URL links when cross-referencing RefEntrys? <xsl:param name="citerefentry.link" select="0"></xsl:param> If non-zero, a web link will be generated, presumably to an online man->HTML gateway. The text of the link is generated by the generate.citerefentry.link template. refentry.separator boolean refentry.separator Generate a separator between consecutive RefEntry elements? <xsl:param name="refentry.separator" select="1"></xsl:param> If true, a separator will be generated between consecutive reference pages. refclass.suppress boolean refclass.suppress Suppress display of refclass contents? <xsl:param name="refclass.suppress" select="0"></xsl:param> If the value of refclass.suppress is non-zero, then display of refclass contents is suppressed in output. default.table.width length default.table.width The default width of tables <xsl:param name="default.table.width"></xsl:param> If non-zero, this value will be used for the width attribute on tables that do not specify an alternate width (with the dbhtml table-width or dbfo table-width processing instruction). nominal.table.width length nominal.table.width The (absolute) nominal width of tables <xsl:param name="nominal.table.width">6in</xsl:param> 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 percentage). table.borders.with.css boolean table.borders.with.css Use CSS to specify table, row, and cell borders? <xsl:param name="table.borders.with.css" select="0"></xsl:param> If non-zero, CSS will be used to draw table borders. table.cell.border.style list none solid dotted dashed double groove ridge inset outset solid table.cell.border.style Specifies the border style of table cells <xsl:param name="table.cell.border.style">solid</xsl:param> Specifies the border style of table cells. To control properties of cell borders in HTML output, you must also turn on the table.borders.with.css parameter. table.cell.border.thickness length table.cell.border.thickness Specifies the thickness of table cell borders <xsl:param name="table.cell.border.thickness">0.5pt</xsl:param> If non-zero, specifies the thickness of borders on table cells. The units are points. See CSS To control properties of cell borders in HTML output, you must also turn on the table.borders.with.css parameter. table.cell.border.color color table.cell.border.color Specifies the border color of table cells <xsl:param name="table.cell.border.color"></xsl:param> Set the color of table cell borders. If non-zero, the value is used for the border coloration. See CSS. A color is either a keyword or a numerical RGB specification. Keywords are aqua, black, blue, fuchsia, gray, green, lime, maroon, navy, olive, orange, purple, red, silver, teal, white, and yellow. To control properties of cell borders in HTML output, you must also turn on the table.borders.with.css parameter. table.frame.border.style list none solid dotted dashed double groove ridge inset outset solid table.frame.border.style Specifies the border style of table frames <xsl:param name="table.frame.border.style">solid</xsl:param> Specifies the border style of table frames. table.frame.border.thickness length table.frame.border.thickness Specifies the thickness of the frame border <xsl:param name="table.frame.border.thickness">0.5pt</xsl:param> Specifies the thickness of the border on the table's frame. table.frame.border.color color table.frame.border.color Specifies the border color of table frames <xsl:param name="table.frame.border.color"></xsl:param> Specifies the border color of table frames. default.table.frame string default.table.frame The default framing of tables <xsl:param name="default.table.frame">all</xsl:param> This value will be used when there is no frame attribute on the table. html.cellspacing integer html.cellspacing Default value for cellspacing in HTML tables <xsl:param name="html.cellspacing"></xsl:param> If non-zero, this value will be used as the default cellspacing value in HTML tables. nn for pixels or nn% for percentage length. E.g. 5 or 5% html.cellpadding integer html.cellpadding Default value for cellpadding in HTML tables <xsl:param name="html.cellpadding"></xsl:param> If non-zero, this value will be used as the default cellpadding value in HTML tables. nn for pixels or nn% for percentage length. E.g. 5 or 5% qanda.defaultlabel list number qanda none qanda.defaultlabel Sets the default for defaultlabel on QandASet. <xsl:param name="qanda.defaultlabel">number</xsl:param> If no defaultlabel attribute is specified on a qandaset, this value is used. It must be one of the legal values for the defaultlabel attribute, one from none, number or qanda. The default value is 'number'. Meaning qanda - questions are labeled “Q:” and answers are labeled “A:”. number - The entries are enumerated. none - No distinguishing label precedes Questions or Answers. qanda.inherit.numeration boolean qanda.inherit.numeration Does enumeration of QandASet components inherit the numeration of parent elements? <xsl:param name="qanda.inherit.numeration" select="1"></xsl:param> If non-zero, numbered qandadiv elements and question and answer inherit the enumeration of the ancestors of the qandaset. qanda.in.toc boolean qanda.in.toc Should qa