Description

If true (non-zero), admonitions are presented in an alternate style that uses a graphic. Default graphics are provided in the distribution.

Description

Sets the filename extension to use on admonition graphics.

Description

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

Description

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.

Description

How do you want admonitions titles styled?

Set the font-size, weight etc to the style required.

Description

How do you want admonitions styled?

Set the font-size, weight, etc. to the style required

Description

These properties are added to the outer block containing the entire graphical admonition, including its title. It is used when the parameter admon.graphics is set to nonzero. Use this attribute-set to set the space above and below, and any indent for the whole admonition.

In addition to these properties, a graphical admonition also applies the admonition.title.properties attribute-set to the title, and applies the admonition.properties attribute-set to the rest of the content.

Description

These properties are added to the outer block containing the entire nongraphical admonition, including its title. It is used when the parameter admon.graphics is set to zero. Use this attribute-set to set the space above and below, and any indent for the whole admonition.

In addition to these properties, a nongraphical admonition also applies the admonition.title.properties attribute-set to the title, and the admonition.properties attribute-set to the rest of the content.

Description

If a callout does not identify a column (for example, if it uses the linerange unit), it will appear in the default column.

Description

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.

Description

Sets the filename extension to use on callout graphics.

Description

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.

Description

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.

Description

Specifies the size of the callout marker icons. The default size is 7 points.

Description

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.

Description

The name of the font to specify around Unicode callout glyphs. If set to the empty string, no font change will occur.

Description

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.

Description

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.

Description

The callouts extension processes areaset elements in ProgramListingCO and other text-based callout elements.

Description

String used to separate labels and titles in a table of contents.

Description

Specifies that if an empty toc element is found in a source document, an automated TOC is generated at this point in the document.

Description

Specifies that the contents of a non-empty "hard-coded" toc element in a source document are processed to generate a TOC in output.

Description

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.

Description

Specify if an index should be generated.

Description

This parameter enables a very neat trick for getting properly merged, collated back-of-the-book indexes. G. Ken Holman suggested this trick at Extreme Markup Languages 2002 and I'm indebted to him for it.

Jeni Tennison's excellent code in autoidx.xsl does a great job of merging and sorting indexterms in the document and building a back-of-the-book index. However, there's one thing that it cannot reasonably be expected to do: merge page numbers into ranges. (I would not have thought that it could collate and suppress duplicate page numbers, but in fact it appears to manage that task somehow.)

Ken's trick is to produce a document in which the index at the back of the book is “displayed” in XML. Because the index is generated by the FO processor, all of the page numbers have been resolved. It's a bit hard to explain, but what it boils down to is that instead of having an index at the back of the book that looks like this:

you get one that looks like this:

After building a PDF file with this sort of odd-looking index, you can extract the text from the PDF file and the result is a proper index expressed in XML.

Now you have data that's amenable to processing and a simple Perl script (such as fo/pdf2index) can merge page ranges and generate a proper index.

Finally, reformat your original document using this literal index instead of an automatically generated one and “bingo”!

Description

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:

Description

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.

Description

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.

Description

Properties used to emphasize page number references for significant index terms (significance=preffered). Currently works only with XEP.

Description

This attribute set is applied to the block containing the entries in a letter division in an index. It can be used to set the font-size, font-family, and other inheritable properties that will be applied to all index entries.

Description

This attribute set is used on the letter headings that separate the divisions in an index.

Description

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.

Description

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.

Description

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.

Description

Properties associated with XEP index-items, which generate page numbers in an index processed by XEP. For more info see the XEP documentation section "Indexes" in http://www.renderx.com/reference.html#Indexes.

This attribute-set also adds by default any properties from the index.page.number.properties attribute-set.

Description

Specifies the depth to which recursive sections should appear in the TOC.

Description

Specifies the maximal depth of TOC on all levels.

Description

Specifies, in points, the distance by which each level of the TOC is indented from its parent.

This value is expressed in points, without a unit (in other words, it is a bare number). Using a bare number allows the stylesheet to perform calculations that would otherwise have to be performed by the FO processor because not all processors support expressions.

Description

Properties which are applied to every line in ToC (or LoT). You can modify them in order to change appearance of all, or some lines. For example in order to make lines for chapters in bold specify the following in your customization layer.

<xsl:attribute-set name="toc.line.properties">
  <xsl:attribute name="font-weight">
    <xsl:when test="self::chapter | self::preface | self::appendix">bold</xsl:when>
    <xsl:otherwise>normal</xsl:otherwise>
  </xsl:attribute>
</xsl:attribute-set>

Description

This attribute set is used on Tables of Contents. These attributes are set on the wrapper that surrounds the ToC block, not on each individual lines.

Description

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.

Description

If non-zero, simplesects will be included in the TOC.

Description

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.

Description

If non-zero, Arbortext extensions will be used.

This parameter can also affect which graphics file formats are supported

Description

If non-zero, XSL Formatter extensions will be used. XSL Formatter extensions consists of PDF bookmarks, document information and better index processing.

This parameter can also affect which graphics file formats are supported

Description

If non-zero, extensions intended for FOP version 0.20.5 and earlier will be used. At present, this consists of PDF bookmarks.

This parameter can also affect which graphics file formats are supported.

If you are using a version of FOP beyond version 0.20.5, then use the fop1.extensions parameter instead.

Description

If non-zero, extensions for FOP version 0.90 and later will be used.

This parameter can also affect which graphics file formats are supported.

The original fop.extensions parameter should still be used for FOP version 0.20.5 and earlier.

Description

If non-zero, PassiveTeX extensions will be used. At present, this consists of PDF bookmarks and sorted index terms.

This parameter can also affect which graphics file formats are supported

Description

If you want type math directly in TeX notation in equations, this parameter specifies notation used. Currently are supported two values -- plain and latex. Empty value means that you are not using TeX math at all.

Preferred way for including TeX alternative of math is inside of textobject element. Eg.:

<inlineequation>
<inlinemediaobject>
<imageobject>
<imagedata fileref="eq1.gif"/>
</imageobject>
<textobject><phrase>E=mc squared</phrase></textobject>
<textobject role="tex"><phrase>E=mc^2</phrase></textobject>
</inlinemediaobject>
</inlineequation>

If you are using graphic element, you can store TeX inside alt element:

<inlineequation>
<alt role="tex">a^2+b^2=c^2</alt>
<graphic fileref="a2b2c2.gif"/>  
</inlineequation>

