Swiftdiff options
Diffstat (limited to '3rdParty/SCons/scons-3.0.1/engine/SCons/Tool/docbook/docbook-xsl-1.76.1/html/param.xml')
| -rw-r--r-- | 3rdParty/SCons/scons-3.0.1/engine/SCons/Tool/docbook/docbook-xsl-1.76.1/html/param.xml | 10905 |
1 files changed, 10905 insertions, 0 deletions
diff --git a/3rdParty/SCons/scons-3.0.1/engine/SCons/Tool/docbook/docbook-xsl-1.76.1/html/param.xml b/3rdParty/SCons/scons-3.0.1/engine/SCons/Tool/docbook/docbook-xsl-1.76.1/html/param.xml new file mode 100644 index 0000000..e70de9c --- /dev/null +++ b/3rdParty/SCons/scons-3.0.1/engine/SCons/Tool/docbook/docbook-xsl-1.76.1/html/param.xml @@ -0,0 +1,10905 @@ +<?xml version="1.0" encoding="ASCII"?> +<book version="5.0"> +<info> +<title>HTML Parameter Reference</title> +<releaseinfo role="meta"> +$Id: param.xweb 8552 2009-12-07 17:45:26Z bobstayton $ +</releaseinfo> +<author> + <personname> + <surname>Walsh</surname> + <firstname>Norman</firstname> + </personname> +</author> +<copyright> + <year>1999</year> + <year>2000</year> + <year>2001</year> + <year>2002</year> + <year>2003</year> + <year>2004</year> + <year>2005</year> + <year>2006</year> + <year>2007</year> + <holder>Norman Walsh</holder> +</copyright> +<abstract> + <para>This is reference documentation for all user-configurable + parameters in the DocBook XSL HTML stylesheets (for generating + HTML output).</para> +</abstract> +</info> +<reference xml:id="admons"><title>Admonitions</title> +<refentry version="5.0" xml:id="admon.graphics.extension"> +<refmeta> +<refentrytitle>admon.graphics.extension</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>admon.graphics.extension</refname> +<refpurpose>Filename extension for admonition graphics</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="admon.graphics.extension.frag"> +<xsl:param name="admon.graphics.extension">.png</xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Sets the filename extension to use on admonition graphics.</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="admon.graphics.path"> +<refmeta> +<refentrytitle>admon.graphics.path</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>admon.graphics.path</refname> +<refpurpose>Path to admonition graphics</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="admon.graphics.path.frag"><xsl:param name="admon.graphics.path">images/</xsl:param></programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>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 <parameter>base.dir</parameter></para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="admon.graphics"> +<refmeta> +<refentrytitle>admon.graphics</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>admon.graphics</refname> +<refpurpose>Use graphics in admonitions?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="admon.graphics.frag"> +<xsl:param name="admon.graphics" select="0"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If true (non-zero), admonitions are presented in an alternate style that uses +a graphic. Default graphics are provided in the distribution. +</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="admon.textlabel"> +<refmeta> +<refentrytitle>admon.textlabel</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>admon.textlabel</refname> +<refpurpose>Use text label in admonitions?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="admon.textlabel.frag"> +<xsl:param name="admon.textlabel" select="1"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>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. +</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="admon.style"> +<refmeta> +<refentrytitle>admon.style</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>admon.style</refname> +<refpurpose>Specifies the CSS style attribute that should be added to +admonitions.</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="admon.style.frag"><xsl:param name="admon.style"> + <xsl:value-of select="concat('margin-', $direction.align.start, ': 0.5in; margin-', $direction.align.end, ': 0.5in;')"></xsl:value-of> +</xsl:param></programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Specifies the value of the CSS <tag class="attribute">style</tag> +attribute that should be added to admonitions. +</para> + +</refsection> +</refentry> + +</reference> +<reference xml:id="callouts"><title>Callouts</title> +<refentry version="5.0" xml:id="callout.defaultcolumn"> +<refmeta> +<refentrytitle>callout.defaultcolumn</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo> +</refmeta> +<refnamediv> +<refname>callout.defaultcolumn</refname> +<refpurpose>Indicates what column callouts appear in by default</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="callout.defaultcolumn.frag"> +<xsl:param name="callout.defaultcolumn">60</xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If a callout does not identify a column (for example, if it uses +the <literal>linerange</literal> <tag class="attribute">unit</tag>), +it will appear in the default column. +</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="callout.graphics.extension"> +<refmeta> +<refentrytitle>callout.graphics.extension</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>callout.graphics.extension</refname> +<refpurpose>Filename extension for callout graphics</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="callout.graphics.extension.frag"> +<xsl:param name="callout.graphics.extension">.png</xsl:param> + +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> +<para>Sets the filename extension to use on callout graphics. </para> + +<itemizedlist> +<para>The Docbook XSL distribution provides callout graphics in the following formats:</para> +<listitem><para>SVG (extension: <filename class="extension">.svg</filename>)</para></listitem> +<listitem><para>PNG (extension: <filename class="extension">.png</filename>)</para></listitem> +<listitem><para>GIF (extension: <filename class="extension">.gif</filename>)</para></listitem> +</itemizedlist> +</refsection> +</refentry> + +<refentry version="5.0" xml:id="callout.graphics.number.limit"> +<refmeta> +<refentrytitle>callout.graphics.number.limit</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo> +</refmeta> +<refnamediv> +<refname>callout.graphics.number.limit</refname> +<refpurpose>Number of the largest callout graphic</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="callout.graphics.number.limit.frag"> +<xsl:param name="callout.graphics.number.limit">15</xsl:param> + +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If <parameter>callout.graphics</parameter> is non-zero, graphics +are used to represent callout numbers instead of plain text. The value +of <parameter>callout.graphics.number.limit</parameter> 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. +</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="callout.graphics.path"> +<refmeta> +<refentrytitle>callout.graphics.path</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>callout.graphics.path</refname> +<refpurpose>Path to callout graphics</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="callout.graphics.path.frag"> +<xsl:param name="callout.graphics.path">images/callouts/</xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>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. +</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="callout.graphics"> +<refmeta> +<refentrytitle>callout.graphics</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>callout.graphics</refname> +<refpurpose>Use graphics for callouts?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="callout.graphics.frag"> +<xsl:param name="callout.graphics" select="1"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>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. +</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="callout.list.table"> +<refmeta> +<refentrytitle>callout.list.table</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>callout.list.table</refname> +<refpurpose>Present callout lists using a table?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="callout.list.table.frag"> +<xsl:param name="callout.list.table" select="1"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The default presentation of <tag>calloutlist</tag>s uses +an HTML <tag>DL</tag> element. Some browsers don't align DLs very well +if <parameter>callout.graphics</parameter> is used. With this option +turned on, <tag>calloutlist</tag>s are presented in an HTML +<tag>TABLE</tag>, which usually results in better alignment +of the callout number with the callout description.</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="callout.unicode.number.limit"> +<refmeta> +<refentrytitle>callout.unicode.number.limit</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo> +</refmeta> +<refnamediv> +<refname>callout.unicode.number.limit</refname> +<refpurpose>Number of the largest unicode callout character</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="callout.unicode.number.limit.frag"> +<xsl:param name="callout.unicode.number.limit">10</xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If <parameter>callout.unicode</parameter> +is non-zero, unicode characters are used to represent +callout numbers. The value of +<parameter>callout.unicode.number.limit</parameter> +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. +</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="callout.unicode.start.character"> +<refmeta> +<refentrytitle>callout.unicode.start.character</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo> +</refmeta> +<refnamediv> +<refname>callout.unicode.start.character</refname> +<refpurpose>First Unicode character to use, decimal value.</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="callout.unicode.start.character.frag"> +<xsl:param name="callout.unicode.start.character">10102</xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If <parameter>callout.graphics</parameter> is zero and <parameter>callout.unicode</parameter> +is non-zero, unicode characters are used to represent +callout numbers. The value of +<parameter>callout.unicode.start.character</parameter> +is the decimal unicode value used for callout number one. Currently, +only 10102 is supported in the stylesheets for this parameter. +</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="callout.unicode"> +<refmeta> +<refentrytitle>callout.unicode</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>callout.unicode</refname> +<refpurpose>Use Unicode characters rather than images for callouts.</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="callout.unicode.frag"><xsl:param name="callout.unicode" select="0"></xsl:param></programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>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. +</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="callouts.extension"> +<refmeta> +<refentrytitle>callouts.extension</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>callouts.extension</refname> +<refpurpose>Enable the callout extension</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="callouts.extension.frag"> +<xsl:param name="callouts.extension" select="1"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The callouts extension processes <tag>areaset</tag> +elements in <tag>programlistingco</tag> and other text-based +callout elements. +</para> + +</refsection> +</refentry> + +</reference> +<reference xml:id="ebnf"><title>EBNF</title> +<refentry version="5.0" xml:id="ebnf.table.bgcolor"> +<refmeta> +<refentrytitle>ebnf.table.bgcolor</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">color</refmiscinfo> +</refmeta> +<refnamediv> +<refname>ebnf.table.bgcolor</refname> +<refpurpose>Background color for EBNF tables</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="ebnf.table.bgcolor.frag"> +<xsl:param name="ebnf.table.bgcolor">#F5DCB3</xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Sets the background color for EBNF tables (a pale brown). No +<tag>bgcolor</tag> attribute is output if +<parameter>ebnf.table.bgcolor</parameter> is set to the null string. </para> + + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="ebnf.table.border"> +<refmeta> +<refentrytitle>ebnf.table.border</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>ebnf.table.border</refname> +<refpurpose>Selects border on EBNF tables</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="ebnf.table.border.frag"><xsl:param name="ebnf.table.border" select="1"></xsl:param></programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Selects the border on EBNF tables. If non-zero, the tables have +borders, otherwise they don't.</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="ebnf.assignment"> +<refmeta> +<refentrytitle>ebnf.assignment</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">rtf</refmiscinfo> +</refmeta> +<refnamediv> +<refname>ebnf.assignment</refname> +<refpurpose>The EBNF production assignment operator</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="ebnf.assignment.frag"> +<xsl:param name="ebnf.assignment"> +<code>::=</code> +</xsl:param> + +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The <parameter>ebnf.assignment</parameter> parameter determines what +text is used to show <quote>assignment</quote> in <tag>production</tag>s +in <tag>productionset</tag>s.</para> + +<para>While <quote><literal>::=</literal></quote> is common, so are several +other operators.</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="ebnf.statement.terminator"> +<refmeta> +<refentrytitle>ebnf.statement.terminator</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">rtf</refmiscinfo> +</refmeta> +<refnamediv> +<refname>ebnf.statement.terminator</refname> +<refpurpose>Punctuation that ends an EBNF statement.</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="ebnf.statement.terminator.frag"> +<xsl:param name="ebnf.statement.terminator"></xsl:param> + +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The <parameter>ebnf.statement.terminator</parameter> parameter determines what +text is used to terminate each <tag>production</tag> +in <tag>productionset</tag>.</para> + +<para>Some notations end each statement with a period.</para> + +</refsection> +</refentry> + +</reference> +<reference xml:id="toc_index"><title>ToC/LoT/Index Generation</title> +<refentry version="5.0" xml:id="annotate.toc"> +<refmeta> +<refentrytitle>annotate.toc</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>annotate.toc</refname> +<refpurpose>Annotate the Table of Contents?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="annotate.toc.frag"><xsl:param name="annotate.toc" select="1"></xsl:param></programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If true, TOCs will be annotated. At present, this just means +that the <tag>refpurpose</tag> of <tag>refentry</tag> +TOC entries will be displayed. +</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="autotoc.label.separator"> +<refmeta> +<refentrytitle>autotoc.label.separator</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>autotoc.label.separator</refname> +<refpurpose>Separator between labels and titles in the ToC</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="autotoc.label.separator.frag"> +<xsl:param name="autotoc.label.separator">. </xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>String used to separate labels and titles in a table of contents.</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="autotoc.label.in.hyperlink"> +<refmeta> +<refentrytitle>autotoc.label.in.hyperlink</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>autotoc.label.in.hyperlink</refname> +<refpurpose>Include label in hyperlinked titles in TOC?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="autotoc.label.in.hyperlink.frag"><xsl:param name="autotoc.label.in.hyperlink" select="1"></xsl:param></programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If the value of +<parameter>autotoc.label.in.hyperlink</parameter> 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.</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="process.source.toc"> +<refmeta> +<refentrytitle>process.source.toc</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>process.source.toc</refname> +<refpurpose>Process a non-empty <tag>toc</tag> element if it occurs in a source document?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="process.source.toc.frag"><xsl:param name="process.source.toc" select="0"></xsl:param></programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Specifies that the contents of a non-empty "hard-coded" +<tag>toc</tag> element in a source document are processed to +generate a TOC in output. +<note> + <para>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 <parameter>generate.toc</parameter> paramameter.</para> + + <para>The <tag>process.source.toc</tag> parameter also has + no effect if the <tag>toc</tag> element is empty; handling + for empty <tag>toc</tag> is controlled by the + <parameter>process.empty.source.toc</parameter> parameter.</para> +</note> +</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="process.empty.source.toc"> +<refmeta> +<refentrytitle>process.empty.source.toc</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>process.empty.source.toc</refname> +<refpurpose>Generate automated TOC if <tag>toc</tag> element occurs in a source document?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="process.empty.source.toc.frag"><xsl:param name="process.empty.source.toc" select="0"></xsl:param></programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Specifies that if an empty <tag>toc</tag> element is found in a +source document, an automated TOC is generated at this point in the +document. +<note> + <para>Depending on what the value of the + <parameter>generate.toc</parameter> parameter is, setting this + parameter to <literal>1</literal> could result in generation of + duplicate automated TOCs. So the + <parameter>process.empty.source.toc</parameter> is primarily useful + as an "override": by placing an empty <tag>toc</tag> in your + document and setting this parameter to <literal>1</literal>, you can + force a TOC to be generated even if <tag>generate.toc</tag> + says not to.</para> +</note> +</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="bridgehead.in.toc"> +<refmeta> +<refentrytitle>bridgehead.in.toc</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>bridgehead.in.toc</refname> +<refpurpose>Should bridgehead elements appear in the TOC?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="bridgehead.in.toc.frag"><xsl:param name="bridgehead.in.toc" select="0"></xsl:param></programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, <tag>bridgehead</tag>s appear in the TOC. Note that +this option is not fully supported and may be removed in a future +version of the stylesheets. +</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="simplesect.in.toc"> +<refmeta> +<refentrytitle>simplesect.in.toc</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>simplesect.in.toc</refname> +<refpurpose>Should <tag>simplesect</tag> elements appear in the TOC?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="simplesect.in.toc.frag"><xsl:param name="simplesect.in.toc" select="0"></xsl:param></programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, <tag>simplesect</tag>s will be included in the TOC. +</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="manual.toc"> +<refmeta> +<refentrytitle>manual.toc</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>manual.toc</refname> +<refpurpose>An explicit TOC to be used for the TOC</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="manual.toc.frag"> +<xsl:param name="manual.toc"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The <parameter>manual.toc</parameter> identifies an explicit TOC that +will be used for building the printed TOC. +</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="toc.list.type"> +<refmeta> +<refentrytitle>toc.list.type</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">list</refmiscinfo> +<refmiscinfo class="other" otherclass="value">dl</refmiscinfo> +<refmiscinfo class="other" otherclass="value">ul</refmiscinfo> +<refmiscinfo class="other" otherclass="value">ol</refmiscinfo> +</refmeta> +<refnamediv> +<refname>toc.list.type</refname> +<refpurpose>Type of HTML list element to use for Tables of Contents</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="toc.list.type.frag"><xsl:param name="toc.list.type">dl</xsl:param></programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>When an automatically generated Table of Contents (or List of Titles) +is produced, this HTML element will be used to make the list. +</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="toc.section.depth"> +<refmeta> +<refentrytitle>toc.section.depth</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo> +</refmeta> +<refnamediv> +<refname>toc.section.depth</refname> +<refpurpose>How deep should recursive <tag>section</tag>s appear +in the TOC?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="toc.section.depth.frag"><xsl:param name="toc.section.depth">2</xsl:param></programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Specifies the depth to which recursive sections should appear in the +TOC. +</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="toc.max.depth"> +<refmeta> +<refentrytitle>toc.max.depth</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo> +</refmeta> +<refnamediv> +<refname>toc.max.depth</refname> +<refpurpose>How many levels should be created for each TOC?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="toc.max.depth.frag"><xsl:param name="toc.max.depth">8</xsl:param></programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Specifies the maximal depth of TOC on all levels.</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="generate.toc"> +<refmeta> +<refentrytitle>generate.toc</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">table</refmiscinfo> +</refmeta> +<refnamediv> +<refname>generate.toc</refname> +<refpurpose>Control generation of ToCs and LoTs</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="generate.toc.frag"> +<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> + +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>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.</para> + +<para>When processing a particular element, the stylesheets consult this table to +determine if a ToC (or LoT(s)) should be generated.</para> + +<para>For example, consider the entry:</para> + +<screen>book toc,figure</screen> + +<para>This indicates that whenever a <tag>book</tag> is formatted, a +Table Of Contents and a List of Figures should be generated. Similarly,</para> + +<screen>/chapter toc</screen> + +<para>indicates that whenever a document <emphasis>that has a root +of</emphasis> <tag>chapter</tag> is formatted, a Table of +Contents should be generated. The entry <literal>chapter</literal> would match +all chapters, but <literal>/chapter</literal> matches only <tag>chapter</tag> +document elements.</para> + +<para>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:</para> + +<screen>book/article toc,figure +part/article toc</screen> + +<para>Note that an article in a part can never match a <literal>book/article</literal>, +so if you want nothing to be generated for articles in parts, you can simply leave +that rule out.</para> + +<para>If you want to leave the rule in, to make it explicit that you're turning +something off, use the value <quote>nop</quote>. For example, the following +entry disables ToCs and LoTs for articles:</para> + +<screen>article nop</screen> + +<para>Do not simply leave the word <quote>article</quote> in the file +without a matching value. That'd be just begging the silly little +path/value parser to get confused.</para> + +<para>Section ToCs are further controlled by the +<parameter>generate.section.toc.level</parameter> parameter. +For a given section level to have a ToC, it must have both an entry in +<parameter>generate.toc</parameter> and be within the range enabled by +<parameter>generate.section.toc.level</parameter>.</para> +</refsection> +</refentry> + +<refentry version="5.0" xml:id="generate.section.toc.level"> +<refmeta> +<refentrytitle>generate.section.toc.level</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo> +</refmeta> +<refnamediv> +<refname>generate.section.toc.level</refname> +<refpurpose>Control depth of TOC generation in sections</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="generate.section.toc.level.frag"> +<xsl:param name="generate.section.toc.level" select="0"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The <parameter>generate.section.toc.level</parameter> parameter +controls the depth of <tag>section</tag> in which TOCs will be generated. Note +that this is related to, but not the same as +<parameter>toc.section.depth</parameter>, which controls the depth to +which TOC entries will be generated in a given TOC.</para> +<para>If, for example, <parameter>generate.section.toc.level</parameter> +is <literal>3</literal>, TOCs will be generated in first, second, and third +level sections, but not in fourth level sections. +</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="generate.index"> +<refmeta> +<refentrytitle>generate.index</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>generate.index</refname> +<refpurpose>Do you want an index?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="generate.index.frag"><xsl:param name="generate.index" select="1"></xsl:param></programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Specify if an index should be generated. </para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="index.method"> +<refmeta> +<refentrytitle>index.method</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">list</refmiscinfo> +<refmiscinfo class="other" otherclass="value">basic</refmiscinfo> +<refmiscinfo class="other" otherclass="value">kosek</refmiscinfo> +<refmiscinfo class="other" otherclass="value">kimber</refmiscinfo> +</refmeta> +<refnamediv> +<refname>index.method</refname> +<refpurpose>Select method used to group index entries in an index</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="index.method.frag"> +<xsl:param name="index.method">basic</xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>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 <quote>Á</quote> (U+00C1 LATIN CAPITAL LETTER A WITH ACUTE) would sort together +with <quote>A</quote> (U+0041 LATIN CAPITAL LETTER A), so both would appear in the <quote>A</quote> +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. +</para> + +<para>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.</para> + +<para>The three choices for indexing method are:</para> +<variablelist> +<varlistentry> +<term><literal>basic</literal></term> +<listitem> +<para> +(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 <quote>Symbols</quote> section of the index. +</para> +</listitem> +</varlistentry> +<varlistentry> +<term><literal>kosek</literal></term> +<listitem> +<para> +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 <filename>common/fr.xml</filename>. +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). +</para> +<para>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. +</para> + +<para>To use the kosek method, you must:</para> + +<orderedlist> +<listitem> +<para>Use a processor that supports its extensions, such as +Saxon 6 or Xalan (xsltproc and Saxon 8 do not). +</para> +</listitem> +<listitem> +<para>Set the index.method parameter's value to <quote>kosek</quote>. +</para> +</listitem> +<listitem> +<para>Import the appropriate index extensions stylesheet module +<filename>fo/autoidx-kosek.xsl</filename> or +<filename>html/autoidx-kosek.xsl</filename> into your +customization. +</para> +</listitem> +</orderedlist> + +</listitem> +</varlistentry> +<varlistentry> +<term><literal>kimber</literal></term> +<listitem> +<para> +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.</para> +<itemizedlist> +<listitem> +<para>For a whitepaper describing the extensions, see: +<link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://www.innodata-isogen.com/knowledge_center/white_papers/back_of_book_for_xsl_fo.pdf">http://www.innodata-isogen.com/knowledge_center/white_papers/back_of_book_for_xsl_fo.pdf</link>. +</para> +</listitem> +<listitem> +<para>To download the extension library, see +<link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://www.innodata-isogen.com/knowledge_center/tools_downloads/i18nsupport">http://www.innodata-isogen.com/knowledge_center/tools_downloads/i18nsupport</link>. +</para> +</listitem> +</itemizedlist> + +<para>To use the kimber method, you must:</para> + +<orderedlist> +<listitem> +<para>Use Saxon (version 6 or 8) as your XSLT processor. +</para> +</listitem> +<listitem> +<para>Install and configure the Innodata Isogen library, using +the documentation that comes with it. +</para> +</listitem> +<listitem> +<para>Set the index.method parameter's value to <quote>kimber</quote>. +</para> +</listitem> +<listitem> +<para>Import the appropriate index extensions stylesheet module +<filename>fo/autoidx-kimber.xsl</filename> or +<filename>html/autoidx-kimber.xsl</filename> into your +customization. +</para> +</listitem> +</orderedlist> + +</listitem> +</varlistentry> +</variablelist> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="index.on.type"> +<refmeta> +<refentrytitle>index.on.type</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>index.on.type</refname> +<refpurpose>Select indexterms based on <tag class="attribute">type</tag> +attribute value</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="index.on.type.frag"> +<xsl:param name="index.on.type" select="0"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para> +If non-zero, +then an <tag>index</tag> element that has a +<tag class="attribute">type</tag> attribute +value will contain only those <tag>indexterm</tag> +elements with a matching <tag class="attribute">type</tag> attribute value. +If an <tag>index</tag> has no <tag class="attribute">type</tag> +attribute or it is blank, then the index will contain +all <tag>indexterm</tag>s in the current scope. +</para> + +<para> +If <literal>index.on.type</literal> is zero, then the +<tag class="attribute">type</tag> attribute has no effect +on selecting indexterms for an index. +</para> + +<para>For those using DocBook version 4.2 or earlier, +the <tag class="attribute">type</tag> attribute is not available +for index terms. However, you can achieve the same +effect by using the <tag class="attribute">role</tag> attribute +in the same manner on <tag>indexterm</tag> +and <tag>index</tag>, and setting the stylesheet parameter +<parameter>index.on.role</parameter> to a nonzero value. +</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="index.on.role"> +<refmeta> +<refentrytitle>index.on.role</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>index.on.role</refname> +<refpurpose>Select indexterms based on <tag class="attribute">role</tag> value</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="index.on.role.frag"> +<xsl:param name="index.on.role" select="0"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para> +If non-zero, +then an <tag>index</tag> element that has a +<tag class="attribute">role</tag> attribute +value will contain only those <tag>indexterm</tag> +elements with a matching role value. +If an <tag>index</tag> has no <tag class="attribute">role</tag> +attribute or it is blank, then the index will contain +all <tag>indexterm</tag>s in the current scope. +</para> +<para> +If <literal>index.on.role</literal> is zero, then the +<tag class="attribute">role</tag> attribute has no effect +on selecting indexterms for an index. +</para> + +<para>If you are using DocBook version 4.3 or later, you should +use the <tag class="attribute">type</tag> attribute instead of <tag class="attribute">role</tag> +on <tag>indexterm</tag> and <tag>index</tag>, +and set the <parameter>index.on.type</parameter> to a nonzero +value. +</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="index.links.to.section"> +<refmeta> +<refentrytitle>index.links.to.section</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>index.links.to.section</refname> +<refpurpose>HTML index entries link to container section title</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="index.links.to.section.frag"> +<xsl:param name="index.links.to.section" select="1"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If zero, then an index entry in an index links +directly to the location of the +generated <tag>anchor</tag> that is output +for the indexterm. If two identical indexterm elements +exist in the same section, then both entries appear +in the index with the same title but link to different +locations.</para> + +<para>If non-zero, then an index entry in an index links to the +section title containing the <tag>indexterm</tag>, rather than +directly to the <tag>anchor</tag> output for the indexterm. +Duplicate indexterm entries in the same section are dropped. +</para> + +<para>The default value is 1, so index entries link to +section titles by default.</para> + +<para>In both cases, the link text in an index entry is the +title of the section containing the indexterm. +That is because HTML does not have numbered pages. +It also provides the reader with context information +for each link.</para> + +<para>This parameter lets you choose which style of +index linking you want. </para> + +<itemizedlist> +<listitem> +<para>When set to 0, an index entry takes you +to the precise location of its corresponding indexterm. +However, if you have a lot of duplicate +entries in sections, then you have a lot of duplicate +titles in the index, which makes it more cluttered. +The reader may not recognize why duplicate titles +appear until they follow the links. Also, the links +may land the reader in the middle of a section where the +section title is not visible, which may also be +confusing to the reader.</para> +</listitem> +<listitem> +<para>When set to 1, an index entry link is +less precise, but duplicate titles in the +index entries are eliminated. +Landing on the section title location may confirm the reader's +expectation that a link that +shows a section title will take them to that section title, +not a location within the section. +</para> +</listitem> +</itemizedlist> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="index.prefer.titleabbrev"> +<refmeta> +<refentrytitle>index.prefer.titleabbrev</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>index.prefer.titleabbrev</refname> +<refpurpose>Should abbreviated titles be used as back references?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="index.prefer.titleabbrev.frag"> +<xsl:param name="index.prefer.titleabbrev" select="0"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, and if a <tag>titleabbrev</tag> is defined, the abbreviated title +is used as the link text of a back reference in the index. +</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="index.term.separator"> +<refmeta> +<refentrytitle>index.term.separator</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>index.term.separator</refname> +<refpurpose>Override for punctuation separating an index term +from its list of page references in an index</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="index.term.separator.frag"> +<xsl:param name="index.term.separator"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>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. +</para> + +<para>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. +</para> + +<para>So this text string can be customized in two ways. +You can reset the default gentext string using +the <parameter>local.l10n.xml</parameter> 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 <tag>fo:leader</tag> +element to provide space of a specific length, or a dot leader. +</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="index.number.separator"> +<refmeta> +<refentrytitle>index.number.separator</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>index.number.separator</refname> +<refpurpose>Override for punctuation separating page numbers in index</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="index.number.separator.frag"> +<xsl:param name="index.number.separator"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>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. +</para> + +<para>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. +</para> + +<para>So this text string can be customized in two ways. +You can reset the default gentext string using +the <parameter>local.l10n.xml</parameter> 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. +</para> + +<para>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. +</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="index.range.separator"> +<refmeta> +<refentrytitle>index.range.separator</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>index.range.separator</refname> +<refpurpose>Override for punctuation separating the two numbers +in a page range in index</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="index.range.separator.frag"> +<xsl:param name="index.range.separator"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>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).</para> + +<para>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. +</para> + +<para>So this text string can be customized in two ways. +You can reset the default gentext string using +the <parameter>local.l10n.xml</parameter> 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. +</para> + +<para>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. +</para> + +</refsection> +</refentry> + +</reference> +<reference xml:id="dbk_ext"><title>Stylesheet Extensions</title> +<refentry version="5.0" xml:id="linenumbering.everyNth"> +<refmeta> +<refentrytitle>linenumbering.everyNth</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo> +</refmeta> +<refnamediv> +<refname>linenumbering.everyNth</refname> +<refpurpose>Indicate which lines should be numbered</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="linenumbering.everyNth.frag"> +<xsl:param name="linenumbering.everyNth">5</xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If line numbering is enabled, everyNth line will be +numbered. Note that numbering is one based, not zero based. +</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="linenumbering.extension"> +<refmeta> +<refentrytitle>linenumbering.extension</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>linenumbering.extension</refname> +<refpurpose>Enable the line numbering extension</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="linenumbering.extension.frag"> +<xsl:param name="linenumbering.extension" select="1"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, verbatim environments (<tag>address</tag>, <tag>literallayout</tag>, +<tag>programlisting</tag>, <tag>screen</tag>, <tag>synopsis</tag>) that specify line numbering will +have line numbers. +</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="linenumbering.separator"> +<refmeta> +<refentrytitle>linenumbering.separator</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>linenumbering.separator</refname> +<refpurpose>Specify a separator between line numbers and lines</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="linenumbering.separator.frag"> +<xsl:param name="linenumbering.separator"><xsl:text> </xsl:text></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>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 <parameter>linenumbering.width</parameter> +</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="linenumbering.width"> +<refmeta> +<refentrytitle>linenumbering.width</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo> +</refmeta> +<refnamediv> +<refname>linenumbering.width</refname> +<refpurpose>Indicates the width of line numbers</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="linenumbering.width.frag"> +<xsl:param name="linenumbering.width">3</xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If line numbering is enabled, line numbers will appear right +justified in a field "width" characters wide. +</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="tablecolumns.extension"> +<refmeta> +<refentrytitle>tablecolumns.extension</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>tablecolumns.extension</refname> +<refpurpose>Enable the table columns extension function</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="tablecolumns.extension.frag"> +<xsl:param name="tablecolumns.extension" select="1"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>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. +</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="textinsert.extension"> + <refmeta> + <refentrytitle>textinsert.extension</refentrytitle> + <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> + </refmeta> + <refnamediv> + <refname>textinsert.extension</refname> + <refpurpose>Enables the textinsert extension element</refpurpose> + </refnamediv> + <refsynopsisdiv> + <programlisting xml:id="textinsert.extension.frag"> + <xsl:param name="textinsert.extension" select="1"></xsl:param> +</programlisting> + </refsynopsisdiv> + <refsection><info><title>Description</title></info> + <para>The textinsert extension element inserts the contents of + a file into the result tree (as text).</para> + <note> + <para>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 <link xmlns:xlink="http://www.w3.org/1999/xlink" role="tcg" xlink:href="InstallingAProcessor.html#SaxonExtensions">DocBook Saxon Extensions</link> and <link xmlns:xlink="http://www.w3.org/1999/xlink" role="tcg" xlink:href="InstallingAProcessor.html#XalanExtensions">DocBook Xalan Extensions</link>), and you must set both + the <parameter>use.extensions</parameter> and + <parameter>textinsert.extension</parameter> parameters to + <literal>1</literal>.</para> + <para>As an alternative to using the textinsert element, + consider using an Xinclude element with the + <literal>parse="text"</literal> attribute and value + specified, as detailed in <link xmlns:xlink="http://www.w3.org/1999/xlink" role="tcg" xlink:href="ExternalCode.html#XIncludeCode">Using XInclude for text inclusions</link>.</para> + </note> + </refsection> + <refsection><info><title>See Also</title></info> + <para>You can also use the <tag class="xmlpi">dbhtml-include href</tag> processing + instruction to insert external files — both files containing + plain text and files with markup content (including HTML + content).</para> + </refsection> + <refsection><info><title>More information</title></info> + <para>For how-to documentation on inserting contents of + external code files and other text files into output, see + <link xmlns:xlink="http://www.w3.org/1999/xlink" role="tcg" xlink:href="ExternalCode.html">External code files</link>.</para> + <para>For guidelines on inserting contents of + HTML files into output, see <link xmlns:xlink="http://www.w3.org/1999/xlink" role="tcg" xlink:href="InsertExtHtml.html">Inserting external HTML code</link>.</para> + </refsection> +</refentry> + +<refentry version="5.0" xml:id="textdata.default.encoding"> +<refmeta> +<refentrytitle>textdata.default.encoding</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>textdata.default.encoding</refname> +<refpurpose>Default encoding of external text files which are included +using textdata element</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="textdata.default.encoding.frag"> +<xsl:param name="textdata.default.encoding"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Specifies the encoding of any external text files included using +<tag>textdata</tag> 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.</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="graphicsize.extension"> +<refmeta> +<refentrytitle>graphicsize.extension</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>graphicsize.extension</refname> +<refpurpose>Enable the getWidth()/getDepth() extension functions</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="graphicsize.extension.frag"> +<xsl:param name="graphicsize.extension" select="1"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero (and if <parameter>use.extensions</parameter> is non-zero +and if you're using a processor that supports extension functions), the +<function>getWidth</function> and <function>getDepth</function> functions +will be used to extract image sizes from graphics.</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="graphicsize.use.img.src.path"> +<refmeta> +<refentrytitle>graphicsize.use.img.src.path</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>graphicsize.use.img.src.path</refname> +<refpurpose>Prepend <parameter>img.src.path</parameter> before +filenames passed to extension functions</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="graphicsize.use.img.src.path.frag"> +<xsl:param name="graphicsize.use.img.src.path" select="0"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero <parameter>img.src.path</parameter> parameter will +be appended before filenames passed to extension functions for +measuring image dimensions.</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="use.extensions"> +<refmeta> +<refentrytitle>use.extensions</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>use.extensions</refname> +<refpurpose>Enable extensions</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="use.extensions.frag"> +<xsl:param name="use.extensions" select="0"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, extensions may be used. Each extension is +further controlled by its own parameter. But if +<parameter>use.extensions</parameter> is zero, no extensions will +be used. +</para> + +</refsection> +</refentry> + +</reference> +<reference xml:id="labels"><title>Automatic labelling</title> +<refentry version="5.0" xml:id="chapter.autolabel"> +<refmeta> +<refentrytitle>chapter.autolabel</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">list</refmiscinfo> +<refmiscinfo class="other" otherclass="value">0<alt>none</alt></refmiscinfo> +<refmiscinfo class="other" otherclass="value">1<alt>1,2,3...</alt></refmiscinfo> +<refmiscinfo class="other" otherclass="value">A<alt>A,B,C...</alt></refmiscinfo> +<refmiscinfo class="other" otherclass="value">a<alt>a,b,c...</alt></refmiscinfo> +<refmiscinfo class="other" otherclass="value">i<alt>i,ii,iii...</alt></refmiscinfo> +<refmiscinfo class="other" otherclass="value">I<alt>I,II,III...</alt></refmiscinfo> +</refmeta> +<refnamediv> +<refname>chapter.autolabel</refname> +<refpurpose>Specifies the labeling format for Chapter titles</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="chapter.autolabel.frag"> +<xsl:param name="chapter.autolabel" select="1"></xsl:param></programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, then chapters will be numbered using the parameter +value as the number format if the value matches one of the following: +</para> + +<variablelist> + <varlistentry> + <term>1 or arabic</term> + <listitem> + <para>Arabic numeration (1, 2, 3 ...).</para> + </listitem> + </varlistentry> + <varlistentry> + <term>A or upperalpha</term> + <listitem> + <para>Uppercase letter numeration (A, B, C ...).</para> + </listitem> + </varlistentry> + <varlistentry> + <term>a or loweralpha</term> + <listitem> + <para>Lowercase letter numeration (a, b, c ...).</para> + </listitem> + </varlistentry> + <varlistentry> + <term>I or upperroman</term> + <listitem> + <para>Uppercase roman numeration (I, II, III ...).</para> + </listitem> + </varlistentry> + <varlistentry> + <term>i or lowerroman</term> + <listitem> + <para>Lowercase roman letter numeration (i, ii, iii ...).</para> + </listitem> + </varlistentry> +</variablelist> + +<para>Any nonzero value other than the above will generate +the default number format (arabic). +</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="appendix.autolabel"> +<refmeta> +<refentrytitle>appendix.autolabel</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">list</refmiscinfo> +<refmiscinfo class="other" otherclass="value">0<alt>none</alt></refmiscinfo> +<refmiscinfo class="other" otherclass="value">1<alt>1,2,3...</alt></refmiscinfo> +<refmiscinfo class="other" otherclass="value">A<alt>A,B,C...</alt></refmiscinfo> +<refmiscinfo class="other" otherclass="value">a<alt>a,b,c...</alt></refmiscinfo> +<refmiscinfo class="other" otherclass="value">i<alt>i,ii,iii...</alt></refmiscinfo> +<refmiscinfo class="other" otherclass="value">I<alt>I,II,III...</alt></refmiscinfo> +</refmeta> +<refnamediv> +<refname>appendix.autolabel</refname> +<refpurpose>Specifies the labeling format for Appendix titles</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="appendix.autolabel.frag"> +<xsl:param name="appendix.autolabel">A</xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, then appendices will be numbered using the +parameter value as the number format if the value matches one of the +following: +</para> + +<variablelist> + <varlistentry> + <term>1 or arabic</term> + <listitem> + <para>Arabic numeration (1, 2, 3 ...).</para> + </listitem> + </varlistentry> + <varlistentry> + <term>A or upperalpha</term> + <listitem> + <para>Uppercase letter numeration (A, B, C ...).</para> + </listitem> + </varlistentry> + <varlistentry> + <term>a or loweralpha</term> + <listitem> + <para>Lowercase letter numeration (a, b, c ...).</para> + </listitem> + </varlistentry> + <varlistentry> + <term>I or upperroman</term> + <listitem> + <para>Uppercase roman numeration (I, II, III ...).</para> + </listitem> + </varlistentry> + <varlistentry> + <term>i or lowerroman</term> + <listitem> + <para>Lowercase roman letter numeration (i, ii, iii ...).</para> + </listitem> + </varlistentry> +</variablelist> + +<para>Any nonzero value other than the above will generate +the default number format (upperalpha). +</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="part.autolabel"> +<refmeta> +<refentrytitle>part.autolabel</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">list</refmiscinfo> +<refmiscinfo class="other" otherclass="value">0<alt>none</alt></refmiscinfo> +<refmiscinfo class="other" otherclass="value">1<alt>1,2,3...</alt></refmiscinfo> +<refmiscinfo class="other" otherclass="value">A<alt>A,B,C...</alt></refmiscinfo> +<refmiscinfo class="other" otherclass="value">a<alt>a,b,c...</alt></refmiscinfo> +<refmiscinfo class="other" otherclass="value">i<alt>i,ii,iii...</alt></refmiscinfo> +<refmiscinfo class="other" otherclass="value">I<alt>I,II,III...</alt></refmiscinfo> +</refmeta> +<refnamediv> +<refname>part.autolabel</refname> +<refpurpose>Specifies the labeling format for Part titles</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="part.autolabel.frag"> +<xsl:param name="part.autolabel">I</xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, then parts will be numbered using the parameter +value as the number format if the value matches one of the following: +</para> + +<variablelist> + <varlistentry> + <term>1 or arabic</term> + <listitem> + <para>Arabic numeration (1, 2, 3 ...).</para> + </listitem> + </varlistentry> + <varlistentry> + <term>A or upperalpha</term> + <listitem> + <para>Uppercase letter numeration (A, B, C ...).</para> + </listitem> + </varlistentry> + <varlistentry> + <term>a or loweralpha</term> + <listitem> + <para>Lowercase letter numeration (a, b, c ...).</para> + </listitem> + </varlistentry> + <varlistentry> + <term>I or upperroman</term> + <listitem> + <para>Uppercase roman numeration (I, II, III ...).</para> + </listitem> + </varlistentry> + <varlistentry> + <term>i or lowerroman</term> + <listitem> + <para>Lowercase roman letter numeration (i, ii, iii ...).</para> + </listitem> + </varlistentry> +</variablelist> + +<para>Any nonzero value other than the above will generate +the default number format (upperroman). +</para> + + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="reference.autolabel"> +<refmeta> +<refentrytitle>reference.autolabel</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">list</refmiscinfo> +<refmiscinfo class="other" otherclass="value">0<alt>none</alt></refmiscinfo> +<refmiscinfo class="other" otherclass="value">1<alt>1,2,3...</alt></refmiscinfo> +<refmiscinfo class="other" otherclass="value">A<alt>A,B,C...</alt></refmiscinfo> +<refmiscinfo class="other" otherclass="value">a<alt>a,b,c...</alt></refmiscinfo> +<refmiscinfo class="other" otherclass="value">i<alt>i,ii,iii...</alt></refmiscinfo> +<refmiscinfo class="other" otherclass="value">I<alt>I,II,III...</alt></refmiscinfo> +</refmeta> +<refnamediv> +<refname>reference.autolabel</refname> +<refpurpose>Specifies the labeling format for Reference titles</refpurpose> +</refnamediv> +<refsynopsisdiv> +<programlisting xml:id="reference.autolabel.frag"> + <xsl:param name="reference.autolabel">I</xsl:param> +</programlisting> +</refsynopsisdiv> +<refsection><info><title>Description</title></info> +<para>If non-zero, references will be numbered using the parameter + value as the number format if the value matches one of the + following: +</para> +<variablelist> + <varlistentry> + <term>1 or arabic</term> + <listitem> + <para>Arabic numeration (1, 2, 3 ...).</para> + </listitem> + </varlistentry> + <varlistentry> + <term>A or upperalpha</term> + <listitem> + <para>Uppercase letter numeration (A, B, C ...).</para> + </listitem> + </varlistentry> + <varlistentry> + <term>a or loweralpha</term> + <listitem> + <para>Lowercase letter numeration (a, b, c ...).</para> + </listitem> + </varlistentry> + <varlistentry> + <term>I or upperroman</term> + <listitem> + <para>Uppercase roman numeration (I, II, III ...).</para> + </listitem> + </varlistentry> + <varlistentry> + <term>i or lowerroman</term> + <listitem> + <para>Lowercase roman letter numeration (i, ii, iii ...).</para> + </listitem> + </varlistentry> +</variablelist> +<para>Any non-zero value other than the above will generate +the default number format (upperroman). +</para> +</refsection> +</refentry> + +<refentry version="5.0" xml:id="preface.autolabel"> +<refmeta> +<refentrytitle>preface.autolabel</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">list</refmiscinfo> +<refmiscinfo class="other" otherclass="value">0<alt>none</alt></refmiscinfo> +<refmiscinfo class="other" otherclass="value">1<alt>1,2,3...</alt></refmiscinfo> +<refmiscinfo class="other" otherclass="value">A<alt>A,B,C...</alt></refmiscinfo> +<refmiscinfo class="other" otherclass="value">a<alt>a,b,c...</alt></refmiscinfo> +<refmiscinfo class="other" otherclass="value">i<alt>i,ii,iii...</alt></refmiscinfo> +<refmiscinfo class="other" otherclass="value">I<alt>I,II,III...</alt></refmiscinfo> +</refmeta> +<refnamediv> +<refname>preface.autolabel</refname> +<refpurpose>Specifices the labeling format for Preface titles</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="preface.autolabel.frag"><xsl:param name="preface.autolabel" select="0"></xsl:param></programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero then prefaces will be numbered using the parameter +value as the number format if the value matches one of the following: +</para> + +<variablelist> + <varlistentry> + <term>1 or arabic</term> + <listitem> + <para>Arabic numeration (1, 2, 3 ...).</para> + </listitem> + </varlistentry> + <varlistentry> + <term>A or upperalpha</term> + <listitem> + <para>Uppercase letter numeration (A, B, C ...).</para> + </listitem> + </varlistentry> + <varlistentry> + <term>a or loweralpha</term> + <listitem> + <para>Lowercase letter numeration (a, b, c ...).</para> + </listitem> + </varlistentry> + <varlistentry> + <term>I or upperroman</term> + <listitem> + <para>Uppercase roman numeration (I, II, III ...).</para> + </listitem> + </varlistentry> + <varlistentry> + <term>i or lowerroman</term> + <listitem> + <para>Lowercase roman letter numeration (i, ii, iii ...).</para> + </listitem> + </varlistentry> +</variablelist> + +<para>Any nonzero value other than the above will generate +the default number format (arabic). +</para> + + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="qandadiv.autolabel"> +<refmeta> +<refentrytitle>qandadiv.autolabel</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>qandadiv.autolabel</refname> +<refpurpose>Are divisions in QAndASets enumerated?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="qandadiv.autolabel.frag"><xsl:param name="qandadiv.autolabel" select="1"></xsl:param></programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, unlabeled qandadivs will be enumerated. +</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="section.autolabel"> +<refmeta> +<refentrytitle>section.autolabel</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>section.autolabel</refname> +<refpurpose>Are sections enumerated?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="section.autolabel.frag"><xsl:param name="section.autolabel" select="0"></xsl:param></programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If true (non-zero), unlabeled sections will be enumerated. +</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="section.autolabel.max.depth"> +<refmeta> +<refentrytitle>section.autolabel.max.depth</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo> +</refmeta> +<refnamediv> +<refname>section.autolabel.max.depth</refname> +<refpurpose>The deepest level of sections that are numbered.</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="section.autolabel.max.depth.frag"> +<xsl:param name="section.autolabel.max.depth">8</xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>When section numbering is turned on by the +<parameter>section.autolabel</parameter> parameter, then this +parameter controls the depth of <tag>section</tag> nesting that is +numbered. Sections nested to a level deeper than this value will not +be numbered. +</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="section.label.includes.component.label"> +<refmeta> +<refentrytitle>section.label.includes.component.label</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>section.label.includes.component.label</refname> +<refpurpose>Do section labels include the component label?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="section.label.includes.component.label.frag"><xsl:param name="section.label.includes.component.label" select="0"></xsl:param></programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, section labels are prefixed with the label of the +component that contains them. +</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="label.from.part"> +<refmeta> +<refentrytitle>label.from.part</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>label.from.part</refname> +<refpurpose>Renumber components in each part?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="label.from.part.frag"> +<xsl:param name="label.from.part" select="0"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If <parameter>label.from.part</parameter> is non-zero, then + numbering of components — <tag>preface</tag>, + <tag>chapter</tag>, <tag>appendix</tag>, and + <tag>reference</tag> (when <tag>reference</tag> occurs at the + component level) — is re-started within each + <tag>part</tag>.</para> +<para>If <parameter>label.from.part</parameter> is zero (the + default), numbering of components is <emphasis>not</emphasis> + re-started within each <tag>part</tag>; instead, components are + numbered sequentially throughout each <tag>book</tag>, + regardless of whether or not they occur within <tag>part</tag> + instances.</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="component.label.includes.part.label"> +<refmeta> +<refentrytitle>component.label.includes.part.label</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>component.label.includes.part.label</refname> +<refpurpose>Do component labels include the part label?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="component.label.includes.part.label.frag"><xsl:param name="component.label.includes.part.label" select="0"></xsl:param></programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, number labels for <tag>chapter</tag>, +<tag>appendix</tag>, 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 <tag>table</tag> and <tag>figure</tag> will include +the part label. If there is no part element container, then no prefix +is generated. +</para> +<para> +This feature is most useful when the +<parameter>label.from.part</parameter> parameter is turned on. +In that case, there would be more than one <tag>chapter</tag> +<quote>1</quote>, and the extra part label prefix will identify +each chapter unambiguously. +</para> + +</refsection> +</refentry> + +</reference> + +<reference xml:id="html"><title>HTML</title> +<refentry version="5.0" xml:id="html.base"> +<refmeta> +<refentrytitle>html.base</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo> +</refmeta> +<refnamediv> +<refname>html.base</refname> +<refpurpose>An HTML base URI</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="html.base.frag"> +<xsl:param name="html.base"></xsl:param></programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If html.base is set, it is used for the <tag>base</tag> element +in the <tag>head</tag> 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.</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="html.stylesheet.type"> +<refmeta> +<refentrytitle>html.stylesheet.type</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>html.stylesheet.type</refname> +<refpurpose>The type of the stylesheet used in the generated HTML</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="html.stylesheet.type.frag"><xsl:param name="html.stylesheet.type">text/css</xsl:param></programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The type of the stylesheet to place in the HTML <tag>link</tag> tag. +</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="html.stylesheet"> +<refmeta> +<refentrytitle>html.stylesheet</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>html.stylesheet</refname> +<refpurpose>Name of the stylesheet(s) to use in the generated HTML</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="html.stylesheet.frag"> +<xsl:param name="html.stylesheet"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The <parameter>html.stylesheet</parameter> parameter is either +empty, indicating that no stylesheet <tag>link</tag> tag should be +generated in the html output, or it is a list of one or more +stylesheet files.</para> + +<para>Multiple stylesheets are space-delimited. If you need to +reference a stylesheet URI that includes a space, encode it with +<literal>%20</literal>. A separate html <literal>link</literal> element will +be generated for each stylesheet in the order they are listed in the +parameter.</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="css.decoration"> +<refmeta> +<refentrytitle>css.decoration</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>css.decoration</refname> +<refpurpose>Enable CSS decoration of elements</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="css.decoration.frag"> +<xsl:param name="css.decoration" select="1"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para> +If non-zero, then html elements produced by the stylesheet may be +decorated with <literal>style</literal> attributes. For example, the +<literal>li</literal> tags produced for list items may include a +fragment of CSS in the <literal>style</literal> attribute which sets +the CSS property "list-style-type". +</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="spacing.paras"> +<refmeta> +<refentrytitle>spacing.paras</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>spacing.paras</refname> +<refpurpose>Insert additional <p> elements for spacing?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="spacing.paras.frag"> +<xsl:param name="spacing.paras" select="0"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>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. +</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="emphasis.propagates.style"> +<refmeta> +<refentrytitle>emphasis.propagates.style</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>emphasis.propagates.style</refname> +<refpurpose>Pass emphasis role attribute through to HTML?</refpurpose> +</refnamediv> +<refsynopsisdiv> +<programlisting xml:id="emphasis.propagates.style.frag"> +<xsl:param name="emphasis.propagates.style" select="1"></xsl:param> +</programlisting> +</refsynopsisdiv> +<refsection><info><title>Description</title></info> +<para>If non-zero, the <literal>role</literal> attribute of +<tag>emphasis</tag> elements will be passed through to the HTML as a +class attribute on a <literal>span</literal> that surrounds the +emphasis.</para> +</refsection> +</refentry> + +<refentry version="5.0" xml:id="para.propagates.style"> +<refmeta> +<refentrytitle>para.propagates.style</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>para.propagates.style</refname> +<refpurpose>Pass para role attribute through to HTML?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="para.propagates.style.frag"> +<xsl:param name="para.propagates.style" select="1"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If true, the role attribute of <tag>para</tag> elements +will be passed through to the HTML as a class attribute on the +<tag>p</tag> generated for the paragraph.</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="phrase.propagates.style"> +<refmeta> +<refentrytitle>phrase.propagates.style</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>phrase.propagates.style</refname> +<refpurpose>Pass phrase role attribute through to HTML?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="phrase.propagates.style.frag"> +<xsl:param name="phrase.propagates.style" select="1"></xsl:param></programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, the role attribute of <tag>phrase</tag> elements +will be passed through to the HTML as a <literal>class</literal> +attribute on a <literal>span</literal> that surrounds the +phrase.</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="entry.propagates.style"> +<refmeta> +<refentrytitle>entry.propagates.style</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>entry.propagates.style</refname> +<refpurpose>Pass entry role attribute through to HTML?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="entry.propagates.style.frag"> +<xsl:param name="entry.propagates.style" select="1"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If true, the role attribute of <tag>entry</tag> elements +will be passed through to the HTML as a class attribute on the +<tag>td</tag> or <tag>th</tag> generated for the table +cell.</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="html.longdesc"> +<refmeta> +<refentrytitle>html.longdesc</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>html.longdesc</refname> +<refpurpose>Should longdesc URIs be created?</refpurpose> +</refnamediv> +<refsynopsisdiv> +<programlisting xml:id="html.longdesc.frag"> +<xsl:param name="html.longdesc" select="1"></xsl:param> +</programlisting> +</refsynopsisdiv> +<refsection><info><title>Description</title></info> +<para>If non-zero, HTML files will be created for the +<literal>longdesc</literal> attribute. These files +are created from the <tag>textobject</tag>s in +<tag>mediaobject</tag>s and +<tag>inlinemediaobject</tag>. +</para> +</refsection> +</refentry> + +<refentry version="5.0" xml:id="html.longdesc.link"> +<refmeta> +<refentrytitle>html.longdesc.link</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>html.longdesc.link</refname> +<refpurpose>Should a link to the longdesc be included in the HTML?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="html.longdesc.link.frag"> +<xsl:param name="html.longdesc.link" select="$html.longdesc"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, links will be created to the +HTML files created for the +<literal>longdesc</literal> attribute. It makes no +sense to enable this option without also enabling the +<parameter>html.longdesc</parameter> parameter.</para> + + + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="make.valid.html"> +<refmeta> +<refentrytitle>make.valid.html</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>make.valid.html</refname> +<refpurpose>Attempt to make sure the HTML output is valid HTML</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="make.valid.html.frag"> +<xsl:param name="make.valid.html" select="0"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If <parameter>make.valid.html</parameter> is true, the stylesheets take +extra effort to ensure that the resulting HTML is valid. This may mean that some +<tag>para</tag> tags are translated into HTML <tag>div</tag>s or +that other substitutions occur.</para> + +<para>This parameter is different from <parameter>html.cleanup</parameter> +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.</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="html.cleanup"> +<refmeta> +<refentrytitle>html.cleanup</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>html.cleanup</refname> +<refpurpose>Attempt to clean up the resulting HTML?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="html.cleanup.frag"> +<xsl:param name="html.cleanup" select="1"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, and if the <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://www.exslt.org/">EXSLT</link> +extensions are supported by your processor, the resulting HTML will be +<quote>cleaned up</quote>. This improves the chances that the +resulting HTML will be valid. It may also improve the formatting of +some elements.</para> + +<para>This parameter is different from <parameter>make.valid.html</parameter> +because it uses extension functions to manipulate result-tree-fragments.</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="html.append"> +<refmeta> +<refentrytitle>html.append</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>html.append</refname> +<refpurpose>Specifies content to append to HTML output</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="html.append.frag"><xsl:param name="html.append"></xsl:param></programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Specifies content to append to the end of HTML files output by +the <filename>html/docbook.xsl</filename> stylesheet, after the +closing <code><html></code> 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: <code>&#x0a;</code> or +<code>&#10;</code></para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="draft.mode"> +<refmeta> +<refentrytitle>draft.mode</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">list</refmiscinfo> +<refmiscinfo class="other" otherclass="value">no</refmiscinfo> +<refmiscinfo class="other" otherclass="value">yes</refmiscinfo> +<refmiscinfo class="other" otherclass="value">maybe</refmiscinfo> +</refmeta> +<refnamediv> +<refname>draft.mode</refname> +<refpurpose>Select draft mode</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="draft.mode.frag"> +<xsl:param name="draft.mode">no</xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Selects draft mode. If <parameter>draft.mode</parameter> is +<quote><literal>yes</literal></quote>, the entire document will be treated +as a draft. If it is <quote><literal>no</literal></quote>, the entire document +will be treated as a final copy. If it is <quote><literal>maybe</literal></quote>, +individual sections will be treated as draft or final independently, depending +on how their <literal>status</literal> attribute is set. +</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="draft.watermark.image"> +<refmeta> +<refentrytitle>draft.watermark.image</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo> +</refmeta> +<refnamediv> +<refname>draft.watermark.image</refname> +<refpurpose>The URI of the image to be used for draft watermarks</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="draft.watermark.image.frag"> +<xsl:param name="draft.watermark.image">images/draft.png</xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The image to be used for draft watermarks.</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="generate.id.attributes"> +<refmeta> +<refentrytitle>generate.id.attributes</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>generate.id.attributes</refname> +<refpurpose>Generate ID attributes on container elements?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="generate.id.attributes.frag"> +<xsl:param name="generate.id.attributes" select="0"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, the HTML stylesheet will generate ID attributes on +containers. For example, the markup:</para> + +<screen><section id="foo"><title>Some Title</title> +<para>Some para.</para> +</section></screen> + +<para>might produce:</para> + +<screen><div class="section" id="foo"> +<h2>Some Title</h2> +<p>Some para.</p> +</div></screen> + +<para>The alternative is to generate anchors:</para> + +<screen><div class="section"> +<h2><a name="foo"></a>Some Title</h2> +<p>Some para.</p> +</div></screen> + +<para>Because the <tag class="attribute">name</tag> attribute of +the <tag>a</tag> element and the <tag class="attribute">id</tag> +attribute of other tags are both of type <quote>ID</quote>, producing both +generates invalid documents.</para> + +<para>As of version 1.50, you can use this switch to control which type of +identifier is generated. For backwards-compatibility, generating +<tag>a</tag> anchors is preferred.</para> + +<para>Note: at present, this switch is incompletely implemented. +Disabling ID attributes will suppress them, but enabling ID attributes +will not suppress the anchors.</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="generate.meta.abstract"> +<refmeta> +<refentrytitle>generate.meta.abstract</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>generate.meta.abstract</refname> +<refpurpose>Generate HTML <tag>META</tag> element from <tag>abstract</tag>?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="generate.meta.abstract.frag"> +<xsl:param name="generate.meta.abstract" select="1"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, document abstracts will be reproduced in the HTML +<literal>head</literal>, with <literal>>meta name="description" content="..."</literal></para> + + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="make.clean.html"> +<refmeta> +<refentrytitle>make.clean.html</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>make.clean.html</refname> +<refpurpose>Make HTML conform to modern coding standards</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="make.clean.html.frag"> +<xsl:param name="make.clean.html" select="0"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If <parameter>make.clean.html</parameter> is true, the stylesheets take +extra effort to ensure that the resulting HTML is conforms to +modern HTML coding standards. In addition to eliminating +excessive and noncompliant coding, it moves presentation +HTML coding to a CSS stylesheet.</para> + +<para>The resulting HTML is dependent on +CSS for formatting, and so the stylesheet is capable of +generating a supporting CSS file. The <parameter>docbook.css.source</parameter> +and <parameter>custom.css.source</parameter> parameters control +how a CSS file is generated.</para> + +<para>If you require your CSS to reside in the HTML +<tag>head</tag> element, then the <parameter>generate.css.header</parameter> +can be used to do that.</para> + +<para>The <parameter>make.clean.html</parameter> parameter is +different from <parameter>html.cleanup</parameter> +because the former changes the resulting markup; it does not use extension functions +like the latter to manipulate result-tree-fragments, +and is therefore applicable to any XSLT processor.</para> + +<para>If <parameter>make.clean.html</parameter> is set to zero (the default), +then the stylesheet retains its original +<quote>old style</quote> +HTML formatting features.</para> +</refsection> +</refentry> + +<refentry version="5.0" xml:id="docbook.css.source"> + <refmeta> + <refentrytitle>docbook.css.source</refentrytitle> + <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> + </refmeta> + <refnamediv> + <refname>docbook.css.source</refname> + <refpurpose>Name of the default CSS input file</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <programlisting xml:id="docbook.css.source.frag"><xsl:param name="docbook.css.source">docbook.css.xml</xsl:param></programlisting> + </refsynopsisdiv> + + <refsection><info><title>Description</title></info> + +<para>The <parameter>docbook.css.source</parameter> parameter +specifies the name of the file containing the default DocBook +CSS styles. Those styles are necessary when the +<parameter>make.clean.html</parameter> parameter is nonzero.</para> + +<para>The file is a well-formed XML file that +must consist of a single <tag>style</tag> root +element that contains CSS styles as its text content. +The default value of the parameter (and filename) +is <literal>docbook.css.xml</literal>. +The stylesheets ship with the default file. You can substitute +your own and specify its path in this parameter.</para> + +<para>If <parameter>docbook.css.source</parameter> is not blank, +and <parameter>make.clean.html</parameter> is nonzero, then +the stylesheet takes the following actions:</para> + +<orderedlist> + <listitem> + <para>The stylesheet uses the XSLT <literal>document()</literal> + function to open the file specified by the parameter and + load it into a variable.</para> + </listitem> + <listitem> + <para>The stylesheet forms an output pathname consisting of the + value of the <parameter>base.dir</parameter> parameter (if it is set) + and the value of <parameter>docbook.css.source</parameter>, + with the <literal>.xml</literal> suffix stripped off. + </para> + </listitem> + <listitem> + <para>The stylesheet removes the <tag>style</tag> + wrapper element and writes just the CSS text content to the output file.</para> + </listitem> + <listitem> + <para>The stylesheet adds a <tag>link</tag> element to the + HTML <tag>HEAD</tag> element to reference the external CSS stylesheet. + For example:</para> + <programlisting><link rel="stylesheet" href="docbook.css" type="text/css"> + </programlisting> + <para>However, if the <parameter>docbook.css.link</parameter> + parameter is set to zero, then no <tag>link</tag> is written + for the default CSS file. That is useful if a custom + CSS file will import the default CSS stylesheet to ensure + proper cascading of styles.</para> + </listitem> +</orderedlist> + +<para>If the <parameter>docbook.css.source</parameter> parameter +is changed from its default <literal>docbook.css.xml</literal> to blank, +then no default CSS is generated. Likewise if the +<parameter>make.clean.html</parameter> parameter is set to zero, +then no default CSS is generated. The +<parameter>custom.css.source</parameter> parameter can be used +instead to generate a complete custom CSS file.</para> + +<para>You can use the <parameter>generate.css.header</parameter> +parameter to instead write the CSS to each HTML <tag>HEAD</tag> +element in a <tag>style</tag> tag instead of an external CSS file.</para> + + </refsection> +</refentry> + +<refentry version="5.0" xml:id="docbook.css.link"> +<refmeta> +<refentrytitle>docbook.css.link</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>docbook.css.link</refname> +<refpurpose>Insert a link referencing the default CSS stylesheet</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="docbook.css.link.frag"> +<xsl:param name="docbook.css.link" select="1"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The stylesheets are capable of generating a default +CSS stylesheet file. The parameters +<parameter>make.clean.html</parameter> and +<parameter>docbook.css.source</parameter> control that feature.</para> + +<para>Normally if a default CSS file is generated, then +the stylesheet inserts a <tag>link</tag> tag in the HTML +<tag>HEAD</tag> element to reference it. +However, you can omit that <tag>link</tag> reference if +you set the <parameter>docbook.css.link</parameter> to zero +(1 is the default).</para> + +<para>This parameter is useful when you want to import the +default CSS into a custom CSS file generated using the +<parameter>custom.css.source</parameter> parameter. +</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="custom.css.source"> + <refmeta> + <refentrytitle>custom.css.source</refentrytitle> + <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> + </refmeta> + <refnamediv> + <refname>custom.css.source</refname> + <refpurpose>Name of a custom CSS input file</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <programlisting xml:id="custom.css.source.frag"><xsl:param name="custom.css.source"></xsl:param></programlisting> + </refsynopsisdiv> + + <refsection><info><title>Description</title></info> + +<para>The <parameter>custom.css.source</parameter> +parameter enables you to add CSS styles to DocBook's +HTML output.</para> + +<para>The parameter +specifies the name of a file containing custom +CSS styles. The file must be a well-formed XML file that +consists of a single <tag>style</tag> root +element that contains CSS styles as its text content. +For example:</para> +<programlisting><?xml version="1.0"?> +<style> +h2 { + font-weight: bold; + color: blue; +} +... +</style> +</programlisting> + +<para>The filename specified by the parameter +should have a <literal>.xml</literal> +filename suffix, although that is not required. +The default value of this parameter is blank.</para> + +<para>If <parameter>custom.css.source</parameter> is not blank, then +the stylesheet takes the following actions. +These actions take place regardless of the value of +the <parameter>make.clean.html</parameter> parameter.</para> + +<orderedlist> + <listitem> + <para>The stylesheet uses the XSLT <literal>document()</literal> + function to open the file specified by the parameter and + load it into a variable.</para> + </listitem> + <listitem> + <para>The stylesheet forms an output pathname consisting of the + value of the <parameter>base.dir</parameter> parameter (if it is set) + and the value of <parameter>custom.css.source</parameter>, + with the <literal>.xml</literal> suffix stripped off. + </para> + </listitem> + <listitem> + <para>The stylesheet removes the <tag>style</tag> + wrapper element and writes just the CSS text content to the output file.</para> + </listitem> + <listitem> + <para>The stylesheet adds a <tag>link</tag> element to the + HTML <tag>HEAD</tag> element to reference this external CSS stylesheet. + For example: + <programlisting><link rel="stylesheet" href="custom.css" type="text/css"> + </programlisting> + </para> + </listitem> +</orderedlist> + + + +<para>If the <parameter>make.clean.html</parameter> parameter is nonzero +(the default is zero), +and if the <parameter>docbook.css.source</parameter> parameter +is not blank (the default is not blank), +then the stylesheet will also generate a default CSS file +and add a <tag>link</tag> tag to reference it. +The <tag>link</tag> to the custom CSS comes after the +<tag>link</tag> to the default, so it should cascade properly +in most browsers. +If you do not want two <tag>link</tag> tags, and +instead want your custom CSS to import the default generated +CSS file, then do the following: +</para> + +<orderedlist> + <listitem> + <para>Add a line like the following to your custom CSS source file:</para> + <programlisting>@import url("docbook.css") + </programlisting> + </listitem> + <listitem> + <para>Set the <parameter>docbook.css.link</parameter> parameter + to zero. This will omit the <tag>link</tag> tag + that references the default CSS file.</para> + </listitem> +</orderedlist> + +<para>If you set <parameter>make.clean.html</parameter> to nonzero but +you do not want the default CSS generated, then also set +the <parameter>docbook.css.source</parameter> parameter to blank. +Then no default CSS will be generated, and so +all CSS styles must come from your custom CSS file.</para> + +<para>You can use the <parameter>generate.css.header</parameter> +parameter to instead write the CSS to each HTML <tag>HEAD</tag> +element in a <tag>style</tag> tag instead of an external CSS file.</para> + + </refsection> +</refentry> + +<refentry version="5.0" xml:id="generate.css.header"> +<refmeta> +<refentrytitle>generate.css.header</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>generate.css.header</refname> +<refpurpose>Insert generated CSS styles in HEAD element</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="generate.css.header.frag"> +<xsl:param name="generate.css.header" select="0"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The stylesheets are capable of generating both default +and custom CSS stylesheet files. The parameters +<parameter>make.clean.html</parameter>, +<parameter>docbook.css.source</parameter>, and +<parameter>custom.css.source</parameter> control that feature.</para> + +<para>If you require that CSS styles reside in the HTML +<tag>HEAD</tag> element instead of external CSS files, +then set the <parameter>generate.css.header</parameter> +parameter to nonzero (it is zero by default). +Then instead of generating the CSS in external files, +they are wrapped in <tag>style</tag> elements in +the <tag>HEAD</tag> element of each HTML output file. +</para> + +</refsection> +</refentry> + +</reference> +<reference xml:id="xslt"><title>XSLT Processing</title> +<refentry version="5.0" xml:id="rootid"> +<refmeta> +<refentrytitle>rootid</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>rootid</refname> +<refpurpose>Specify the root element to format</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="rootid.frag"> +<xsl:param name="rootid"></xsl:param></programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If <parameter>rootid</parameter> 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 <tag>chapter</tag> 4 of a <tag>book</tag>.</para> +<para>Because the entire document is available to the processor, automatic +numbering, cross references, and other dependencies are correctly +resolved.</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="suppress.navigation"> +<refmeta> +<refentrytitle>suppress.navigation</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>suppress.navigation</refname> +<refpurpose>Disable header and footer navigation</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="suppress.navigation.frag"> +<xsl:param name="suppress.navigation" select="0"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para> +If non-zero, header and footer navigation will be suppressed.</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="suppress.header.navigation"> +<refmeta> +<refentrytitle>suppress.header.navigation</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>suppress.header.navigation</refname> +<refpurpose>Disable header navigation</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="suppress.header.navigation.frag"> +<xsl:param name="suppress.header.navigation" select="0"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, header navigation will be suppressed.</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="suppress.footer.navigation"> +<refmeta> +<refentrytitle>suppress.footer.navigation</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>suppress.footer.navigation</refname> +<refpurpose>Disable footer navigation</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="suppress.footer.navigation.frag"><xsl:param name="suppress.footer.navigation">0</xsl:param></programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para> +If non-zero, footer navigation will be suppressed.</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="header.rule"> +<refmeta> +<refentrytitle>header.rule</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>header.rule</refname> +<refpurpose>Rule under headers?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="header.rule.frag"> +<xsl:param name="header.rule" select="1"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, a rule will be drawn below the page headers.</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="footer.rule"> +<refmeta> +<refentrytitle>footer.rule</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>footer.rule</refname> +<refpurpose>Rule over footers?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="footer.rule.frag"> +<xsl:param name="footer.rule" select="1"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, a rule will be drawn above the page footers.</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="id.warnings"> +<refmeta> +<refentrytitle>id.warnings</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>id.warnings</refname> +<refpurpose>Should warnings be generated for titled elements without IDs?</refpurpose> +</refnamediv> +<refsynopsisdiv> +<programlisting xml:id="id.warnings.frag"> +<xsl:param name="id.warnings" select="0"></xsl:param> +</programlisting> +</refsynopsisdiv> +<refsection><info><title>Description</title></info> +<para>If non-zero, the stylesheet will issue a warning for any element +(other than the root element) which has a <tag>title</tag> but does not have an +ID.</para> +</refsection> +</refentry> + +</reference> +<reference xml:id="meta"><title>Meta/*Info and Titlepages</title> +<refentry version="5.0" xml:id="inherit.keywords"> +<refmeta> +<refentrytitle>inherit.keywords</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>inherit.keywords</refname> +<refpurpose>Inherit keywords from ancestor elements?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="inherit.keywords.frag"> +<xsl:param name="inherit.keywords" select="1"></xsl:param></programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If <parameter>inherit.keywords</parameter> +is non-zero, the keyword <literal>meta</literal> for each HTML +<literal>head</literal> element will include all of the keywords from +ancestor elements. Otherwise, only the keywords from the current section +will be used. +</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="make.single.year.ranges"> +<refmeta> +<refentrytitle>make.single.year.ranges</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>make.single.year.ranges</refname> +<refpurpose>Print single-year ranges (e.g., 1998-1999)</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="make.single.year.ranges.frag"> +<xsl:param name="make.single.year.ranges" select="0"></xsl:param></programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, year ranges that span a single year will be printed +in range notation (1998-1999) instead of discrete notation +(1998, 1999).</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="make.year.ranges"> +<refmeta> +<refentrytitle>make.year.ranges</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>make.year.ranges</refname> +<refpurpose>Collate copyright years into ranges?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="make.year.ranges.frag"><xsl:param name="make.year.ranges" select="0"></xsl:param></programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, multiple copyright <tag>year</tag> 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. If a year element contains a dash or +a comma, then that year element will not be merged into +any range. +</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="author.othername.in.middle"> +<refmeta> +<refentrytitle>author.othername.in.middle</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>author.othername.in.middle</refname> +<refpurpose>Is <tag>othername</tag> in <tag>author</tag> a +middle name?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="author.othername.in.middle.frag"> +<xsl:param name="author.othername.in.middle" select="1"></xsl:param></programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, the <tag>othername</tag> of an <tag>author</tag> +appears between the <tag>firstname</tag> and +<tag>surname</tag>. Otherwise, <tag>othername</tag> +is suppressed. +</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="blurb.on.titlepage.enabled"> +<refmeta> +<refentrytitle>blurb.on.titlepage.enabled</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>blurb.on.titlepage.enabled</refname> +<refpurpose>Display personblurb and authorblurb on title pages?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="blurb.on.titlepage.enabled.frag"> +<xsl:param name="blurb.on.titlepage.enabled" select="0"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, output from <tag>authorblurb</tag> and +<tag>personblurb</tag> elements is displayed on title pages. If zero +(the default), output from those elements is suppressed on title pages +(unless you are using a <literal>titlepage</literal> customization +that causes them to be included).</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="contrib.inline.enabled"> +<refmeta> +<refentrytitle>contrib.inline.enabled</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>contrib.inline.enabled</refname> +<refpurpose>Display contrib output inline?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="contrib.inline.enabled.frag"><xsl:param name="contrib.inline.enabled">1</xsl:param></programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero (the default), output of the <tag>contrib</tag> element is +displayed as inline content rather than as block content.</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="editedby.enabled"> +<refmeta> +<refentrytitle>editedby.enabled</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>editedby.enabled</refname> +<refpurpose>Display “Edited by” heading above editor name?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="editedby.enabled.frag"><xsl:param name="editedby.enabled">1</xsl:param></programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, a localized <emphasis role="bold">Edited +by</emphasis> heading is displayed above editor names in output of the +<tag>editor</tag> element.</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="abstract.notitle.enabled"> +<refmeta> +<refentrytitle>abstract.notitle.enabled</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>abstract.notitle.enabled</refname> +<refpurpose>Suppress display of abstract titles?</refpurpose> +</refnamediv> +<refsynopsisdiv> + <programlisting xml:id="abstract.notitle.enabled.frag"><xsl:param name="abstract.notitle.enabled" select="0"></xsl:param></programlisting> +</refsynopsisdiv> +<refsection><info><title>Description</title></info> +<para>If non-zero, in output of the <tag>abstract</tag> element on titlepages, +display of the abstract title is suppressed.</para> +</refsection> +</refentry> + +<refentry version="5.0" xml:id="othercredit.like.author.enabled"> +<refmeta> +<refentrytitle>othercredit.like.author.enabled</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>othercredit.like.author.enabled</refname> +<refpurpose>Display othercredit in same style as author?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="othercredit.like.author.enabled.frag"><xsl:param name="othercredit.like.author.enabled">0</xsl:param></programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, output of the +<tag>othercredit</tag> element on titlepages is displayed in +the same style as <tag>author</tag> and +<tag>editor</tag> output. If zero then +<tag>othercredit</tag> output is displayed using a style +different than that of <tag>author</tag> and +<tag>editor</tag>.</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="generate.legalnotice.link"> +<refmeta> +<refentrytitle>generate.legalnotice.link</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>generate.legalnotice.link</refname> +<refpurpose>Write legalnotice to separate chunk and generate link?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="generate.legalnotice.link.frag"><xsl:param name="generate.legalnotice.link" select="0"></xsl:param></programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If the value of <parameter>generate.legalnotice.link</parameter> +is non-zero, the stylesheet: + +<itemizedlist> + <listitem> + <para>writes the contents of <tag>legalnotice</tag> to a separate + HTML file</para> + </listitem> + <listitem> + <para>inserts a hyperlink to the <tag>legalnotice</tag> file</para> + </listitem> + <listitem> + <para>adds (in the HTML <literal>head</literal>) either a single + <literal>link</literal> or element or multiple + <literal>link</literal> elements (depending on the value of the + <parameter>html.head.legalnotice.link.multiple</parameter> + parameter), with the value or values derived from the + <parameter>html.head.legalnotice.link.types</parameter> + parameter</para> + </listitem> + </itemizedlist> + + Otherwise, if <parameter>generate.legalnotice.link</parameter> is + zero, <tag>legalnotice</tag> contents are rendered on the title + page.</para> + +<para>The name of the separate HTML file is computed as follows: + +<orderedlist> +<listitem> + <para>If a filename is given by the <tag class="xmlpi">dbhtml filename</tag> +processing instruction, that filename is used.</para> +</listitem> +<listitem> + <para>If the legalnotice has an <tag class="attribute">id</tag>/<tag class="attribute">xml:id</tag> +attribute, and if <parameter>use.id.as.filename</parameter> != 0, the filename +is the concatenation of the id value and the value of the <parameter>html.ext</parameter> +parameter.</para> +</listitem> +<listitem> + <para>If the legalnotice does not have an <tag class="attribute">id</tag>/<tag class="attribute">xml:id</tag> + attribute, or if <parameter>use.id.as.filename</parameter> = 0, the filename is the concatenation of "ln-", +auto-generated id value, and <parameter>html.ext</parameter> value. + </para> +</listitem> +</orderedlist> + +</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="generate.revhistory.link"> +<refmeta> +<refentrytitle>generate.revhistory.link</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>generate.revhistory.link</refname> +<refpurpose>Write revhistory to separate chunk and generate link?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="generate.revhistory.link.frag"><xsl:param name="generate.revhistory.link" select="0"></xsl:param></programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, the contents of <tag>revhistory</tag> are written +to a separate HTML file and a link to the file is +generated. Otherwise, <tag>revhistory</tag> contents are rendered on +the title page.</para> + +<para>The name of the separate HTML file is computed as follows: + +<orderedlist> +<listitem> + <para>If a filename is given by the <tag class="xmlpi">dbhtml filename</tag> processing instruction, +that filename is used.</para> +</listitem> +<listitem> + <para>If the revhistory has an <tag class="attribute">id</tag>/<tag class="attribute">xml:id</tag> +attribute, and if <parameter>use.id.as.filename</parameter> != 0, the filename is the concatenation of +the id value and the value of the <parameter>html.ext</parameter> parameter.</para> +</listitem> +<listitem> + <para>If the revhistory does not have an <tag class="attribute">id</tag>/<tag class="attribute">xml:id</tag> +attribute, or if <parameter>use.id.as.filename</parameter> = 0, the filename is the concatenation of "rh-", +auto-generated id value, and <parameter>html.ext</parameter> value. + </para> +</listitem> +</orderedlist> + +</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="html.head.legalnotice.link.types"> +<refmeta> +<refentrytitle>html.head.legalnotice.link.types</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>html.head.legalnotice.link.types</refname> +<refpurpose>Specifies link types for legalnotice link in html head</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="html.head.legalnotice.link.types.frag"> +<xsl:param name="html.head.legalnotice.link.types">copyright</xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The value of +<parameter>html.head.legalnotice.link.types</parameter> is a +space-separated list of link types, as described in <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://www.w3.org/TR/html401/types.html#type-links">Section 6.12 +of the HTML 4.01 specification</link>. If the value of the +<parameter>generate.legalnotice.link</parameter> parameter is +non-zero, then the stylesheet generates (in the +<literal>head</literal> section of the HTML source) either a single +HTML <literal>link</literal> element or, if the value of the +<parameter>html.head.legalnotice.link.multiple</parameter> is +non-zero, one <literal>link</literal> element for each link type +specified. Each <literal>link</literal> has the following attributes: + +<itemizedlist> + <listitem> + <para>a <tag class="attribute">rel</tag> attribute whose + value is derived from the value of + <parameter>html.head.legalnotice.link.types</parameter></para> + </listitem> + <listitem> + <para>an <tag class="attribute">href</tag> attribute whose + value is set to the URL of the file containing the + <tag>legalnotice</tag></para> + </listitem> + <listitem> + <para>a <tag class="attribute">title</tag> attribute whose + value is set to the title of the corresponding + <tag>legalnotice</tag> (or a title programatically + determined by the stylesheet)</para> + </listitem> +</itemizedlist> + +For example: + +<screen> <link rel="license" href="ln-id2524073.html" title="Legal Notice"></screen> +</para> + +<refsection><info><title>About the default value</title></info> + + <para>In an ideal world, the default value of + <parameter>html.head.legalnotice.link.types</parameter> would + probably be “<literal>license</literal>”, since the content of the + DocBook <tag>legalnotice</tag> is typically license + information, not copyright information. However, the default value + is “<literal>copyright</literal>” for pragmatic reasons: because + that’s among the set of “recognized link types” listed in <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://www.w3.org/TR/html401/types.html#type-links">Section + 6.12 of the HTML 4.01 specification</link>, and because certain + browsers and browser extensions are preconfigured to recognize that + value.</para> +</refsection> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="html.head.legalnotice.link.multiple"> +<refmeta> +<refentrytitle>html.head.legalnotice.link.multiple</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>html.head.legalnotice.link.multiple</refname> +<refpurpose>Generate multiple link instances in html head for legalnotice?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="html.head.legalnotice.link.multiple.frag"> +<xsl:param name="html.head.legalnotice.link.multiple" select="1"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If <parameter>html.head.legalnotice.link.multiple</parameter> is +non-zero and the value of +<parameter>html.head.legalnotice.link.types</parameter> contains +multiple link types, then the stylesheet generates (in the +<literal>head</literal> section of the HTML source) one +<literal>link</literal> element for each link type specified. For +example, if the value of +<parameter>html.head.legalnotice.link.types</parameter> is +“<literal>copyright license</literal>”: + +<screen> <link rel="copyright" href="ln-id2524073.html" title="Legal Notice"> + <link rel="license" href="ln-id2524073.html" title="Legal Notice"></screen> + + Otherwise, the stylesheet generates generates a single + <literal>link</literal> instance; for example: + +<screen> <link rel="copyright license" href="ln-id2524073.html" title="Legal Notice"></screen> + +</para> +</refsection> +</refentry> + +</reference> +<reference xml:id="refentry"><title>Reference Pages</title> +<refentry version="5.0" xml:id="funcsynopsis.decoration"> +<refmeta> +<refentrytitle>funcsynopsis.decoration</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>funcsynopsis.decoration</refname> +<refpurpose>Decorate elements of a <tag>funcsynopsis</tag>?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="funcsynopsis.decoration.frag"> +<xsl:param name="funcsynopsis.decoration" select="1"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, elements of the <tag>funcsynopsis</tag> 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. +</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="funcsynopsis.style"> +<refmeta> +<refentrytitle>funcsynopsis.style</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">list</refmiscinfo> +<refmiscinfo class="other" otherclass="value">ansi</refmiscinfo> +<refmiscinfo class="other" otherclass="value">kr</refmiscinfo> +</refmeta> +<refnamediv> +<refname>funcsynopsis.style</refname> +<refpurpose>What style of <tag>funcsynopsis</tag> should be generated?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="funcsynopsis.style.frag"><xsl:param name="funcsynopsis.style">kr</xsl:param></programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If <parameter>funcsynopsis.style</parameter> is <literal>ansi</literal>, +ANSI-style function synopses are generated for a +<tag>funcsynopsis</tag>, otherwise K&R-style +function synopses are generated. +</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="function.parens"> +<refmeta> +<refentrytitle>function.parens</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>function.parens</refname> +<refpurpose>Generate parens after a function?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="function.parens.frag"> +<xsl:param name="function.parens" select="0"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, the formatting of a <tag>function</tag> element +will include generated parentheses. +</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="refentry.generate.name"> +<refmeta> +<refentrytitle>refentry.generate.name</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>refentry.generate.name</refname> +<refpurpose>Output NAME header before <tag>refname</tag>s?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="refentry.generate.name.frag"> +<xsl:param name="refentry.generate.name" select="1"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, a "NAME" section title is output before the list +of <tag>refname</tag>s. This parameter and +<parameter>refentry.generate.title</parameter> are mutually +exclusive. This means that if you change this parameter to zero, you +should set <parameter>refentry.generate.title</parameter> to non-zero unless +you want get quite strange output. +</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="refentry.generate.title"> +<refmeta> +<refentrytitle>refentry.generate.title</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>refentry.generate.title</refname> +<refpurpose>Output title before <tag>refname</tag>s?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="refentry.generate.title.frag"> +<xsl:param name="refentry.generate.title" select="0"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, the reference page title or first name is +output before the list of <tag>refname</tag>s. This parameter and +<parameter>refentry.generate.name</parameter> are mutually exclusive. +This means that if you change this parameter to non-zero, you +should set <parameter>refentry.generate.name</parameter> to zero unless +you want get quite strange output.</para> + + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="refentry.xref.manvolnum"> +<refmeta> +<refentrytitle>refentry.xref.manvolnum</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>refentry.xref.manvolnum</refname> +<refpurpose>Output <tag>manvolnum</tag> as part of +<tag>refentry</tag> cross-reference?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="refentry.xref.manvolnum.frag"> +<xsl:param name="refentry.xref.manvolnum" select="1"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>if non-zero, the <tag>manvolnum</tag> is used when cross-referencing +<tag>refentry</tag>s, either with <tag>xref</tag> +or <tag>citerefentry</tag>. +</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="citerefentry.link"> +<refmeta> +<refentrytitle>citerefentry.link</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>citerefentry.link</refname> +<refpurpose>Generate URL links when cross-referencing RefEntrys?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="citerefentry.link.frag"> +<xsl:param name="citerefentry.link" select="0"></xsl:param></programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>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 <literal>generate.citerefentry.link</literal> template. +</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="refentry.separator"> +<refmeta> +<refentrytitle>refentry.separator</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>refentry.separator</refname> +<refpurpose>Generate a separator between consecutive RefEntry elements?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="refentry.separator.frag"> +<xsl:param name="refentry.separator" select="1"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If true, a separator will be generated between consecutive +reference pages. +</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="refclass.suppress"> +<refmeta> +<refentrytitle>refclass.suppress</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>refclass.suppress</refname> +<refpurpose>Suppress display of refclass contents?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="refclass.suppress.frag"> +<xsl:param name="refclass.suppress" select="0"></xsl:param></programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If the value of <parameter>refclass.suppress</parameter> is +non-zero, then display of <tag>refclass</tag> contents is +suppressed in output.</para> + +</refsection> +</refentry> + +</reference> +<reference xml:id="tables"><title>Tables</title> +<refentry version="5.0" xml:id="default.table.width"> +<refmeta> +<refentrytitle>default.table.width</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">length</refmiscinfo> +</refmeta> +<refnamediv> +<refname>default.table.width</refname> +<refpurpose>The default width of tables</refpurpose> +</refnamediv> +<refsynopsisdiv> +<programlisting xml:id="default.table.width.frag"> +<xsl:param name="default.table.width"></xsl:param> +</programlisting> +</refsynopsisdiv> +<refsection><info><title>Description</title></info> +<para>If non-zero, this value will be used for the +<literal>width</literal> attribute on <tag>table</tag>s that do not specify an +alternate width (with the <tag class="xmlpi">dbhtml table-width</tag> or +<tag class="xmlpi">dbfo table-width</tag> processing instruction).</para> +</refsection> +</refentry> + +<refentry version="5.0" xml:id="nominal.table.width"> +<refmeta> +<refentrytitle>nominal.table.width</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">length</refmiscinfo> +</refmeta> +<refnamediv> +<refname>nominal.table.width</refname> +<refpurpose>The (absolute) nominal width of tables</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="nominal.table.width.frag"> +<xsl:param name="nominal.table.width">6in</xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>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).</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="table.borders.with.css"> +<refmeta> +<refentrytitle>table.borders.with.css</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>table.borders.with.css</refname> +<refpurpose>Use CSS to specify table, row, and cell borders?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="table.borders.with.css.frag"> +<xsl:param name="table.borders.with.css" select="0"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, CSS will be used to draw table borders. +</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="table.cell.border.style"> +<refmeta> +<refentrytitle>table.cell.border.style</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">list</refmiscinfo> +<refmiscinfo class="other" otherclass="value">none</refmiscinfo> +<refmiscinfo class="other" otherclass="value">solid</refmiscinfo> +<refmiscinfo class="other" otherclass="value">dotted</refmiscinfo> +<refmiscinfo class="other" otherclass="value">dashed</refmiscinfo> +<refmiscinfo class="other" otherclass="value">double</refmiscinfo> +<refmiscinfo class="other" otherclass="value">groove</refmiscinfo> +<refmiscinfo class="other" otherclass="value">ridge</refmiscinfo> +<refmiscinfo class="other" otherclass="value">inset</refmiscinfo> +<refmiscinfo class="other" otherclass="value">outset</refmiscinfo> +<refmiscinfo class="other" otherclass="value">solid</refmiscinfo> +</refmeta> +<refnamediv> +<refname>table.cell.border.style</refname> +<refpurpose>Specifies the border style of table cells</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="table.cell.border.style.frag"> +<xsl:param name="table.cell.border.style">solid</xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Specifies the border style of table cells.</para> + +<note> + <para>To control properties of cell borders in HTML output, you must also turn on the + <parameter>table.borders.with.css</parameter> parameter.</para> +</note> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="table.cell.border.thickness"> +<refmeta> +<refentrytitle>table.cell.border.thickness</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">length</refmiscinfo> +</refmeta> +<refnamediv> +<refname>table.cell.border.thickness</refname> +<refpurpose>Specifies the thickness of table cell borders</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="table.cell.border.thickness.frag"> +<xsl:param name="table.cell.border.thickness">0.5pt</xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, specifies the thickness of borders on table +cells. The units are points. See <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://www.w3.org/TR/CSS21/box.html#border-width-properties"> +CSS</link></para> + +<note> + <para>To control properties of cell borders in HTML output, you must also turn on the + <parameter>table.borders.with.css</parameter> parameter.</para> +</note> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="table.cell.border.color"> +<refmeta> +<refentrytitle>table.cell.border.color</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">color</refmiscinfo> +</refmeta> +<refnamediv> +<refname>table.cell.border.color</refname> +<refpurpose>Specifies the border color of table cells</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="table.cell.border.color.frag"> +<xsl:param name="table.cell.border.color"></xsl:param> + +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Set the color of table cell borders. If non-zero, the value is used +for the border coloration. See <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://www.w3.org/TR/CSS21/syndata.html#value-def-color">CSS</link>. A +<literal>color</literal> 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.</para> + +<note> + <para>To control properties of cell borders in HTML output, you must also turn on the + <parameter>table.borders.with.css</parameter> parameter.</para> +</note> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="table.frame.border.style"> +<refmeta> +<refentrytitle>table.frame.border.style</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">list</refmiscinfo> +<refmiscinfo class="other" otherclass="value">none</refmiscinfo> +<refmiscinfo class="other" otherclass="value">solid</refmiscinfo> +<refmiscinfo class="other" otherclass="value">dotted</refmiscinfo> +<refmiscinfo class="other" otherclass="value">dashed</refmiscinfo> +<refmiscinfo class="other" otherclass="value">double</refmiscinfo> +<refmiscinfo class="other" otherclass="value">groove</refmiscinfo> +<refmiscinfo class="other" otherclass="value">ridge</refmiscinfo> +<refmiscinfo class="other" otherclass="value">inset</refmiscinfo> +<refmiscinfo class="other" otherclass="value">outset</refmiscinfo> +<refmiscinfo class="other" otherclass="value">solid</refmiscinfo> +</refmeta> +<refnamediv> +<refname>table.frame.border.style</refname> +<refpurpose>Specifies the border style of table frames</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="table.frame.border.style.frag"> +<xsl:param name="table.frame.border.style">solid</xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Specifies the border style of table frames.</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="table.frame.border.thickness"> +<refmeta> +<refentrytitle>table.frame.border.thickness</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">length</refmiscinfo> +</refmeta> +<refnamediv> +<refname>table.frame.border.thickness</refname> +<refpurpose>Specifies the thickness of the frame border</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="table.frame.border.thickness.frag"> +<xsl:param name="table.frame.border.thickness">0.5pt</xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Specifies the thickness of the border on the table's frame.</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="table.frame.border.color"> +<refmeta> +<refentrytitle>table.frame.border.color</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">color</refmiscinfo> +</refmeta> +<refnamediv> +<refname>table.frame.border.color</refname> +<refpurpose>Specifies the border color of table frames</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="table.frame.border.color.frag"> +<xsl:param name="table.frame.border.color"></xsl:param> + +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Specifies the border color of table frames.</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="default.table.frame"> +<refmeta> +<refentrytitle>default.table.frame</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>default.table.frame</refname> +<refpurpose>The default framing of tables</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="default.table.frame.frag"> +<xsl:param name="default.table.frame">all</xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>This value will be used when there is no frame attribute on the +table. </para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="html.cellspacing"> +<refmeta> +<refentrytitle>html.cellspacing</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo> +</refmeta> +<refnamediv> +<refname>html.cellspacing</refname> +<refpurpose>Default value for cellspacing in HTML tables</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="html.cellspacing.frag"> +<xsl:param name="html.cellspacing"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>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%</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="html.cellpadding"> +<refmeta> +<refentrytitle>html.cellpadding</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo> +</refmeta> +<refnamediv> +<refname>html.cellpadding</refname> +<refpurpose>Default value for cellpadding in HTML tables</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="html.cellpadding.frag"> +<xsl:param name="html.cellpadding"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>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%</para> + +</refsection> +</refentry> + +</reference> +<reference xml:id="qa"><title>QAndASet</title> +<refentry version="5.0" xml:id="qanda.defaultlabel"> +<refmeta> +<refentrytitle>qanda.defaultlabel</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">list</refmiscinfo> +<refmiscinfo class="other" otherclass="value">number</refmiscinfo> +<refmiscinfo class="other" otherclass="value">qanda</refmiscinfo> +<refmiscinfo class="other" otherclass="value">none</refmiscinfo> +</refmeta> +<refnamediv> +<refname>qanda.defaultlabel</refname> +<refpurpose>Sets the default for defaultlabel on QandASet.</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="qanda.defaultlabel.frag"> +<xsl:param name="qanda.defaultlabel">number</xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If no <literal>defaultlabel</literal> attribute is specified on +a <tag>qandaset</tag>, this value is used. It is generally one of the legal +values for the defaultlabel attribute (<literal>none</literal>, +<literal>number</literal> or +<literal>qanda</literal>), or one of the additional stylesheet-specific values +(<literal>qnumber</literal> or <literal>qnumberanda</literal>). +The default value is 'number'. +</para> +<para>The values are rendered as follows:</para> +<variablelist> +<varlistentry><term><literal>qanda</literal></term> +<listitem> +<para><tag>question</tag>s are labeled "Q:" and +<tag>answer</tag>s are labeled "A:". </para> +</listitem> +</varlistentry> + +<varlistentry><term><literal>number</literal></term> +<listitem> +<para>The questions are enumerated and the answers +are not labeled. </para> +</listitem> +</varlistentry> + +<varlistentry><term><literal>qnumber</literal></term> +<listitem> +<para>The questions are labeled "Q:" followed by a number, and answers are not +labeled. +When sections are numbered, adding a label +to the number distinguishes the question numbers +from the section numbers. +This value is not allowed in the +<tag class="attribute">defaultlabel</tag> attribute +of a <tag>qandaset</tag> element.</para> +</listitem> +</varlistentry> + +<varlistentry><term><literal>qnumberanda</literal></term> +<listitem> +<para>The questions are labeled "Q:" followed by a number, and +the answers are labeled "A:". +When sections are numbered, adding a label +to the number distinguishes the question numbers +from the section numbers. +This value is not allowed in the +<tag class="attribute">defaultlabel</tag> attribute +of a <tag>qandaset</tag> element.</para> +</listitem> +</varlistentry> + +<varlistentry><term><literal>none</literal></term> +<listitem> +<para>No distinguishing label precedes Questions or Answers. +</para> +</listitem> +</varlistentry> +</variablelist> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="qanda.inherit.numeration"> +<refmeta> +<refentrytitle>qanda.inherit.numeration</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>qanda.inherit.numeration</refname> +<refpurpose>Does enumeration of QandASet components inherit the numeration of parent elements?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="qanda.inherit.numeration.frag"> +<xsl:param name="qanda.inherit.numeration" select="1"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, numbered <tag>qandadiv</tag> elements and +<tag>question</tag> and <tag>answer</tag> inherit the enumeration of +the ancestors of the <tag>qandaset</tag>. +</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="qanda.in.toc"> +<refmeta> +<refentrytitle>qanda.in.toc</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>qanda.in.toc</refname> +<refpurpose>Should qandaentry questions appear in +the document table of contents?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="qanda.in.toc.frag"><xsl:param name="qanda.in.toc" select="0"></xsl:param></programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If true (non-zero), then the generated table of contents +for a document will include <tag>qandaset</tag> titles, +<tag>qandadiv</tag> titles, +and <tag>question</tag> elements. The default value (zero) excludes +them from the TOC. +</para> +<para>This parameter does not affect any tables of contents +that may be generated inside a qandaset or qandadiv. +</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="qanda.nested.in.toc"> +<refmeta> +<refentrytitle>qanda.nested.in.toc</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>qanda.nested.in.toc</refname> +<refpurpose>Should nested answer/qandaentry instances appear in TOC?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="qanda.nested.in.toc.frag"> +<xsl:param name="qanda.nested.in.toc" select="0"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, instances of <tag>qandaentry</tag> +that are children of <tag>answer</tag> elements are shown in +the TOC.</para> + +</refsection> +</refentry> + +</reference> +<reference xml:id="links"><title>Linking</title> +<refentry version="5.0" xml:id="target.database.document"> +<refmeta> +<refentrytitle>target.database.document</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo> +</refmeta> +<refnamediv> +<refname>target.database.document</refname> +<refpurpose>Name of master database file for resolving +olinks</refpurpose> +</refnamediv> +<refsynopsisdiv> +<programlisting xml:id="target.database.document.frag"> + <xsl:param name="target.database.document">olinkdb.xml</xsl:param> +</programlisting> +</refsynopsisdiv> +<refsection><info><title>Description</title></info> + +<para> +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 <filename>olinkdb.xml</filename>.</para> + +<para>The data structure of the file is defined in the +<filename>targetdatabase.dtd</filename> 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 +<parameter>targets.filename</parameter>. </para> </refsection> +</refentry> + +<refentry version="5.0" xml:id="targets.filename"> +<refmeta> +<refentrytitle>targets.filename</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>targets.filename</refname> +<refpurpose>Name of cross reference targets data file</refpurpose> +</refnamediv> +<refsynopsisdiv> <programlisting xml:id="targets.filename.frag"> +<xsl:param name="targets.filename">target.db</xsl:param> +</programlisting> +</refsynopsisdiv> +<refsection><info><title>Description</title></info> + +<para> +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 <filename>target.db</filename>. +The name must agree with that used in the target database +used to resolve olinks during processing. +See also <parameter>target.database.document</parameter>. +</para> +</refsection> +</refentry> + +<refentry version="5.0" xml:id="olink.base.uri"> +<refmeta> +<refentrytitle>olink.base.uri</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo> +</refmeta> +<refnamediv> +<refname>olink.base.uri</refname> +<refpurpose>Base URI used in olink hrefs</refpurpose> +</refnamediv> +<refsynopsisdiv> <programlisting xml:id="olink.base.uri.frag"> +<xsl:param name="olink.base.uri"></xsl:param> +</programlisting> +</refsynopsisdiv> +<refsection><info><title>Description</title></info> + +<para>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 +<literal>#idref</literal>. 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 +<literal>outfile.html#idref</literal>, which can be reached as links +from other documents.</para> +</refsection> +</refentry> + +<refentry version="5.0" xml:id="use.local.olink.style"> +<refmeta> +<refentrytitle>use.local.olink.style</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>use.local.olink.style</refname> +<refpurpose>Process olinks using xref style of current +document</refpurpose> +</refnamediv> +<refsynopsisdiv> <programlisting xml:id="use.local.olink.style.frag"> +<xsl:param name="use.local.olink.style" select="0"></xsl:param> </programlisting> +</refsynopsisdiv> +<refsection><info><title>Description</title></info> + +<para>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 <parameter>use.local.olink.style</parameter> 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.</para> +</refsection> +</refentry> + +<refentry version="5.0" xml:id="current.docid"> +<refmeta> +<refentrytitle>current.docid</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>current.docid</refname> +<refpurpose>targetdoc identifier for the document being +processed</refpurpose> +</refnamediv> +<refsynopsisdiv> <programlisting xml:id="current.docid.frag"> +<xsl:param name="current.docid"></xsl:param> +</programlisting> +</refsynopsisdiv> +<refsection><info><title>Description</title></info> + +<para>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 <literal>targetdoc</literal> identifiers for both documents, as they appear in the <parameter>target.database.document</parameter> 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. </para> +<para>This parameter can also be used for print output. If an olink's <literal>targetdoc</literal> id differs from the <literal>current.docid</literal>, 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 <parameter>olink.doctitle</parameter> to enable that feature.</para> +</refsection> +</refentry> + +<refentry version="5.0" xml:id="olink.doctitle"> +<refmeta> +<refentrytitle>olink.doctitle</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">list</refmiscinfo> +<refmiscinfo class="other" otherclass="value">no</refmiscinfo> +<refmiscinfo class="other" otherclass="value">yes</refmiscinfo> +<refmiscinfo class="other" otherclass="value">maybe</refmiscinfo> +</refmeta> +<refnamediv> +<refname>olink.doctitle</refname> +<refpurpose>show the document title for external olinks?</refpurpose> + +</refnamediv> +<refsynopsisdiv> <programlisting xml:id="olink.doctitle.frag"> +<xsl:param name="olink.doctitle">no</xsl:param> +</programlisting> +</refsynopsisdiv> +<refsection><info><title>Description</title></info> + +<para>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.</para> +<itemizedlist> +<listitem> +<para>This <parameter>olink.doctitle</parameter> parameter +should be set to either <literal>yes</literal> or <literal>maybe</literal> +to enable this feature. +</para> +</listitem> +<listitem> +<para>And you should also set the <parameter>current.docid</parameter> +parameter to the document id for the document currently +being processed for output. +</para> +</listitem> +</itemizedlist> + +<para> +Then if an olink's <literal>targetdoc</literal> id differs from +the <literal>current.docid</literal> 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. </para> + +<para>The text for the target document's title is copied from the +olink database from the <tag>ttl</tag> element +of the top-level <tag>div</tag> for that document. +If that <tag>ttl</tag> element is missing or empty, +no title is output. +</para> + +<para>The supported values for <parameter>olink.doctitle</parameter> are: +</para> +<variablelist> +<varlistentry> +<term><literal>yes</literal></term> +<listitem> +<para> +Always insert the title to the target document if it is not +the current document. +</para> +</listitem> +</varlistentry> +<varlistentry> +<term><literal>no</literal></term> +<listitem> +<para> +Never insert the title to the target document, even if requested +in an <tag class="attribute">xrefstyle</tag> attribute. +</para> +</listitem> +</varlistentry> +<varlistentry> +<term><literal>maybe</literal></term> +<listitem> +<para> +Only insert the title to the target document, if requested +in an <tag class="attribute">xrefstyle</tag> attribute. +</para> +</listitem> +</varlistentry> +</variablelist> +<para>An <tag class="attribute">xrefstyle</tag> attribute +may override the global setting for individual olinks. +The following values are supported in an +<tag class="attribute">xrefstyle</tag> +attribute using the <literal>select:</literal> syntax: +</para> + +<variablelist> +<varlistentry> +<term><literal>docname</literal></term> +<listitem> +<para> +Insert the target document name for this olink using the +<literal>docname</literal> gentext template, but only +if the value of <parameter>olink.doctitle</parameter> +is not <literal>no</literal>. +</para> +</listitem> +</varlistentry> +<varlistentry> +<term><literal>docnamelong</literal></term> +<listitem> +<para> +Insert the target document name for this olink using the +<literal>docnamelong</literal> gentext template, but only +if the value of <parameter>olink.doctitle</parameter> +is not <literal>no</literal>. +</para> +</listitem> +</varlistentry> +<varlistentry> +<term><literal>nodocname</literal></term> +<listitem> +<para> +Omit the target document name even if +the value of <parameter>olink.doctitle</parameter> +is <literal>yes</literal>. +</para> +</listitem> +</varlistentry> +</variablelist> +<para>Another way of inserting the target document name +for a single olink is to employ an +<tag class="attribute">xrefstyle</tag> +attribute using the <literal>template:</literal> syntax. +The <literal>%o</literal> 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 <parameter>olink.doctitle</parameter>. +</para> +<para>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. +</para> +</refsection> +</refentry> + +<refentry version="5.0" xml:id="olink.debug"> +<refmeta> +<refentrytitle>olink.debug</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>olink.debug</refname> +<refpurpose>Turn on debugging messages for olinks</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="olink.debug.frag"> +<xsl:param name="olink.debug" select="0"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>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. +</para> + +<para>You may need to read through the olink XSL templates +to understand the context for some of the debug messages. +</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="olink.properties"> +<refmeta> +<refentrytitle>olink.properties</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>olink.properties</refname> +<refpurpose>Properties associated with the cross-reference +text of an olink.</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="olink.properties.frag"> +<xsl:attribute-set name="olink.properties"> + <xsl:attribute name="show-destination">replace</xsl:attribute> +</xsl:attribute-set> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>This <literal>attribute set</literal> is applied to the +<literal>fo:basic-link</literal> element of an olink. It is not applied to the +optional page number or optional title of the external +document.</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="olink.lang.fallback.sequence"> +<refmeta> +<refentrytitle>olink.lang.fallback.sequence</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>olink.lang.fallback.sequence</refname> +<refpurpose>look up translated documents if olink not found?</refpurpose> + +</refnamediv> +<refsynopsisdiv> <programlisting xml:id="olink.lang.fallback.sequence.frag"> +<xsl:param name="olink.lang.fallback.sequence"></xsl:param> +</programlisting> +</refsynopsisdiv> +<refsection><info><title>Description</title></info> + + +<para>This parameter defines a list of lang values +to search among to resolve olinks. +</para> + +<para>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 +<tag class="attribute">lang</tag> attribute, otherwise the +value of the <parameter>l10n.gentext.default.lang</parameter> +parameter. +</para> + +<para>An olink database can contain target data for the same +document in multiple languages. Each set of data has the +same value for the <tag>targetdoc</tag> attribute in +the <tag>document</tag> element in the database, but with a +different <tag>lang</tag> attribute value. +</para> + +<para>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.</para> + +<para>The <parameter>olink.lang.fallback.sequence</parameter> +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.</para> + +<para>For example, a document might be written in German +and contain an olink with +<literal>targetdoc="adminguide"</literal>. +When the document is processed, the processor +first looks for a target dataset in the +olink database starting with:</para> + +<literallayout><literal><document targetdoc="adminguide" lang="de"></literal>. +</literallayout> + +<para>If there is no such element, then the +<parameter>olink.lang.fallback.sequence</parameter> +parameter is consulted. +If its value is, for example, <quote>fr en</quote>, then the processor next +looks for <literal>targetdoc="adminguide" lang="fr"</literal>, and +then for <literal>targetdoc="adminguide" lang="en"</literal>. +If there is still no match, it looks for +<literal>targetdoc="adminguide"</literal> with no +lang attribute. +</para> + +<para>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. +</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="insert.olink.page.number"> +<refmeta> +<refentrytitle>insert.olink.page.number</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">list</refmiscinfo> +<refmiscinfo class="other" otherclass="value">no</refmiscinfo> +<refmiscinfo class="other" otherclass="value">yes</refmiscinfo> +<refmiscinfo class="other" otherclass="value">maybe</refmiscinfo> +</refmeta> +<refnamediv> +<refname>insert.olink.page.number</refname> +<refpurpose>Turns page numbers in olinks on and off</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="insert.olink.page.number.frag"> +<xsl:param name="insert.olink.page.number">no</xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The value of this parameter determines if +cross references made between documents with +<tag>olink</tag> will +include page number citations. +In most cases this is only applicable to references in printed output. +</para> +<para>The parameter has three possible values. +</para> +<variablelist> +<varlistentry> +<term>no</term> +<listitem><para>No page number references will be generated for olinks. +</para></listitem> +</varlistentry> +<varlistentry> +<term>yes</term> +<listitem><para>Page number references will be generated +for all <tag>olink</tag> references. +The style of page reference may be changed +if an <tag class="attribute">xrefstyle</tag> +attribute is used. +</para></listitem> +</varlistentry> +<varlistentry> +<term>maybe</term> +<listitem><para>Page number references will not be generated +for an <tag>olink</tag> element unless +it has an +<tag class="attribute">xrefstyle</tag> +attribute whose value specifies a page reference. +</para></listitem> +</varlistentry> +</variablelist> +<para>Olinks that point to targets within the same document +are treated as <tag>xref</tag>s, and controlled by +the <parameter>insert.xref.page.number</parameter> parameter. +</para> + +<para>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 +(<tag>div</tag> or <tag>obj</tag>) +must have a <tag class="attribute">page</tag> 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. +</para> + + + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="insert.olink.pdf.frag"> +<refmeta> +<refentrytitle>insert.olink.pdf.frag</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>insert.olink.pdf.frag</refname> +<refpurpose>Add fragment identifiers for links into PDF files</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="insert.olink.pdf.frag.frag"> +<xsl:param name="insert.olink.pdf.frag" select="0"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The value of this parameter determines whether +the cross reference URIs to PDF documents made with +<tag>olink</tag> will +include fragment identifiers. +</para> + +<para>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. +</para> + +<para>If <parameter>insert.olink.pdf.frag</parameter> 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 +<parameter>olink.base.uri</parameter> parameter, the +value of the <tag class="attribute">baseuri</tag> +attribute from the <tag class="element">document</tag> +element in the olink database with the matching +<tag class="attribute">targetdoc</tag> value, +and the value of the <tag class="attribute">href</tag> +attribute for the targeted element in the olink database. +The <tag class="attribute">href</tag> attribute +contains the fragment identifier. +</para> + +<para>If <parameter>insert.olink.pdf.frag</parameter> is set +to zero (the default value), then +the <tag class="attribute">href</tag> 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 +<tag class="attribute">baseuri</tag> attribute +from the matching <tag class="element">document</tag> +element in the olink database ends with '.pdf'. +Any other olinks will still have the fragment identifier added. +</para> +</refsection> +</refentry> + +<refentry version="5.0" xml:id="prefer.internal.olink"> +<refmeta> +<refentrytitle>prefer.internal.olink</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>prefer.internal.olink</refname> +<refpurpose>Prefer a local olink reference to an external reference</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="prefer.internal.olink.frag"> +<xsl:param name="prefer.internal.olink" select="0"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>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. +</para> + +<para>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. +</para> + +<para>How do you write the link to custom.xml in intro.xml +so that it is interpreted correctly in all 3 documents?</para> +<itemizedlist> +<listitem><para>If you use xref, it will fail in user.xml.</para> +</listitem> +<listitem><para>If you use olink (pointing to reference.xml), +the reference in user.xml +will point to the customization section of the reference manual, while it is +actually available in user.xml.</para> +</listitem> +</itemizedlist> + +<para>If you set the <parameter>prefer.internal.olink</parameter> +parameter to a non-zero value, then the processor will +first look in the olink database +for the olink's <tag>targetptr</tag> attribute value +in document matching the <parameter>current.docid</parameter> +parameter value. If it isn't found there, then +it tries the document in the database +with the <tag>targetdoc</tag> +value that matches the olink's <tag>targetdoc</tag> +attribute. +</para> + +<para>This feature permits an olink reference to resolve to +the current document if there is an element +with an id matching the olink's <tag>targetptr</tag> +value. The current document's olink data must be +included in the target database for this to work.</para> + +<caution> +<para>There is a potential for incorrect links if +the same <tag>id</tag> attribute value is used for different +content in different documents. +Some of your olinks may be redirected to the current document +when they shouldn't be. It is not possible to control +individual olink instances.</para> +</caution> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="link.mailto.url"> +<refmeta> +<refentrytitle>link.mailto.url</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>link.mailto.url</refname> +<refpurpose>Mailto URL for the LINK REL=made HTML HEAD element</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="link.mailto.url.frag"> +<xsl:param name="link.mailto.url"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If not the empty string, this address will be used for the +rel=made <literal>link</literal> element in the html <literal>head</literal> +</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="ulink.target"> +<refmeta> +<refentrytitle>ulink.target</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>ulink.target</refname> +<refpurpose>The HTML anchor target for ULinks</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="ulink.target.frag"> +<xsl:param name="ulink.target">_top</xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If <parameter>ulink.target</parameter> is non-zero, its value will +be used for the <literal>target</literal> attribute +on anchors generated for <tag>ulink</tag>s.</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="olink.fragid"> +<refmeta> +<refentrytitle>olink.fragid</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>olink.fragid</refname> +<refpurpose>Names the fragment identifier portion of an OLink resolver query</refpurpose> +</refnamediv> +<refsynopsisdiv> +<programlisting xml:id="olink.fragid.frag"> +<xsl:param name="olink.fragid">fragid=</xsl:param> +</programlisting> +</refsynopsisdiv> +<refsection><info><title>Description</title></info> +<para>The fragment identifier portion of an <tag>olink</tag> target.</para> +</refsection> +</refentry> + +<refentry version="5.0" xml:id="olink.outline.ext"> +<refmeta> +<refentrytitle>olink.outline.ext</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>olink.outline.ext</refname> +<refpurpose>The extension of OLink outline files</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="olink.outline.ext.frag"> +<xsl:param name="olink.outline.ext">.olink</xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The extension to be expected for OLink outline files</para> +<para>Bob has this parameter as dead. Please don't use</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="olink.pubid"> +<refmeta> +<refentrytitle>olink.pubid</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>olink.pubid</refname> +<refpurpose>Names the public identifier portion of an OLink resolver query</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="olink.pubid.frag"> +<xsl:param name="olink.pubid">pubid</xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para/> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="olink.sysid"> +<refmeta> +<refentrytitle>olink.sysid</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>olink.sysid</refname> +<refpurpose>Names the system identifier portion of an OLink resolver query</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="olink.sysid.frag"> +<xsl:param name="olink.sysid">sysid</xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>FIXME</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="olink.resolver"> +<refmeta> +<refentrytitle>olink.resolver</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>olink.resolver</refname> +<refpurpose>The root name of the OLink resolver (usually a script)</refpurpose> +</refnamediv> +<refsynopsisdiv> +<programlisting xml:id="olink.resolver.frag"> + <xsl:param name="olink.resolver">/cgi-bin/olink</xsl:param> +</programlisting> +</refsynopsisdiv> +<refsection><info><title>Description</title></info> +<para>FIXME:</para> +</refsection> +</refentry> + +</reference> +<reference xml:id="xrefs"><title>Cross References</title> +<refentry version="5.0" xml:id="collect.xref.targets"> +<refmeta> +<refentrytitle>collect.xref.targets</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">list</refmiscinfo> +<refmiscinfo class="other" otherclass="value">no</refmiscinfo> +<refmiscinfo class="other" otherclass="value">yes</refmiscinfo> +<refmiscinfo class="other" otherclass="value">only</refmiscinfo> +</refmeta> +<refnamediv> +<refname>collect.xref.targets</refname> +<refpurpose>Controls whether cross reference data is +collected</refpurpose> +</refnamediv> +<refsynopsisdiv> <programlisting xml:id="collect.xref.targets.frag"> +<xsl:param name="collect.xref.targets">no</xsl:param> +</programlisting> +</refsynopsisdiv> +<refsection><info><title>Description</title></info> + +<para> +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 <literal>no</literal>, which means the data file is not generated during processing. The other choices are <literal>yes</literal>, which means the data file is created and the document is processed for output, and <literal>only</literal>, which means the data file is created but the document is not processed for output. +See also <parameter>targets.filename</parameter>. +</para> +</refsection> +</refentry> + +<refentry version="5.0" xml:id="insert.xref.page.number"> +<refmeta> +<refentrytitle>insert.xref.page.number</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">list</refmiscinfo> +<refmiscinfo class="other" otherclass="value">no</refmiscinfo> +<refmiscinfo class="other" otherclass="value">yes</refmiscinfo> +<refmiscinfo class="other" otherclass="value">maybe</refmiscinfo> +</refmeta> +<refnamediv> +<refname>insert.xref.page.number</refname> +<refpurpose>Turns page numbers in xrefs on and off</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="insert.xref.page.number.frag"> +<xsl:param name="insert.xref.page.number">no</xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The value of this parameter determines if +cross references (<tag>xref</tag>s) in +printed output will +include page number citations. +It has three possible values. +</para> +<variablelist> +<varlistentry> +<term>no</term> +<listitem><para>No page number references will be generated. +</para></listitem> +</varlistentry> +<varlistentry> +<term>yes</term> +<listitem><para>Page number references will be generated +for all <tag>xref</tag> elements. +The style of page reference may be changed +if an <tag class="attribute">xrefstyle</tag> +attribute is used. +</para></listitem> +</varlistentry> +<varlistentry> +<term>maybe</term> +<listitem><para>Page number references will not be generated +for an <tag>xref</tag> element unless +it has an +<tag class="attribute">xrefstyle</tag> +attribute whose value specifies a page reference. +</para></listitem> +</varlistentry> +</variablelist> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="use.role.as.xrefstyle"> +<refmeta> +<refentrytitle>use.role.as.xrefstyle</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>use.role.as.xrefstyle</refname> +<refpurpose>Use <tag class="attribute">role</tag> attribute for +<tag class="attribute">xrefstyle</tag> on <tag>xref</tag>?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="use.role.as.xrefstyle.frag"> +<xsl:param name="use.role.as.xrefstyle" select="1"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>In DocBook documents that conform to a schema older than V4.3, this parameter allows +<tag class="attribute">role</tag> to serve the purpose of specifying the cross reference style.</para> + +<para>If non-zero, the <tag class="attribute">role</tag> attribute on +<tag>xref</tag> will be used to select the cross reference style. +In DocBook V4.3, the <tag class="attribute">xrefstyle</tag> attribute was added for this purpose. +If the <tag class="attribute">xrefstyle</tag> attribute is present, +<tag class="attribute">role</tag> will be ignored, regardless of the setting +of this parameter.</para> + +</refsection> + +<refsection><info><title>Example</title></info> + +<para>The following small stylesheet shows how to configure the +stylesheets to make use of the cross reference style:</para> + +<programlisting><?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></programlisting> + +<para>With this stylesheet, the cross references in the following document:</para> + +<programlisting><?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></programlisting> + +<para>will appear as:</para> + +<informalexample> +<para>Normal: Chapter 1.</para> +<para>Title: Chapter 1, <emphasis>First Chapter</emphasis>.</para> +</informalexample> +</refsection> + +</refentry> + +<refentry version="5.0" xml:id="xref.with.number.and.title"> +<refmeta> +<refentrytitle>xref.with.number.and.title</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>xref.with.number.and.title</refname> +<refpurpose>Use number and title in cross references</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="xref.with.number.and.title.frag"> +<xsl:param name="xref.with.number.and.title" select="1"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>A cross reference may include the number (for example, the number of +an example or figure) and the <tag>title</tag> which is a required child of some +targets. This parameter inserts both the relevant number as well as +the title into the link. </para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="xref.label-page.separator"> +<refmeta> +<refentrytitle>xref.label-page.separator</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>xref.label-page.separator</refname> +<refpurpose>Punctuation or space separating label from page number in xref</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="xref.label-page.separator.frag"><xsl:param name="xref.label-page.separator"><xsl:text> </xsl:text></xsl:param></programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para> +This parameter allows you to control the punctuation of certain +types of generated cross reference text. +When cross reference text is generated for an +<tag class="element">xref</tag> or +<tag class="element">olink</tag> element +using an <tag class="attribute">xrefstyle</tag> attribute +that makes use of the <literal>select:</literal> 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. +</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="xref.label-title.separator"> +<refmeta> +<refentrytitle>xref.label-title.separator</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>xref.label-title.separator</refname> +<refpurpose>Punctuation or space separating label from title in xref</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="xref.label-title.separator.frag"><xsl:param name="xref.label-title.separator">: </xsl:param></programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para> +This parameter allows you to control the punctuation of certain +types of generated cross reference text. +When cross reference text is generated for an +<tag class="element">xref</tag> or +<tag class="element">olink</tag> element +using an <tag class="attribute">xrefstyle</tag> attribute +that makes use of the <literal>select:</literal> 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. +</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="xref.title-page.separator"> +<refmeta> +<refentrytitle>xref.title-page.separator</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>xref.title-page.separator</refname> +<refpurpose>Punctuation or space separating title from page number in xref</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="xref.title-page.separator.frag"><xsl:param name="xref.title-page.separator"><xsl:text> </xsl:text></xsl:param></programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para> +This parameter allows you to control the punctuation of certain +types of generated cross reference text. +When cross reference text is generated for an +<tag class="element">xref</tag> or +<tag class="element">olink</tag> element +using an <tag class="attribute">xrefstyle</tag> attribute +that makes use of the <literal>select:</literal> 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. +</para> + +</refsection> +</refentry> + +</reference> +<reference xml:id="lists"><title>Lists</title> +<refentry version="5.0" xml:id="segmentedlist.as.table"> +<refmeta> +<refentrytitle>segmentedlist.as.table</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>segmentedlist.as.table</refname> +<refpurpose>Format segmented lists as tables?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="segmentedlist.as.table.frag"> +<xsl:param name="segmentedlist.as.table" select="0"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, <tag>segmentedlist</tag>s will be formatted as +tables.</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="variablelist.as.table"> +<refmeta> +<refentrytitle>variablelist.as.table</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>variablelist.as.table</refname> +<refpurpose>Format <tag>variablelist</tag>s as tables?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="variablelist.as.table.frag"> +<xsl:param name="variablelist.as.table" select="0"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, <tag>variablelist</tag>s will be formatted as +tables. A processing instruction exists to specify a particular width for the +column containing the <tag>term</tag>s: +<tag class="xmlpi">dbhtml term-width=".25in"</tag></para> + +<para>You can override this setting with a processing instruction as the +child of <tag>variablelist</tag>: <tag class="xmlpi">dbhtml +list-presentation="table"</tag> or <tag class="xmlpi">dbhtml +list-presentation="list"</tag>.</para> + +<para>This parameter only applies to the HTML transformations. In the +FO case, proper list markup is robust enough to handle the formatting. +But see also <parameter>variablelist.as.blocks</parameter>.</para> + +<programlisting> <variablelist> + <?dbhtml list-presentation="table"?> + <?dbhtml term-width="1.5in"?> + <?dbfo list-presentation="list"?> + <?dbfo term-width="1in"?> + <varlistentry> + <term>list</term> + <listitem> + <para> + Formatted as a table even if variablelist.as.table is set to 0. + </para> + </listitem> + </varlistentry> + </variablelist></programlisting> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="variablelist.term.separator"> +<refmeta> +<refentrytitle>variablelist.term.separator</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>variablelist.term.separator</refname> +<refpurpose>Text to separate <tag>term</tag>s within a multi-term +<tag>varlistentry</tag></refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="variablelist.term.separator.frag"> +<xsl:param name="variablelist.term.separator">, </xsl:param></programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>When a <tag>varlistentry</tag> contains multiple <tag>term</tag> +elements, the string specified in the value of the +<parameter>variablelist.term.separator</parameter> parameter is placed +after each <tag>term</tag> except the last.</para> + +<note> + <para>To generate a line break between multiple <tag>term</tag>s in + a <tag>varlistentry</tag>, set a non-zero value for the + <parameter>variablelist.term.break.after</parameter> parameter. If + you do so, you may also want to set the value of the + <parameter>variablelist.term.separator</parameter> parameter to an + empty string (to suppress rendering of the default comma and space + after each <tag>term</tag>).</para> +</note> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="variablelist.term.break.after"> +<refmeta> +<refentrytitle>variablelist.term.break.after</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>variablelist.term.break.after</refname> +<refpurpose>Generate line break after each <tag>term</tag> within a +multi-term <tag>varlistentry</tag>?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="variablelist.term.break.after.frag"> +<xsl:param name="variablelist.term.break.after">0</xsl:param></programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Set a non-zero value for the +<parameter>variablelist.term.break.after</parameter> parameter to +generate a line break between <tag>term</tag>s in a +multi-term <tag>varlistentry</tag>.</para> + +<note> +<para>If you set a non-zero value for +<parameter>variablelist.term.break.after</parameter>, you may also +want to set the value of the +<parameter>variablelist.term.separator</parameter> parameter to an +empty string (to suppress rendering of the default comma and space +after each <tag>term</tag>).</para> +</note> + +</refsection> +</refentry> + +</reference> +<reference xml:id="biblio"><title>Bibliography</title> +<refentry version="5.0" xml:id="bibliography.style"> +<refmeta> +<refentrytitle>bibliography.style</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">list</refmiscinfo> +<refmiscinfo class="other" otherclass="value">normal</refmiscinfo> +<refmiscinfo class="other" otherclass="value">iso690</refmiscinfo> +</refmeta> +<refnamediv> +<refname>bibliography.style</refname> +<refpurpose>Style used for formatting of biblioentries.</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="bibliography.style.frag"> +<xsl:param name="bibliography.style">normal</xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Currently only <literal>normal</literal> and +<literal>iso690</literal> styles are supported.</para> + +<para>In order to use ISO690 style to the full extent you might need +to use additional markup described on <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://wiki.docbook.org/topic/ISO690Bibliography">the +following WiKi page</link>.</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="biblioentry.item.separator"> +<refmeta> +<refentrytitle>biblioentry.item.separator</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>biblioentry.item.separator</refname> +<refpurpose>Text to separate bibliography entries</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="biblioentry.item.separator.frag"><xsl:param name="biblioentry.item.separator">. </xsl:param></programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Text to separate bibliography entries +</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="bibliography.collection"> +<refmeta> +<refentrytitle>bibliography.collection</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>bibliography.collection</refname> +<refpurpose>Name of the bibliography collection file</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="bibliography.collection.frag"> +<xsl:param name="bibliography.collection">http://docbook.sourceforge.net/release/bibliography/bibliography.xml</xsl:param> + +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>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 <quote>extract</quote> +the ones you need in each document.</para> + +<para>That's the purpose of the +<parameter>bibliography.collection</parameter> parameter. To setup a global +bibliography <quote>database</quote>, follow these steps:</para> + +<para>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 <tag>biblioentry</tag> or <tag>bibliomixed</tag>) +has an ID.</para> + +<para>My global bibliography, <filename>~/bibliography.xml</filename> begins +like this:</para> + +<informalexample> +<programlisting><!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> +</programlisting> +</informalexample> + +<para>When you create a bibliography in your document, simply +provide <emphasis>empty</emphasis> <tag>bibliomixed</tag> +entries for each document that you wish to cite. Make sure that these +elements have the same ID as the corresponding <quote>real</quote> +entry in your global bibliography.</para> + +<para>For example:</para> + +<informalexample> +<programlisting><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></programlisting> +</informalexample> + +<para>Note that it's perfectly acceptable to mix entries from your +global bibliography with <quote>normal</quote> entries. You can use +<tag>xref</tag> or other elements to cross-reference your +bibliography entries in exactly the same way you do now.</para> + +<para>Finally, when you are ready to format your document, simply set the +<parameter>bibliography.collection</parameter> parameter (in either a +customization layer or directly through your processor's interface) to +point to your global bibliography.</para> + +<para>The stylesheets will format the bibliography in your document as if +all of the entries referenced appeared there literally.</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="bibliography.numbered"> +<refmeta> +<refentrytitle>bibliography.numbered</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>bibliography.numbered</refname> +<refpurpose>Should bibliography entries be numbered?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="bibliography.numbered.frag"> +<xsl:param name="bibliography.numbered" select="0"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero bibliography entries will be numbered</para> + +</refsection> +</refentry> + +</reference> +<reference xml:id="glossary"><title>Glossary</title> +<refentry version="5.0" xml:id="glossterm.auto.link"> +<refmeta> +<refentrytitle>glossterm.auto.link</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>glossterm.auto.link</refname> +<refpurpose>Generate links from glossterm to glossentry automatically?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="glossterm.auto.link.frag"> +<xsl:param name="glossterm.auto.link" select="0"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, links from inline <tag>glossterm</tag>s to the corresponding +<tag>glossentry</tag> elements in a <tag>glossary</tag> or <tag>glosslist</tag> +will be automatically generated. This is useful when your glossterms are consistent +and you don't want to add links manually.</para> + +<para>The automatic link generation feature is not used on <tag>glossterm</tag> elements +that have a <tag class="attribute">linkend</tag> attribute.</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="firstterm.only.link"> +<refmeta> +<refentrytitle>firstterm.only.link</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>firstterm.only.link</refname> +<refpurpose>Does automatic glossterm linking only apply to firstterms?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="firstterm.only.link.frag"> +<xsl:param name="firstterm.only.link" select="0"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, only <tag>firstterm</tag>s will be automatically linked +to the glossary. If glossary linking is not enabled, this parameter +has no effect.</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="glossary.collection"> +<refmeta> +<refentrytitle>glossary.collection</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>glossary.collection</refname> +<refpurpose>Name of the glossary collection file</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="glossary.collection.frag"> +<xsl:param name="glossary.collection"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>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 +<quote>extract</quote> the ones you need in each document.</para> + +<para>That's the purpose of the +<parameter>glossary.collection</parameter> parameter. To setup a global +glossary <quote>database</quote>, follow these steps:</para> + +<refsection><info><title>Setting Up the Glossary Database</title></info> + +<para>First, create a stand-alone glossary document that contains all of +the entries that you wish to reference. Make sure that each glossary +entry has an ID.</para> + +<para>Here's an example glossary:</para> + +<informalexample> +<programlisting> +<?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></programlisting> +</informalexample> + +</refsection> + +<refsection><info><title>Marking Up Glossary Terms</title></info> + +<para>That takes care of the glossary database, now you have to get the entries +into your document. Unlike bibliography entries, which can be empty, creating +<quote>placeholder</quote> glossary entries would be very tedious. So instead, +support for <parameter>glossary.collection</parameter> relies on implicit linking.</para> + +<para>In your source document, simply use <tag>firstterm</tag> and +<tag>glossterm</tag> to identify the terms you wish to have included +in the glossary. The stylesheets assume that you will either set the +<tag class="attribute">baseform</tag> attribute correctly, or that the +content of the element exactly matches a term in your glossary.</para> + +<para>If you're using a <parameter>glossary.collection</parameter>, don't +make explicit links on the terms in your document.</para> + +<para>So, in your document, you might write things like this:</para> + +<informalexample> +<programlisting><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></programlisting> +</informalexample> + +<para>If you set the <parameter>firstterm.only.link</parameter> parameter, +only the terms marked with <tag>firstterm</tag> will be links. +Otherwise, all the terms will be linked.</para> + +</refsection> + +<refsection><info><title>Marking Up the Glossary</title></info> + +<para>The glossary itself has to be identified for the stylesheets. For lack +of a better choice, the <tag class="attribute">role</tag> is used. +To identify the glossary as the target for automatic processing, set +the role to <quote><literal>auto</literal></quote>. The title of this +glossary (and any other information from the <tag>glossaryinfo</tag> +that's rendered by your stylesheet) will be displayed, but the entries will +come from the database. +</para> + +<para>Unfortunately, the glossary can't be empty, so you must put in +at least one <tag>glossentry</tag>. The content of this entry +is irrelevant, it will not be rendered:</para> + +<informalexample> +<programlisting><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></programlisting> +</informalexample> + +<para>What about glossary divisions? If your glossary database has glossary +divisions <emphasis>and</emphasis> your automatic glossary contains at least +one <tag>glossdiv</tag>, the automic glossary will have divisions. +If the <tag>glossdiv</tag> is missing from either location, no divisions +will be rendered.</para> + +<para>Glossary entries (and divisions, if appropriate) in the glossary will +occur in precisely the order they occur in your database.</para> + +</refsection> + +<refsection><info><title>Formatting the Document</title></info> + +<para>Finally, when you are ready to format your document, simply set the +<parameter>glossary.collection</parameter> parameter (in either a +customization layer or directly through your processor's interface) to +point to your global glossary.</para> + +<para>The stylesheets will format the glossary in your document as if +all of the entries implicilty referenced appeared there literally.</para> +</refsection> + +<refsection><info><title>Limitations</title></info> + +<para>Glossary cross-references <emphasis>within the glossary</emphasis> are +not supported. For example, this <emphasis>will not</emphasis> work:</para> + +<informalexample> +<programlisting><glossentry> +<glossterm>gloss-1</glossterm> +<glossdef><para>A description that references <glossterm>gloss-2</glossterm>.</para> +<glossseealso>gloss-2</glossseealso> +</glossdef> +</glossentry></programlisting> +</informalexample> + +<para>If you put glossary cross-references in your glossary that way, +you'll get the cryptic error: <computeroutput>Warning: +glossary.collection specified, but there are 0 automatic +glossaries</computeroutput>.</para> + +<para>Instead, you must do two things:</para> + +<orderedlist> +<listitem> +<para>Markup your glossary using <tag>glossseealso</tag>:</para> + +<informalexample> +<programlisting><glossentry> +<glossterm>gloss-1</glossterm> +<glossdef><para>A description that references <glossterm>gloss-2</glossterm>.</para> +<glossseealso>gloss-2</glossseealso> +</glossdef> +</glossentry></programlisting> +</informalexample> +</listitem> + +<listitem> +<para>Make sure there is at least one <tag>glossterm</tag> reference to +<glossterm>gloss-2</glossterm> <emphasis>in your document</emphasis>. The +easiest way to do that is probably within a <tag>remark</tag> in your +automatic glossary:</para> + +<informalexample> +<programlisting><glossary role="auto"> +<remark>Make sure there's a reference to <glossterm>gloss-2</glossterm>.</remark> +<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></programlisting> +</informalexample> +</listitem> +</orderedlist> +</refsection> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="glossary.sort"> +<refmeta> +<refentrytitle>glossary.sort</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>glossary.sort</refname> +<refpurpose>Sort glossentry elements?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="glossary.sort.frag"> +<xsl:param name="glossary.sort" select="0"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>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. +</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="glossentry.show.acronym"> +<refmeta> +<refentrytitle>glossentry.show.acronym</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">list</refmiscinfo> +<refmiscinfo class="other" otherclass="value">no</refmiscinfo> +<refmiscinfo class="other" otherclass="value">yes</refmiscinfo> +<refmiscinfo class="other" otherclass="value">primary</refmiscinfo> +</refmeta> +<refnamediv> +<refname>glossentry.show.acronym</refname> +<refpurpose>Display <tag>glossentry</tag> acronyms?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="glossentry.show.acronym.frag"> +<xsl:param name="glossentry.show.acronym">no</xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>A setting of <quote>yes</quote> means they should be displayed; +<quote>no</quote> means they shouldn't. If <quote>primary</quote> is used, +then they are shown as the primary text for the entry.</para> + +<note> +<para>This setting controls both <tag>acronym</tag> and +<tag>abbrev</tag> elements in the <tag>glossentry</tag>.</para> +</note> + +</refsection> +</refentry> + +</reference> +<reference xml:id="misc"><title>Miscellaneous</title> +<refentry version="5.0" xml:id="formal.procedures"> +<refmeta> +<refentrytitle>formal.procedures</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>formal.procedures</refname> +<refpurpose>Selects formal or informal procedures</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="formal.procedures.frag"> +<xsl:param name="formal.procedures" select="1"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Formal procedures are numbered and always have a title. +</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="formal.title.placement"> +<refmeta> +<refentrytitle>formal.title.placement</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">table</refmiscinfo> +</refmeta> +<refnamediv> +<refname>formal.title.placement</refname> +<refpurpose>Specifies where formal object titles should occur</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="formal.title.placement.frag"> +<xsl:param name="formal.title.placement"> +figure before +example before +equation before +table before +procedure before +task before +</xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Specifies where formal object titles should occur. For each formal object +type (<tag>figure</tag>, +<tag>example</tag>, +<tag>equation</tag>, +<tag>table</tag>, and <tag>procedure</tag>) +you can specify either the keyword +<quote><literal>before</literal></quote> or +<quote><literal>after</literal></quote>.</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="runinhead.default.title.end.punct"> +<refmeta> +<refentrytitle>runinhead.default.title.end.punct</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>runinhead.default.title.end.punct</refname> +<refpurpose>Default punctuation character on a run-in-head</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="runinhead.default.title.end.punct.frag"><xsl:param name="runinhead.default.title.end.punct">.</xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, For a <tag>formalpara</tag>, use the specified +string as the separator between the title and following text. The period is the default value.</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="runinhead.title.end.punct"> +<refmeta> +<refentrytitle>runinhead.title.end.punct</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>runinhead.title.end.punct</refname> +<refpurpose>Characters that count as punctuation on a run-in-head</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="runinhead.title.end.punct.frag"> +<xsl:param name="runinhead.title.end.punct">.!?:</xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>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 +<parameter>runinhead.default.title.end.punct</parameter> contents are +inserted. This is to avoid duplicated punctuation in the output. +</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="show.comments"> +<refmeta> +<refentrytitle>show.comments</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>show.comments</refname> +<refpurpose>Display <tag>remark</tag> elements?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="show.comments.frag"> +<xsl:param name="show.comments" select="1"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, comments will be displayed, otherwise they +are suppressed. Comments here refers to the <tag>remark</tag> element +(which was called <literal>comment</literal> prior to DocBook +4.0), not XML comments (<-- like this -->) which are +unavailable. +</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="show.revisionflag"> +<refmeta> +<refentrytitle>show.revisionflag</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>show.revisionflag</refname> +<refpurpose>Enable decoration of elements that have a revisionflag</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="show.revisionflag.frag"> +<xsl:param name="show.revisionflag" select="0"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para> +If <parameter>show.revisionflag</parameter> is turned on, then the stylesheets +may produce additional markup designed to allow a CSS stylesheet to +highlight elements that have specific revisionflag settings.</para> + +<para>The markup inserted will be usually be either a <span> or +<div> with an appropriate <literal>class</literal> +attribute. (The value of the class attribute will be the same as the +value of the revisionflag attribute). In some contexts, for example +tables, where extra markup would be structurally illegal, the class +attribute will be added to the appropriate container element.</para> + +<para>In general, the stylesheets only test for revisionflag in contexts +where an importing stylesheet would have to redefine whole templates. +Most of the revisionflag processing is expected to be done by another +stylesheet, for example <filename>changebars.xsl</filename>.</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="shade.verbatim"> +<refmeta> +<refentrytitle>shade.verbatim</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>shade.verbatim</refname> +<refpurpose>Should verbatim environments be shaded?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="shade.verbatim.frag"><xsl:param name="shade.verbatim" select="0"></xsl:param></programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>In the FO stylesheet, if this parameter is non-zero then the +<property>shade.verbatim.style</property> properties will be applied +to verbatim environments.</para> + +<para>In the HTML stylesheet, this parameter is now deprecated. Use +CSS instead.</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="shade.verbatim.style"> +<refmeta> +<refentrytitle>shade.verbatim.style</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>shade.verbatim.style</refname> +<refpurpose>Properties that specify the style of shaded verbatim listings</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="shade.verbatim.style.frag"> +<xsl:attribute-set name="shade.verbatim.style"> + <xsl:attribute name="border">0</xsl:attribute> + <xsl:attribute name="bgcolor">#E0E0E0</xsl:attribute> +</xsl:attribute-set> + +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>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 <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://www.w3.org/TR/2004/WD-xsl11-20041216/#border">xsl-fo</link></para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="punct.honorific"> +<refmeta> +<refentrytitle>punct.honorific</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>punct.honorific</refname> +<refpurpose>Punctuation after an honorific in a personal name.</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="punct.honorific.frag"> +<xsl:param name="punct.honorific">.</xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>This parameter specifies the punctuation that should be added after an +honorific in a personal name.</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="tex.math.in.alt"> +<refmeta> +<refentrytitle>tex.math.in.alt</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">list</refmiscinfo> +<refmiscinfo class="other" otherclass="value">plain</refmiscinfo> +<refmiscinfo class="other" otherclass="value">latex</refmiscinfo> +</refmeta> +<refnamediv> +<refname>tex.math.in.alt</refname> +<refpurpose>TeX notation used for equations</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="tex.math.in.alt.frag"> +<xsl:param name="tex.math.in.alt"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If you want type math directly in TeX notation in equations, +this parameter specifies notation used. Currently are supported two +values -- <literal>plain</literal> and <literal>latex</literal>. Empty +value means that you are not using TeX math at all.</para> + +<para>Preferred way for including TeX alternative of math is inside of +<tag>textobject</tag> element. Eg.:</para> + +<programlisting><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></programlisting> + +<para>If you are using <tag>graphic</tag> element, you can +store TeX inside <tag>alt</tag> element:</para> + +<programlisting><inlineequation> +<alt role="tex">a^2+b^2=c^2</alt> +<graphic fileref="a2b2c2.gif"/> +</inlineequation></programlisting> + +<para>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.</para> + +<para>If you want equations in HTML, just process generated file +<filename>tex-math-equations.tex</filename> by TeX or LaTeX. Then run +dvi2bitmap program on result DVI file. You will get images for +equations in your document.</para> + +<warning> + <para>This feature is useful for print/PDF output only if you + use the obsolete and now unsupported PassiveTeX XSL-FO + engine.</para> +</warning> + +</refsection> + +<refsection><info><title>Related Parameters</title></info> + <para><parameter>tex.math.delims</parameter>, + <parameter>passivetex.extensions</parameter>, + <parameter>tex.math.file</parameter></para> +</refsection> + +</refentry> + +<refentry version="5.0" xml:id="tex.math.file"> +<refmeta> +<refentrytitle>tex.math.file</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>tex.math.file</refname> +<refpurpose>Name of temporary file for generating images from equations</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="tex.math.file.frag"> +<xsl:param name="tex.math.file">tex-math-equations.tex</xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Name of auxiliary file for TeX equations. This file can be +processed by dvi2bitmap to get bitmap versions of equations for HTML +output.</para> + +</refsection> +<refsection><info><title>Related Parameters</title></info> + <para><parameter>tex.math.in.alt</parameter>, + <parameter>tex.math.delims</parameter>, + </para> +</refsection> +<refsection><info><title>More information</title></info> + <para>For how-to documentation on embedding TeX equations and + generating output from them, see + <link xmlns:xlink="http://www.w3.org/1999/xlink" role="tcg" xlink:href="TexMath.html">DBTeXMath</link>.</para> +</refsection> +</refentry> + +<refentry version="5.0" xml:id="tex.math.delims"> +<refmeta> +<refentrytitle>tex.math.delims</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>tex.math.delims</refname> +<refpurpose>Should equations output for processing by TeX be +surrounded by math mode delimiters?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="tex.math.delims.frag"> +<xsl:param name="tex.math.delims" select="1"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>For compatibility with DSSSL based DBTeXMath from Allin Cottrell +you should set this parameter to 0.</para> + +<warning> + <para>This feature is useful for print/PDF output only if you + use the obsolete and now unsupported PassiveTeX XSL-FO + engine.</para> +</warning> + +</refsection> +<refsection><info><title>Related Parameters</title></info> + <para><parameter>tex.math.in.alt</parameter>, + <parameter>passivetex.extensions</parameter></para> +</refsection> + +<refsection><info><title>See Also</title></info> + <para>You can also use the <tag class="xmlpi">dbtex delims</tag> processing + instruction to control whether delimiters are output.</para> +</refsection> + + +</refentry> + +<refentry version="5.0" xml:id="pixels.per.inch"> +<refmeta> +<refentrytitle>pixels.per.inch</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo> +</refmeta> +<refnamediv> +<refname>pixels.per.inch</refname> +<refpurpose>How many pixels are there per inch?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="pixels.per.inch.frag"> +<xsl:param name="pixels.per.inch">90</xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>When lengths are converted to pixels, this value is used to +determine the size of a pixel. The default value is taken from the +<link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://www.w3.org/TR/2004/WD-xsl11-20041216/">XSL +Recommendation</link>. +</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="points.per.em"> +<refmeta> +<refentrytitle>points.per.em</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">number</refmiscinfo> +</refmeta> +<refnamediv> +<refname>points.per.em</refname> +<refpurpose>Specify the nominal size of an em-space in points</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="points.per.em.frag"> +<xsl:param name="points.per.em">10</xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The fixed value used for calculations based upon the size of a +character. The assumption made is that ten point font is in use. This +assumption may not be valid.</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="use.svg"> +<refmeta> +<refentrytitle>use.svg</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>use.svg</refname> +<refpurpose>Allow SVG in the result tree?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="use.svg.frag"> +<xsl:param name="use.svg" select="1"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>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.</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="menuchoice.separator"> +<refmeta> +<refentrytitle>menuchoice.separator</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>menuchoice.separator</refname> +<refpurpose>Separator between items of a <tag>menuchoice</tag> +other than <tag>guimenuitem</tag> and +<tag>guisubmenu</tag></refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="menuchoice.separator.frag"> +<xsl:param name="menuchoice.separator">+</xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Separator used to connect items of a <tag>menuchoice</tag> other +than <tag>guimenuitem</tag> and <tag>guisubmenu</tag>. The latter +elements are linked with <parameter>menuchoice.menu.separator</parameter>. +</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="menuchoice.menu.separator"> +<refmeta> +<refentrytitle>menuchoice.menu.separator</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>menuchoice.menu.separator</refname> +<refpurpose>Separator between items of a <tag>menuchoice</tag> +with <tag>guimenuitem</tag> or +<tag>guisubmenu</tag></refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="menuchoice.menu.separator.frag"> +<xsl:param name="menuchoice.menu.separator"> → </xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Separator used to connect items of a <tag>menuchoice</tag> with +<tag>guimenuitem</tag> or <tag>guisubmenu</tag>. Other elements +are linked with <parameter>menuchoice.separator</parameter>. +</para> +<para>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. +</para> +<para>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. +</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="default.float.class"> +<refmeta> +<refentrytitle>default.float.class</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>default.float.class</refname> +<refpurpose>Specifies the default float class</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="default.float.class.frag"> +<xsl:param name="default.float.class"> + <xsl:choose> + <xsl:when test="contains($stylesheet.result.type,'html')">left</xsl:when> + <xsl:otherwise>before</xsl:otherwise> + </xsl:choose> +</xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>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.</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="footnote.number.format"> +<refmeta> +<refentrytitle>footnote.number.format</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">list</refmiscinfo> +<refmiscinfo class="other" otherclass="value">1<alt>1,2,3...</alt></refmiscinfo> +<refmiscinfo class="other" otherclass="value">A<alt>A,B,C...</alt></refmiscinfo> +<refmiscinfo class="other" otherclass="value">a<alt>a,b,c...</alt></refmiscinfo> +<refmiscinfo class="other" otherclass="value">i<alt>i,ii,iii...</alt></refmiscinfo> +<refmiscinfo class="other" otherclass="value">I<alt>I,II,III...</alt></refmiscinfo> +</refmeta> +<refnamediv> +<refname>footnote.number.format</refname> +<refpurpose>Identifies the format used for footnote numbers</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="footnote.number.format.frag"> +<xsl:param name="footnote.number.format">1</xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The <parameter>footnote.number.format</parameter> specifies the format +to use for footnote numeration (1, i, I, a, or A).</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="table.footnote.number.format"> +<refmeta> +<refentrytitle>table.footnote.number.format</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">list</refmiscinfo> +<refmiscinfo class="other" otherclass="value">1<alt>1,2,3...</alt></refmiscinfo> +<refmiscinfo class="other" otherclass="value">A<alt>A,B,C...</alt></refmiscinfo> +<refmiscinfo class="other" otherclass="value">a<alt>a,b,c...</alt></refmiscinfo> +<refmiscinfo class="other" otherclass="value">i<alt>i,ii,iii...</alt></refmiscinfo> +<refmiscinfo class="other" otherclass="value">I<alt>I,II,III...</alt></refmiscinfo> +</refmeta> +<refnamediv> +<refname>table.footnote.number.format</refname> +<refpurpose>Identifies the format used for footnote numbers in tables</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="table.footnote.number.format.frag"> +<xsl:param name="table.footnote.number.format">a</xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The <parameter>table.footnote.number.format</parameter> specifies the format +to use for footnote numeration (1, i, I, a, or A) in tables.</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="footnote.number.symbols"> +<refmeta> +<refentrytitle>footnote.number.symbols</refentrytitle> +<refmiscinfo class="other" otherclass="datatype"/> +</refmeta> +<refnamediv> +<refname>footnote.number.symbols</refname> +<refpurpose>Special characters to use as footnote markers</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="footnote.number.symbols.frag"> +<xsl:param name="footnote.number.symbols"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If <parameter>footnote.number.symbols</parameter> is not the empty string, +footnotes will use the characters it contains as footnote symbols. For example, +<quote>*&#x2020;&#x2021;&#x25CA;&#x2720;</quote> will identify +footnotes with <quote>*</quote>, <quote>†</quote>, <quote>‡</quote>, +<quote>◊</quote>, and <quote>✠</quote>. If there are more footnotes +than symbols, the stylesheets will fall back to numbered footnotes using +<parameter>footnote.number.format</parameter>.</para> + +<para>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.</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="table.footnote.number.symbols"> +<refmeta> +<refentrytitle>table.footnote.number.symbols</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>table.footnote.number.symbols</refname> +<refpurpose>Special characters to use a footnote markers in tables</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="table.footnote.number.symbols.frag"> +<xsl:param name="table.footnote.number.symbols"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If <parameter>table.footnote.number.symbols</parameter> is not the empty string, +table footnotes will use the characters it contains as footnote symbols. For example, +<quote>*&#x2020;&#x2021;&#x25CA;&#x2720;</quote> will identify +footnotes with <quote>*</quote>, <quote>†</quote>, <quote>‡</quote>, +<quote>◊</quote>, and <quote>✠</quote>. If there are more footnotes +than symbols, the stylesheets will fall back to numbered footnotes using +<parameter>table.footnote.number.format</parameter>.</para> + +<para>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.</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="highlight.source"> +<refmeta> +<refentrytitle>highlight.source</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>highlight.source</refname> +<refpurpose>Should the content of <tag>programlisting</tag> +be syntactically highlighted?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="highlight.source.frag"> +<xsl:param name="highlight.source" select="0"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>When this parameter is non-zero, the stylesheets will try to do syntax highlighting of the +content of <tag>programlisting</tag> elements. You specify the language for each programlisting +by using the <tag class="attribute">language</tag> attribute. The <parameter>highlight.default.language</parameter> +parameter can be used to specify the language for programlistings without a <tag class="attribute">language</tag> +attribute. Syntax highlighting also works for <tag>screen</tag> and <tag>synopsis</tag> elements.</para> + +<para>The actual highlighting work is done by the XSLTHL extension module. This is an external Java library that has to be +downloaded separately (see below).</para> + +<itemizedlist> +<para>In order to use this extension, you must</para> + +<listitem><para>add <filename>xslthl-2.x.x.jar</filename> to your Java classpath. The latest version is available +from <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://sourceforge.net/projects/xslthl">the XSLT syntax highlighting project</link> +at SourceForge.</para> +</listitem> +<listitem> +<para>use a customization layer in which you import one of the following stylesheet modules: +<itemizedlist> + <listitem> + <para><filename>html/highlight.xsl</filename> + </para> + </listitem> +<listitem> + <para><filename>xhtml/highlight.xsl</filename> + </para> + </listitem> +<listitem> + <para><filename>xhtml-1_1/highlight.xsl</filename> + </para> + </listitem> +<listitem> + <para><filename>fo/highlight.xsl</filename> + </para> +</listitem> +</itemizedlist> +</para> +</listitem> +<listitem><para>let either the <literal>xslthl.config</literal> Java system property or the +<parameter>highlight.xslthl.config</parameter> parameter point to the configuration file for syntax +highlighting (using URL syntax). DocBook XSL comes with a ready-to-use configuration file, +<filename>highlighting/xslthl-config.xml</filename>.</para> +</listitem> +</itemizedlist> + +<para>The extension works with Saxon 6.5.x and Xalan-J. (Saxon 8.5 or later is also supported, but since it is +an XSLT 2.0 processor it is not guaranteed to work with DocBook XSL in all circumstances.)</para> + +<para>The following is an example of a Saxon 6 command adapted for syntax highlighting, to be used on Windows:</para> + +<informalexample> +<para><command>java -cp c:/Java/saxon.jar;c:/Java/xslthl-2.0.1.jar +-Dxslthl.config=file:///c:/docbook-xsl/highlighting/xslthl-config.xml com.icl.saxon.StyleSheet +-o test.html test.xml myhtml.xsl</command></para> +</informalexample> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="highlight.xslthl.config"> +<refmeta> +<refentrytitle>highlight.xslthl.config</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo> +</refmeta> +<refnamediv> +<refname>highlight.xslthl.config</refname> +<refpurpose>Location of XSLTHL configuration file</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="highlight.xslthl.config.frag"> +<xsl:param name="highlight.xslthl.config"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>This location has precedence over the corresponding Java property.</para> + +<para>Please note that usually you have to specify location as URL not +just as a simple path on the local +filesystem. E.g. <filename>file:///home/user/xslthl/my-xslthl-config.xml</filename>.</para> + + + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="highlight.default.language"> +<refmeta> +<refentrytitle>highlight.default.language</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>highlight.default.language</refname> +<refpurpose>Default language of programlisting</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="highlight.default.language.frag"> +<xsl:param name="highlight.default.language"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>This language is used when there is no language attribute on programlisting.</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="email.delimiters.enabled"> +<refmeta> +<refentrytitle>email.delimiters.enabled</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>email.delimiters.enabled</refname> +<refpurpose>Generate delimiters around email addresses?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="email.delimiters.enabled.frag"> +<xsl:param name="email.delimiters.enabled" select="1"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, delimiters + +<footnote><para>For delimiters, the +stylesheets are currently hard-coded to output angle +brackets.</para></footnote> + +are generated around e-mail addresses +(the output of the <tag>email</tag> element).</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="exsl.node.set.available"> +<refmeta> +<refentrytitle>exsl.node.set.available</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>exsl.node.set.available</refname> +<refpurpose>Is the test function-available('exsl:node-set') true?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="exsl.node.set.available.frag"><xsl:param name="exsl.node.set.available"> + <xsl:choose> + <xsl:when exsl:foo="" test="function-available('exsl:node-set') or contains(system-property('xsl:vendor'), 'Apache Software Foundation')">1</xsl:when> + <xsl:otherwise>0</xsl:otherwise> + </xsl:choose> +</xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, +then the exsl:node-set() function is available to be used in +the stylesheet. +If zero, then the function is not available. +This param automatically detects the presence of +the function and does not normally need to be set manually.</para> + +<para>This param was created to handle a long-standing +bug in the Xalan processor that fails to detect the +function even though it is available.</para> + +</refsection> +</refentry> + +</reference> +<reference xml:id="annos"><title>Annotations</title> +<refentry version="5.0" xml:id="annotation.support"> +<refmeta> +<refentrytitle>annotation.support</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>annotation.support</refname> +<refpurpose>Enable annotations?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="annotation.support.frag"> +<xsl:param name="annotation.support" select="0"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, the stylesheets will attempt to support annotation +elements in HTML by including some JavaScript (see +<parameter>annotation.js</parameter>).</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="annotation.js"> +<refmeta> +<refentrytitle>annotation.js</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>annotation.js</refname> +<refpurpose>URIs identifying JavaScript files with support for annotation popups</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="annotation.js.frag"> + +<xsl:param name="annotation.js"> +<xsl:text>http://docbook.sourceforge.net/release/script/AnchorPosition.js http://docbook.sourceforge.net/release/script/PopupWindow.js</xsl:text></xsl:param> + +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If <property>annotation.support</property> is enabled and the +document contains <tag>annotation</tag>s, then the URIs listed +in this parameter will be included. These JavaScript files are required +for popup annotation support.</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="annotation.css"> +<refmeta> +<refentrytitle>annotation.css</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>annotation.css</refname> +<refpurpose>CSS rules for annotations</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="annotation.css.frag"> +<xsl:param name="annotation.css"> +/* ====================================================================== + Annotations +*/ + +div.annotation-list { visibility: hidden; + } + +div.annotation-nocss { position: absolute; + visibility: hidden; + } + +div.annotation-popup { position: absolute; + z-index: 4; + visibility: hidden; + padding: 0px; + margin: 2px; + border-style: solid; + border-width: 1px; + width: 200px; + background-color: white; + } + +div.annotation-title { padding: 1px; + font-weight: bold; + border-bottom-style: solid; + border-bottom-width: 1px; + color: white; + background-color: black; + } + +div.annotation-body { padding: 2px; + } + +div.annotation-body p { margin-top: 0px; + padding-top: 0px; + } + +div.annotation-close { position: absolute; + top: 2px; + right: 2px; + } +</xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If <parameter>annotation.support</parameter> is enabled and the +document contains <tag>annotation</tag>s, then the CSS in this +parameter will be included in the document.</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="annotation.graphic.open"> +<refmeta> +<refentrytitle>annotation.graphic.open</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo> +</refmeta> +<refnamediv> +<refname>annotation.graphic.open</refname> +<refpurpose>Image for identifying a link that opens an annotation popup</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="annotation.graphic.open.frag"> +<xsl:param name="annotation.graphic.open">http://docbook.sourceforge.net/release/images/annot-open.png</xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>This image is used inline to identify the location of +annotations. It may be replaced by a user provided graphic. The size should be approximately 10x10 pixels.</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="annotation.graphic.close"> +<refmeta> +<refentrytitle>annotation.graphic.close</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo> +</refmeta> +<refnamediv> +<refname>annotation.graphic.close</refname> +<refpurpose>Image for identifying a link that closes an annotation popup</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="annotation.graphic.close.frag"> +<xsl:param name="annotation.graphic.close"> +http://docbook.sourceforge.net/release/images/annot-close.png</xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>This image is used on popup annotations as the “x” that the +user can click to dismiss the popup.</para> +<para>This image is used on popup annotations as the “x” that the user can +click to dismiss the popup. It may be replaced by a user provided graphic. The size should be approximately 10x10 pixels.</para> + +</refsection> +</refentry> + +</reference> +<reference xml:id="graphics"><title>Graphics</title> +<refentry version="5.0" xml:id="img.src.path"> +<refmeta> +<refentrytitle>img.src.path</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>img.src.path</refname> +<refpurpose>Path to HTML/FO image files</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="img.src.path.frag"><xsl:param name="img.src.path"></xsl:param></programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Add a path prefix to the value of the <tag class="attribute">fileref</tag> +attribute of <tag>graphic</tag>, <tag>inlinegraphic</tag>, and <tag>imagedata</tag> elements. The resulting +compound path is used in the output as the value of the <tag class="attribute">src</tag> +attribute of <tag class="element">img</tag> (HTML) or <tag class="element">external-graphic</tag> (FO). +</para> + +<para> +The path given by <literal>img.src.path</literal> 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. +</para> + +<para>This prefix is not applied to any filerefs that start +with "/" or contain "//:". +</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="keep.relative.image.uris"> +<refmeta> +<refentrytitle>keep.relative.image.uris</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>keep.relative.image.uris</refname> +<refpurpose>Should image URIs be resolved against xml:base?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="keep.relative.image.uris.frag"> +<xsl:param name="keep.relative.image.uris" select="1"></xsl:param> + +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, relative URIs (in, for example +<literal>fileref</literal> attributes) will be used in the generated +output. Otherwise, the URIs will be made absolute with respect to the +base URI.</para> + +<para>Note that the stylesheets calculate (and use) the absolute form +for some purposes, this only applies to the resulting output.</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="graphic.default.extension"> +<refmeta> +<refentrytitle>graphic.default.extension</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>graphic.default.extension</refname> +<refpurpose>Default extension for graphic filenames</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="graphic.default.extension.frag"><xsl:param name="graphic.default.extension"></xsl:param></programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If a <tag>graphic</tag> or <tag>mediaobject</tag> +includes a reference to a filename that does not include an extension, +and the <tag class="attribute">format</tag> attribute is +<emphasis>unspecified</emphasis>, the default extension will be used. +</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="default.image.width"> +<refmeta> +<refentrytitle>default.image.width</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">length</refmiscinfo> +</refmeta> +<refnamediv> +<refname>default.image.width</refname> +<refpurpose>The default width of images</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="default.image.width.frag"> +<xsl:param name="default.image.width"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If specified, this value will be used for the +<tag class="attribute">width</tag> attribute on images that do not specify any +<emphasis xmlns:xlink="http://www.w3.org/1999/xlink" xlink:title="DocBook 5: The Definitive Guide" xlink:href="http://docbook.org/tdg5/en/html/imagedata.html#viewport.area">viewport dimensions</emphasis>.</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="nominal.image.width"> +<refmeta> +<refentrytitle>nominal.image.width</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">length</refmiscinfo> +</refmeta> +<refnamediv> +<refname>nominal.image.width</refname> +<refpurpose>The nominal image width</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="nominal.image.width.frag"> +<xsl:param name="nominal.image.width" select="6 * $pixels.per.inch"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Graphic widths expressed as a percentage are problematic. In the +following discussion, we speak of width and contentwidth, but +the same issues apply to depth and contentdepth.</para> + +<para>A width of 50% means "half of the available space for the image." +That's fine. But note that in HTML, this is a dynamic property and +the image size will vary if the browser window is resized.</para> + +<para>A contentwidth of 50% means "half of the actual image width". +But what does that mean if the stylesheets cannot assess the image's +actual size? Treating this as a width of 50% is one possibility, but +it produces behavior (dynamic scaling) that seems entirely out of +character with the meaning.</para> + +<para>Instead, the stylesheets define a +<parameter>nominal.image.width</parameter> and convert percentages to +actual values based on that nominal size.</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="nominal.image.depth"> +<refmeta> +<refentrytitle>nominal.image.depth</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">length</refmiscinfo> +</refmeta> +<refnamediv> +<refname>nominal.image.depth</refname> +<refpurpose>Nominal image depth</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="nominal.image.depth.frag"> +<xsl:param name="nominal.image.depth" select="4 * $pixels.per.inch"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>See <parameter>nominal.image.width</parameter>.</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="use.embed.for.svg"> +<refmeta> +<refentrytitle>use.embed.for.svg</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>use.embed.for.svg</refname> +<refpurpose>Use HTML <tag>embed</tag> for SVG?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="use.embed.for.svg.frag"> +<xsl:param name="use.embed.for.svg" select="0"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, an <tag>embed</tag> element will be created for +SVG figures. An <tag>object</tag> is <emphasis>always</emphasis> created, +this parameter merely controls whether or not an additional <tag>embed</tag> +is generated inside the <tag>object</tag>.</para> + +<para>On the plus side, this may be more portable among browsers and plug-ins. +On the minus side, it isn't valid HTML.</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="make.graphic.viewport"> +<refmeta> +<refentrytitle>make.graphic.viewport</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>make.graphic.viewport</refname> +<refpurpose>Use tables in HTML to make viewports for graphics</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="make.graphic.viewport.frag"> +<xsl:param name="make.graphic.viewport" select="1"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The HTML <tag>img</tag> element only supports the notion +of content-area scaling; it doesn't support the distinction between a +content-area and a viewport-area, so we have to make some compromises.</para> + +<para>If <parameter>make.graphic.viewport</parameter> is non-zero, a table +will be used to frame the image. This creates an effective viewport-area. +</para> + +<para>Tables and alignment don't work together, so this parameter is ignored +if alignment is specified on an image.</para> +</refsection> +</refentry> + +<refentry version="5.0" xml:id="preferred.mediaobject.role"> +<refmeta> +<refentrytitle>preferred.mediaobject.role</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>preferred.mediaobject.role</refname> +<refpurpose>Select which mediaobject to use based on +this value of an object's <tag class="attribute">role</tag> attribute. +</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="preferred.mediaobject.role.frag"> +<xsl:param name="preferred.mediaobject.role"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>A mediaobject may contain several objects such as imageobjects. +If the parameter <parameter>use.role.for.mediaobject</parameter> is +non-zero, then the <literal>role</literal> attribute on +<tag>imageobject</tag>s and other objects within a +<tag>mediaobject</tag> container will be used to select which object +will be used. If one of the objects has a role value that matches the +<parameter>preferred.mediaobject.role</parameter> parameter, then it +has first priority for selection. If more than one has such a role +value, the first one is used. +</para> +<para> +See the <parameter>use.role.for.mediaobject</parameter> parameter +for the sequence of selection.</para> +</refsection> +</refentry> + +<refentry version="5.0" xml:id="use.role.for.mediaobject"> +<refmeta> +<refentrytitle>use.role.for.mediaobject</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>use.role.for.mediaobject</refname> +<refpurpose>Use <tag class="attribute">role</tag> attribute +value for selecting which of several objects within a mediaobject to use. +</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="use.role.for.mediaobject.frag"> +<xsl:param name="use.role.for.mediaobject" select="1"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, the <tag class="attribute">role</tag> attribute on +<tag>imageobject</tag>s or other objects within a <tag>mediaobject</tag> container will be used to select which object will be +used. +</para> +<para> +The order of selection when then parameter is non-zero is: +</para> +<orderedlist> +<listitem> + <para>If the stylesheet parameter <parameter>preferred.mediaobject.role</parameter> has a value, then the object whose role equals that value is selected.</para> +</listitem> +<listitem> +<para>Else if an object's role attribute has a value of +<literal>html</literal> for HTML processing or +<literal>fo</literal> for FO output, then the first +of such objects is selected. +</para> +</listitem> +<listitem> +<para>Else the first suitable object is selected.</para> +</listitem> +</orderedlist> +<para> +If the value of +<parameter>use.role.for.mediaobject</parameter> +is zero, then role attributes are not considered +and the first suitable object +with or without a role value is used. +</para> +</refsection> +</refentry> + +<refentry version="5.0" xml:id="ignore.image.scaling"> +<refmeta> +<refentrytitle>ignore.image.scaling</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>ignore.image.scaling</refname> +<refpurpose>Tell the stylesheets to ignore the author's image scaling attributes</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="ignore.image.scaling.frag"> +<xsl:param name="ignore.image.scaling" select="0"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, the scaling attributes on graphics and media objects are +ignored.</para> + +</refsection> +</refentry> + +</reference> +<reference xml:id="chunking"><title>Chunking</title> +<refentry version="5.0" xml:id="chunker.output.cdata-section-elements"> +<refmeta> +<refentrytitle>chunker.output.cdata-section-elements</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>chunker.output.cdata-section-elements</refname> +<refpurpose>List of elements to escape with CDATA sections</refpurpose> +</refnamediv> +<refsynopsisdiv> +<programlisting xml:id="chunker.output.cdata-section-elements.frag"> +<xsl:param name="chunker.output.cdata-section-elements"></xsl:param> +</programlisting> +</refsynopsisdiv> +<refsection><info><title>Description</title></info> +<para>This parameter specifies the list of elements that should be escaped +as CDATA sections by the chunking stylesheet. Not all processors support +specification of this parameter. +</para> +<note> +<para>This parameter is documented here, but the declaration is actually +in the <filename>chunker.xsl</filename> stylesheet module.</para> +</note> +</refsection> +</refentry> + +<refentry version="5.0" xml:id="chunker.output.doctype-public"> +<refmeta> +<refentrytitle>chunker.output.doctype-public</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>chunker.output.doctype-public</refname> +<refpurpose>Public identifer to use in the document type of generated pages</refpurpose> +</refnamediv> +<refsynopsisdiv> +<programlisting xml:id="chunker.output.doctype-public.frag"> +<xsl:param name="chunker.output.doctype-public"></xsl:param> +</programlisting> +</refsynopsisdiv> +<refsection><info><title>Description</title></info> +<para>This parameter specifies the public identifier that should be used by +the chunking stylesheet in the document type declaration of chunked pages. +Not all processors support specification of +this parameter. +</para> +<note> +<para>This parameter is documented here, but the declaration is actually +in the <filename>chunker.xsl</filename> stylesheet module.</para> +</note> +</refsection> +</refentry> + +<refentry version="5.0" xml:id="chunker.output.doctype-system"> +<refmeta> +<refentrytitle>chunker.output.doctype-system</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo> +</refmeta> +<refnamediv> +<refname>chunker.output.doctype-system</refname> +<refpurpose>System identifier to use for the document type in generated pages</refpurpose> +</refnamediv> +<refsynopsisdiv> +<programlisting xml:id="chunker.output.doctype-system.frag"> +<xsl:param name="chunker.output.doctype-system"></xsl:param> +</programlisting> +</refsynopsisdiv> +<refsection><info><title>Description</title></info> +<para>This parameter specifies the system identifier that should be used by +the chunking stylesheet in the document type declaration of chunked pages. +Not all processors support specification of +this parameter. +</para> +<note> +<para>This parameter is documented here, but the declaration is actually +in the <filename>chunker.xsl</filename> stylesheet module.</para> +</note> +</refsection> +</refentry> + +<refentry version="5.0" xml:id="chunker.output.encoding"> +<refmeta> +<refentrytitle>chunker.output.encoding</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>chunker.output.encoding</refname> +<refpurpose>Encoding used in generated pages</refpurpose> +</refnamediv> +<refsynopsisdiv> +<programlisting xml:id="chunker.output.encoding.frag"> +<xsl:param name="chunker.output.encoding">ISO-8859-1</xsl:param> +</programlisting> +</refsynopsisdiv> +<refsection><info><title>Description</title></info> +<para>This parameter specifies the encoding to be used in files +generated by the chunking stylesheet. Not all processors support +specification of this parameter. +</para> +<para>This parameter used to be named <literal>default.encoding</literal>.</para> +<note> +<para>This parameter is documented here, but the declaration is actually +in the <filename>chunker.xsl</filename> stylesheet module.</para> +</note> +</refsection> +</refentry> + +<refentry version="5.0" xml:id="chunker.output.indent"> +<refmeta> +<refentrytitle>chunker.output.indent</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>chunker.output.indent</refname> +<refpurpose>Specification of indentation on generated pages</refpurpose> +</refnamediv> +<refsynopsisdiv> +<programlisting xml:id="chunker.output.indent.frag"> +<xsl:param name="chunker.output.indent">no</xsl:param> +</programlisting> +</refsynopsisdiv> +<refsection><info><title>Description</title></info> +<para>This parameter specifies the value of the indent +specification for generated pages. Not all processors support +specification of this parameter. +</para> +<note> +<para>This parameter is documented here, but the declaration is actually +in the <filename>chunker.xsl</filename> stylesheet module.</para> +</note> +</refsection> +</refentry> + +<refentry version="5.0" xml:id="chunker.output.media-type"> +<refmeta> +<refentrytitle>chunker.output.media-type</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>chunker.output.media-type</refname> +<refpurpose>Media type to use in generated pages</refpurpose> +</refnamediv> +<refsynopsisdiv> +<programlisting xml:id="chunker.output.media-type.frag"> +<xsl:param name="chunker.output.media-type"></xsl:param> +</programlisting> +</refsynopsisdiv> +<refsection><info><title>Description</title></info> +<para>This parameter specifies the media type that should be used by +the chunking stylesheet. Not all processors support specification of +this parameter. +</para> +<para>This parameter specifies the media type that should be used by the +chunking stylesheet. This should be one from those defined in +<link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://www.ietf.org/rfc/rfc2045.txt">[RFC2045]</link> and + <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://www.ietf.org/rfc/rfc2046.txt">[RFC2046]</link> </para> +<note> +<para>This parameter is documented here, but the declaration is actually +in the <filename>chunker.xsl</filename> stylesheet module.</para> +<para>It must be one from html, xml or text</para> +</note> +</refsection> +</refentry> + +<refentry version="5.0" xml:id="chunker.output.method"> +<refmeta> +<refentrytitle>chunker.output.method</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">list</refmiscinfo> +<refmiscinfo class="other" otherclass="value">html</refmiscinfo> +<refmiscinfo class="other" otherclass="value">xml</refmiscinfo> +</refmeta> +<refnamediv> +<refname>chunker.output.method</refname> +<refpurpose>Method used in generated pages</refpurpose> +</refnamediv> +<refsynopsisdiv> +<programlisting xml:id="chunker.output.method.frag"> +<xsl:param name="chunker.output.method">html</xsl:param> +</programlisting> +</refsynopsisdiv> +<refsection><info><title>Description</title></info> +<para>This parameter specifies the output method to be used in files +generated by the chunking stylesheet. +</para> +<para>This parameter used to be named <literal>output.method</literal>.</para> +<note> +<para>This parameter is documented here, but the declaration is actually +in the <filename>chunker.xsl</filename> stylesheet module.</para> +</note> +</refsection> +</refentry> + +<refentry version="5.0" xml:id="chunker.output.omit-xml-declaration"> +<refmeta> +<refentrytitle>chunker.output.omit-xml-declaration</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>chunker.output.omit-xml-declaration</refname> +<refpurpose>Omit-xml-declaration for generated pages</refpurpose> +</refnamediv> +<refsynopsisdiv> +<programlisting xml:id="chunker.output.omit-xml-declaration.frag"> +<xsl:param name="chunker.output.omit-xml-declaration">no</xsl:param> +</programlisting> +</refsynopsisdiv> +<refsection><info><title>Description</title></info> +<para>This parameter specifies the value of the omit-xml-declaration +specification for generated pages. Not all processors support +specification of this parameter. +</para> +<note> +<para>This parameter is documented here, but the declaration is actually +in the <filename>chunker.xsl</filename> stylesheet module.</para> +</note> +</refsection> +</refentry> + +<refentry version="5.0" xml:id="chunker.output.standalone"> +<refmeta> +<refentrytitle>chunker.output.standalone</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>chunker.output.standalone</refname> +<refpurpose>Standalone declaration for generated pages</refpurpose> +</refnamediv> +<refsynopsisdiv> +<programlisting xml:id="chunker.output.standalone.frag"> +<xsl:param name="chunker.output.standalone">no</xsl:param> +</programlisting> +</refsynopsisdiv> +<refsection><info><title>Description</title></info> +<para>This parameter specifies the value of the standalone + specification for generated pages. It must be either + <literal>yes</literal> or <literal>no</literal>. Not all + processors support specification of this parameter. +</para> +<note> +<para>This parameter is documented here, but the declaration is actually +in the <filename>chunker.xsl</filename> stylesheet module.</para> +</note> +</refsection> +</refentry> + +<refentry version="5.0" xml:id="saxon.character.representation"> +<refmeta> +<refentrytitle>saxon.character.representation</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>saxon.character.representation</refname> +<refpurpose>Saxon character representation used in generated HTML pages</refpurpose> +</refnamediv> + +<refsynopsisdiv> + <programlisting xml:id="saxon.character.representation.frag"><xsl:param name="saxon.character.representation" select="'entity;decimal'"></xsl:param></programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>This parameter has effect only when Saxon 6 is used (version 6.4.2 or later). +It sets the character representation in files generated by the chunking stylesheets. +If you want to suppress entity references for characters with direct representations in +<parameter>chunker.output.encoding</parameter>, set the parameter value to <literal>native</literal>. +</para> + +<para> For more information, see <link xmlns:xlink="http://www.w3.org/1999/xlink" role="tcg" xlink:href="OutputEncoding.html#SaxonCharacter">Saxon output character representation</link>.</para> + +<note> +<para>This parameter is documented here, but the declaration is actually +in the <filename>chunker.xsl</filename> stylesheet module.</para> +</note> + +</refsection> + +</refentry> + +<refentry version="5.0" xml:id="html.ext"> +<refmeta> +<refentrytitle>html.ext</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>html.ext</refname> +<refpurpose>Identifies the extension of generated HTML files</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="html.ext.frag"> +<xsl:param name="html.ext">.html</xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The extension identified by <parameter>html.ext</parameter> will +be used as the filename extension for chunks created by this +stylesheet. </para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="use.id.as.filename"> +<refmeta> +<refentrytitle>use.id.as.filename</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>use.id.as.filename</refname> +<refpurpose>Use ID value of chunk elements as the filename?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="use.id.as.filename.frag"> +<xsl:param name="use.id.as.filename" select="0"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If <parameter>use.id.as.filename</parameter> +is non-zero, the filename of chunk elements that have IDs will be +derived from the ID value. +</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="html.extra.head.links"> +<refmeta> +<refentrytitle>html.extra.head.links</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>html.extra.head.links</refname> +<refpurpose>Toggle extra HTML head link information</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="html.extra.head.links.frag"> +<xsl:param name="html.extra.head.links" select="0"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, extra <tag>link</tag> elements will be +generated in the <tag>head</tag> of chunked HTML files. These +extra links point to chapters, appendixes, sections, etc. as supported +by the <quote>Site Navigation Bar</quote> in Mozilla 1.0 (as of CR1, at least). +</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="root.filename"> +<refmeta> +<refentrytitle>root.filename</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo> +</refmeta> +<refnamediv> +<refname>root.filename</refname> +<refpurpose>Identifies the name of the root HTML file when chunking</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="root.filename.frag"> +<xsl:param name="root.filename">index</xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The <parameter>root.filename</parameter> is the base filename for +the chunk created for the root of each document processed. +</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="base.dir"> +<refmeta> +<refentrytitle>base.dir</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo> +</refmeta> +<refnamediv> +<refname>base.dir</refname> +<refpurpose>The base directory of chunks</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="base.dir.frag"> +<xsl:param name="base.dir"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If specified, the <parameter>base.dir</parameter> identifies +the output directory for chunks. (If not specified, the output directory +is system dependent.)</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="generate.manifest"> + <refmeta> + <refentrytitle>generate.manifest</refentrytitle> + <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> + </refmeta> + <refnamediv> + <refname>generate.manifest</refname> + <refpurpose>Generate a manifest file?</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <programlisting xml:id="generate.manifest.frag"><xsl:param name="generate.manifest" select="0"></xsl:param></programlisting> + </refsynopsisdiv> + + <refsection><info><title>Description</title></info> + + <para>If non-zero, a list of HTML files generated by the + stylesheet transformation is written to the file named by + the <parameter>manifest</parameter> parameter.</para> + + </refsection> +</refentry> + +<refentry version="5.0" xml:id="manifest"> + <refmeta> + <refentrytitle>manifest</refentrytitle> + <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> + </refmeta> + <refnamediv> + <refname>manifest</refname> + <refpurpose>Name of manifest file</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <programlisting xml:id="manifest.frag"> + <xsl:param name="manifest">HTML.manifest</xsl:param> + </programlisting> + </refsynopsisdiv> + + <refsection><info><title>Description</title></info> + + <para>The name of the file to which a manifest is written (if the + value of the <parameter>generate.manifest</parameter> parameter + is non-zero).</para> + + </refsection> +</refentry> + +<refentry version="5.0" xml:id="manifest.in.base.dir"> +<refmeta> +<refentrytitle>manifest.in.base.dir</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>manifest.in.base.dir</refname> +<refpurpose>Should the manifest file be written into <parameter>base.dir</parameter>?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="manifest.in.base.dir.frag"> +<xsl:param name="manifest.in.base.dir" select="0"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, the manifest file as well as project files for HTML Help and +Eclipse Help are written into <parameter>base.dir</parameter> instead +of the current directory.</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="chunk.toc"> +<refmeta> +<refentrytitle>chunk.toc</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>chunk.toc</refname> +<refpurpose>An explicit TOC to be used for chunking</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="chunk.toc.frag"> +<xsl:param name="chunk.toc"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The <parameter>chunk.toc</parameter> identifies an explicit TOC that +will be used for chunking. This parameter is only used by the +<filename>chunktoc.xsl</filename> stylesheet (and customization layers built +from it).</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="chunk.tocs.and.lots"> +<refmeta> +<refentrytitle>chunk.tocs.and.lots</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>chunk.tocs.and.lots</refname> +<refpurpose>Should ToC and LoTs be in separate chunks?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="chunk.tocs.and.lots.frag"> +<xsl:param name="chunk.tocs.and.lots" select="0"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, ToC and LoT (List of Examples, List of Figures, etc.) +will be put in a separate chunk. At the moment, this chunk is not in the +normal forward/backward navigation list. Instead, a new link is added to the +navigation footer.</para> + +<para>This feature is still somewhat experimental. Feedback welcome.</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="chunk.separate.lots"> +<refmeta> +<refentrytitle>chunk.separate.lots</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>chunk.separate.lots</refname> +<refpurpose>Should each LoT be in its own separate chunk?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="chunk.separate.lots.frag"> +<xsl:param name="chunk.separate.lots" select="0"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, each of the ToC and LoTs +(List of Examples, List of Figures, etc.) +will be put in its own separate chunk. +The title page includes generated links to each of the separate files. +</para> +<para> +This feature depends on the +<parameter>chunk.tocs.and.lots</parameter> +parameter also being non-zero. +</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="chunk.tocs.and.lots.has.title"> +<refmeta> +<refentrytitle>chunk.tocs.and.lots.has.title</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>chunk.tocs.and.lots.has.title</refname> +<refpurpose>Should ToC and LoTs in a separate chunks have title?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="chunk.tocs.and.lots.has.title.frag"> +<xsl:param name="chunk.tocs.and.lots.has.title" select="1"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero title of document is shown before ToC/LoT in +separate chunk.</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="chunk.section.depth"> +<refmeta> +<refentrytitle>chunk.section.depth</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo> +</refmeta> +<refnamediv> +<refname>chunk.section.depth</refname> +<refpurpose>Depth to which sections should be chunked</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="chunk.section.depth.frag"> +<xsl:param name="chunk.section.depth" select="1"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>This parameter sets the depth of section chunking.</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="chunk.first.sections"> +<refmeta> +<refentrytitle>chunk.first.sections</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>chunk.first.sections</refname> +<refpurpose>Chunk the first top-level section?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="chunk.first.sections.frag"> +<xsl:param name="chunk.first.sections" select="0"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, a chunk will be created for the first top-level +<tag>sect1</tag> or <tag>section</tag> elements in +each component. Otherwise, that section will be part of the chunk for +its parent. +</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="chunk.quietly"> +<refmeta> +<refentrytitle>chunk.quietly</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>chunk.quietly</refname> +<refpurpose>Omit the chunked filename messages.</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="chunk.quietly.frag"> +<xsl:param name="chunk.quietly" select="0"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If zero (the default), the XSL processor emits a message naming +each separate chunk filename as it is being output. +If nonzero, then the messages are suppressed. +</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="chunk.append"> +<refmeta> +<refentrytitle>chunk.append</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>chunk.append</refname> +<refpurpose>Specifies content to append to chunked HTML output</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="chunk.append.frag"><xsl:param name="chunk.append"></xsl:param></programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Specifies content to append to the end of HTML files output by +the <filename>html/chunk.xsl</filename> stylesheet, after the closing +<code><html></code> 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: <code>&#x0a;</code> or +<code>&#10;</code></para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="navig.graphics"> +<refmeta> +<refentrytitle>navig.graphics</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>navig.graphics</refname> +<refpurpose>Use graphics in navigational headers and footers?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="navig.graphics.frag"> +<xsl:param name="navig.graphics" select="0"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, the navigational headers and footers in chunked +HTML are presented in an alternate style that uses graphical icons for +Next, Previous, Up, and Home. Default graphics are provided in the +distribution. If zero, text is used instead of graphics. +</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="navig.graphics.extension"> +<refmeta> +<refentrytitle>navig.graphics.extension</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>navig.graphics.extension</refname> +<refpurpose>Extension for navigational graphics</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="navig.graphics.extension.frag"> +<xsl:param name="navig.graphics.extension">.gif</xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Sets the filename extension to use on navigational graphics used +in the headers and footers of chunked HTML.</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="navig.graphics.path"> +<refmeta> +<refentrytitle>navig.graphics.path</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>navig.graphics.path</refname> +<refpurpose>Path to navigational graphics</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="navig.graphics.path.frag"> +<xsl:param name="navig.graphics.path">images/</xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Sets the path, probably relative to the directory where the HTML +files are created, to the navigational graphics used in the +headers and footers of chunked HTML. +</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="navig.showtitles"> +<refmeta> +<refentrytitle>navig.showtitles</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>navig.showtitles</refname> +<refpurpose>Display titles in HTML headers and footers?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="navig.showtitles.frag"><xsl:param name="navig.showtitles">1</xsl:param></programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, +the headers and footers of chunked HTML +display the titles of the next and previous chunks, +along with the words 'Next' and 'Previous' (or the +equivalent graphical icons if navig.graphics is true). +If false (zero), then only the words 'Next' and 'Previous' +(or the icons) are displayed. +</para> + +</refsection> +</refentry> + +</reference> +<reference xml:id="profiling"><title>Profiling</title> +<partintro xml:id="partintro"> +<para>The following parameters can be used for attribute-based +profiling of your document. For more information about profiling, see +<link xmlns:xlink="http://www.w3.org/1999/xlink" role="tcg" xlink:href="Profiling.html">Profiling (conditional text)</link>.</para> +</partintro> +<refentry version="5.0" xml:id="profile.arch"> +<refmeta> +<refentrytitle>profile.arch</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>profile.arch</refname> +<refpurpose>Target profile for <tag class="attribute">arch</tag> +attribute</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="profile.arch.frag"> +<xsl:param name="profile.arch"></xsl:param> +</programlisting> +</refsynopsisdiv> + + +<refsection><info><title>Description</title></info> + +<para>The value of this parameter specifies profiles which should be +included in the output. You can specify multiple profiles by +separating them by semicolon. You can change separator character by +<parameter>profile.separator</parameter> +parameter.</para> + +<para>This parameter has effect only when you are using profiling +stylesheets (<filename>profile-docbook.xsl</filename>, +<filename>profile-chunk.xsl</filename>, …) instead of normal +ones (<filename>docbook.xsl</filename>, +<filename>chunk.xsl</filename>, …).</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="profile.audience"> +<refmeta> +<refentrytitle>profile.audience</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>profile.audience</refname> +<refpurpose>Target profile for <tag class="attribute">audience</tag> +attribute</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="profile.audience.frag"> +<xsl:param name="profile.audience"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Value of this parameter specifies profiles which should be +included in the output. You can specify multiple profiles by +separating them by semicolon. You can change separator character by +<parameter>profile.separator</parameter> +parameter.</para> + +<para>This parameter has effect only when you are using profiling +stylesheets (<filename>profile-docbook.xsl</filename>, +<filename>profile-chunk.xsl</filename>, …) instead of normal +ones (<filename>docbook.xsl</filename>, +<filename>chunk.xsl</filename>, …).</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="profile.condition"> +<refmeta> +<refentrytitle>profile.condition</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>profile.condition</refname> +<refpurpose>Target profile for <tag class="attribute">condition</tag> +attribute</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="profile.condition.frag"> +<xsl:param name="profile.condition"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The value of this parameter specifies profiles which should be +included in the output. You can specify multiple profiles by +separating them by semicolon. You can change separator character by +<parameter>profile.separator</parameter> +parameter.</para> + +<para>This parameter has effect only when you are using profiling +stylesheets (<filename>profile-docbook.xsl</filename>, +<filename>profile-chunk.xsl</filename>, …) instead of normal +ones (<filename>docbook.xsl</filename>, +<filename>chunk.xsl</filename>, …).</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="profile.conformance"> +<refmeta> +<refentrytitle>profile.conformance</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>profile.conformance</refname> +<refpurpose>Target profile for <tag class="attribute">conformance</tag> +attribute</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="profile.conformance.frag"> +<xsl:param name="profile.conformance"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The value of this parameter specifies profiles which should be +included in the output. You can specify multiple profiles by +separating them by semicolon. You can change separator character by +<parameter>profile.separator</parameter> +parameter.</para> + +<para>This parameter has effect only when you are using profiling +stylesheets (<filename>profile-docbook.xsl</filename>, +<filename>profile-chunk.xsl</filename>, …) instead of normal +ones (<filename>docbook.xsl</filename>, +<filename>chunk.xsl</filename>, …).</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="profile.lang"> +<refmeta> +<refentrytitle>profile.lang</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>profile.lang</refname> +<refpurpose>Target profile for <tag class="attribute">lang</tag> +attribute</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="profile.lang.frag"> +<xsl:param name="profile.lang"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The value of this parameter specifies profiles which should be +included in the output. You can specify multiple profiles by +separating them by semicolon. You can change separator character by +<parameter>profile.separator</parameter> +parameter.</para> + +<para>This parameter has effect only when you are using profiling +stylesheets (<filename>profile-docbook.xsl</filename>, +<filename>profile-chunk.xsl</filename>, …) instead of normal +ones (<filename>docbook.xsl</filename>, +<filename>chunk.xsl</filename>, …).</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="profile.os"> +<refmeta> +<refentrytitle>profile.os</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>profile.os</refname> +<refpurpose>Target profile for <tag class="attribute">os</tag> +attribute</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="profile.os.frag"> +<xsl:param name="profile.os"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The value of this parameter specifies profiles which should be +included in the output. You can specify multiple profiles by +separating them by semicolon. You can change separator character by +<parameter>profile.separator</parameter> +parameter.</para> + +<para>This parameter has effect only when you are using profiling +stylesheets (<filename>profile-docbook.xsl</filename>, +<filename>profile-chunk.xsl</filename>, …) instead of normal +ones (<filename>docbook.xsl</filename>, +<filename>chunk.xsl</filename>, …).</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="profile.revision"> +<refmeta> +<refentrytitle>profile.revision</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>profile.revision</refname> +<refpurpose>Target profile for <tag class="attribute">revision</tag> +attribute</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="profile.revision.frag"> +<xsl:param name="profile.revision"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The value of this parameter specifies profiles which should be +included in the output. You can specify multiple profiles by +separating them by semicolon. You can change separator character by +<parameter>profile.separator</parameter> +parameter.</para> + +<para>This parameter has effect only when you are using profiling +stylesheets (<filename>profile-docbook.xsl</filename>, +<filename>profile-chunk.xsl</filename>, …) instead of normal +ones (<filename>docbook.xsl</filename>, +<filename>chunk.xsl</filename>, …).</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="profile.revisionflag"> +<refmeta> +<refentrytitle>profile.revisionflag</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>profile.revisionflag</refname> +<refpurpose>Target profile for <tag class="attribute">revisionflag</tag> +attribute</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="profile.revisionflag.frag"> +<xsl:param name="profile.revisionflag"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The value of this parameter specifies profiles which should be +included in the output. You can specify multiple profiles by +separating them by semicolon. You can change separator character by +<parameter>profile.separator</parameter> +parameter.</para> + +<para>This parameter has effect only when you are using profiling +stylesheets (<filename>profile-docbook.xsl</filename>, +<filename>profile-chunk.xsl</filename>, …) instead of normal +ones (<filename>docbook.xsl</filename>, +<filename>chunk.xsl</filename>, …).</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="profile.role"> +<refmeta> +<refentrytitle>profile.role</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>profile.role</refname> +<refpurpose>Target profile for <tag class="attribute">role</tag> +attribute</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="profile.role.frag"> +<xsl:param name="profile.role"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The value of this parameter specifies profiles which should be +included in the output. You can specify multiple profiles by +separating them by semicolon. You can change separator character by +<parameter>profile.separator</parameter> +parameter.</para> + +<para>This parameter has effect only when you are using profiling +stylesheets (<filename>profile-docbook.xsl</filename>, +<filename>profile-chunk.xsl</filename>, …) instead of normal +ones (<filename>docbook.xsl</filename>, +<filename>chunk.xsl</filename>, …).</para> + +<warning> +<para>Note that <tag class="attribute">role</tag> is often +used for other purposes than profiling. For example it is commonly +used to get emphasize in bold font:</para> + +<programlisting><emphasis role="bold">very important</emphasis></programlisting> + +<para>If you are using <tag class="attribute">role</tag> for +these purposes do not forget to add values like <literal>bold</literal> to +value of this parameter. If you forgot you will get document with +small pieces missing which are very hard to track.</para> + +<para>For this reason it is not recommended to use <tag class="attribute">role</tag> attribute for profiling. You should +rather use profiling specific attributes like <tag class="attribute">userlevel</tag>, <tag class="attribute">os</tag>, <tag class="attribute">arch</tag>, <tag class="attribute">condition</tag>, etc.</para> +</warning> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="profile.security"> +<refmeta> +<refentrytitle>profile.security</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>profile.security</refname> +<refpurpose>Target profile for <tag class="attribute">security</tag> +attribute</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="profile.security.frag"> +<xsl:param name="profile.security"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The value of this parameter specifies profiles which should be +included in the output. You can specify multiple profiles by +separating them by semicolon. You can change separator character by +<parameter>profile.separator</parameter> +parameter.</para> + +<para>This parameter has effect only when you are using profiling +stylesheets (<filename>profile-docbook.xsl</filename>, +<filename>profile-chunk.xsl</filename>, …) instead of normal +ones (<filename>docbook.xsl</filename>, +<filename>chunk.xsl</filename>, …).</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="profile.status"> +<refmeta> +<refentrytitle>profile.status</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>profile.status</refname> +<refpurpose>Target profile for <tag class="attribute">status</tag> +attribute</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="profile.status.frag"> +<xsl:param name="profile.status"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The value of this parameter specifies profiles which should be +included in the output. You can specify multiple profiles by +separating them by semicolon. You can change separator character by +<parameter>profile.separator</parameter> +parameter.</para> + +<para>This parameter has effect only when you are using profiling +stylesheets (<filename>profile-docbook.xsl</filename>, +<filename>profile-chunk.xsl</filename>, …) instead of normal +ones (<filename>docbook.xsl</filename>, +<filename>chunk.xsl</filename>, …).</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="profile.userlevel"> +<refmeta> +<refentrytitle>profile.userlevel</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>profile.userlevel</refname> +<refpurpose>Target profile for <tag class="attribute">userlevel</tag> +attribute</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="profile.userlevel.frag"> +<xsl:param name="profile.userlevel"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The value of this parameter specifies profiles which should be +included in the output. You can specify multiple profiles by +separating them by semicolon. You can change separator character by +<parameter>profile.separator</parameter> +parameter.</para> + +<para>This parameter has effect only when you are using profiling +stylesheets (<filename>profile-docbook.xsl</filename>, +<filename>profile-chunk.xsl</filename>, …) instead of normal +ones (<filename>docbook.xsl</filename>, +<filename>chunk.xsl</filename>, …).</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="profile.vendor"> +<refmeta> +<refentrytitle>profile.vendor</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>profile.vendor</refname> +<refpurpose>Target profile for <tag class="attribute">vendor</tag> +attribute</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="profile.vendor.frag"> +<xsl:param name="profile.vendor"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The value of this parameter specifies profiles which should be +included in the output. You can specify multiple profiles by +separating them by semicolon. You can change separator character by +<parameter>profile.separator</parameter> +parameter.</para> + +<para>This parameter has effect only when you are using profiling +stylesheets (<filename>profile-docbook.xsl</filename>, +<filename>profile-chunk.xsl</filename>, …) instead of normal +ones (<filename>docbook.xsl</filename>, +<filename>chunk.xsl</filename>, …).</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="profile.wordsize"> +<refmeta> +<refentrytitle>profile.wordsize</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>profile.wordsize</refname> +<refpurpose>Target profile for <tag class="attribute">wordsize</tag> +attribute</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="profile.wordsize.frag"> +<xsl:param name="profile.wordsize"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The value of this parameter specifies profiles which should be +included in the output. You can specify multiple profiles by +separating them by semicolon. You can change separator character by +<parameter>profile.separator</parameter> +parameter.</para> + +<para>This parameter has effect only when you are using profiling +stylesheets (<filename>profile-docbook.xsl</filename>, +<filename>profile-chunk.xsl</filename>, …) instead of normal +ones (<filename>docbook.xsl</filename>, +<filename>chunk.xsl</filename>, …).</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="profile.attribute"> +<refmeta> +<refentrytitle>profile.attribute</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>profile.attribute</refname> +<refpurpose>Name of user-specified profiling attribute</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="profile.attribute.frag"> +<xsl:param name="profile.attribute"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>This parameter is used in conjuction with +<parameter>profile.value</parameter>.</para> + +<para>This parameter has effect only when you are using profiling +stylesheets (<filename>profile-docbook.xsl</filename>, +<filename>profile-chunk.xsl</filename>, …) instead of normal +ones (<filename>docbook.xsl</filename>, +<filename>chunk.xsl</filename>, …).</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="profile.value"> +<refmeta> +<refentrytitle>profile.value</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>profile.value</refname> +<refpurpose>Target profile for user-specified attribute</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="profile.value.frag"> +<xsl:param name="profile.value"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>When you are using this parameter you must also specify name of +profiling attribute with parameter +<parameter>profile.attribute</parameter>.</para> + +<para>The value of this parameter specifies profiles which should be +included in the output. You can specify multiple profiles by +separating them by semicolon. You can change separator character by +<parameter>profile.separator</parameter> +parameter.</para> + +<para>This parameter has effect only when you are using profiling +stylesheets (<filename>profile-docbook.xsl</filename>, +<filename>profile-chunk.xsl</filename>, …) instead of normal +ones (<filename>docbook.xsl</filename>, +<filename>chunk.xsl</filename>, …).</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="profile.separator"> +<refmeta> +<refentrytitle>profile.separator</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>profile.separator</refname> +<refpurpose>Separator character for compound profile values</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="profile.separator.frag"> +<xsl:param name="profile.separator">;</xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Separator character used for compound profile values. See <parameter>profile.arch</parameter></para> + +</refsection> +</refentry> + +</reference> +<reference xml:id="htmlhelp"><title>HTML Help</title> +<refentry version="5.0" xml:id="htmlhelp.encoding"> +<refmeta> +<refentrytitle>htmlhelp.encoding</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.encoding</refname> +<refpurpose>Character encoding to use in files for HTML Help compiler.</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="htmlhelp.encoding.frag"> +<xsl:param name="htmlhelp.encoding">iso-8859-1</xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>HTML Help Compiler is not UTF-8 aware, so you should always use an +appropriate single-byte encoding here. Use one from <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="ftp://ftp.isi.edu/in-notes/iana/assignments/character-sets">iana</link>, the registered charset values.</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="htmlhelp.autolabel"> +<refmeta> +<refentrytitle>htmlhelp.autolabel</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.autolabel</refname> +<refpurpose>Should tree-like ToC use autonumbering feature?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="htmlhelp.autolabel.frag"> +<xsl:param name="htmlhelp.autolabel" select="0"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Set this to non-zero to include chapter and section numbers into ToC +in the left panel.</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="htmlhelp.chm"> +<refmeta> +<refentrytitle>htmlhelp.chm</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.chm</refname> +<refpurpose>Filename of output HTML Help file.</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="htmlhelp.chm.frag"> +<xsl:param name="htmlhelp.chm">htmlhelp.chm</xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Set the name of resulting CHM file</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="htmlhelp.default.topic"> +<refmeta> +<refentrytitle>htmlhelp.default.topic</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.default.topic</refname> +<refpurpose>Name of file with default topic</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="htmlhelp.default.topic.frag"> +<xsl:param name="htmlhelp.default.topic"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Normally first chunk of document is displayed when you open HTML +Help file. If you want to display another topic, simply set its +filename by this parameter.</para> + +<para>This is useful especially if you don't generate ToC in front of +your document and you also hide root element in ToC. E.g.:</para> + +<programlisting><xsl:param name="generate.book.toc" select="0"/> +<xsl:param name="htmlhelp.hhc.show.root" select="0"/> +<xsl:param name="htmlhelp.default.topic">pr01.html</xsl:param> +</programlisting> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="htmlhelp.display.progress"> +<refmeta> +<refentrytitle>htmlhelp.display.progress</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.display.progress</refname> +<refpurpose>Display compile progress?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="htmlhelp.display.progress.frag"> +<xsl:param name="htmlhelp.display.progress" select="1"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Set to non-zero to to display compile progress +</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="htmlhelp.hhp"> +<refmeta> +<refentrytitle>htmlhelp.hhp</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.hhp</refname> +<refpurpose>Filename of project file.</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="htmlhelp.hhp.frag"> +<xsl:param name="htmlhelp.hhp">htmlhelp.hhp</xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Change this parameter if you want different name of project +file than htmlhelp.hhp.</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="htmlhelp.hhc"> +<refmeta> +<refentrytitle>htmlhelp.hhc</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.hhc</refname> +<refpurpose>Filename of TOC file.</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="htmlhelp.hhc.frag"> +<xsl:param name="htmlhelp.hhc">toc.hhc</xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Set the name of the TOC file. The default is <filename>toc.hhc</filename>.</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="htmlhelp.hhk"> +<refmeta> +<refentrytitle>htmlhelp.hhk</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.hhk</refname> +<refpurpose>Filename of index file.</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="htmlhelp.hhk.frag"> +<xsl:param name="htmlhelp.hhk">index.hhk</xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>set the name of the index file. The default is <filename>index.hhk</filename>.</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="htmlhelp.hhp.tail"> +<refmeta> +<refentrytitle>htmlhelp.hhp.tail</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.hhp.tail</refname> +<refpurpose>Additional content for project file.</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="htmlhelp.hhp.tail.frag"> +<xsl:param name="htmlhelp.hhp.tail"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If you want to include some additional parameters into project file, +store appropriate part of project file into this parameter.</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="htmlhelp.hhp.window"> +<refmeta> +<refentrytitle>htmlhelp.hhp.window</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.hhp.window</refname> +<refpurpose>Name of default window.</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="htmlhelp.hhp.window.frag"> +<xsl:param name="htmlhelp.hhp.window">Main</xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Name of default window. If empty no [WINDOWS] section will be +added to project file.</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="htmlhelp.hhp.windows"> +<refmeta> +<refentrytitle>htmlhelp.hhp.windows</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.hhp.windows</refname> +<refpurpose>Definition of additional windows</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="htmlhelp.hhp.windows.frag"> +<xsl:param name="htmlhelp.hhp.windows"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Content of this parameter is placed at the end of [WINDOWS] +section of project file. You can use it for defining your own +addtional windows.</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="htmlhelp.enhanced.decompilation"> +<refmeta> +<refentrytitle>htmlhelp.enhanced.decompilation</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.enhanced.decompilation</refname> +<refpurpose>Allow enhanced decompilation of CHM?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="htmlhelp.enhanced.decompilation.frag"> +<xsl:param name="htmlhelp.enhanced.decompilation" select="0"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>When non-zero this parameter enables enhanced decompilation of CHM.</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="htmlhelp.enumerate.images"> +<refmeta> +<refentrytitle>htmlhelp.enumerate.images</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.enumerate.images</refname> +<refpurpose>Should the paths to all used images be added to the project file?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="htmlhelp.enumerate.images.frag"> +<xsl:param name="htmlhelp.enumerate.images" select="0"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Set to non-zero if you insert images into your documents as +external binary entities or if you are using absolute image paths.</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="htmlhelp.force.map.and.alias"> +<refmeta> +<refentrytitle>htmlhelp.force.map.and.alias</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.force.map.and.alias</refname> +<refpurpose>Should [MAP] and [ALIAS] sections be added to the project file unconditionally?</refpurpose> +</refnamediv> +<refsynopsisdiv> +<programlisting xml:id="htmlhelp.force.map.and.alias.frag"> +<xsl:param name="htmlhelp.force.map.and.alias" select="0"></xsl:param> +</programlisting> +</refsynopsisdiv> +<refsection><info><title>Description</title></info> + <para>Set to non-zero if you have your own + <literal>alias.h</literal> and <literal>context.h</literal> + files and you want to include references to them in the project + file.</para> +</refsection> +</refentry> + +<refentry version="5.0" xml:id="htmlhelp.map.file"> +<refmeta> +<refentrytitle>htmlhelp.map.file</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.map.file</refname> +<refpurpose>Filename of map file.</refpurpose> +</refnamediv> +<refsynopsisdiv> +<programlisting xml:id="htmlhelp.map.file.frag"> +<xsl:param name="htmlhelp.map.file">context.h</xsl:param> +</programlisting> +</refsynopsisdiv> +<refsection><info><title>Description</title></info> +<para>Set the name of map file. The default is + <filename>context.h</filename>. (used for context-sensitive + help).</para> +</refsection> +</refentry> + +<refentry version="5.0" xml:id="htmlhelp.alias.file"> +<refmeta> +<refentrytitle>htmlhelp.alias.file</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.alias.file</refname> +<refpurpose>Filename of alias file.</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="htmlhelp.alias.file.frag"> +<xsl:param name="htmlhelp.alias.file">alias.h</xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Specifies the filename of the alias file (used for context-sensitive help).</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="htmlhelp.hhc.section.depth"> +<refmeta> +<refentrytitle>htmlhelp.hhc.section.depth</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.hhc.section.depth</refname> +<refpurpose>Depth of TOC for sections in a left pane.</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="htmlhelp.hhc.section.depth.frag"> +<xsl:param name="htmlhelp.hhc.section.depth">5</xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Set the section depth in the left pane of HTML Help viewer. </para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="htmlhelp.hhc.show.root"> +<refmeta> +<refentrytitle>htmlhelp.hhc.show.root</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.hhc.show.root</refname> +<refpurpose>Should there be an entry for the root element in the ToC?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="htmlhelp.hhc.show.root.frag"> +<xsl:param name="htmlhelp.hhc.show.root" select="1"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If set to zero, there will be no entry for the root element in the +ToC. This is useful when you want to provide the user with an expanded +ToC as a default.</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="htmlhelp.hhc.folders.instead.books"> +<refmeta> +<refentrytitle>htmlhelp.hhc.folders.instead.books</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.hhc.folders.instead.books</refname> +<refpurpose>Use folder icons in ToC (instead of book icons)?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="htmlhelp.hhc.folders.instead.books.frag"> +<xsl:param name="htmlhelp.hhc.folders.instead.books" select="1"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Set to non-zero for folder-like icons or zero for book-like icons in the ToC. +If you want to use folder-like icons, you must switch off the binary ToC using +<parameter>htmlhelp.hhc.binary</parameter>. + +</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="htmlhelp.hhc.binary"> +<refmeta> +<refentrytitle>htmlhelp.hhc.binary</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.hhc.binary</refname> +<refpurpose>Generate binary ToC?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="htmlhelp.hhc.binary.frag"> +<xsl:param name="htmlhelp.hhc.binary" select="1"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Set to non-zero to generate a binary TOC. You must create a binary TOC +if you want to add Prev/Next buttons to toolbar (which is default +behaviour). Files with binary TOC can't be merged.</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="htmlhelp.hhc.width"> +<refmeta> +<refentrytitle>htmlhelp.hhc.width</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.hhc.width</refname> +<refpurpose>Width of navigation pane</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="htmlhelp.hhc.width.frag"> +<xsl:param name="htmlhelp.hhc.width"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>This parameter specifies the width of the navigation pane (containing TOC and +other navigation tabs) in pixels.</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="htmlhelp.title"> +<refmeta> +<refentrytitle>htmlhelp.title</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.title</refname> +<refpurpose>Title of HTML Help</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="htmlhelp.title.frag"> +<xsl:param name="htmlhelp.title"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Content of this parameter will be used as a title for generated +HTML Help. If empty, title will be automatically taken from document.</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="htmlhelp.show.menu"> +<refmeta> +<refentrytitle>htmlhelp.show.menu</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.show.menu</refname> +<refpurpose>Should the menu bar be shown?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="htmlhelp.show.menu.frag"> +<xsl:param name="htmlhelp.show.menu" select="0"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Set to non-zero to have an application menu bar in your HTML Help window. +</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="htmlhelp.show.toolbar.text"> +<refmeta> +<refentrytitle>htmlhelp.show.toolbar.text</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.show.toolbar.text</refname> +<refpurpose>Show text under toolbar buttons?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="htmlhelp.show.toolbar.text.frag"> +<xsl:param name="htmlhelp.show.toolbar.text" select="1"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Set to non-zero to display texts under toolbar buttons, zero to switch +off displays.</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="htmlhelp.show.advanced.search"> +<refmeta> +<refentrytitle>htmlhelp.show.advanced.search</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.show.advanced.search</refname> +<refpurpose>Should advanced search features be available?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="htmlhelp.show.advanced.search.frag"> +<xsl:param name="htmlhelp.show.advanced.search" select="0"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If you want advanced search features in your help, turn this +parameter to 1.</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="htmlhelp.show.favorities"> +<refmeta> +<refentrytitle>htmlhelp.show.favorities</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.show.favorities</refname> +<refpurpose>Should the Favorites tab be shown?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="htmlhelp.show.favorities.frag"> +<xsl:param name="htmlhelp.show.favorities" select="0"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Set to non-zero to include a Favorites tab in the navigation pane +of the help window.</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="htmlhelp.button.hideshow"> +<refmeta> +<refentrytitle>htmlhelp.button.hideshow</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.button.hideshow</refname> +<refpurpose>Should the Hide/Show button be shown?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="htmlhelp.button.hideshow.frag"> +<xsl:param name="htmlhelp.button.hideshow" select="1"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Set to non-zero to include the Hide/Show button shown on toolbar</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="htmlhelp.button.back"> +<refmeta> +<refentrytitle>htmlhelp.button.back</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.button.back</refname> +<refpurpose>Should the Back button be shown?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="htmlhelp.button.back.frag"> +<xsl:param name="htmlhelp.button.back" select="1"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Set to non-zero to include the Hide/Show button shown on toolbar</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="htmlhelp.button.forward"> +<refmeta> +<refentrytitle>htmlhelp.button.forward</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.button.forward</refname> +<refpurpose>Should the Forward button be shown?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="htmlhelp.button.forward.frag"> +<xsl:param name="htmlhelp.button.forward" select="0"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Set to non-zero to include the Forward button on the toolbar.</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="htmlhelp.button.stop"> +<refmeta> +<refentrytitle>htmlhelp.button.stop</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.button.stop</refname> +<refpurpose>Should the Stop button be shown?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="htmlhelp.button.stop.frag"> +<xsl:param name="htmlhelp.button.stop" select="0"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If you want Stop button shown on toolbar, turn this +parameter to 1.</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="htmlhelp.button.refresh"> +<refmeta> +<refentrytitle>htmlhelp.button.refresh</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.button.refresh</refname> +<refpurpose>Should the Refresh button be shown?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="htmlhelp.button.refresh.frag"> +<xsl:param name="htmlhelp.button.refresh" select="0"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Set to non-zero to include the Stop button on the toolbar.</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="htmlhelp.button.home"> +<refmeta> +<refentrytitle>htmlhelp.button.home</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.button.home</refname> +<refpurpose>Should the Home button be shown?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="htmlhelp.button.home.frag"> +<xsl:param name="htmlhelp.button.home" select="0"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Set to non-zero to include the Home button on the toolbar.</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="htmlhelp.button.home.url"> +<refmeta> +<refentrytitle>htmlhelp.button.home.url</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.button.home.url</refname> +<refpurpose>URL address of page accessible by Home button</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="htmlhelp.button.home.url.frag"> +<xsl:param name="htmlhelp.button.home.url"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>URL address of page accessible by Home button.</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="htmlhelp.button.options"> +<refmeta> +<refentrytitle>htmlhelp.button.options</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.button.options</refname> +<refpurpose>Should the Options button be shown?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="htmlhelp.button.options.frag"> +<xsl:param name="htmlhelp.button.options" select="1"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If you want Options button shown on toolbar, turn this +parameter to 1.</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="htmlhelp.button.print"> +<refmeta> +<refentrytitle>htmlhelp.button.print</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.button.print</refname> +<refpurpose>Should the Print button be shown?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="htmlhelp.button.print.frag"> +<xsl:param name="htmlhelp.button.print" select="1"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Set to non-zero to include the Print button on the toolbar. +</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="htmlhelp.button.locate"> +<refmeta> +<refentrytitle>htmlhelp.button.locate</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.button.locate</refname> +<refpurpose>Should the Locate button be shown?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="htmlhelp.button.locate.frag"> +<xsl:param name="htmlhelp.button.locate" select="0"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If you want Locate button shown on toolbar, turn this +parameter to 1.</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="htmlhelp.button.jump1"> +<refmeta> +<refentrytitle>htmlhelp.button.jump1</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.button.jump1</refname> +<refpurpose>Should the Jump1 button be shown?</refpurpose> +</refnamediv> +<refsynopsisdiv> +<programlisting xml:id="htmlhelp.button.jump1.frag"> +<xsl:param name="htmlhelp.button.jump1" select="0"></xsl:param> +</programlisting> +</refsynopsisdiv> +<refsection><info><title>Description</title></info> + <para>Set to non-zero to include the <literal>Jump1</literal> button on the toolbar.</para> +</refsection> +</refentry> + +<refentry version="5.0" xml:id="htmlhelp.button.jump1.url"> +<refmeta> +<refentrytitle>htmlhelp.button.jump1.url</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.button.jump1.url</refname> +<refpurpose>URL address of page accessible by Jump1 button</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="htmlhelp.button.jump1.url.frag"> +<xsl:param name="htmlhelp.button.jump1.url"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>URL address of page accessible by Jump1 button.</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="htmlhelp.button.jump1.title"> +<refmeta> +<refentrytitle>htmlhelp.button.jump1.title</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.button.jump1.title</refname> +<refpurpose>Title of Jump1 button</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="htmlhelp.button.jump1.title.frag"> +<xsl:param name="htmlhelp.button.jump1.title">User1</xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Title of Jump1 button.</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="htmlhelp.button.jump2"> +<refmeta> +<refentrytitle>htmlhelp.button.jump2</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.button.jump2</refname> +<refpurpose>Should the Jump2 button be shown?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="htmlhelp.button.jump2.frag"> +<xsl:param name="htmlhelp.button.jump2" select="0"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Set to non-zero to include the Jump2 button on the toolbar.</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="htmlhelp.button.jump2.url"> +<refmeta> +<refentrytitle>htmlhelp.button.jump2.url</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.button.jump2.url</refname> +<refpurpose>URL address of page accessible by Jump2 button</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="htmlhelp.button.jump2.url.frag"> +<xsl:param name="htmlhelp.button.jump2.url"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>URL address of page accessible by Jump2 button.</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="htmlhelp.button.jump2.title"> +<refmeta> +<refentrytitle>htmlhelp.button.jump2.title</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.button.jump2.title</refname> +<refpurpose>Title of Jump2 button</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="htmlhelp.button.jump2.title.frag"> +<xsl:param name="htmlhelp.button.jump2.title">User2</xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Title of Jump2 button.</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="htmlhelp.button.next"> +<refmeta> +<refentrytitle>htmlhelp.button.next</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.button.next</refname> +<refpurpose>Should the Next button be shown?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="htmlhelp.button.next.frag"> +<xsl:param name="htmlhelp.button.next" select="1"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Set to non-zero to include the Next button on the toolbar.</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="htmlhelp.button.prev"> +<refmeta> +<refentrytitle>htmlhelp.button.prev</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.button.prev</refname> +<refpurpose>Should the Prev button be shown?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="htmlhelp.button.prev.frag"> +<xsl:param name="htmlhelp.button.prev" select="1"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Set to non-zero to include the Prev button on the toolbar. +</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="htmlhelp.button.zoom"> +<refmeta> +<refentrytitle>htmlhelp.button.zoom</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.button.zoom</refname> +<refpurpose>Should the Zoom button be shown?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="htmlhelp.button.zoom.frag"> +<xsl:param name="htmlhelp.button.zoom" select="0"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Set to non-zero to include the Zoom button on the toolbar. +</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="htmlhelp.remember.window.position"> +<refmeta> +<refentrytitle>htmlhelp.remember.window.position</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.remember.window.position</refname> +<refpurpose>Remember help window position?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="htmlhelp.remember.window.position.frag"> +<xsl:param name="htmlhelp.remember.window.position" select="0"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Set to non-zero to remember help window position between starts.</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="htmlhelp.window.geometry"> +<refmeta> +<refentrytitle>htmlhelp.window.geometry</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.window.geometry</refname> +<refpurpose>Set initial geometry of help window</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="htmlhelp.window.geometry.frag"> +<xsl:param name="htmlhelp.window.geometry"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>This parameter specifies initial position of help +window. E.g.</para> + +<programlisting><xsl:param name="htmlhelp.window.geometry">[160,64,992,704]</xsl:param></programlisting> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="htmlhelp.use.hhk"> +<refmeta> +<refentrytitle>htmlhelp.use.hhk</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.use.hhk</refname> +<refpurpose>Should the index be built using the HHK file?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="htmlhelp.use.hhk.frag"> +<xsl:param name="htmlhelp.use.hhk" select="0"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, the index is created using the HHK file (instead of using <tag role="html">object</tag> +elements in the HTML files). For more information, see <link xmlns:xlink="http://www.w3.org/1999/xlink" role="tcg" xlink:href="HtmlHelp.html#HHGenIndex">Generating an index</link>.</para> +</refsection> +</refentry> + +<refentry version="5.0" xml:id="htmlhelp.only"> +<refmeta> +<refentrytitle>htmlhelp.only</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.only</refname> +<refpurpose>Should only project files be generated?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="htmlhelp.only.frag"> +<xsl:param name="htmlhelp.only" select="0"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + + +<para>Set to non-zero if you want to play with various HTML Help parameters +and you don't need to regenerate all HTML files. This setting will not +process whole document, only project files (hhp, hhc, hhk,...) will be +generated.</para> + + +</refsection> +</refentry> + +</reference> +<reference xml:id="eclipse_help"><title>Eclipse Help Platform</title> +<refentry version="5.0" xml:id="eclipse.autolabel"> +<refmeta> +<refentrytitle>eclipse.autolabel</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>eclipse.autolabel</refname> +<refpurpose>Should tree-like ToC use autonumbering feature?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="eclipse.autolabel.frag"> +<xsl:param name="eclipse.autolabel" select="0"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If you want to include chapter and section numbers into ToC in +the left panel, set this parameter to 1.</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="eclipse.plugin.name"> +<refmeta> +<refentrytitle>eclipse.plugin.name</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>eclipse.plugin.name</refname> +<refpurpose>Eclipse Help plugin name</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="eclipse.plugin.name.frag"> +<xsl:param name="eclipse.plugin.name">DocBook Online Help Sample</xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Eclipse Help plugin name.</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="eclipse.plugin.id"> +<refmeta> +<refentrytitle>eclipse.plugin.id</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>eclipse.plugin.id</refname> +<refpurpose>Eclipse Help plugin id</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="eclipse.plugin.id.frag"> +<xsl:param name="eclipse.plugin.id">com.example.help</xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Eclipse Help plugin id. You should change this id to something +unique for each help.</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="eclipse.plugin.provider"> +<refmeta> +<refentrytitle>eclipse.plugin.provider</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>eclipse.plugin.provider</refname> +<refpurpose>Eclipse Help plugin provider name</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="eclipse.plugin.provider.frag"> +<xsl:param name="eclipse.plugin.provider">Example provider</xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Eclipse Help plugin provider name.</para> + +</refsection> +</refentry> + +</reference> +<reference xml:id="javahelp"><title>JavaHelp</title> +<refentry version="5.0" xml:id="javahelp.encoding"> +<refmeta> +<refentrytitle>javahelp.encoding</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>javahelp.encoding</refname> +<refpurpose>Character encoding to use in control files for JavaHelp.</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="javahelp.encoding.frag"> +<xsl:param name="javahelp.encoding">iso-8859-1</xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>JavaHelp crashes on some characters when written as character +references. In that case you can use this parameter to select an appropriate encoding.</para> + +</refsection> +</refentry> + + + + +</reference> +<reference xml:id="l10n"><title>Localization</title> +<refentry version="5.0" xml:id="l10n.gentext.language"> +<refmeta> +<refentrytitle>l10n.gentext.language</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>l10n.gentext.language</refname> +<refpurpose>Sets the gentext language</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="l10n.gentext.language.frag"> +<xsl:param name="l10n.gentext.language"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If this parameter is set to any value other than the empty string, its +value will be used as the value for the language when generating text. Setting +<parameter>l10n.gentext.language</parameter> overrides any settings within the +document being formatted.</para> + +<para>It's much more likely that you might want to set the +<parameter>l10n.gentext.default.language</parameter> parameter.</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="l10n.gentext.default.language"> + <refmeta> + <refentrytitle>l10n.gentext.default.language</refentrytitle> + <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> + </refmeta> + <refnamediv> + <refname>l10n.gentext.default.language</refname> + <refpurpose>Sets the default language for generated text</refpurpose> + </refnamediv> + + <refsynopsisdiv> +<programlisting xml:id="l10n.gentext.default.language.frag"> +<xsl:param name="l10n.gentext.default.language">en</xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The value of the <parameter>l10n.gentext.default.language</parameter> +parameter is used as the language for generated text if no setting is provided +in the source document.</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="l10n.gentext.use.xref.language"> +<refmeta> +<refentrytitle>l10n.gentext.use.xref.language</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>l10n.gentext.use.xref.language</refname> +<refpurpose>Use the language of target when generating cross-reference text?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="l10n.gentext.use.xref.language.frag"> +<xsl:param name="l10n.gentext.use.xref.language" select="0"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, the language of the target will be used when +generating cross reference text. Usually, the <quote>current</quote> +language is used when generating text (that is, the language of the +element that contains the cross-reference element). But setting this parameter +allows the language of the element <emphasis>pointed to</emphasis> to control +the generated text.</para> + +<para>Consider the following example:</para> + +<informalexample> +<programlisting><para lang="en">See also <xref linkend="chap3"/>.</para> +</programlisting> +</informalexample> + +<para>Suppose that Chapter 3 happens to be written in German. +If <parameter>l10n.gentext.use.xref.language</parameter> is non-zero, the +resulting text will be something like this:</para> + +<blockquote> +<para>See also Kapital 3.</para> +</blockquote> + +<para>Where the more traditional rendering would be:</para> + +<blockquote> +<para>See also Chapter 3.</para> +</blockquote> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="l10n.lang.value.rfc.compliant"> +<refmeta> +<refentrytitle>l10n.lang.value.rfc.compliant</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>l10n.lang.value.rfc.compliant</refname> +<refpurpose>Make value of lang attribute RFC compliant?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="l10n.lang.value.rfc.compliant.frag"> +<xsl:param name="l10n.lang.value.rfc.compliant" select="1"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, ensure that the values for all <tag class="attribute">lang</tag> attributes in HTML output are RFC +compliant<footnote><para>Section 8.1.1, <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://www.w3.org/TR/REC-html40/struct/dirlang.html#h-8.1.1">Language Codes</link>, in the HTML 4.0 Recommendation states that: + +<blockquote><para>[RFC1766] defines and explains the language codes +that must be used in HTML documents.</para> +<para>Briefly, language codes consist of a primary code and a possibly +empty series of subcodes: + +<literallayout class="monospaced">language-code = primary-code ( "-" subcode )*</literallayout> +</para> +<para>And in RFC 1766, <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://www.ietf.org/rfc/rfc1766.txt">Tags for the Identification +of Languages</link>, the EBNF for "language tag" is given as: + +<literallayout class="monospaced">Language-Tag = Primary-tag *( "-" Subtag ) +Primary-tag = 1*8ALPHA +Subtag = 1*8ALPHA</literallayout> +</para> +</blockquote> +</para></footnote>. + +by taking any underscore characters in any <tag class="attribute">lang</tag> values found in source documents, and +replacing them with hyphen characters in output HTML files. For +example, <literal>zh_CN</literal> in a source document becomes +<literal>zh-CN</literal> in the HTML output form that source. + +<note> +<para>This parameter does not cause any case change in <tag class="attribute">lang</tag> values, because RFC 1766 +explicitly states that all "language tags" (as it calls them) "are +to be treated as case insensitive".</para> +</note> +</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="writing.mode"> +<refmeta> +<refentrytitle>writing.mode</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>writing.mode</refname> +<refpurpose>Direction of text flow based on locale</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="writing.mode.frag"> +<xsl:param name="writing.mode"> + <xsl:call-template name="gentext"> + <xsl:with-param name="key">writing-mode</xsl:with-param> + <xsl:with-param name="lang"> + <xsl:call-template name="l10n.language"> + <xsl:with-param name="target" select="/*[1]"></xsl:with-param> + </xsl:call-template> + </xsl:with-param> + </xsl:call-template> +</xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Sets direction of text flow and text alignment based on locale. +The value is normally taken from the gentext file for the +lang attribute of the document's root element, using the +key name 'writing-mode' to look it up in the gentext file. +But the param can also be +set on the command line to override that gentext value. +</para> +<para>Accepted values are: +<variablelist> + <varlistentry> + <term>lr-tb</term> + <listitem> + <para>Left-to-right text flow in each line, lines stack top to bottom.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>rl-tb</term> + <listitem> + <para>Right-to-left text flow in each line, lines stack top to bottom.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>tb-rl</term> + <listitem> + <para>Top-to-bottom text flow in each vertical line, lines stack right to left. + Supported by only a few XSL-FO processors. Not supported in HTML output.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>lr</term> + <listitem> + <para>Shorthand for lr-tb.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>rl</term> + <listitem> + <para>Shorthand for rl-tb.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>tb</term> + <listitem> + <para>Shorthand for tb-rl.</para> + </listitem> + </varlistentry> +</variablelist> +</para> + +</refsection> +</refentry> + +</reference> +<appendix xml:id="stylesheet"><title>The Stylesheet</title> + +<para>The <filename>param.xsl</filename> stylesheet is just a wrapper +around all these parameters.</para> + +<programlisting xml:id="top"> + +<!-- This file is generated from param.xweb --> + +<xsl:stylesheet exclude-result-prefixes="src" version="1.0"> + +<!-- ******************************************************************** + $Id: param.xweb 8552 2009-12-07 17:45:26Z bobstayton $ + ******************************************************************** + + This file is part of the XSL DocBook Stylesheet distribution. + See ../README or http://docbook.sf.net/release/xsl/current/ for + copyright and other information. + + ******************************************************************** --> + +<src:fragref linkend="abstract.notitle.enabled.frag"></src:fragref> +<src:fragref linkend="admon.graphics.extension.frag"></src:fragref> +<src:fragref linkend="admon.graphics.frag"></src:fragref> +<src:fragref linkend="admon.graphics.path.frag"></src:fragref> +<src:fragref linkend="admon.style.frag"></src:fragref> +<src:fragref linkend="admon.textlabel.frag"></src:fragref> +<src:fragref linkend="annotate.toc.frag"></src:fragref> +<src:fragref linkend="annotation.css.frag"></src:fragref> +<src:fragref linkend="annotation.graphic.close.frag"></src:fragref> +<src:fragref linkend="annotation.graphic.open.frag"></src:fragref> +<src:fragref linkend="annotation.js.frag"></src:fragref> +<src:fragref linkend="annotation.support.frag"></src:fragref> +<src:fragref linkend="appendix.autolabel.frag"></src:fragref> +<src:fragref linkend="author.othername.in.middle.frag"></src:fragref> +<src:fragref linkend="autotoc.label.in.hyperlink.frag"></src:fragref> +<src:fragref linkend="autotoc.label.separator.frag"></src:fragref> +<src:fragref linkend="base.dir.frag"></src:fragref> +<src:fragref linkend="biblioentry.item.separator.frag"></src:fragref> +<src:fragref linkend="bibliography.collection.frag"></src:fragref> +<src:fragref linkend="bibliography.numbered.frag"></src:fragref> +<src:fragref linkend="bibliography.style.frag"></src:fragref> +<src:fragref linkend="blurb.on.titlepage.enabled.frag"></src:fragref> +<src:fragref linkend="bridgehead.in.toc.frag"></src:fragref> +<src:fragref linkend="callout.defaultcolumn.frag"></src:fragref> +<src:fragref linkend="callout.graphics.extension.frag"></src:fragref> +<src:fragref linkend="callout.graphics.frag"></src:fragref> +<src:fragref linkend="callout.graphics.number.limit.frag"></src:fragref> +<src:fragref linkend="callout.graphics.path.frag"></src:fragref> +<src:fragref linkend="callout.list.table.frag"></src:fragref> +<src:fragref linkend="callout.unicode.frag"></src:fragref> +<src:fragref linkend="callout.unicode.number.limit.frag"></src:fragref> +<src:fragref linkend="callout.unicode.start.character.frag"></src:fragref> +<src:fragref linkend="callouts.extension.frag"></src:fragref> +<src:fragref linkend="chapter.autolabel.frag"></src:fragref> +<src:fragref linkend="chunk.append.frag"></src:fragref> +<src:fragref linkend="chunk.first.sections.frag"></src:fragref> +<src:fragref linkend="chunk.quietly.frag"></src:fragref> +<src:fragref linkend="chunk.section.depth.frag"></src:fragref> +<src:fragref linkend="chunk.separate.lots.frag"></src:fragref> +<src:fragref linkend="chunk.toc.frag"></src:fragref> +<src:fragref linkend="chunk.tocs.and.lots.frag"></src:fragref> +<src:fragref linkend="chunk.tocs.and.lots.has.title.frag"></src:fragref> +<src:fragref linkend="citerefentry.link.frag"></src:fragref> +<src:fragref linkend="collect.xref.targets.frag"></src:fragref> +<src:fragref linkend="component.label.includes.part.label.frag"></src:fragref> +<src:fragref linkend="contrib.inline.enabled.frag"></src:fragref> +<src:fragref linkend="css.decoration.frag"></src:fragref> +<src:fragref linkend="current.docid.frag"></src:fragref> +<src:fragref linkend="custom.css.source.frag"></src:fragref> +<src:fragref linkend="default.float.class.frag"></src:fragref> +<src:fragref linkend="default.image.width.frag"></src:fragref> +<src:fragref linkend="default.table.frame.frag"></src:fragref> +<src:fragref linkend="default.table.width.frag"></src:fragref> +<src:fragref linkend="docbook.css.link.frag"></src:fragref> +<src:fragref linkend="docbook.css.source.frag"></src:fragref> +<src:fragref linkend="draft.mode.frag"></src:fragref> +<src:fragref linkend="draft.watermark.image.frag"></src:fragref> +<src:fragref linkend="ebnf.assignment.frag"></src:fragref> +<src:fragref linkend="ebnf.statement.terminator.frag"></src:fragref> +<src:fragref linkend="ebnf.table.bgcolor.frag"></src:fragref> +<src:fragref linkend="ebnf.table.border.frag"></src:fragref> +<src:fragref linkend="eclipse.autolabel.frag"></src:fragref> +<src:fragref linkend="eclipse.plugin.id.frag"></src:fragref> +<src:fragref linkend="eclipse.plugin.name.frag"></src:fragref> +<src:fragref linkend="eclipse.plugin.provider.frag"></src:fragref> +<src:fragref linkend="editedby.enabled.frag"></src:fragref> +<src:fragref linkend="email.delimiters.enabled.frag"></src:fragref> +<src:fragref linkend="emphasis.propagates.style.frag"></src:fragref> +<src:fragref linkend="entry.propagates.style.frag"></src:fragref> +<src:fragref linkend="exsl.node.set.available.frag"></src:fragref> +<src:fragref linkend="firstterm.only.link.frag"></src:fragref> +<src:fragref linkend="footer.rule.frag"></src:fragref> +<src:fragref linkend="footnote.number.format.frag"></src:fragref> +<src:fragref linkend="footnote.number.symbols.frag"></src:fragref> +<src:fragref linkend="formal.procedures.frag"></src:fragref> +<src:fragref linkend="formal.title.placement.frag"></src:fragref> +<src:fragref linkend="funcsynopsis.decoration.frag"></src:fragref> +<src:fragref linkend="funcsynopsis.style.frag"></src:fragref> +<src:fragref linkend="function.parens.frag"></src:fragref> +<src:fragref linkend="generate.css.header.frag"></src:fragref> +<src:fragref linkend="generate.id.attributes.frag"></src:fragref> +<src:fragref linkend="generate.index.frag"></src:fragref> +<src:fragref linkend="generate.legalnotice.link.frag"></src:fragref> +<src:fragref linkend="generate.manifest.frag"></src:fragref> +<src:fragref linkend="generate.meta.abstract.frag"></src:fragref> +<src:fragref linkend="generate.revhistory.link.frag"></src:fragref> +<src:fragref linkend="generate.section.toc.level.frag"></src:fragref> +<src:fragref linkend="generate.toc.frag"></src:fragref> +<src:fragref linkend="glossary.collection.frag"></src:fragref> +<src:fragref linkend="glossary.sort.frag"></src:fragref> +<src:fragref linkend="glossentry.show.acronym.frag"></src:fragref> +<src:fragref linkend="glossterm.auto.link.frag"></src:fragref> +<src:fragref linkend="graphic.default.extension.frag"></src:fragref> +<src:fragref linkend="graphicsize.extension.frag"></src:fragref> +<src:fragref linkend="graphicsize.use.img.src.path.frag"></src:fragref> +<src:fragref linkend="header.rule.frag"></src:fragref> +<src:fragref linkend="highlight.default.language.frag"></src:fragref> +<src:fragref linkend="highlight.source.frag"></src:fragref> +<src:fragref linkend="highlight.xslthl.config.frag"></src:fragref> +<src:fragref linkend="html.append.frag"></src:fragref> +<src:fragref linkend="html.base.frag"></src:fragref> +<src:fragref linkend="html.cellpadding.frag"></src:fragref> +<src:fragref linkend="html.cellspacing.frag"></src:fragref> +<src:fragref linkend="html.cleanup.frag"></src:fragref> +<src:fragref linkend="html.ext.frag"></src:fragref> +<src:fragref linkend="html.extra.head.links.frag"></src:fragref> +<src:fragref linkend="html.head.legalnotice.link.multiple.frag"></src:fragref> +<src:fragref linkend="html.head.legalnotice.link.types.frag"></src:fragref> +<src:fragref linkend="html.longdesc.frag"></src:fragref> +<src:fragref linkend="html.longdesc.link.frag"></src:fragref> +<src:fragref linkend="html.stylesheet.frag"></src:fragref> +<src:fragref linkend="html.stylesheet.type.frag"></src:fragref> +<src:fragref linkend="htmlhelp.alias.file.frag"></src:fragref> +<src:fragref linkend="htmlhelp.autolabel.frag"></src:fragref> +<src:fragref linkend="htmlhelp.button.back.frag"></src:fragref> +<src:fragref linkend="htmlhelp.button.forward.frag"></src:fragref> +<src:fragref linkend="htmlhelp.button.hideshow.frag"></src:fragref> +<src:fragref linkend="htmlhelp.button.home.frag"></src:fragref> +<src:fragref linkend="htmlhelp.button.home.url.frag"></src:fragref> +<src:fragref linkend="htmlhelp.button.jump1.frag"></src:fragref> +<src:fragref linkend="htmlhelp.button.jump1.title.frag"></src:fragref> +<src:fragref linkend="htmlhelp.button.jump1.url.frag"></src:fragref> +<src:fragref linkend="htmlhelp.button.jump2.frag"></src:fragref> +<src:fragref linkend="htmlhelp.button.jump2.title.frag"></src:fragref> +<src:fragref linkend="htmlhelp.button.jump2.url.frag"></src:fragref> +<src:fragref linkend="htmlhelp.button.locate.frag"></src:fragref> +<src:fragref linkend="htmlhelp.button.next.frag"></src:fragref> +<src:fragref linkend="htmlhelp.button.options.frag"></src:fragref> +<src:fragref linkend="htmlhelp.button.prev.frag"></src:fragref> +<src:fragref linkend="htmlhelp.button.print.frag"></src:fragref> +<src:fragref linkend="htmlhelp.button.refresh.frag"></src:fragref> +<src:fragref linkend="htmlhelp.button.stop.frag"></src:fragref> +<src:fragref linkend="htmlhelp.button.zoom.frag"></src:fragref> +<src:fragref linkend="htmlhelp.chm.frag"></src:fragref> +<src:fragref linkend="htmlhelp.default.topic.frag"></src:fragref> +<src:fragref linkend="htmlhelp.display.progress.frag"></src:fragref> +<src:fragref linkend="htmlhelp.encoding.frag"></src:fragref> +<src:fragref linkend="htmlhelp.enhanced.decompilation.frag"></src:fragref> +<src:fragref linkend="htmlhelp.enumerate.images.frag"></src:fragref> +<src:fragref linkend="htmlhelp.force.map.and.alias.frag"></src:fragref> +<src:fragref linkend="htmlhelp.hhc.binary.frag"></src:fragref> +<src:fragref linkend="htmlhelp.hhc.folders.instead.books.frag"></src:fragref> +<src:fragref linkend="htmlhelp.hhc.frag"></src:fragref> +<src:fragref linkend="htmlhelp.hhc.section.depth.frag"></src:fragref> +<src:fragref linkend="htmlhelp.hhc.show.root.frag"></src:fragref> +<src:fragref linkend="htmlhelp.hhc.width.frag"></src:fragref> +<src:fragref linkend="htmlhelp.hhk.frag"></src:fragref> +<src:fragref linkend="htmlhelp.hhp.frag"></src:fragref> +<src:fragref linkend="htmlhelp.hhp.tail.frag"></src:fragref> +<src:fragref linkend="htmlhelp.hhp.window.frag"></src:fragref> +<src:fragref linkend="htmlhelp.hhp.windows.frag"></src:fragref> +<src:fragref linkend="htmlhelp.map.file.frag"></src:fragref> +<src:fragref linkend="htmlhelp.only.frag"></src:fragref> +<src:fragref linkend="htmlhelp.remember.window.position.frag"></src:fragref> +<src:fragref linkend="htmlhelp.show.advanced.search.frag"></src:fragref> +<src:fragref linkend="htmlhelp.show.favorities.frag"></src:fragref> +<src:fragref linkend="htmlhelp.show.menu.frag"></src:fragref> +<src:fragref linkend="htmlhelp.show.toolbar.text.frag"></src:fragref> +<src:fragref linkend="htmlhelp.title.frag"></src:fragref> +<src:fragref linkend="htmlhelp.use.hhk.frag"></src:fragref> +<src:fragref linkend="htmlhelp.window.geometry.frag"></src:fragref> +<src:fragref linkend="id.warnings.frag"></src:fragref> +<src:fragref linkend="ignore.image.scaling.frag"></src:fragref> +<src:fragref linkend="img.src.path.frag"></src:fragref> +<src:fragref linkend="index.links.to.section.frag"></src:fragref> +<src:fragref linkend="index.method.frag"></src:fragref> +<src:fragref linkend="index.number.separator.frag"></src:fragref> +<src:fragref linkend="index.on.role.frag"></src:fragref> +<src:fragref linkend="index.on.type.frag"></src:fragref> +<src:fragref linkend="index.prefer.titleabbrev.frag"></src:fragref> +<src:fragref linkend="index.range.separator.frag"></src:fragref> +<src:fragref linkend="index.term.separator.frag"></src:fragref> +<src:fragref linkend="inherit.keywords.frag"></src:fragref> +<src:fragref linkend="insert.olink.page.number.frag"></src:fragref> +<src:fragref linkend="insert.olink.pdf.frag.frag"></src:fragref> +<src:fragref linkend="insert.xref.page.number.frag"></src:fragref> +<src:fragref linkend="javahelp.encoding.frag"></src:fragref> +<src:fragref linkend="keep.relative.image.uris.frag"></src:fragref> +<src:fragref linkend="l10n.gentext.default.language.frag"></src:fragref> +<src:fragref linkend="l10n.gentext.language.frag"></src:fragref> +<src:fragref linkend="l10n.gentext.use.xref.language.frag"></src:fragref> +<src:fragref linkend="l10n.lang.value.rfc.compliant.frag"></src:fragref> +<src:fragref linkend="label.from.part.frag"></src:fragref> +<src:fragref linkend="linenumbering.everyNth.frag"></src:fragref> +<src:fragref linkend="linenumbering.extension.frag"></src:fragref> +<src:fragref linkend="linenumbering.separator.frag"></src:fragref> +<src:fragref linkend="linenumbering.width.frag"></src:fragref> +<src:fragref linkend="link.mailto.url.frag"></src:fragref> +<src:fragref linkend="make.clean.html.frag"></src:fragref> +<src:fragref linkend="make.graphic.viewport.frag"></src:fragref> +<src:fragref linkend="make.single.year.ranges.frag"></src:fragref> +<src:fragref linkend="make.valid.html.frag"></src:fragref> +<src:fragref linkend="make.year.ranges.frag"></src:fragref> +<src:fragref linkend="manifest.frag"></src:fragref> +<src:fragref linkend="manifest.in.base.dir.frag"></src:fragref> +<src:fragref linkend="manual.toc.frag"></src:fragref> +<src:fragref linkend="menuchoice.menu.separator.frag"></src:fragref> +<src:fragref linkend="menuchoice.separator.frag"></src:fragref> +<src:fragref linkend="navig.graphics.extension.frag"></src:fragref> +<src:fragref linkend="navig.graphics.frag"></src:fragref> +<src:fragref linkend="navig.graphics.path.frag"></src:fragref> +<src:fragref linkend="navig.showtitles.frag"></src:fragref> +<src:fragref linkend="nominal.image.depth.frag"></src:fragref> +<src:fragref linkend="nominal.image.width.frag"></src:fragref> +<src:fragref linkend="nominal.table.width.frag"></src:fragref> +<src:fragref linkend="olink.base.uri.frag"></src:fragref> +<src:fragref linkend="olink.debug.frag"></src:fragref> +<src:fragref linkend="olink.doctitle.frag"></src:fragref> +<src:fragref linkend="olink.fragid.frag"></src:fragref> +<src:fragref linkend="olink.lang.fallback.sequence.frag"></src:fragref> +<src:fragref linkend="olink.outline.ext.frag"></src:fragref> +<src:fragref linkend="olink.properties.frag"></src:fragref> +<src:fragref linkend="olink.pubid.frag"></src:fragref> +<src:fragref linkend="olink.resolver.frag"></src:fragref> +<src:fragref linkend="olink.sysid.frag"></src:fragref> +<src:fragref linkend="othercredit.like.author.enabled.frag"></src:fragref> +<src:fragref linkend="para.propagates.style.frag"></src:fragref> +<src:fragref linkend="part.autolabel.frag"></src:fragref> +<src:fragref linkend="phrase.propagates.style.frag"></src:fragref> +<src:fragref linkend="pixels.per.inch.frag"></src:fragref> +<src:fragref linkend="points.per.em.frag"></src:fragref> +<src:fragref linkend="preface.autolabel.frag"></src:fragref> +<src:fragref linkend="prefer.internal.olink.frag"></src:fragref> +<src:fragref linkend="preferred.mediaobject.role.frag"></src:fragref> +<src:fragref linkend="process.empty.source.toc.frag"></src:fragref> +<src:fragref linkend="process.source.toc.frag"></src:fragref> +<src:fragref linkend="profile.arch.frag"></src:fragref> +<src:fragref linkend="profile.attribute.frag"></src:fragref> +<src:fragref linkend="profile.audience.frag"></src:fragref> +<src:fragref linkend="profile.condition.frag"></src:fragref> +<src:fragref linkend="profile.conformance.frag"></src:fragref> +<src:fragref linkend="profile.lang.frag"></src:fragref> +<src:fragref linkend="profile.os.frag"></src:fragref> +<src:fragref linkend="profile.revision.frag"></src:fragref> +<src:fragref linkend="profile.revisionflag.frag"></src:fragref> +<src:fragref linkend="profile.role.frag"></src:fragref> +<src:fragref linkend="profile.security.frag"></src:fragref> +<src:fragref linkend="profile.separator.frag"></src:fragref> +<src:fragref linkend="profile.status.frag"></src:fragref> +<src:fragref linkend="profile.userlevel.frag"></src:fragref> +<src:fragref linkend="profile.value.frag"></src:fragref> +<src:fragref linkend="profile.vendor.frag"></src:fragref> +<src:fragref linkend="profile.wordsize.frag"></src:fragref> +<src:fragref linkend="punct.honorific.frag"></src:fragref> +<src:fragref linkend="qanda.defaultlabel.frag"></src:fragref> +<src:fragref linkend="qanda.in.toc.frag"></src:fragref> +<src:fragref linkend="qanda.inherit.numeration.frag"></src:fragref> +<src:fragref linkend="qanda.nested.in.toc.frag"></src:fragref> +<src:fragref linkend="qandadiv.autolabel.frag"></src:fragref> +<src:fragref linkend="refclass.suppress.frag"></src:fragref> +<src:fragref linkend="refentry.generate.name.frag"></src:fragref> +<src:fragref linkend="refentry.generate.title.frag"></src:fragref> +<src:fragref linkend="refentry.separator.frag"></src:fragref> +<src:fragref linkend="refentry.xref.manvolnum.frag"></src:fragref> +<src:fragref linkend="reference.autolabel.frag"></src:fragref> +<src:fragref linkend="root.filename.frag"></src:fragref> +<src:fragref linkend="rootid.frag"></src:fragref> +<src:fragref linkend="runinhead.default.title.end.punct.frag"></src:fragref> +<src:fragref linkend="runinhead.title.end.punct.frag"></src:fragref> +<src:fragref linkend="section.autolabel.frag"></src:fragref> +<src:fragref linkend="section.autolabel.max.depth.frag"></src:fragref> +<src:fragref linkend="section.label.includes.component.label.frag"></src:fragref> +<src:fragref linkend="segmentedlist.as.table.frag"></src:fragref> +<src:fragref linkend="shade.verbatim.frag"></src:fragref> +<src:fragref linkend="shade.verbatim.style.frag"></src:fragref> +<src:fragref linkend="show.comments.frag"></src:fragref> +<src:fragref linkend="show.revisionflag.frag"></src:fragref> +<src:fragref linkend="simplesect.in.toc.frag"></src:fragref> +<src:fragref linkend="spacing.paras.frag"></src:fragref> +<src:fragref linkend="suppress.footer.navigation.frag"></src:fragref> +<src:fragref linkend="suppress.header.navigation.frag"></src:fragref> +<src:fragref linkend="suppress.navigation.frag"></src:fragref> +<src:fragref linkend="table.borders.with.css.frag"></src:fragref> +<src:fragref linkend="table.cell.border.color.frag"></src:fragref> +<src:fragref linkend="table.cell.border.style.frag"></src:fragref> +<src:fragref linkend="table.cell.border.thickness.frag"></src:fragref> +<src:fragref linkend="table.footnote.number.format.frag"></src:fragref> +<src:fragref linkend="table.footnote.number.symbols.frag"></src:fragref> +<src:fragref linkend="table.frame.border.color.frag"></src:fragref> +<src:fragref linkend="table.frame.border.style.frag"></src:fragref> +<src:fragref linkend="table.frame.border.thickness.frag"></src:fragref> +<src:fragref linkend="tablecolumns.extension.frag"></src:fragref> +<src:fragref linkend="target.database.document.frag"></src:fragref> +<src:fragref linkend="targets.filename.frag"></src:fragref> +<src:fragref linkend="tex.math.delims.frag"></src:fragref> +<src:fragref linkend="tex.math.file.frag"></src:fragref> +<src:fragref linkend="tex.math.in.alt.frag"></src:fragref> +<src:fragref linkend="textdata.default.encoding.frag"></src:fragref> +<src:fragref linkend="textinsert.extension.frag"></src:fragref> +<src:fragref linkend="toc.list.type.frag"></src:fragref> +<src:fragref linkend="toc.max.depth.frag"></src:fragref> +<src:fragref linkend="toc.section.depth.frag"></src:fragref> +<src:fragref linkend="ulink.target.frag"></src:fragref> +<src:fragref linkend="use.embed.for.svg.frag"></src:fragref> +<src:fragref linkend="use.extensions.frag"></src:fragref> +<src:fragref linkend="use.id.as.filename.frag"></src:fragref> +<src:fragref linkend="use.local.olink.style.frag"></src:fragref> +<src:fragref linkend="use.role.as.xrefstyle.frag"></src:fragref> +<src:fragref linkend="use.role.for.mediaobject.frag"></src:fragref> +<src:fragref linkend="use.svg.frag"></src:fragref> +<src:fragref linkend="variablelist.as.table.frag"></src:fragref> +<src:fragref linkend="variablelist.term.break.after.frag"></src:fragref> +<src:fragref linkend="variablelist.term.separator.frag"></src:fragref> +<src:fragref linkend="writing.mode.frag"></src:fragref> +<src:fragref linkend="xref.label-page.separator.frag"></src:fragref> +<src:fragref linkend="xref.label-title.separator.frag"></src:fragref> +<src:fragref linkend="xref.title-page.separator.frag"></src:fragref> +<src:fragref linkend="xref.with.number.and.title.frag"></src:fragref> + +</xsl:stylesheet> +</programlisting> + +</appendix> +</book> |