If you want use this feature, you should process your FO with PassiveTeX, which only supports TeX math notation. When calling stylsheet, don't forget to specify also passivetex.extensions=1.

If you want equations in HTML, just process generated file tex-math-equations.tex by TeX or LaTeX. Then run dvi2bitmap program on result DVI file. You will get images for equations in your document.

Related Parameters

tex.math.delims, passivetex.extensions, tex.math.file

More information

For how-to documentation on embedding TeX equations and generating output from them, see DBTeXMath.

Description

For compatibility with DSSSL based DBTeXMath from Allin Cottrell you should set this parameter to 0.

Related Parameters

tex.math.in.alt, passivetex.extensions

See Also

You can also use the <?dbtex delims?> processing instruction to control whether delimiters are output.

More information

For how-to documentation on embedding TeX equations and generating output from them, see DBTeXMath.

Description

If non-zero, XEP extensions will be used. XEP extensions consists of PDF bookmarks, document information and better index processing.

This parameter can also affect which graphics file formats are supported

Description

If line numbering is enabled, everyNth line will be numbered. Note that numbering is one based, not zero based.

Description

If non-zero, verbatim environments (address, literallayout, programlisting, screen, synopsis) that specify line numbering will have line numbers.

Description

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

Description

If line numbering is enabled, line numbers will appear right justified in a field "width" characters wide.

Description

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.

Description

The textinsert extension element inserts the contents of a file into the result tree (as text).

See Also

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).

More information

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.

Description

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.

Description

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.

Description

If non-zero, then appendices will be numbered using the parameter value as the number format if the value matches one of the following:

Any nonzero value other than the above will generate the default number format (upperalpha).

Description

If non-zero, then chapters will be numbered using the parameter value as the number format if the value matches one of the following:

Any nonzero value other than the above will generate the default number format (arabic).

Description

If non-zero, then parts will be numbered using the parameter value as the number format if the value matches one of the following:

Any nonzero value other than the above will generate the default number format (upperroman).

Description

If non-zero, references will be numbered using the parameter value as the number format if the value matches one of the following:

Any non-zero value other than the above will generate the default number format (upperroman).

Description

If non-zero then prefaces will be numbered using the parameter value as the number format if the value matches one of the following:

Any nonzero value other than the above will generate the default number format (arabic).

Description

If true (non-zero), unlabeled sections will be enumerated.

Description

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.

Description

If non-zero, section labels are prefixed with the label of the component that contains them.

Description

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.

Description

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.

Description

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.

Description

If non-zero, year ranges that span a single year will be printed in range notation (1998-1999) instead of discrete notation (1998, 1999).

Description

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.

Description

If non-zero, the othername of an author appears between the firstname and surname. Otherwise, othername is suppressed.

Description

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.

Description

If funcsynopsis.style is ansi, ANSI-style function synopses are generated for a funcsynopsis, otherwise K&R-style function synopses are generated.

Description

If non-zero, the formatting of a function element will include generated parentheses.

Description

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.

Description

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.

Description

If non-zero (the default), each refentry element will start on a new page. If zero, a page break will not be generated between refentry elements. The exception is when the refentry elements are children of a part element, in which case the page breaks are always retained. That is because a part element does not generate a page-sequence for its children, so each refentry must start its own page-sequence.

Description

Formatting properties applied to the title generated for the refnamediv part of output for refentry when the value of the refentry.generate.title parameter is non-zero. The font size is supplied by the appropriate section.levelX.title.properties attribute-set, computed from the location of the refentry in the section hierarchy.

Description

if non-zero, the manvolnum is used when cross-referencing refentrys, either with xref or citerefentry.

Description

If the value of refclass.suppress is non-zero, then display of refclass contents is suppressed in output.

Description

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).

Description

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).

Description

This value will be used when there is no frame attribute on the table.

Description

Specifies the padding of table cells.

Description

Specifies the thickness of the border on the table's frame.

Description

Specifies the border style of table frames.

Description

Specifies the border color of table frames.

Description

If non-zero, specifies the thickness of borders on table cells. The units are points. See CSS

Description

Specifies the border style of table cells.

Description

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.

Description

The styling for tables. This parameter should really have been called table.properties, but that parameter name was inadvertently established for the block-level properties of the table as a whole.

See also table.properties.

Description

When olinks between documents are resolved for HTML output, the stylesheet can compute the relative path between the current document and the target document. The stylesheet needs to know the targetdoc identifiers for both documents, as they appear in the target.database.document database file. This parameter passes to the stylesheet the targetdoc identifier of the current document, since that identifier does not appear in the document itself.

This parameter can also be used for print output. If an olink's targetdoc id differs from the current.docid, then the stylesheet can append the target document's title to the generated olink text. That identifies to the reader that the link is to a different document, not the current document. See also olink.doctitle to enable that feature.

Description

In order to resolve olinks efficiently, the stylesheets can generate an external data file containing information about all potential cross reference endpoints in a document. This parameter determines whether the collection process is run when the document is processed by the stylesheet. The default value is no, which means the data file is not generated during processing. The other choices are yes, which means the data file is created and the document is processed for output, and only, which means the data file is created but the document is not processed for output. See also targets.filename.

Description

The value of this parameter determines if cross references made between documents with olink will include page number citations. In most cases this is only applicable to references in printed output.

The parameter has three possible values.

Olinks that point to targets within the same document are treated as xrefs, and controlled by the insert.xref.page.number parameter.

Page number references for olinks to external documents can only be inserted if the information exists in the olink database. This means each olink target element (div or obj) must have a page attribute whose value is its page number in the target document. The XSL stylesheets are not able to extract that information during processing because pages have not yet been created in XSLT transformation. Only the XSL-FO processor knows what page each element is placed on. Therefore some postprocessing must take place to populate page numbers in the olink database.

Description

The value of this parameter determines whether the cross reference URIs to PDF documents made with olink will include fragment identifiers.

When forming a URI to link to a PDF document, a fragment identifier (typically a '#' followed by an id value) appended to the PDF filename can be used by the PDF viewer to open the PDF file to a location within the document instead of the first page. However, not all PDF files have id values embedded in them, and not all PDF viewers can handle fragment identifiers.

If insert.olink.pdf.frag is set to a non-zero value, then any olink targeting a PDF file will have the fragment identifier appended to the URI. The URI is formed by concatenating the value of the olink.base.uri parameter, the value of the baseuri attribute from the document element in the olink database with the matching targetdoc value, and the value of the href attribute for the targeted element in the olink database. The href attribute contains the fragment identifier.

If insert.olink.pdf.frag is set to zero (the default value), then the href attribute from the olink database is not appended to PDF olinks, so the fragment identifier is left off. A PDF olink is any olink for which the baseuri attribute from the matching document element in the olink database ends with '.pdf'. Any other olinks will still have the fragment identifier added.

Description

When cross reference data is collected for resolving olinks, it may be necessary to prepend a base URI to each target's href. This parameter lets you set that base URI when cross reference data is collected. This feature is needed when you want to link to a document that is processed without chunking. The output filename for such a document is not known to the XSL stylesheet; the only target information consists of fragment identifiers such as #idref. To enable the resolution of olinks between documents, you should pass the name of the HTML output file as the value of this parameter. Then the hrefs recorded in the cross reference data collection look like outfile.html#idref, which can be reached as links from other documents.

Description

If non-zero, then each olink will generate several messages about how it is being resolved during processing. This is useful when an olink does not resolve properly and the standard error messages are not sufficient to find the problem.

You may need to read through the olink XSL templates to understand the context for some of the debug messages.

Description

When olinks between documents are resolved, the generated text may not make it clear that the reference is to another document. It is possible for the stylesheets to append the other document's title to external olinks. For this to happen, two parameters must be set.

Then if an olink's targetdoc id differs from the current.docid value, the stylesheet knows that it is a reference to another document and can append the target document's title to the generated olink text.

The text for the target document's title is copied from the olink database from the ttl element of the top-level div for that document. If that ttl element is missing or empty, no title is output.

The supported values for olink.doctitle are:

An xrefstyle attribute may override the global setting for individual olinks. The following values are supported in an xrefstyle attribute using the select: syntax:

Another way of inserting the target document name for a single olink is to employ an xrefstyle attribute using the template: syntax. The %o placeholder (the letter o, not zero) in such a template will be filled in with the target document's title when it is processed. This will occur regardless of the value of olink.doctitle.

Note that prior to version 1.66 of the XSL stylesheets, the allowed values for this parameter were 0 and 1. Those values are still supported and mapped to 'no' and 'yes', respectively.

Description

This parameter defines a list of lang values to search among to resolve olinks.

Normally an olink tries to resolve to a document in the same language as the olink itself. The language of an olink is determined by its nearest ancestor element with a lang attribute, otherwise the value of the l10n.gentext.default.lang parameter.

An olink database can contain target data for the same document in multiple languages. Each set of data has the same value for the targetdoc attribute in the document element in the database, but with a different lang attribute value.

When an olink is being resolved, the target is first sought in the document with the same language as the olink. If no match is found there, then this parameter is consulted for additional languages to try.

The olink.lang.fallback.sequence must be a whitespace separated list of lang values to try. The first one with a match in the olink database is used. The default value is empty.

For example, a document might be written in German and contain an olink with targetdoc="adminguide". When the document is processed, the processor first looks for a target dataset in the olink database starting with:

If there is no such element, then the olink.lang.fallback.sequence parameter is consulted. If its value is, for example, “fr en”, then the processor next looks for targetdoc="adminguide" lang="fr", and then for targetdoc="adminguide" lang="en". If there is still no match, it looks for targetdoc="adminguide" with no lang attribute.

This parameter is useful when a set of documents is only partially translated, or is in the process of being translated. If a target of an olink has not yet been translated, then this parameter permits the processor to look for the document in other languages. This assumes the reader would rather have a link to a document in a different language than to have a broken link.

Description

This attribute set is applied to the fo:basic-link element of an olink. It is not applied to the optional page number or optional title of the external document.

Description

If you are re-using XML content modules in multiple documents, you may want to redirect some of your olinks. This parameter permits you to redirect an olink to the current document.

For example: you are writing documentation for a product, which includes 3 manuals: a little installation booklet (booklet.xml), a user guide (user.xml), and a reference manual (reference.xml). All 3 documents begin with the same introduction section (intro.xml) that contains a reference to the customization section (custom.xml) which is included in both user.xml and reference.xml documents.

How do you write the link to custom.xml in intro.xml so that it is interpreted correctly in all 3 documents?

If you set the prefer.internal.olink parameter to a non-zero value, then the processor will first look in the olink database for the olink's targetptr attribute value in document matching the current.docid parameter value. If it isn't found there, then it tries the document in the database with the targetdoc value that matches the olink's targetdoc attribute.

This feature permits an olink reference to resolve to the current document if there is an element with an id matching the olink's targetptr value. The current document's olink data must be included in the target database for this to work.

Description

To resolve olinks between documents, the stylesheets use a master database document that identifies the target datafiles for all the documents within the scope of the olinks. This parameter value is the URI of the master document to be read during processing to resolve olinks. The default value is olinkdb.xml.

The data structure of the file is defined in the targetdatabase.dtd DTD. The database file provides the high level elements to record the identifiers, locations, and relationships of documents. The cross reference data for individual documents is generally pulled into the database using system entity references or XIncludes. See also targets.filename.

Description

In order to resolve olinks efficiently, the stylesheets can generate an external data file containing information about all potential cross reference endpoints in a document. This parameter lets you change the name of the generated file from the default name target.db. The name must agree with that used in the target database used to resolve olinks during processing. See also target.database.document.

Description

When cross reference data is collected for use by olinks, the data for each potential target includes one field containing a completely assembled cross reference string, as if it were an xref generated in that document. Other fields record the separate title, number, and element name of each target. When an olink is formed to a target from another document, the olink resolves to that preassembled string by default. If the use.local.olink.style parameter is set to non-zero, then instead the cross reference string is formed again from the target title, number, and element name, using the stylesheet processing the targeting document. Then olinks will match the xref style in the targeting document rather than in the target document. If both documents are processed with the same stylesheet, then the results will be the same.

Description

The value of this parameter determines if cross references (xrefs) in printed output will include page number citations. It has three possible values.

Description

This attribute set is used to set properties on cross reference text.

Description

This parameter allows you to control the punctuation of certain types of generated cross reference text. When cross reference text is generated for an xref or olink element using an xrefstyle attribute that makes use of the select: feature, and the selected components include both label and title, then the value of this parameter is inserted between label and title in the output.

Description

This parameter allows you to control the punctuation of certain types of generated cross reference text. When cross reference text is generated for an xref or olink element using an xrefstyle attribute that makes use of the select: feature, and the selected components include both label and page but no title, then the value of this parameter is inserted between label and page number in the output. If a title is included, then other separators are used.

Description

This parameter allows you to control the punctuation of certain types of generated cross reference text. When cross reference text is generated for an xref or olink element using an xrefstyle attribute that makes use of the select: feature, and the selected components include both title and page number, then the value of this parameter is inserted between title and page number in the output.

Description

The value of this parameter determines if cross references using the link element in printed output will include standard page number citations. It has three possible values.

Although the xrefstyle attribute can be used to turn the page reference on or off, it cannot be used to control the formatting of the page number as it can in xref. In link it will always format with the style established by the gentext template with name="page.citation" in the l:context name="xref".

Description

Specify what spacing you want between each list item when spacing is “compact”.

Description

Properties that apply to each fo:list-block generated by itemizedlist.

Description

Properties that apply to each label inside itemized list. E.g.:

<xsl:attribute-set name="itemizedlist.label.properties">
  <xsl:attribute name="text-align">right</xsl:attribute>
</xsl:attribute-set>

Description

Specifies the default width of the label (usually a bullet or other symbol) in an itemized list. You can override the default value on any particular list with the “dbfo” processing instruction using the “label-width” pseudoattribute.

Description

Properties that apply to each fo:list-block generated by itemizedlist/orderedlist.

Description

Specify the spacing required before and after a list. It is necessary to specify the space after a list block because lists can come inside of paras.

Description

Specify what spacing you want between each list item.

Description

Properties that apply to each fo:list-block generated by orderedlist.

Description

Properties that apply to each label inside ordered list. E.g.:

<xsl:attribute-set name="orderedlist.label.properties">
  <xsl:attribute name="text-align">right</xsl:attribute>
</xsl:attribute-set>

Description

Specifies the default width of the label (usually a number or sequence of numbers) in an ordered list. You can override the default value on any particular list with the “dbfo” processing instruction using the “label-width” pseudoattribute.

Description

In variablelists, the listitem is indented to leave room for the term elements. That indent may be computed if it is not specified with a termlength attribute on the variablelist element.

The computation counts characters in the term elements in the list to find the longest term. However, some terms are very long and would produce extreme indents. This parameter lets you set a maximum character count. Any terms longer than the maximum would line wrap. The default value is 24.

The character counts are converted to physical widths by multiplying by 0.50em. There will be some variability in how many actual characters fit in the space since some characters are wider than others.

Description

When a varlistentry contains multiple term elements, the string specified in the value of the variablelist.term.separator parameter is placed after each term except the last.

Description

Set a non-zero value for the variablelist.term.break.after parameter to generate a line break between terms in a multi-term varlistentry.

Description

If non-zero, unlabeled qandadivs will be enumerated.

Description

If non-zero, numbered qandadiv elements and question and answer inherit the enumeration of the ancestors of the qandaset.

Description

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.

Description

If true (non-zero), then the generated table of contents for a document will include qandaset titles, qandadiv titles, and question elements. The default value (zero) excludes them from the TOC.

This parameter does not affect any tables of contents that may be generated inside a qandaset or qandadiv.

Description

If non-zero, instances of qandaentry that are children of answer elements are shown in the TOC.

Description

Currently only normal and iso690 styles are supported.

In order to use ISO690 style to the full extent you might need to use additional markup described on the following WiKi page.

Description

Text to separate bibliography entries

Description

Maintaining bibliography entries across a set of documents is tedious, time consuming, and error prone. It makes much more sense, usually, to store all of the bibliography entries in a single place and simply “extract” the ones you need in each document.

That's the purpose of the bibliography.collection parameter. To setup a global bibliography “database”, follow these steps:

First, create a stand-alone bibliography document that contains all of the documents that you wish to reference. Make sure that each bibliography entry (whether you use biblioentry or bibliomixed) has an ID.

My global bibliography, ~/bibliography.xml begins like this:

<!DOCTYPE bibliography
  PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
  "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<bibliography><title>References</title>

<bibliomixed id="xml-rec"><abbrev>XML 1.0</abbrev>Tim Bray,
Jean Paoli, C. M. Sperberg-McQueen, and Eve Maler, editors.
<citetitle><ulink url="http://www.w3.org/TR/REC-xml">Extensible Markup
Language (XML) 1.0 Second Edition</ulink></citetitle>.
World Wide Web Consortium, 2000.
</bibliomixed>

<bibliomixed id="xml-names"><abbrev>Namespaces</abbrev>Tim Bray,
Dave Hollander,
and Andrew Layman, editors.
<citetitle><ulink url="http://www.w3.org/TR/REC-xml-names/">Namespaces in
XML</ulink></citetitle>.
World Wide Web Consortium, 1999.
</bibliomixed>

<!-- ... -->
</bibliography>

When you create a bibliography in your document, simply provide empty bibliomixed entries for each document that you wish to cite. Make sure that these elements have the same ID as the corresponding “real” entry in your global bibliography.

For example:

<bibliography><title>Bibliography</title>

<bibliomixed id="xml-rec"/>
<bibliomixed id="xml-names"/>
<bibliomixed id="DKnuth86">Donald E. Knuth. <citetitle>Computers and
Typesetting: Volume B, TeX: The Program</citetitle>. Addison-Wesley,
1986.  ISBN 0-201-13437-3.
</bibliomixed>
<bibliomixed id="relaxng"/>

</bibliography>

Note that it's perfectly acceptable to mix entries from your global bibliography with “normal” entries. You can use xref or other elements to cross-reference your bibliography entries in exactly the same way you do now.

Finally, when you are ready to format your document, simply set the bibliography.collection parameter (in either a customization layer or directly through your processor's interface) to point to your global bibliography.

The stylesheets will format the bibliography in your document as if all of the entries referenced appeared there literally.

Description

If non-zero bibliography entries will be numbered

Description

How do you want biblioentry styled?

Set the font-size, weight, space-above and space-below, indents, etc. to the style required

Description

If non-zero, links from inline glossterms to the corresponding glossentry elements in a glossary or glosslist will be automatically generated. This is useful when your glossterms are consistent and you don't want to add links manually.

The automatic link generation feature is not used on glossterm elements that have a linkend attribute.

Description

If non-zero, only firstterms will be automatically linked to the glossary. If glossary linking is not enabled, this parameter has no effect.

Description

Glossaries maintained independently across a set of documents are likely to become inconsistent unless considerable effort is expended to keep them in sync. It makes much more sense, usually, to store all of the glossary entries in a single place and simply “extract” the ones you need in each document.

That's the purpose of the glossary.collection parameter. To setup a global glossary “database”, follow these steps:

<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE glossary
  PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
  "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<glossary>
<glossaryinfo>
<editor><firstname>Eric</firstname><surname>Raymond</surname></editor>
<title>Jargon File 4.2.3 (abridged)</title>
<releaseinfo>Just some test data</releaseinfo>
</glossaryinfo>

<glossdiv><title>0</title>

<glossentry>
<glossterm>0</glossterm>
<glossdef>
<para>Numeric zero, as opposed to the letter `O' (the 15th letter of
the English alphabet). In their unmodified forms they look a lot
alike, and various kluges invented to make them visually distinct have
compounded the confusion. If your zero is center-dotted and letter-O
is not, or if letter-O looks almost rectangular but zero looks more
like an American football stood on end (or the reverse), you're
probably looking at a modern character display (though the dotted zero
seems to have originated as an option on IBM 3270 controllers). If
your zero is slashed but letter-O is not, you're probably looking at
an old-style ASCII graphic set descended from the default typewheel on
the venerable ASR-33 Teletype (Scandinavians, for whom /O is a letter,
curse this arrangement). (Interestingly, the slashed zero long
predates computers; Florian Cajori's monumental "A History of
Mathematical Notations" notes that it was used in the twelfth and
thirteenth centuries.) If letter-O has a slash across it and the zero
does not, your display is tuned for a very old convention used at IBM
and a few other early mainframe makers (Scandinavians curse <emphasis>this</emphasis>
arrangement even more, because it means two of their letters collide).
Some Burroughs/Unisys equipment displays a zero with a <emphasis>reversed</emphasis>
slash. Old CDC computers rendered letter O as an unbroken oval and 0
as an oval broken at upper right and lower left. And yet another
convention common on early line printers left zero unornamented but
added a tail or hook to the letter-O so that it resembled an inverted
Q or cursive capital letter-O (this was endorsed by a draft ANSI
standard for how to draw ASCII characters, but the final standard
changed the distinguisher to a tick-mark in the upper-left corner).
Are we sufficiently confused yet?</para>
</glossdef>
</glossentry>

<glossentry>
<glossterm>1TBS</glossterm>
<glossdef>
<para role="accidence">
<phrase role="pronounce"></phrase>
<phrase role="partsofspeach">n</phrase>
</para>
<para>The "One True Brace Style"</para>
<glossseealso>indent style</glossseealso>
</glossdef>
</glossentry>

<!-- ... -->

</glossdiv>

<!-- ... -->

</glossary>

<para>This is dummy text, without any real meaning.
The point is simply to reference glossary terms like <glossterm>0</glossterm>
and the <firstterm baseform="1TBS">One True Brace Style (1TBS)</firstterm>.
The <glossterm>1TBS</glossterm>, as you can probably imagine, is a nearly
religious issue.</para>

<glossary role="auto">
<glossentry>
<glossterm>Irrelevant</glossterm>
<glossdef>
<para>If you can see this, the document was processed incorrectly. Use
the <parameter>glossary.collection</parameter> parameter.</para>
</glossdef>
</glossentry>
</glossary>

<glossentry>
<glossterm>gloss-1</glossterm>
<glossdef><para>A description that references <glossterm>gloss-2</glossterm>.</para>
<glossseealso>gloss-2</glossseealso>
</glossdef>
</glossentry>

Description

Specifies the separation between glossary terms and descriptions when glossarys are presented using lists.

Description

This parameter specifies the width reserved for glossary terms when a list presentation is used.

Description

If non-zero, glossarys will be formatted as blocks.

If you have long glossterms, proper list markup in the FO case may produce unattractive lists. By setting this parameter, you can force the stylesheets to produce block markup instead of proper lists.

You can override this setting with a processing instruction as the child of glossary: <?dbfo glossary-presentation="blocks"?> or <?dbfo glossary-presentation="list"?>

Description

See glossary.as.blocks.

Description

A setting of “yes” means they should be displayed; “no” means they shouldn't. If “primary” is used, then they are shown as the primary text for the entry.

Description

If non-zero, then the glossentry elements within a glossary, glossdiv, or glosslist are sorted on the glossterm, using the current lang setting. If zero (the default), then glossentry elements are not sorted and are presented in document order.

Description

Formal procedures are numbered and always have a title.

Description

Specifies where formal object titles should occur. For each formal object type (figure, example, equation, table, and procedure) you can specify either the keyword “before” or “after”.

Description

If non-zero, For a formalpara, use the specified string as the separator between the title and following text. The period is the default value.

Description

Specify which characters are to be counted as punctuation. These characters are checked for a match with the last character of the title. If no match is found, the runinhead.default.title.end.punct contents are inserted. This is to avoid duplicated punctuation in the output.

Description

If non-zero, comments will be displayed, otherwise they are suppressed. Comments here refers to the remark element (which was called comment prior to DocBook 4.0), not XML comments (<-- like this -->) which are unavailable.

Description

This parameter specifies the punctuation that should be added after an honorific in a personal name.

Description

If non-zero, segmentedlists will be formatted as tables.

Description

If non-zero, variablelists will be formatted as blocks.

If you have long terms, proper list markup in the FO case may produce unattractive lists. By setting this parameter, you can force the stylesheets to produce block markup instead of proper lists.

You can override this setting with a processing instruction as the child of variablelist: <?dbfo list-presentation="blocks"?> or <?dbfo list-presentation="list"?>.

When using list-presentation="list", you can also control the amount of space used for the terms with the <?dbfo term-width=".25in"?> processing instruction, the termlength attribute on variablelist, or allow the stylesheets to attempt to calculate the amount of space to leave based on the number of letters in the longest term.

  <variablelist>
        <?dbfo list-presentation="list"?>
        <?dbfo term-width="1.5in"?>
        <?dbhtml list-presentation="table"?>
        <?dbhtml term-width="1.5in"?>
        <varlistentry>
          <term>list</term>
          <listitem>
                <para>
                  Formatted as a list even if variablelist.as.blocks is set to 1.
                </para>
          </listitem>
        </varlistentry>
  </variablelist>

Description

The blockquote.properties attribute set specifies the formating properties of block quotations.

Description

If non-zero, the URL of each ulink will appear after the text of the link. If the text of the link and the URL are identical, the URL is suppressed.

See also ulink.footnotes.

Description

If non-zero, and if ulink.show also is non-zero, the URL of each ulink will appear as a footnote.

Description

If not empty, the specified character (or more generally, content) is added to URLs after every character included in the string in the ulink.hyphenate.chars parameter (default is “/”). If the character in this parameter is a Unicode soft hyphen (0x00AD) or Unicode zero-width space (0x200B), some FO processors will be able to reasonably hyphenate long URLs.

As of 28 Jan 2002, discretionary hyphens are more widely and correctly supported than zero-width spaces for this purpose.

Description

If the ulink.hyphenate is not empty, then hyphenation of ulinks is turned on, and any character contained in this parameter is treated as an allowable hyphenation point.

The default value is “/”, but the parameter could be customized to contain other URL characters, as for example:

<xsl:param name="ulink.hyphenate.chars">:/@&?.#</xsl:param>

Description

In the FO stylesheet, if this parameter is non-zero then the shade.verbatim.style properties will be applied to verbatim environments.

In the HTML stylesheet, this parameter is now deprecated. Use CSS instead.

Description

Properties that specify the style of shaded verbatim listings. The parameters specified (the border and background color) are added to the styling of the xsl-fo output. A border might be specified as "thin black solid" for example. See xsl-fo

Description

If the lines of program listing are too long to fit into one line it is quite common to split them at space and indicite by hook arrow that code continues on the next line. You can turn on this behaviour for programlisting, screen and synopsis elements by using this parameter.

Note that you must also enable line wrapping for verbatim environments and select appropriate hyphenation character (e.g. hook arrow). This can be done using monospace.verbatim.properties attribute set:

<xsl:attribute-set name="monospace.verbatim.properties" 
                   use-attribute-sets="verbatim.properties monospace.properties">
  <xsl:attribute name="wrap-option">wrap</xsl:attribute>
  <xsl:attribute name="hyphenation-character">&#x25BA;</xsl:attribute>
</xsl:attribute-set>

For a list of arrows available in Unicode see http://www.unicode.org/charts/PDF/U2190.pdf and http://www.unicode.org/charts/PDF/U2900.pdf and make sure that selected character is available in the font you are using for verbatim environments.

Description

If you enable hyphenate.verbatim line breaks are allowed only on space characters. If this is not enough for your document, you can specify list of additional characters after which line break is allowed in this parameter.

Description

If non-zero, SVG will be considered an acceptable image format. SVG is passed through to the result tree, so correct rendering of the resulting diagram depends on the formatter (FO processor or web browser) that is used to process the output from the stylesheet.

Description

If non-zero, the role attribute on xref will be used to select the cross reference style. The DocBook Technical Committee recently added an xrefstyle attribute for this purpose. If the xrefstyle attribute is present, role will be ignored, regardless of this setting.

Until an official DocBook release that includes the new attribute, this flag allows role to serve that purpose.

Example

The following small stylesheet shows how to configure the stylesheets to make use of the cross reference style:

<?xml version="1.0"?>
<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
                version="1.0">

<xsl:import href="../xsl/html/docbook.xsl"/>

<xsl:output method="html"/>

<xsl:param name="local.l10n.xml" select="document('')"/>
<l:i18n xmlns:l="http://docbook.sourceforge.net/xmlns/l10n/1.0">
  <l:l10n xmlns:l="http://docbook.sourceforge.net/xmlns/l10n/1.0" language="en">
   <l:context name="xref">
      <l:template name="chapter" style="title" text="Chapter %n, %t"/>
      <l:template name="chapter" text="Chapter %n"/>
    </l:context>
  </l:l10n>
</l:i18n>

</xsl:stylesheet>

With this stylesheet, the cross references in the following document:

<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
                  "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<book id="book"><title>Book</title>

<preface>
<title>Preface</title>

<para>Normal: <xref linkend="ch1"/>.</para>
<para>Title: <xref xrefstyle="title" linkend="ch1"/>.</para>

</preface>

<chapter id="ch1">
<title>First Chapter</title>

<para>Irrelevant.</para>

</chapter>
</book>

will appear as:

Description

Separator used to connect items of a menuchoice other than guimenuitem and guisubmenu. The latter elements are linked with menuchoice.menu.separator.

Description

Separator used to connect items of a menuchoice with guimenuitem or guisubmenu. Other elements are linked with menuchoice.separator.

The default value is &#x2192;, which is the &rarr; (right arrow) character entity. The current FOP (0.20.5) requires setting the font-family explicitly.

The default value also includes spaces around the arrow, which will allow a line to break. Replace the spaces with &#xA0; (nonbreaking space) if you don't want those spaces to break.

Description

Selects the direction in which a float should be placed. for xsl-fo this is before, for html it is left. For Western texts, the before direction is the top of the page.

Description

The footnote.number.format specifies the format to use for footnote numeration (1, i, I, a, or A).

Description

The table.footnote.number.format specifies the format to use for footnote numeration (1, i, I, a, or A) in tables.

Description

If footnote.number.symbols is not the empty string, footnotes will use the characters it contains as footnote symbols. For example, “*&#x2020;&#x2021;&#x25CA;&#x2720;” will identify footnotes with “*”, “†”, “‡”, “◊”, and “✠”. If there are more footnotes than symbols, the stylesheets will fall back to numbered footnotes using footnote.number.format.

The use of symbols for footnotes depends on the ability of your processor (or browser) to render the symbols you select. Not all systems are capable of displaying the full range of Unicode characters. If the quoted characters in the preceding paragraph are not displayed properly, that's a good indicator that you may have trouble using those symbols for footnotes.

Description

If table.footnote.number.symbols is not the empty string, table footnotes will use the characters it contains as footnote symbols. For example, “*&#x2020;&#x2021;&#x25CA;&#x2720;” will identify footnotes with “*”, “†”, “‡”, “◊”, and “✠”. If there are more footnotes than symbols, the stylesheets will fall back to numbered footnotes using table.footnote.number.format.

The use of symbols for footnotes depends on the ability of your processor (or browser) to render the symbols you select. Not all systems are capable of displaying the full range of Unicode characters. If the quoted characters in the preceding paragraph are not displayed properly, that's a good indicator that you may have trouble using those symbols for footnotes.

Description

This attribute set is applied to the footnote-block for each footnote. It can be used to set the font-size, font-family, and other inheritable properties that will be applied to all footnotes.

Description

This attribute set is applied to the footnote-block for each table footnote. It can be used to set the font-size, font-family, and other inheritable properties that will be applied to all table footnotes.

Description

This attribute set is applied to the footnote mark used for each footnote. It should contain only inline properties.

The property to make the mark a superscript is contained in the footnote template itself, because the current version of FOP reports an error if baseline-shift is used.

Description

The styling for the rule line that separates the footnotes from the body text. These are properties applied to the fo:leader used as the separator.

If you want to do more than just set properties on the leader element, then you can customize the template named footnote.separator in fo/pagesetup.xsl.

Description

A cross reference may include the number (for example, the number of an example or figure) and the title which is a required child of some targets. This parameter inserts both the relevant number as well as the title into the link.

Description

Specifies styling properties for superscripts.

Description

Specifies styling properties for subscripts.

Description

This attribute set is used to set the properties that make a figure or table "page wide" in fo output. It comes into effect when an attribute pgwide="1" is used.

By default, it sets start-indent to 0pt. In a stylesheet that sets the parameter body.start.indent to a non-zero value in order to indent body text, this attribute set can be used to outdent pgwide figures to the left margin.

If a document uses a multi-column page layout, then this attribute set could try setting span to a value of all. However, this may not work with some processors because a span property must be on an fo:block that is a direct child of fo:flow. It may work in some processors anyway.

Description

When this parameter is non-zero, the stylesheets will try to do syntax highlighting of the content of the programlisting element. The highlighting is done by the XSLTHL extension module. This is an external Java library which is not part of the DocBook XSL distribution.

In order to use this extension, you must add xslthl.jar to your Java classpath. You can download this software from the XSLT syntax highlighting project at SourceForge.

The configuration of syntax highlighting is stored in highlighting/xslthl-config.xml. The Java property xslthl.config must point to this file (using URL syntax).

This extension is known to work with Saxon 6.5.x. Here is an example of a modified Saxon command:

java -cp c:\batch\;…;c:\path\to\xslthl.jar -Dxslthl.config=file:///c:/docbook-xsl/highlighting/xslthl-config.xml … com.icl.saxon.StyleSheet …

You can specify the language for each programlisting by using the language attribute. The highlighting.default.language parameter can be used for specifying the language to be used for programlistings without a language attribute.

Description

This language is used when there is no language attribute on programlisting.

Description

If non-zero, delimiters ^[1] are generated around e-mail addresses (the output of the email element).

Description

Selects the element name for outer container of each section. The choices are block (default) or wrapper. The fo: namespace prefix is added by the stylesheet to form the full element name.

This element receives the section id attribute and the appropriate section level attribute-set.

Changing this parameter to wrapper is only necessary when producing multi-column output that contains page-wide spans. Using fo:wrapper avoids the nesting of fo:block elements that prevents spans from working (the standard says a span must be on a block that is a direct child of fo:flow).

If set to wrapper, the section attribute-sets only support properties that are inheritable. That's because there is no block to apply them to. Properties such as font-family are inheritable, but properties such as border are not.

Only some XSL-FO processors need to use this parameter. The Antenna House processor, for example, will handle spans in nested blocks without changing the element name. The RenderX XEP product and FOP follow the XSL-FO standard and need to use wrapper.

Description

If a graphic or mediaobject includes a reference to a filename that does not include an extension, and the format attribute is unspecified, the default extension will be used.

Description

If specified, this value will be used for the width attribute on images that do not specify any viewport dimensions.

Description

A mediaobject may contain several objects such as imageobjects. If the parameter use.role.for.mediaobject is non-zero, then the role attribute on imageobjects and other objects within a mediaobject container will be used to select which object will be used. If one of the objects has a role value that matches the preferred.mediaobject.role parameter, then it has first priority for selection. If more than one has such a role value, the first one is used.

See the use.role.for.mediaobject parameter for the sequence of selection.

Description

If non-zero, the role attribute on imageobjects or other objects within a mediaobject container will be used to select which object will be used.

The order of selection when then parameter is non-zero is:

If the value of use.role.for.mediaobject is zero, then role attributes are not considered and the first suitable object with or without a role value is used.

Description

If non-zero, the scaling attributes on graphics and media objects are ignored.

Description

Add a path prefix to the value of the fileref attribute of graphic, inlinegraphic, and imagedata elements. The resulting compound path is used in the output as the value of the src attribute of img (HTML) or external-graphic (FO).

The path given by img.src.path could be relative to the directory where the HTML/FO files are created, or it could be an absolute URI. The default value is empty. Be sure to include a trailing slash if needed.

This prefix is not applied to any filerefs that start with "/" or contain "//:".

Description

If non-zero, relative URIs (in, for example fileref attributes) will be used in the generated output. Otherwise, the URIs will be made absolute with respect to the base URI.

Note that the stylesheets calculate (and use) the absolute form for some purposes, this only applies to the resulting output.

Description

The page height is generally calculated from the paper.type and page.orientation.

Description

The portrait page height is the length of the long edge of the physical page.

Description

The bottom page margin is the distance from the bottom of the region-after to the physical bottom of the page.

Description

The inner page margin is the distance from binding edge of the page to the first column of text. In the left-to-right, top-to-bottom writing direction, this is the left margin of recto pages.

The inner and outer margins are usually the same unless the output is double-sided.

Description

The outer page margin is the distance from non-binding edge of the page to the last column of text. In the left-to-right, top-to-bottom writing direction, this is the right margin of recto pages.

The inner and outer margins are usually the same unless the output is double-sided.

Description

The top page margin is the distance from the physical top of the page to the top of the region-before.

Description

Select one from portrait or landscape. In portrait orientation, the short edge is horizontal; in landscape orientation, it is vertical.

Description

The page width is generally calculated from the paper.type and page.orientation.

Description

The portrait page width is the length of the short edge of the physical page.

Description

The paper type is a convenient way to specify the paper size. The list of known paper sizes includes USletter and most of the A, B, and C sizes. See page.width.portrait, for example.

Description

Double-sided documents are printed with a slightly wider margin on the binding edge of the page.

FIXME: The current set of parameters does not take writing direction into account.

Description

The body bottom margin is the distance from the last line of text in the page body to the bottom of the region-after.

Description

The body top margin is the distance from the top of the region-before to the first line of text in the page body.

Description

This parameter provides one means of indenting the body text relative to the left page margin. It is used in place of the title.margin.left for all XSL-FO processors except FOP. It enables support for side floats to appear in the indented margin area.

This start-indent property is added to the fo:flow for certain page sequences. Which page-sequences it is applied to is determined by the template named set.flow.properties. By default, that template adds it to the flow for page-sequences using the “body” master-reference, as well as appendixes and prefaces.

If this parameter is used, section titles should have a start-indent value of 0pt if they are to be outdented relative to the body text.

If you are using FOP, then set this parameter to a zero width value and set the title.margin.left parameter to the negative value of the desired indent.

See also body.end.indent and title.margin.left.

Description

This end-indent property is added to the fo:flow for certain page sequences. Which page-sequences it is applied to is determined by the template named set.flow.properties. By default, that template adds it to the flow for page-sequences using the “body” master-reference, as well as appendixes and prefaces.

See also body.start.indent.

Description

The default text alignment is used for most body text.

Description

If true, words may be hyphenated. Otherwise, they may not.

Description

Sets the line-height property.

Description

Number of columns on back matter (appendix, glossary, etc.) pages.

Description

Number of columns on body pages.

Description

Number of columns on front matter (dedication, preface, etc.) pages.

Description

Number of columns on index pages.

Description

Number of columns on a page sequence containing the Table of Contents, List of Figures, etc.

Description

Number of columns on a title page

Description

Specifies the gap between columns in back matter (if column.count.back is greater than one).

Description

Specifies the gap between columns in body matter (if column.count.body is greater than one).

Description

Specifies the gap between columns in front matter (if column.count.front is greater than one).

Description

Specifies the gap between columns in indexes (if column.count.index is greater than one).

Description

Specifies the gap between columns on 'List-of-Titles' pages (if column.count.lot is greater than one).

Description

Specifies the gap between columns on title pages (if column.count.titlepage is greater than one).

Description

The region after extent is the height of the area where footers are printed.

Description

The region before extent is the height of the area where headers are printed.

Description

If an unqualified dimension is encountered (for example, in a graphic width), the default-units will be used for the units. Unqualified dimensions are not allowed in XSL Formatting Objects.

Description

Specify the spacing required between normal paragraphs

Description

The body font size is specified in two parameters (body.font.master and body.font.size) so that math can be performed on the font size by XSLT.

Description

The body font size is specified in two parameters (body.font.master and body.font.size) so that math can be performed on the font size by XSLT.

Description

The footnote font size is used for...footnotes!

Description

This parameter provides one means of adjusting the left margin for titles. The left margin of the body region is calculated to include this space, and titles are outdented to the left by this amount, effectively leaving titles at the left margin and the body text indented. Currently this method is only used for FOP because it cannot properly use the body.start.indent parameter. the relative

The default value for FOP is -4pc, which means the body text is indented 4 picas relative to the titles. The default value for other processors is 0pt, and the body indent is provided by the body.start.indent parameter.

If you set the value to zero, be sure to still include a unit indicator such as 0pt, or the FO processor will report errors.

This parameter must be set to 0pt if the passivetex.extensions parameter is nonzero because PassiveTeX cannot handle the math expression with negative values used to calculate the indents.

Description

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.

Description

The image to be used for draft watermarks.

Description

If non-zero, headers will be placed on blank pages.

Description

If non-zero, footers will be placed on blank pages.

Description

If non-zero, a rule will be drawn below the page headers.

Description

If non-zero, a rule will be drawn above the page footers.

Description

Page headers in print output use a three column table to position text at the left, center, and right side of the header on the page. This parameter lets you specify the relative sizes of the three columns. The default value is "1 1 1".

The parameter value must be three numbers, separated by white space. The first number represents the relative width of the left header for single-sided output, or the inside header for double-sided output. The second number is the relative width of the center header. The third number is the relative width of the right header for single-sided output, or the outside header for double-sided output.

The numbers are used to specify the column widths for the table that makes up the header area. In the FO output, this looks like:

<fo:table-column column-number="1" 
    column-width="proportional-column-width(1)"/>

The proportional-column-width() function computes a column width by dividing its argument by the total of the arguments for all the columns, and then multiplying the result by the width of the whole table (assuming all the column specs use the function). Its argument can be any positive integer or floating point number. Zero is an acceptable value, although some FO processors may warn about it, in which case using a very small number might be more satisfactory.

For example, the value "1 2 1" means the center header should have twice the width of the other areas. A value of "0 0 1" means the entire header area is reserved for the right (or outside) header text. Note that to keep the center area centered on the page, the left and right values must be the same. A specification like "1 2 3" means the center area is no longer centered on the page since the right area is three times the width of the left area.

Description

Page footers in print output use a three column table to position text at the left, center, and right side of the footer on the page. This parameter lets you specify the relative sizes of the three columns. The default value is "1 1 1".

The parameter value must be three numbers, separated by white space. The first number represents the relative width of the left footer for single-sided output, or the inside footer for double-sided output. The second number is the relative width of the center footer. The third number is the relative width of the right footer for single-sided output, or the outside footer for double-sided output.

The numbers are used to specify the column widths for the table that makes up the footer area. In the FO output, this looks like:

<fo:table-column column-number="1" 
    column-width="proportional-column-width(1)"/>

The proportional-column-width() function computes a column width by dividing its argument by the total of the arguments for all the columns, and then multiplying the result by the width of the whole table (assuming all the column specs use the function). Its argument can be any positive integer or floating point number. Zero is an acceptable value, although some FO processors may warn about it, in which case using a very small number might be more satisfactory.

For example, the value "1 2 1" means the center footer should have twice the width of the other areas. A value of "0 0 1" means the entire footer area is reserved for the right (or outside) footer text. Note that to keep the center area centered on the page, the left and right values must be the same. A specification like "1 2 3" means the center area is no longer centered on the page since the right area is three times the width of the left area.

Description

Properties applied to the table that lays out the page header.

Description

Page headers in print output use a three column table to position text at the left, center, and right side of the header on the page. This parameter lets you specify the minimum height of the single row in the table. Since this specifies only the minimum height, the table should automatically grow to fit taller content. The default value is "14pt".

Description

Properties applied to the table that lays out the page footer.

Description

Page footers in print output use a three column table to position text at the left, center, and right side of the footer on the page. This parameter lets you specify the minimum height of the single row in the table. Since this specifies only the minimum height, the table should automatically grow to fit taller content. The default value is "14pt".

Description

Properties of page header content.

Description

Properties of page footer content.