1 <?xml version="1.0" encoding="ASCII"?><set xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0" xml:base="../docsrc/">
2 <!-- * WARNING WARNING WARNING -->
3 <!-- * WARNING WARNING WARNING -->
5 <!-- * This document has duplicate IDs in it and is intended for -->
6 <!-- * processing using the chunk.xsl stylesheet to generate chunked -->
7 <!-- * output from it (not for generating a single HTML output file) -->
9 <!-- * WARNING WARNING WARNING -->
10 <!-- * WARNING WARNING WARNING -->
11 <title>DocBook XSL Stylesheets: Reference Documentation</title>
12 <info><releaseinfo role="meta"/>
13 <authorgroup version="5.0">
16 <surname>Walsh</surname><firstname>Norman</firstname>
20 <orgname>The DocBook Project</orgname>
24 <year>1999-2007</year>
25 <holder>Norman Walsh</holder>
26 </copyright><copyright>
28 <holder>Jiří Kosek</holder>
29 </copyright><copyright>
30 <year>2004-2007</year>
31 <holder>Steve Ball</holder>
32 </copyright><copyright>
33 <year>2001-2007</year>
34 <holder>The DocBook Project</holder>
36 <legalnotice version="5.0" id="copyright"><title>License</title>
37 <para>Permission is hereby granted, free of charge, to any person
38 obtaining a copy of this software and associated documentation files
39 (the <quote>Software</quote>), to deal in the Software without
40 restriction, including without limitation the rights to use, copy,
41 modify, merge, publish, distribute, sublicense, and/or sell copies of
42 the Software, and to permit persons to whom the Software is furnished
43 to do so, subject to the following conditions:
45 <para>The above copyright notice and this permission notice shall be
46 included in all copies or substantial portions of the Software.</para>
47 <para>Except as contained in this notice, the names of individuals
48 credited with contribution to this software shall not be used in
49 advertising or otherwise to promote the sale, use or other dealings in
50 this Software without prior written authorization from the individuals
52 <para>Any stylesheet derived from this Software that is publically
53 distributed will be identified with a different name and the version
54 strings in any derived Software will be changed so that no possibility
55 of confusion between the derived package and this Software will
58 <legalnotice version="5.0" id="warranty"><title>Warranty</title>
59 <para>THE SOFTWARE IS PROVIDED <quote>AS IS</quote>,
60 WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
61 LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
62 PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL NORMAN WALSH OR ANY
63 OTHER CONTRIBUTOR BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
64 WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT
65 OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
69 <title>About this document</title>
70 <para>This is generated reference documentation for the DocBook
71 XSL stylesheets. It is available in the following formats:
74 <para><link xlink:href="http://cdn.docbook.org/release/xsl/current/doc/reference.html">HTML</link>,
75 <link xlink:href="http://cdn.docbook.org/release/xsl/current/doc/reference.pdf">PDF</link>,
76 <link xlink:href="http://cdn.docbook.org/release/xsl/current/doc/reference.txt">plain text</link></para>
79 This is primarily documentation on the parameters and processing instructions you can use
80 to control the behavior of the stylesheets.
82 <para>This is purely reference documentation – not how-to
83 documentation. For a thorough step-by-step how-to guide to
84 publishing content using the DocBook XSL stylesheets, see
85 Bob Stayton’s <link xlink:href="http://www.sagehill.net/book-description.html">DocBook XSL: The Complete Guide</link>, available online
86 at <link xlink:href="http://www.sagehill.net/docbookxsl/index.html">http://www.sagehill.net/docbookxsl/index.html</link>
89 This document is divided into three sets of references:
90 the first two sets provides user documentation; the third,
91 developer documentation.</para>
94 <book id="param"><title>DocBook XSL Stylesheets User Reference: Parameters</title>
97 <para>This is generated reference documentation for all
98 user-configurable parameters in the DocBook XSL
101 <para>This is purely reference documentation – not how-to
102 documentation. For a thorough step-by-step how-to guide to
103 publishing content using the DocBook XSL stylesheets, see
104 Bob Stayton’s <link xlink:href="http://www.sagehill.net/book-description.html">DocBook XSL: The Complete Guide</link>, available online
105 at <link xlink:href="http://www.sagehill.net/docbookxsl/index.html">http://www.sagehill.net/docbookxsl/index.html</link>
112 <?dbhtml dir="html"?>
113 <?dbhtml filename="index.html"?>
114 <title xml:base="../html/param.xml">HTML Parameter Reference</title>
115 <partintro id="htmlintro">
117 <para xml:base="../html/param.xml">This is reference documentation for all user-configurable
118 parameters in the DocBook XSL HTML stylesheets (for generating
122 <reference id="admons" xml:base="../html/param.xml"><title>Admonitions</title>
123 <refentry version="5.0" id="admon.graphics.extension">
125 <refentrytitle>admon.graphics.extension</refentrytitle>
126 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
129 <refname>admon.graphics.extension</refname>
130 <refpurpose>Filename extension for admonition graphics</refpurpose>
134 <programlisting id="admon.graphics.extension.frag">
135 <xsl:param name="admon.graphics.extension">.png</xsl:param>
139 <refsection><info><title>Description</title></info>
141 <para>Sets the filename extension to use on admonition graphics.</para>
144 <para>The DocBook XSL distribution provides admonition graphics in the following formats:</para>
145 <listitem><para>GIF (extension: <filename class="extension">.gif</filename>)</para></listitem>
146 <listitem><para>PNG (extension: <filename class="extension">.png</filename>)</para></listitem>
147 <listitem><para>SVG (extension: <filename class="extension">.svg</filename>)</para></listitem>
148 <listitem><para>TIFF (extension: <filename class="extension">.tif</filename>)</para></listitem>
154 <refentry version="5.0" id="admon.graphics.path">
156 <refentrytitle>admon.graphics.path</refentrytitle>
157 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
160 <refname>admon.graphics.path</refname>
161 <refpurpose>Path to admonition graphics</refpurpose>
165 <programlisting id="admon.graphics.path.frag"><xsl:param name="admon.graphics.path">images/</xsl:param></programlisting>
168 <refsection><info><title>Description</title></info>
170 <para>Sets the path to the directory containing the admonition graphics
171 (caution.png, important.png etc). This location is normally relative
172 to the output html directory. See <parameter>base.dir</parameter></para>
177 <refentry version="5.0" id="admon.graphics">
179 <refentrytitle>admon.graphics</refentrytitle>
180 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
183 <refname>admon.graphics</refname>
184 <refpurpose>Use graphics in admonitions?</refpurpose>
188 <programlisting id="admon.graphics.frag">
189 <xsl:param name="admon.graphics" select="0"></xsl:param>
193 <refsection><info><title>Description</title></info>
195 <para>If true (non-zero), admonitions are presented in an alternate style that uses
196 a graphic. Default graphics are provided in the distribution.
202 <refentry version="5.0" id="admon.textlabel">
204 <refentrytitle>admon.textlabel</refentrytitle>
205 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
208 <refname>admon.textlabel</refname>
209 <refpurpose>Use text label in admonitions?</refpurpose>
213 <programlisting id="admon.textlabel.frag">
214 <xsl:param name="admon.textlabel" select="1"></xsl:param>
218 <refsection><info><title>Description</title></info>
220 <para>If true (non-zero), admonitions are presented with a generated
221 text label such as Note or Warning in the appropriate language.
222 If zero, such labels are turned off, but any title child
223 of the admonition element are still output.
224 The default value is 1.
230 <refentry version="5.0" id="admon.style">
232 <refentrytitle>admon.style</refentrytitle>
233 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
236 <refname>admon.style</refname>
237 <refpurpose>Specifies the CSS style attribute that should be added to
238 admonitions.</refpurpose>
242 <programlisting id="admon.style.frag"><xsl:param name="admon.style">
243 <xsl:value-of select="concat('margin-', $direction.align.start, ': 0.5in; margin-', $direction.align.end, ': 0.5in;')"></xsl:value-of>
244 </xsl:param></programlisting>
247 <refsection><info><title>Description</title></info>
249 <para>Specifies the value of the CSS <tag class="attribute">style</tag>
250 attribute that should be added to admonitions.
256 </reference><reference id="callouts" xml:base="../html/param.xml"><title>Callouts</title>
257 <refentry version="5.0" id="callout.defaultcolumn">
259 <refentrytitle>callout.defaultcolumn</refentrytitle>
260 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
263 <refname>callout.defaultcolumn</refname>
264 <refpurpose>Indicates what column callouts appear in by default</refpurpose>
268 <programlisting id="callout.defaultcolumn.frag">
269 <xsl:param name="callout.defaultcolumn">60</xsl:param>
273 <refsection><info><title>Description</title></info>
275 <para>If a callout does not identify a column (for example, if it uses
276 the <literal>linerange</literal> <tag class="attribute">unit</tag>),
277 it will appear in the default column.
283 <refentry version="5.0" id="callout.graphics.extension">
285 <refentrytitle>callout.graphics.extension</refentrytitle>
286 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
289 <refname>callout.graphics.extension</refname>
290 <refpurpose>Filename extension for callout graphics</refpurpose>
294 <programlisting id="callout.graphics.extension.frag">
295 <xsl:param name="callout.graphics.extension">.png</xsl:param>
300 <refsection><info><title>Description</title></info>
301 <para>Sets the filename extension to use on callout graphics. </para>
304 <para>The Docbook XSL distribution provides callout graphics in the following formats:</para>
305 <listitem><para>SVG (extension: <filename class="extension">.svg</filename>)</para></listitem>
306 <listitem><para>PNG (extension: <filename class="extension">.png</filename>)</para></listitem>
307 <listitem><para>GIF (extension: <filename class="extension">.gif</filename>)</para></listitem>
312 <refentry version="5.0" id="callout.graphics.number.limit">
314 <refentrytitle>callout.graphics.number.limit</refentrytitle>
315 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
318 <refname>callout.graphics.number.limit</refname>
319 <refpurpose>Number of the largest callout graphic</refpurpose>
323 <programlisting id="callout.graphics.number.limit.frag">
324 <xsl:param name="callout.graphics.number.limit">15</xsl:param>
329 <refsection><info><title>Description</title></info>
331 <para>If <parameter>callout.graphics</parameter> is non-zero, graphics
332 are used to represent callout numbers instead of plain text. The value
333 of <parameter>callout.graphics.number.limit</parameter> is the largest
334 number for which a graphic exists. If the callout number exceeds this
335 limit, the default presentation "(plain text instead of a graphic)"
342 <refentry version="5.0" id="callout.graphics.path">
344 <refentrytitle>callout.graphics.path</refentrytitle>
345 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
348 <refname>callout.graphics.path</refname>
349 <refpurpose>Path to callout graphics</refpurpose>
353 <programlisting id="callout.graphics.path.frag">
354 <xsl:param name="callout.graphics.path">images/callouts/</xsl:param>
358 <refsection><info><title>Description</title></info>
360 <para>Sets the path to the directory holding the callout graphics. his
361 location is normally relative to the output html directory. see
362 base.dir. Always terminate the directory with / since the graphic file
363 is appended to this string, hence needs the separator.
369 <refentry version="5.0" id="callout.graphics">
371 <refentrytitle>callout.graphics</refentrytitle>
372 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
375 <refname>callout.graphics</refname>
376 <refpurpose>Use graphics for callouts?</refpurpose>
380 <programlisting id="callout.graphics.frag">
381 <xsl:param name="callout.graphics" select="1"></xsl:param>
385 <refsection><info><title>Description</title></info>
387 <para>If non-zero, callouts are presented with graphics (e.g., reverse-video
388 circled numbers instead of "(1)", "(2)", etc.).
389 Default graphics are provided in the distribution.
395 <refentry version="5.0" id="callout.list.table">
397 <refentrytitle>callout.list.table</refentrytitle>
398 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
401 <refname>callout.list.table</refname>
402 <refpurpose>Present callout lists using a table?</refpurpose>
406 <programlisting id="callout.list.table.frag">
407 <xsl:param name="callout.list.table" select="1"></xsl:param>
411 <refsection><info><title>Description</title></info>
413 <para>The default presentation of <tag>calloutlist</tag>s uses
414 an HTML <tag>DL</tag> element. Some browsers don't align DLs very well
415 if <parameter>callout.graphics</parameter> is used. With this option
416 turned on, <tag>calloutlist</tag>s are presented in an HTML
417 <tag>TABLE</tag>, which usually results in better alignment
418 of the callout number with the callout description.</para>
423 <refentry version="5.0" id="callout.unicode.number.limit">
425 <refentrytitle>callout.unicode.number.limit</refentrytitle>
426 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
429 <refname>callout.unicode.number.limit</refname>
430 <refpurpose>Number of the largest unicode callout character</refpurpose>
434 <programlisting id="callout.unicode.number.limit.frag">
435 <xsl:param name="callout.unicode.number.limit">10</xsl:param>
439 <refsection><info><title>Description</title></info>
441 <para>If <parameter>callout.unicode</parameter>
442 is non-zero, unicode characters are used to represent
443 callout numbers. The value of
444 <parameter>callout.unicode.number.limit</parameter>
446 the largest number for which a unicode character exists. If the callout number
447 exceeds this limit, the default presentation "(nnn)" will always
454 <refentry version="5.0" id="callout.unicode.start.character">
456 <refentrytitle>callout.unicode.start.character</refentrytitle>
457 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
460 <refname>callout.unicode.start.character</refname>
461 <refpurpose>First Unicode character to use, decimal value.</refpurpose>
465 <programlisting id="callout.unicode.start.character.frag">
466 <xsl:param name="callout.unicode.start.character">10102</xsl:param>
470 <refsection><info><title>Description</title></info>
472 <para>If <parameter>callout.graphics</parameter> is zero and <parameter>callout.unicode</parameter>
473 is non-zero, unicode characters are used to represent
474 callout numbers. The value of
475 <parameter>callout.unicode.start.character</parameter>
476 is the decimal unicode value used for callout number one. Currently,
477 only values 9312 and 10102 are supported in the stylesheets for this parameter.
483 <refentry version="5.0" id="callout.unicode">
485 <refentrytitle>callout.unicode</refentrytitle>
486 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
489 <refname>callout.unicode</refname>
490 <refpurpose>Use Unicode characters rather than images for callouts.</refpurpose>
494 <programlisting id="callout.unicode.frag"><xsl:param name="callout.unicode" select="0"></xsl:param></programlisting>
497 <refsection><info><title>Description</title></info>
499 <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.
505 <refentry version="5.0" id="callouts.extension">
507 <refentrytitle>callouts.extension</refentrytitle>
508 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
511 <refname>callouts.extension</refname>
512 <refpurpose>Enable the callout extension</refpurpose>
516 <programlisting id="callouts.extension.frag">
517 <xsl:param name="callouts.extension" select="1"></xsl:param>
521 <refsection><info><title>Description</title></info>
523 <para>The callouts extension processes <tag>areaset</tag>
524 elements in <tag>programlistingco</tag> and other text-based
531 </reference><reference id="ebnf" xml:base="../html/param.xml"><title>EBNF</title>
532 <refentry version="5.0" id="ebnf.table.bgcolor">
534 <refentrytitle>ebnf.table.bgcolor</refentrytitle>
535 <refmiscinfo class="other" otherclass="datatype">color</refmiscinfo>
538 <refname>ebnf.table.bgcolor</refname>
539 <refpurpose>Background color for EBNF tables</refpurpose>
543 <programlisting id="ebnf.table.bgcolor.frag">
544 <xsl:param name="ebnf.table.bgcolor">#F5DCB3</xsl:param>
548 <refsection><info><title>Description</title></info>
550 <para>Sets the background color for EBNF tables (a pale brown). No
551 <tag>bgcolor</tag> attribute is output if
552 <parameter>ebnf.table.bgcolor</parameter> is set to the null string. </para>
558 <refentry version="5.0" id="ebnf.table.border">
560 <refentrytitle>ebnf.table.border</refentrytitle>
561 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
564 <refname>ebnf.table.border</refname>
565 <refpurpose>Selects border on EBNF tables</refpurpose>
569 <programlisting id="ebnf.table.border.frag"><xsl:param name="ebnf.table.border" select="1"></xsl:param></programlisting>
572 <refsection><info><title>Description</title></info>
574 <para>Selects the border on EBNF tables. If non-zero, the tables have
575 borders, otherwise they don't.</para>
580 <refentry version="5.0" id="ebnf.assignment">
582 <refentrytitle>ebnf.assignment</refentrytitle>
583 <refmiscinfo class="other" otherclass="datatype">rtf</refmiscinfo>
586 <refname>ebnf.assignment</refname>
587 <refpurpose>The EBNF production assignment operator</refpurpose>
591 <programlisting id="ebnf.assignment.frag">
592 <xsl:param name="ebnf.assignment">
593 <code>::=</code>
599 <refsection><info><title>Description</title></info>
601 <para>The <parameter>ebnf.assignment</parameter> parameter determines what
602 text is used to show <quote>assignment</quote> in <tag>production</tag>s
603 in <tag>productionset</tag>s.</para>
605 <para>While <quote><literal>::=</literal></quote> is common, so are several
606 other operators.</para>
611 <refentry version="5.0" id="ebnf.statement.terminator">
613 <refentrytitle>ebnf.statement.terminator</refentrytitle>
614 <refmiscinfo class="other" otherclass="datatype">rtf</refmiscinfo>
617 <refname>ebnf.statement.terminator</refname>
618 <refpurpose>Punctuation that ends an EBNF statement.</refpurpose>
622 <programlisting id="ebnf.statement.terminator.frag">
623 <xsl:param name="ebnf.statement.terminator"></xsl:param>
628 <refsection><info><title>Description</title></info>
630 <para>The <parameter>ebnf.statement.terminator</parameter> parameter determines what
631 text is used to terminate each <tag>production</tag>
632 in <tag>productionset</tag>.</para>
634 <para>Some notations end each statement with a period.</para>
639 </reference><reference id="toc_index" xml:base="../html/param.xml"><title>ToC/LoT/Index Generation</title>
640 <refentry version="5.0" id="annotate.toc">
642 <refentrytitle>annotate.toc</refentrytitle>
643 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
646 <refname>annotate.toc</refname>
647 <refpurpose>Annotate the Table of Contents?</refpurpose>
651 <programlisting id="annotate.toc.frag"><xsl:param name="annotate.toc" select="1"></xsl:param></programlisting>
654 <refsection><info><title>Description</title></info>
656 <para>If true, TOCs will be annotated. At present, this just means
657 that the <tag>refpurpose</tag> of <tag>refentry</tag>
658 TOC entries will be displayed.
664 <refentry version="5.0" id="autotoc.label.separator">
666 <refentrytitle>autotoc.label.separator</refentrytitle>
667 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
670 <refname>autotoc.label.separator</refname>
671 <refpurpose>Separator between labels and titles in the ToC</refpurpose>
675 <programlisting id="autotoc.label.separator.frag">
676 <xsl:param name="autotoc.label.separator">. </xsl:param>
680 <refsection><info><title>Description</title></info>
682 <para>String used to separate labels and titles in a table of contents.</para>
687 <refentry version="5.0" id="autotoc.label.in.hyperlink">
689 <refentrytitle>autotoc.label.in.hyperlink</refentrytitle>
690 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
693 <refname>autotoc.label.in.hyperlink</refname>
694 <refpurpose>Include label in hyperlinked titles in TOC?</refpurpose>
698 <programlisting id="autotoc.label.in.hyperlink.frag"><xsl:param name="autotoc.label.in.hyperlink" select="1"></xsl:param></programlisting>
701 <refsection><info><title>Description</title></info>
703 <para>If the value of
704 <parameter>autotoc.label.in.hyperlink</parameter> is non-zero, labels
705 are included in hyperlinked titles in the TOC. If it is instead zero,
706 labels are still displayed prior to the hyperlinked titles, but
707 are not hyperlinked along with the titles.</para>
712 <refentry version="5.0" id="process.source.toc">
714 <refentrytitle>process.source.toc</refentrytitle>
715 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
718 <refname>process.source.toc</refname>
719 <refpurpose>Process a non-empty <tag>toc</tag> element if it occurs in a source document?</refpurpose>
723 <programlisting id="process.source.toc.frag"><xsl:param name="process.source.toc" select="0"></xsl:param></programlisting>
726 <refsection><info><title>Description</title></info>
728 <para>Specifies that the contents of a non-empty "hard-coded"
729 <tag>toc</tag> element in a source document are processed to
730 generate a TOC in output.
732 <para>This parameter has no effect on automated generation of
733 TOCs. An automated TOC may still be generated along with the
734 "hard-coded" TOC. To suppress automated TOC generation, adjust the
735 value of the <parameter>generate.toc</parameter> paramameter.</para>
737 <para>The <tag>process.source.toc</tag> parameter also has
738 no effect if the <tag>toc</tag> element is empty; handling
739 for empty <tag>toc</tag> is controlled by the
740 <parameter>process.empty.source.toc</parameter> parameter.</para>
747 <refentry version="5.0" id="process.empty.source.toc">
749 <refentrytitle>process.empty.source.toc</refentrytitle>
750 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
753 <refname>process.empty.source.toc</refname>
754 <refpurpose>Generate automated TOC if <tag>toc</tag> element occurs in a source document?</refpurpose>
758 <programlisting id="process.empty.source.toc.frag"><xsl:param name="process.empty.source.toc" select="0"></xsl:param></programlisting>
761 <refsection><info><title>Description</title></info>
763 <para>Specifies that if an empty <tag>toc</tag> element is found in a
764 source document, an automated TOC is generated at this point in the
767 <para>Depending on what the value of the
768 <parameter>generate.toc</parameter> parameter is, setting this
769 parameter to <literal>1</literal> could result in generation of
770 duplicate automated TOCs. So the
771 <parameter>process.empty.source.toc</parameter> is primarily useful
772 as an "override": by placing an empty <tag>toc</tag> in your
773 document and setting this parameter to <literal>1</literal>, you can
774 force a TOC to be generated even if <tag>generate.toc</tag>
782 <refentry version="5.0" id="bridgehead.in.toc">
784 <refentrytitle>bridgehead.in.toc</refentrytitle>
785 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
788 <refname>bridgehead.in.toc</refname>
789 <refpurpose>Should bridgehead elements appear in the TOC?</refpurpose>
793 <programlisting id="bridgehead.in.toc.frag"><xsl:param name="bridgehead.in.toc" select="0"></xsl:param></programlisting>
796 <refsection><info><title>Description</title></info>
798 <para>If non-zero, <tag>bridgehead</tag>s appear in the TOC. Note that
799 this option is not fully supported and may be removed in a future
800 version of the stylesheets.
806 <refentry version="5.0" id="simplesect.in.toc">
808 <refentrytitle>simplesect.in.toc</refentrytitle>
809 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
812 <refname>simplesect.in.toc</refname>
813 <refpurpose>Should <tag>simplesect</tag> elements appear in the TOC?</refpurpose>
817 <programlisting id="simplesect.in.toc.frag"><xsl:param name="simplesect.in.toc" select="0"></xsl:param></programlisting>
820 <refsection><info><title>Description</title></info>
822 <para>If non-zero, <tag>simplesect</tag>s will be included in the TOC.
828 <refentry version="5.0" id="manual.toc">
830 <refentrytitle>manual.toc</refentrytitle>
831 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
834 <refname>manual.toc</refname>
835 <refpurpose>An explicit TOC to be used for the TOC</refpurpose>
839 <programlisting id="manual.toc.frag">
840 <xsl:param name="manual.toc"></xsl:param>
844 <refsection><info><title>Description</title></info>
846 <para>The <parameter>manual.toc</parameter> identifies an explicit TOC that
847 will be used for building the printed TOC.
853 <refentry version="5.0" id="toc.list.type">
855 <refentrytitle>toc.list.type</refentrytitle>
856 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
857 <refmiscinfo class="other" otherclass="value">dl</refmiscinfo>
858 <refmiscinfo class="other" otherclass="value">ul</refmiscinfo>
859 <refmiscinfo class="other" otherclass="value">ol</refmiscinfo>
862 <refname>toc.list.type</refname>
863 <refpurpose>Type of HTML list element to use for Tables of Contents</refpurpose>
867 <programlisting id="toc.list.type.frag"><xsl:param name="toc.list.type">dl</xsl:param></programlisting>
870 <refsection><info><title>Description</title></info>
872 <para>When an automatically generated Table of Contents (or List of Titles)
873 is produced, this HTML element will be used to make the list.
879 <refentry version="5.0" id="toc.section.depth">
881 <refentrytitle>toc.section.depth</refentrytitle>
882 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
885 <refname>toc.section.depth</refname>
886 <refpurpose>How deep should recursive <tag>section</tag>s appear
887 in the TOC?</refpurpose>
891 <programlisting id="toc.section.depth.frag"><xsl:param name="toc.section.depth">2</xsl:param></programlisting>
894 <refsection><info><title>Description</title></info>
896 <para>Specifies the depth to which recursive sections should appear in the
903 <refentry version="5.0" id="toc.max.depth">
905 <refentrytitle>toc.max.depth</refentrytitle>
906 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
909 <refname>toc.max.depth</refname>
910 <refpurpose>How many levels should be created for each TOC?</refpurpose>
914 <programlisting id="toc.max.depth.frag"><xsl:param name="toc.max.depth">8</xsl:param></programlisting>
917 <refsection><info><title>Description</title></info>
919 <para>Specifies the maximal depth of TOC on all levels.</para>
924 <refentry version="5.0" id="generate.toc">
926 <refentrytitle>generate.toc</refentrytitle>
927 <refmiscinfo class="other" otherclass="datatype">table</refmiscinfo>
930 <refname>generate.toc</refname>
931 <refpurpose>Control generation of ToCs and LoTs</refpurpose>
935 <programlisting id="generate.toc.frag">
936 <xsl:param name="generate.toc">
940 book toc,title,figure,table,example,equation
959 <refsection><info><title>Description</title></info>
961 <para>This parameter has a structured value. It is a table of space-delimited
962 path/value pairs. Each path identifies some element in the source document
963 using a restricted subset of XPath (only the implicit child axis, no wildcards,
964 no predicates). Paths can be either relative or absolute.</para>
966 <para>When processing a particular element, the stylesheets consult this table to
967 determine if a ToC (or LoT(s)) should be generated.</para>
969 <para>For example, consider the entry:</para>
971 <screen>book toc,figure</screen>
973 <para>This indicates that whenever a <tag>book</tag> is formatted, a
974 Table Of Contents and a List of Figures should be generated. Similarly,</para>
976 <screen>/chapter toc</screen>
978 <para>indicates that whenever a document <emphasis>that has a root
979 of</emphasis> <tag>chapter</tag> is formatted, a Table of
980 Contents should be generated. The entry <literal>chapter</literal> would match
981 all chapters, but <literal>/chapter</literal> matches only <tag>chapter</tag>
982 document elements.</para>
984 <para>Generally, the longest match wins. So, for example, if you want to distinguish
985 articles in books from articles in parts, you could use these two entries:</para>
987 <screen>book/article toc,figure
988 part/article toc</screen>
990 <para>Note that an article in a part can never match a <literal>book/article</literal>,
991 so if you want nothing to be generated for articles in parts, you can simply leave
992 that rule out.</para>
994 <para>If you want to leave the rule in, to make it explicit that you're turning
995 something off, use the value <quote>nop</quote>. For example, the following
996 entry disables ToCs and LoTs for articles:</para>
998 <screen>article nop</screen>
1000 <para>Do not simply leave the word <quote>article</quote> in the file
1001 without a matching value. That'd be just begging the silly little
1002 path/value parser to get confused.</para>
1004 <para>Section ToCs are further controlled by the
1005 <parameter>generate.section.toc.level</parameter> parameter.
1006 For a given section level to have a ToC, it must have both an entry in
1007 <parameter>generate.toc</parameter> and be within the range enabled by
1008 <parameter>generate.section.toc.level</parameter>.</para>
1012 <refentry version="5.0" id="generate.section.toc.level">
1014 <refentrytitle>generate.section.toc.level</refentrytitle>
1015 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
1018 <refname>generate.section.toc.level</refname>
1019 <refpurpose>Control depth of TOC generation in sections</refpurpose>
1023 <programlisting id="generate.section.toc.level.frag">
1024 <xsl:param name="generate.section.toc.level" select="0"></xsl:param>
1028 <refsection><info><title>Description</title></info>
1030 <para>The <parameter>generate.section.toc.level</parameter> parameter
1031 controls the depth of <tag>section</tag> in which TOCs will be generated. Note
1032 that this is related to, but not the same as
1033 <parameter>toc.section.depth</parameter>, which controls the depth to
1034 which TOC entries will be generated in a given TOC.</para>
1035 <para>If, for example, <parameter>generate.section.toc.level</parameter>
1036 is <literal>3</literal>, TOCs will be generated in first, second, and third
1037 level sections, but not in fourth level sections.
1043 <refentry version="5.0" id="generate.index">
1045 <refentrytitle>generate.index</refentrytitle>
1046 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
1049 <refname>generate.index</refname>
1050 <refpurpose>Do you want an index?</refpurpose>
1054 <programlisting id="generate.index.frag"><xsl:param name="generate.index" select="1"></xsl:param></programlisting>
1057 <refsection><info><title>Description</title></info>
1059 <para>Specify if an index should be generated. </para>
1064 <refentry version="5.0" id="index.method">
1066 <refentrytitle>index.method</refentrytitle>
1067 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
1068 <refmiscinfo class="other" otherclass="value">basic</refmiscinfo>
1069 <refmiscinfo class="other" otherclass="value">kosek</refmiscinfo>
1070 <refmiscinfo class="other" otherclass="value">kimber</refmiscinfo>
1073 <refname>index.method</refname>
1074 <refpurpose>Select method used to group index entries in an index</refpurpose>
1078 <programlisting id="index.method.frag">
1079 <xsl:param name="index.method">basic</xsl:param>
1083 <refsection><info><title>Description</title></info>
1085 <para>This parameter lets you select which method to use for sorting and grouping
1086 index entries in an index.
1087 Indexes in Latin-based languages that have accented characters typically
1088 sort together accented words and unaccented words.
1089 Thus <quote>Á</quote> (U+00C1 LATIN CAPITAL LETTER A WITH ACUTE) would sort together
1090 with <quote>A</quote> (U+0041 LATIN CAPITAL LETTER A), so both would appear in the <quote>A</quote>
1091 section of the index.
1092 Languages using other alphabets (such as Russian, which is written in the Cyrillic alphabet)
1093 and languages using ideographic chararacters (such as Japanese)
1094 require grouping specific to the languages and alphabets.
1097 <para>The default indexing method is limited.
1098 It can group accented characters in Latin-based languages only.
1099 It cannot handle non-Latin alphabets or ideographic languages.
1100 The other indexing methods require extensions of one type or
1101 another, and do not work with
1102 all XSLT processors, which is why they are not used by default.</para>
1104 <para>The three choices for indexing method are:</para>
1107 <term><literal>basic</literal></term>
1110 (default) Sort and groups words based only on the Latin alphabet.
1111 Words with accented Latin letters will group and sort with
1112 their respective primary letter, but
1113 words in non-Latin alphabets will be
1114 put in the <quote>Symbols</quote> section of the index.
1119 <term><literal>kosek</literal></term>
1122 This method sorts and groups words based on letter groups configured in
1123 the DocBook locale file for the given language.
1124 See, for example, the French locale file <filename>common/fr.xml</filename>.
1125 This method requires that the XSLT processor
1126 supports the EXSLT extensions (most do).
1127 It also requires support for using
1128 user-defined functions in xsl:key (xsltproc does not).
1130 <para>This method is suitable for any language for which you can
1131 list all the individual characters that should appear
1132 in each letter group in an index.
1133 It is probably not practical to use it for ideographic languages
1134 such as Chinese that have hundreds or thousands of characters.
1137 <para>To use the kosek method, you must:</para>
1141 <para>Use a processor that supports its extensions, such as
1142 Saxon 6 or Xalan (xsltproc and Saxon 8 do not).
1146 <para>Set the index.method parameter's value to <quote>kosek</quote>.
1150 <para>Import the appropriate index extensions stylesheet module
1151 <filename>fo/autoidx-kosek.xsl</filename> or
1152 <filename>html/autoidx-kosek.xsl</filename> into your
1161 <term><literal>kimber</literal></term>
1164 This method uses extensions to the Saxon processor to implement
1165 sophisticated indexing processes. It uses its own
1166 configuration file, which can include information for any number of
1167 languages. Each language's configuration can group
1168 words using one of two processes. In the
1169 enumerated process similar to that used in the kosek method,
1170 you indicate the groupings character-by-character.
1171 In the between-key process, you specify the
1172 break-points in the sort order that should start a new group.
1173 The latter configuration is useful for ideographic languages
1174 such as Chinese, Japanese, and Korean.
1175 You can also define your own collation algorithms and how you
1176 want mixed Latin-alphabet words sorted.</para>
1179 <para>For a whitepaper describing the extensions, see:
1180 <link 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>.
1184 <para>To download the extension library, see
1185 <link xlink:href="http://www.innodata-isogen.com/knowledge_center/tools_downloads/i18nsupport">http://www.innodata-isogen.com/knowledge_center/tools_downloads/i18nsupport</link>.
1190 <para>To use the kimber method, you must:</para>
1194 <para>Use Saxon (version 6 or 8) as your XSLT processor.
1198 <para>Install and configure the Innodata Isogen library, using
1199 the documentation that comes with it.
1203 <para>Set the index.method parameter's value to <quote>kimber</quote>.
1207 <para>Import the appropriate index extensions stylesheet module
1208 <filename>fo/autoidx-kimber.xsl</filename> or
1209 <filename>html/autoidx-kimber.xsl</filename> into your
1222 <refentry version="5.0" id="index.on.type">
1224 <refentrytitle>index.on.type</refentrytitle>
1225 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
1228 <refname>index.on.type</refname>
1229 <refpurpose>Select indexterms based on <tag class="attribute">type</tag>
1230 attribute value</refpurpose>
1234 <programlisting id="index.on.type.frag">
1235 <xsl:param name="index.on.type" select="0"></xsl:param>
1239 <refsection><info><title>Description</title></info>
1243 then an <tag>index</tag> element that has a
1244 <tag class="attribute">type</tag> attribute
1245 value will contain only those <tag>indexterm</tag>
1246 elements with a matching <tag class="attribute">type</tag> attribute value.
1247 If an <tag>index</tag> has no <tag class="attribute">type</tag>
1248 attribute or it is blank, then the index will contain
1249 all <tag>indexterm</tag>s in the current scope.
1253 If <literal>index.on.type</literal> is zero, then the
1254 <tag class="attribute">type</tag> attribute has no effect
1255 on selecting indexterms for an index.
1258 <para>For those using DocBook version 4.2 or earlier,
1259 the <tag class="attribute">type</tag> attribute is not available
1260 for index terms. However, you can achieve the same
1261 effect by using the <tag class="attribute">role</tag> attribute
1262 in the same manner on <tag>indexterm</tag>
1263 and <tag>index</tag>, and setting the stylesheet parameter
1264 <parameter>index.on.role</parameter> to a nonzero value.
1270 <refentry version="5.0" id="index.on.role">
1272 <refentrytitle>index.on.role</refentrytitle>
1273 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
1276 <refname>index.on.role</refname>
1277 <refpurpose>Select indexterms based on <tag class="attribute">role</tag> value</refpurpose>
1281 <programlisting id="index.on.role.frag">
1282 <xsl:param name="index.on.role" select="0"></xsl:param>
1286 <refsection><info><title>Description</title></info>
1290 then an <tag>index</tag> element that has a
1291 <tag class="attribute">role</tag> attribute
1292 value will contain only those <tag>indexterm</tag>
1293 elements with a matching role value.
1294 If an <tag>index</tag> has no <tag class="attribute">role</tag>
1295 attribute or it is blank, then the index will contain
1296 all <tag>indexterm</tag>s in the current scope.
1299 If <literal>index.on.role</literal> is zero, then the
1300 <tag class="attribute">role</tag> attribute has no effect
1301 on selecting indexterms for an index.
1304 <para>If you are using DocBook version 4.3 or later, you should
1305 use the <tag class="attribute">type</tag> attribute instead of <tag class="attribute">role</tag>
1306 on <tag>indexterm</tag> and <tag>index</tag>,
1307 and set the <parameter>index.on.type</parameter> to a nonzero
1314 <refentry version="5.0" id="index.links.to.section">
1316 <refentrytitle>index.links.to.section</refentrytitle>
1317 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
1320 <refname>index.links.to.section</refname>
1321 <refpurpose>HTML index entries link to container section title</refpurpose>
1325 <programlisting id="index.links.to.section.frag">
1326 <xsl:param name="index.links.to.section" select="1"></xsl:param>
1330 <refsection><info><title>Description</title></info>
1332 <para>If zero, then an index entry in an index links
1333 directly to the location of the
1334 generated <tag>anchor</tag> that is output
1335 for the indexterm. If two identical indexterm elements
1336 exist in the same section, then both entries appear
1337 in the index with the same title but link to different
1340 <para>If non-zero, then an index entry in an index links to the
1341 section title containing the <tag>indexterm</tag>, rather than
1342 directly to the <tag>anchor</tag> output for the indexterm.
1343 Duplicate indexterm entries in the same section are dropped.
1346 <para>The default value is 1, so index entries link to
1347 section titles by default.</para>
1349 <para>In both cases, the link text in an index entry is the
1350 title of the section containing the indexterm.
1351 That is because HTML does not have numbered pages.
1352 It also provides the reader with context information
1353 for each link.</para>
1355 <para>This parameter lets you choose which style of
1356 index linking you want. </para>
1360 <para>When set to 0, an index entry takes you
1361 to the precise location of its corresponding indexterm.
1362 However, if you have a lot of duplicate
1363 entries in sections, then you have a lot of duplicate
1364 titles in the index, which makes it more cluttered.
1365 The reader may not recognize why duplicate titles
1366 appear until they follow the links. Also, the links
1367 may land the reader in the middle of a section where the
1368 section title is not visible, which may also be
1369 confusing to the reader.</para>
1372 <para>When set to 1, an index entry link is
1373 less precise, but duplicate titles in the
1374 index entries are eliminated.
1375 Landing on the section title location may confirm the reader's
1376 expectation that a link that
1377 shows a section title will take them to that section title,
1378 not a location within the section.
1386 <refentry version="5.0" id="index.prefer.titleabbrev">
1388 <refentrytitle>index.prefer.titleabbrev</refentrytitle>
1389 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
1392 <refname>index.prefer.titleabbrev</refname>
1393 <refpurpose>Should abbreviated titles be used as back references?</refpurpose>
1397 <programlisting id="index.prefer.titleabbrev.frag">
1398 <xsl:param name="index.prefer.titleabbrev" select="0"></xsl:param>
1402 <refsection><info><title>Description</title></info>
1404 <para>If non-zero, and if a <tag>titleabbrev</tag> is defined, the abbreviated title
1405 is used as the link text of a back reference in the index.
1411 <refentry version="5.0" id="autolink.index.see">
1413 <refentrytitle>autolink.index.see</refentrytitle>
1414 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
1417 <refname>autolink.index.see</refname>
1418 <refpurpose>Link index see and seealso to index primary</refpurpose>
1422 <programlisting id="autolink.index.see.frag"><xsl:param name="autolink.index.see" select="1"></xsl:param></programlisting>
1425 <refsection><info><title>Description</title></info>
1427 <para>If this param is set to a non-zero value,
1428 (default = 1), then the
1429 stylesheet will attempt for form a link between a
1430 <tag>see</tag> or <tag>seealso</tag> element
1431 and a matching indexterm <tag>primary</tag> element.
1434 <para>The stylesheet uses an exact text match after
1435 applying the <literal>normalize-space()</literal> function.
1436 If the <tag>see</tag> or <tag>seealso</tag> text contains a comma,
1437 then only the text prior to the comma is used.
1438 This assumes the author is using the convention "see primary, secondary"
1439 to specify a subentry. Automatic links always land on the primary
1440 entry in the index, so the reader has to look down to see the
1441 secondary entry.</para>
1442 <para>If there is no match on a
1443 <tag>primary</tag>, no link is formed, but the text
1444 still displays.</para>
1446 <para>No attempt is made to automatically link to text in
1447 <tag>secondary</tag> or <tag>tertiary</tag> elements.
1448 If you want to link to such elements, you can form a
1449 manual link by adding a linkend attribute to the
1450 <tag>see</tag> or <tag>seealso</tag> element, where
1451 the linkend references an id or xml:id attribute on
1452 such a subelement. Such manual links take precedence over
1453 any automatic links.
1456 <para>If this parameter is zero, then
1457 no automatic links from see and seealso
1458 are formed within the index. Any manual links are
1459 still processed, however.</para>
1464 <refentry version="5.0" id="index.term.separator">
1466 <refentrytitle>index.term.separator</refentrytitle>
1467 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
1470 <refname>index.term.separator</refname>
1471 <refpurpose>Override for punctuation separating an index term
1472 from its list of page references in an index</refpurpose>
1476 <programlisting id="index.term.separator.frag">
1477 <xsl:param name="index.term.separator"></xsl:param>
1481 <refsection><info><title>Description</title></info>
1483 <para>This parameter permits you to override
1484 the text to insert between
1485 the end of an index term and its list of page references.
1486 Typically that might be a comma and a space.
1489 <para>Because this text may be locale dependent,
1490 this parameter's value is normally taken from a gentext
1491 template named 'term-separator' in the
1492 context 'index' in the stylesheet
1493 locale file for the language
1494 of the current document.
1495 This parameter can be used to override the gentext string,
1496 and would typically be used on the command line.
1497 This parameter would apply to all languages.
1500 <para>So this text string can be customized in two ways.
1501 You can reset the default gentext string using
1502 the <parameter>local.l10n.xml</parameter> parameter, or you can
1503 fill in the content for this normally empty
1505 The content can be a simple string, or it can be
1506 something more complex such as a call-template.
1507 For fo output, it could be an <tag>fo:leader</tag>
1508 element to provide space of a specific length, or a dot leader.
1514 <refentry version="5.0" id="index.number.separator">
1516 <refentrytitle>index.number.separator</refentrytitle>
1517 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
1520 <refname>index.number.separator</refname>
1521 <refpurpose>Override for punctuation separating page numbers in index</refpurpose>
1525 <programlisting id="index.number.separator.frag">
1526 <xsl:param name="index.number.separator"></xsl:param>
1530 <refsection><info><title>Description</title></info>
1532 <para>This parameter permits you to override the text to insert between
1533 page references in a formatted index entry. Typically
1534 that would be a comma and a space.
1537 <para>Because this text may be locale dependent,
1538 this parameter's value is normally taken from a gentext
1539 template named 'number-separator' in the
1540 context 'index' in the stylesheet
1541 locale file for the language
1542 of the current document.
1543 This parameter can be used to override the gentext string,
1544 and would typically be used on the command line.
1545 This parameter would apply to all languages.
1548 <para>So this text string can be customized in two ways.
1549 You can reset the default gentext string using
1550 the <parameter>local.l10n.xml</parameter> parameter, or you can
1551 override the gentext with the content of this parameter.
1552 The content can be a simple string, or it can be
1553 something more complex such as a call-template.
1556 <para>In HTML index output, section title references are used instead of
1557 page number references. This punctuation appears between
1558 such section titles in an HTML index.
1564 <refentry version="5.0" id="index.range.separator">
1566 <refentrytitle>index.range.separator</refentrytitle>
1567 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
1570 <refname>index.range.separator</refname>
1571 <refpurpose>Override for punctuation separating the two numbers
1572 in a page range in index</refpurpose>
1576 <programlisting id="index.range.separator.frag">
1577 <xsl:param name="index.range.separator"></xsl:param>
1581 <refsection><info><title>Description</title></info>
1583 <para>This parameter permits you
1584 to override the text to insert between
1585 the two numbers of a page range in an index.
1586 This parameter is only used by those XSL-FO processors
1587 that support an extension for generating such page ranges
1588 (such as XEP).</para>
1590 <para>Because this text may be locale dependent,
1591 this parameter's value is normally taken from a gentext
1592 template named 'range-separator' in the
1593 context 'index' in the stylesheet
1594 locale file for the language
1595 of the current document.
1596 This parameter can be used to override the gentext string,
1597 and would typically be used on the command line.
1598 This parameter would apply to all languages.
1601 <para>So this text string can be customized in two ways.
1602 You can reset the default gentext string using
1603 the <parameter>local.l10n.xml</parameter> parameter, or you can
1604 override the gentext with the content of this parameter.
1605 The content can be a simple string, or it can be
1606 something more complex such as a call-template.
1609 <para>In HTML index output, section title references are used instead of
1610 page number references. So there are no page ranges
1611 and this parameter has no effect.
1617 </reference><reference id="dbk_ext" xml:base="../html/param.xml"><title>Stylesheet Extensions</title>
1618 <refentry version="5.0" id="linenumbering.everyNth">
1620 <refentrytitle>linenumbering.everyNth</refentrytitle>
1621 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
1624 <refname>linenumbering.everyNth</refname>
1625 <refpurpose>Indicate which lines should be numbered</refpurpose>
1629 <programlisting id="linenumbering.everyNth.frag">
1630 <xsl:param name="linenumbering.everyNth">5</xsl:param>
1634 <refsection><info><title>Description</title></info>
1636 <para>If line numbering is enabled, everyNth line will be
1637 numbered. Note that numbering is one based, not zero based.
1639 <para>See also <parameter>linenumbering.extension</parameter>,
1640 <parameter>linenumbering.separator</parameter>,
1641 <parameter>linenumbering.width</parameter> and
1642 <parameter>use.extensions</parameter></para>
1647 <refentry version="5.0" id="linenumbering.extension">
1649 <refentrytitle>linenumbering.extension</refentrytitle>
1650 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
1653 <refname>linenumbering.extension</refname>
1654 <refpurpose>Enable the line numbering extension</refpurpose>
1658 <programlisting id="linenumbering.extension.frag">
1659 <xsl:param name="linenumbering.extension" select="1"></xsl:param>
1663 <refsection><info><title>Description</title></info>
1665 <para>If non-zero, verbatim environments (<tag>address</tag>, <tag>literallayout</tag>,
1666 <tag>programlisting</tag>, <tag>screen</tag>, <tag>synopsis</tag>) that specify line numbering will
1673 <refentry version="5.0" id="linenumbering.separator">
1675 <refentrytitle>linenumbering.separator</refentrytitle>
1676 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
1679 <refname>linenumbering.separator</refname>
1680 <refpurpose>Specify a separator between line numbers and lines</refpurpose>
1684 <programlisting id="linenumbering.separator.frag">
1685 <xsl:param name="linenumbering.separator"><xsl:text> </xsl:text></xsl:param>
1689 <refsection><info><title>Description</title></info>
1691 <para>The separator is inserted between line numbers and lines in the
1692 verbatim environment. The default value is a single white space.
1693 Note the interaction with <parameter>linenumbering.width</parameter>
1699 <refentry version="5.0" id="linenumbering.width">
1701 <refentrytitle>linenumbering.width</refentrytitle>
1702 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
1705 <refname>linenumbering.width</refname>
1706 <refpurpose>Indicates the width of line numbers</refpurpose>
1710 <programlisting id="linenumbering.width.frag">
1711 <xsl:param name="linenumbering.width">3</xsl:param>
1715 <refsection><info><title>Description</title></info>
1717 <para>If line numbering is enabled, line numbers will appear right
1718 justified in a field "width" characters wide.
1724 <refentry version="5.0" id="tablecolumns.extension">
1726 <refentrytitle>tablecolumns.extension</refentrytitle>
1727 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
1730 <refname>tablecolumns.extension</refname>
1731 <refpurpose>Enable the table columns extension function</refpurpose>
1735 <programlisting id="tablecolumns.extension.frag">
1736 <xsl:param name="tablecolumns.extension" select="1"></xsl:param>
1740 <refsection><info><title>Description</title></info>
1742 <para>The table columns extension function adjusts the widths of table
1743 columns in the HTML result to more accurately reflect the specifications
1750 <refentry version="5.0" id="textinsert.extension">
1752 <refentrytitle>textinsert.extension</refentrytitle>
1753 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
1756 <refname>textinsert.extension</refname>
1757 <refpurpose>Enables the textinsert extension element</refpurpose>
1760 <programlisting id="textinsert.extension.frag">
1761 <xsl:param name="textinsert.extension" select="1"></xsl:param>
1764 <refsection><info><title>Description</title></info>
1765 <para>The textinsert extension element inserts the contents of
1766 a file into the result tree (as text).</para>
1768 <para>To use the textinsert extension element, you must use
1769 either Saxon or Xalan as your XSLT processor (it doesn’t
1770 work with xsltproc), along with either the DocBook Saxon
1771 extensions or DocBook Xalan extensions (for more
1772 information about those extensions, see <link role="tcg" xlink:href="InstallingAProcessor.html#SaxonExtensions">DocBook Saxon Extensions</link> and <link role="tcg" xlink:href="InstallingAProcessor.html#XalanExtensions">DocBook Xalan Extensions</link>), and you must set both
1773 the <parameter>use.extensions</parameter> and
1774 <parameter>textinsert.extension</parameter> parameters to
1775 <literal>1</literal>.</para>
1776 <para>As an alternative to using the textinsert element,
1777 consider using an Xinclude element with the
1778 <literal>parse="text"</literal> attribute and value
1779 specified, as detailed in <link role="tcg" xlink:href="ExternalCode.html#XIncludeCode">Using XInclude for text inclusions</link>.</para>
1782 <refsection><info><title>See Also</title></info>
1783 <para>You can also use the <tag class="xmlpi">dbhtml-include href</tag> processing
1784 instruction to insert external files — both files containing
1785 plain text and files with markup content (including HTML
1788 <refsection><info><title>More information</title></info>
1789 <para>For how-to documentation on inserting contents of
1790 external code files and other text files into output, see
1791 <link role="tcg" xlink:href="ExternalCode.html">External code files</link>.</para>
1792 <para>For guidelines on inserting contents of
1793 HTML files into output, see <link role="tcg" xlink:href="InsertExtHtml.html">Inserting external HTML code</link>.</para>
1797 <refentry version="5.0" id="textdata.default.encoding">
1799 <refentrytitle>textdata.default.encoding</refentrytitle>
1800 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
1803 <refname>textdata.default.encoding</refname>
1804 <refpurpose>Default encoding of external text files which are included
1805 using textdata element</refpurpose>
1809 <programlisting id="textdata.default.encoding.frag">
1810 <xsl:param name="textdata.default.encoding"></xsl:param>
1814 <refsection><info><title>Description</title></info>
1816 <para>Specifies the encoding of any external text files included using
1817 <tag>textdata</tag> element. This value is used only when you do
1818 not specify encoding by the appropriate attribute
1819 directly on textdata. An empty string is interpreted as the system
1820 default encoding.</para>
1825 <refentry version="5.0" id="graphicsize.extension">
1827 <refentrytitle>graphicsize.extension</refentrytitle>
1828 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
1831 <refname>graphicsize.extension</refname>
1832 <refpurpose>Enable the getWidth()/getDepth() extension functions</refpurpose>
1836 <programlisting id="graphicsize.extension.frag">
1837 <xsl:param name="graphicsize.extension" select="1"></xsl:param>
1841 <refsection><info><title>Description</title></info>
1843 <para>If non-zero (and if <parameter>use.extensions</parameter> is non-zero
1844 and if you're using a processor that supports extension functions), the
1845 <function>getWidth</function> and <function>getDepth</function> functions
1846 will be used to extract image sizes from graphics.</para>
1848 <para>The main supported image formats are GIF, JPEG, and PNG. Somewhat cruder
1849 support for EPS and PDF images is also available.</para>
1853 <refentry version="5.0" id="graphicsize.use.img.src.path">
1855 <refentrytitle>graphicsize.use.img.src.path</refentrytitle>
1856 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
1859 <refname>graphicsize.use.img.src.path</refname>
1860 <refpurpose>Prepend <parameter>img.src.path</parameter> before
1861 filenames passed to extension functions</refpurpose>
1865 <programlisting id="graphicsize.use.img.src.path.frag">
1866 <xsl:param name="graphicsize.use.img.src.path" select="0"></xsl:param>
1870 <refsection><info><title>Description</title></info>
1872 <para>If non-zero <parameter>img.src.path</parameter> parameter will
1873 be appended before filenames passed to extension functions for
1874 measuring image dimensions.</para>
1879 <refentry version="5.0" id="use.extensions">
1881 <refentrytitle>use.extensions</refentrytitle>
1882 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
1885 <refname>use.extensions</refname>
1886 <refpurpose>Enable extensions</refpurpose>
1890 <programlisting id="use.extensions.frag">
1891 <xsl:param name="use.extensions" select="0"></xsl:param>
1895 <refsection><info><title>Description</title></info>
1897 <para>If non-zero, extensions may be used. Each extension is
1898 further controlled by its own parameter. But if
1899 <parameter>use.extensions</parameter> is zero, no extensions will
1906 </reference><reference id="labels" xml:base="../html/param.xml"><title>Automatic labelling</title>
1907 <refentry version="5.0" id="chapter.autolabel">
1909 <refentrytitle>chapter.autolabel</refentrytitle>
1910 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
1911 <refmiscinfo class="other" otherclass="value">0<alt>none</alt></refmiscinfo>
1912 <refmiscinfo class="other" otherclass="value">1<alt>1,2,3...</alt></refmiscinfo>
1913 <refmiscinfo class="other" otherclass="value">A<alt>A,B,C...</alt></refmiscinfo>
1914 <refmiscinfo class="other" otherclass="value">a<alt>a,b,c...</alt></refmiscinfo>
1915 <refmiscinfo class="other" otherclass="value">i<alt>i,ii,iii...</alt></refmiscinfo>
1916 <refmiscinfo class="other" otherclass="value">I<alt>I,II,III...</alt></refmiscinfo>
1919 <refname>chapter.autolabel</refname>
1920 <refpurpose>Specifies the labeling format for Chapter titles</refpurpose>
1924 <programlisting id="chapter.autolabel.frag">
1925 <xsl:param name="chapter.autolabel" select="1"></xsl:param></programlisting>
1928 <refsection><info><title>Description</title></info>
1930 <para>If non-zero, then chapters will be numbered using the parameter
1931 value as the number format if the value matches one of the following:
1936 <term>1 or arabic</term>
1938 <para>Arabic numeration (1, 2, 3 ...).</para>
1942 <term>A or upperalpha</term>
1944 <para>Uppercase letter numeration (A, B, C ...).</para>
1948 <term>a or loweralpha</term>
1950 <para>Lowercase letter numeration (a, b, c ...).</para>
1954 <term>I or upperroman</term>
1956 <para>Uppercase roman numeration (I, II, III ...).</para>
1960 <term>i or lowerroman</term>
1962 <para>Lowercase roman letter numeration (i, ii, iii ...).</para>
1967 <para>Any nonzero value other than the above will generate
1968 the default number format (arabic).
1974 <refentry version="5.0" id="appendix.autolabel">
1976 <refentrytitle>appendix.autolabel</refentrytitle>
1977 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
1978 <refmiscinfo class="other" otherclass="value">0<alt>none</alt></refmiscinfo>
1979 <refmiscinfo class="other" otherclass="value">1<alt>1,2,3...</alt></refmiscinfo>
1980 <refmiscinfo class="other" otherclass="value">A<alt>A,B,C...</alt></refmiscinfo>
1981 <refmiscinfo class="other" otherclass="value">a<alt>a,b,c...</alt></refmiscinfo>
1982 <refmiscinfo class="other" otherclass="value">i<alt>i,ii,iii...</alt></refmiscinfo>
1983 <refmiscinfo class="other" otherclass="value">I<alt>I,II,III...</alt></refmiscinfo>
1986 <refname>appendix.autolabel</refname>
1987 <refpurpose>Specifies the labeling format for Appendix titles</refpurpose>
1991 <programlisting id="appendix.autolabel.frag">
1992 <xsl:param name="appendix.autolabel">A</xsl:param>
1996 <refsection><info><title>Description</title></info>
1998 <para>If non-zero, then appendices will be numbered using the
1999 parameter value as the number format if the value matches one of the
2005 <term>1 or arabic</term>
2007 <para>Arabic numeration (1, 2, 3 ...).</para>
2011 <term>A or upperalpha</term>
2013 <para>Uppercase letter numeration (A, B, C ...).</para>
2017 <term>a or loweralpha</term>
2019 <para>Lowercase letter numeration (a, b, c ...).</para>
2023 <term>I or upperroman</term>
2025 <para>Uppercase roman numeration (I, II, III ...).</para>
2029 <term>i or lowerroman</term>
2031 <para>Lowercase roman letter numeration (i, ii, iii ...).</para>
2036 <para>Any nonzero value other than the above will generate
2037 the default number format (upperalpha).
2043 <refentry version="5.0" id="part.autolabel">
2045 <refentrytitle>part.autolabel</refentrytitle>
2046 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
2047 <refmiscinfo class="other" otherclass="value">0<alt>none</alt></refmiscinfo>
2048 <refmiscinfo class="other" otherclass="value">1<alt>1,2,3...</alt></refmiscinfo>
2049 <refmiscinfo class="other" otherclass="value">A<alt>A,B,C...</alt></refmiscinfo>
2050 <refmiscinfo class="other" otherclass="value">a<alt>a,b,c...</alt></refmiscinfo>
2051 <refmiscinfo class="other" otherclass="value">i<alt>i,ii,iii...</alt></refmiscinfo>
2052 <refmiscinfo class="other" otherclass="value">I<alt>I,II,III...</alt></refmiscinfo>
2055 <refname>part.autolabel</refname>
2056 <refpurpose>Specifies the labeling format for Part titles</refpurpose>
2060 <programlisting id="part.autolabel.frag">
2061 <xsl:param name="part.autolabel">I</xsl:param>
2065 <refsection><info><title>Description</title></info>
2067 <para>If non-zero, then parts will be numbered using the parameter
2068 value as the number format if the value matches one of the following:
2073 <term>1 or arabic</term>
2075 <para>Arabic numeration (1, 2, 3 ...).</para>
2079 <term>A or upperalpha</term>
2081 <para>Uppercase letter numeration (A, B, C ...).</para>
2085 <term>a or loweralpha</term>
2087 <para>Lowercase letter numeration (a, b, c ...).</para>
2091 <term>I or upperroman</term>
2093 <para>Uppercase roman numeration (I, II, III ...).</para>
2097 <term>i or lowerroman</term>
2099 <para>Lowercase roman letter numeration (i, ii, iii ...).</para>
2104 <para>Any nonzero value other than the above will generate
2105 the default number format (upperroman).
2112 <refentry version="5.0" id="reference.autolabel">
2114 <refentrytitle>reference.autolabel</refentrytitle>
2115 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
2116 <refmiscinfo class="other" otherclass="value">0<alt>none</alt></refmiscinfo>
2117 <refmiscinfo class="other" otherclass="value">1<alt>1,2,3...</alt></refmiscinfo>
2118 <refmiscinfo class="other" otherclass="value">A<alt>A,B,C...</alt></refmiscinfo>
2119 <refmiscinfo class="other" otherclass="value">a<alt>a,b,c...</alt></refmiscinfo>
2120 <refmiscinfo class="other" otherclass="value">i<alt>i,ii,iii...</alt></refmiscinfo>
2121 <refmiscinfo class="other" otherclass="value">I<alt>I,II,III...</alt></refmiscinfo>
2124 <refname>reference.autolabel</refname>
2125 <refpurpose>Specifies the labeling format for Reference titles</refpurpose>
2128 <programlisting id="reference.autolabel.frag">
2129 <xsl:param name="reference.autolabel">I</xsl:param>
2132 <refsection><info><title>Description</title></info>
2133 <para>If non-zero, references will be numbered using the parameter
2134 value as the number format if the value matches one of the
2139 <term>1 or arabic</term>
2141 <para>Arabic numeration (1, 2, 3 ...).</para>
2145 <term>A or upperalpha</term>
2147 <para>Uppercase letter numeration (A, B, C ...).</para>
2151 <term>a or loweralpha</term>
2153 <para>Lowercase letter numeration (a, b, c ...).</para>
2157 <term>I or upperroman</term>
2159 <para>Uppercase roman numeration (I, II, III ...).</para>
2163 <term>i or lowerroman</term>
2165 <para>Lowercase roman letter numeration (i, ii, iii ...).</para>
2169 <para>Any non-zero value other than the above will generate
2170 the default number format (upperroman).
2175 <refentry version="5.0" id="preface.autolabel">
2177 <refentrytitle>preface.autolabel</refentrytitle>
2178 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
2179 <refmiscinfo class="other" otherclass="value">0<alt>none</alt></refmiscinfo>
2180 <refmiscinfo class="other" otherclass="value">1<alt>1,2,3...</alt></refmiscinfo>
2181 <refmiscinfo class="other" otherclass="value">A<alt>A,B,C...</alt></refmiscinfo>
2182 <refmiscinfo class="other" otherclass="value">a<alt>a,b,c...</alt></refmiscinfo>
2183 <refmiscinfo class="other" otherclass="value">i<alt>i,ii,iii...</alt></refmiscinfo>
2184 <refmiscinfo class="other" otherclass="value">I<alt>I,II,III...</alt></refmiscinfo>
2187 <refname>preface.autolabel</refname>
2188 <refpurpose>Specifices the labeling format for Preface titles</refpurpose>
2192 <programlisting id="preface.autolabel.frag"><xsl:param name="preface.autolabel" select="0"></xsl:param></programlisting>
2195 <refsection><info><title>Description</title></info>
2197 <para>If non-zero then prefaces will be numbered using the parameter
2198 value as the number format if the value matches one of the following:
2203 <term>1 or arabic</term>
2205 <para>Arabic numeration (1, 2, 3 ...).</para>
2209 <term>A or upperalpha</term>
2211 <para>Uppercase letter numeration (A, B, C ...).</para>
2215 <term>a or loweralpha</term>
2217 <para>Lowercase letter numeration (a, b, c ...).</para>
2221 <term>I or upperroman</term>
2223 <para>Uppercase roman numeration (I, II, III ...).</para>
2227 <term>i or lowerroman</term>
2229 <para>Lowercase roman letter numeration (i, ii, iii ...).</para>
2234 <para>Any nonzero value other than the above will generate
2235 the default number format (arabic).
2242 <refentry version="5.0" id="qandadiv.autolabel">
2244 <refentrytitle>qandadiv.autolabel</refentrytitle>
2245 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
2248 <refname>qandadiv.autolabel</refname>
2249 <refpurpose>Are divisions in QAndASets enumerated?</refpurpose>
2253 <programlisting id="qandadiv.autolabel.frag"><xsl:param name="qandadiv.autolabel" select="1"></xsl:param></programlisting>
2256 <refsection><info><title>Description</title></info>
2258 <para>If non-zero, unlabeled qandadivs will be enumerated.
2264 <refentry version="5.0" id="section.autolabel">
2266 <refentrytitle>section.autolabel</refentrytitle>
2267 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
2270 <refname>section.autolabel</refname>
2271 <refpurpose>Are sections enumerated?</refpurpose>
2275 <programlisting id="section.autolabel.frag"><xsl:param name="section.autolabel" select="0"></xsl:param></programlisting>
2278 <refsection><info><title>Description</title></info>
2280 <para>If true (non-zero), unlabeled sections will be enumerated.
2286 <refentry version="5.0" id="section.autolabel.max.depth">
2288 <refentrytitle>section.autolabel.max.depth</refentrytitle>
2289 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
2292 <refname>section.autolabel.max.depth</refname>
2293 <refpurpose>The deepest level of sections that are numbered.</refpurpose>
2297 <programlisting id="section.autolabel.max.depth.frag">
2298 <xsl:param name="section.autolabel.max.depth">8</xsl:param>
2302 <refsection><info><title>Description</title></info>
2304 <para>When section numbering is turned on by the
2305 <parameter>section.autolabel</parameter> parameter, then this
2306 parameter controls the depth of <tag>section</tag> nesting that is
2307 numbered. Sections nested to a level deeper than this value will not
2314 <refentry version="5.0" id="section.label.includes.component.label">
2316 <refentrytitle>section.label.includes.component.label</refentrytitle>
2317 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
2320 <refname>section.label.includes.component.label</refname>
2321 <refpurpose>Do section labels include the component label?</refpurpose>
2325 <programlisting id="section.label.includes.component.label.frag"><xsl:param name="section.label.includes.component.label" select="0"></xsl:param></programlisting>
2328 <refsection><info><title>Description</title></info>
2330 <para>If non-zero, section labels are prefixed with the label of the
2331 component that contains them.
2337 <refentry version="5.0" id="label.from.part">
2339 <refentrytitle>label.from.part</refentrytitle>
2340 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
2343 <refname>label.from.part</refname>
2344 <refpurpose>Renumber components in each part?</refpurpose>
2348 <programlisting id="label.from.part.frag">
2349 <xsl:param name="label.from.part" select="0"></xsl:param>
2353 <refsection><info><title>Description</title></info>
2355 <para>If <parameter>label.from.part</parameter> is non-zero, then
2356 numbering of components — <tag>preface</tag>,
2357 <tag>chapter</tag>, <tag>appendix</tag>, and
2358 <tag>reference</tag> (when <tag>reference</tag> occurs at the
2359 component level) — is re-started within each
2360 <tag>part</tag>.</para>
2361 <para>If <parameter>label.from.part</parameter> is zero (the
2362 default), numbering of components is <emphasis>not</emphasis>
2363 re-started within each <tag>part</tag>; instead, components are
2364 numbered sequentially throughout each <tag>book</tag>,
2365 regardless of whether or not they occur within <tag>part</tag>
2371 <refentry version="5.0" id="component.label.includes.part.label">
2373 <refentrytitle>component.label.includes.part.label</refentrytitle>
2374 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
2377 <refname>component.label.includes.part.label</refname>
2378 <refpurpose>Do component labels include the part label?</refpurpose>
2382 <programlisting id="component.label.includes.part.label.frag"><xsl:param name="component.label.includes.part.label" select="0"></xsl:param></programlisting>
2385 <refsection><info><title>Description</title></info>
2387 <para>If non-zero, number labels for <tag>chapter</tag>,
2388 <tag>appendix</tag>, and other component elements are prefixed with
2389 the label of the part element that contains them. So you might see
2390 Chapter II.3 instead of Chapter 3. Also, the labels for formal
2391 elements such as <tag>table</tag> and <tag>figure</tag> will include
2392 the part label. If there is no part element container, then no prefix
2396 This feature is most useful when the
2397 <parameter>label.from.part</parameter> parameter is turned on.
2398 In that case, there would be more than one <tag>chapter</tag>
2399 <quote>1</quote>, and the extra part label prefix will identify
2400 each chapter unambiguously.
2406 </reference><reference id="html" xml:base="../html/param.xml"><title>HTML</title>
2407 <refentry version="5.0" id="html.base">
2409 <refentrytitle>html.base</refentrytitle>
2410 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
2413 <refname>html.base</refname>
2414 <refpurpose>An HTML base URI</refpurpose>
2418 <programlisting id="html.base.frag">
2419 <xsl:param name="html.base"></xsl:param></programlisting>
2422 <refsection><info><title>Description</title></info>
2424 <para>If html.base is set, it is used for the <tag>base</tag> element
2425 in the <tag>head</tag> of the html documents. The parameter specifies
2426 the base URL for all relative URLs in the document. This is useful
2427 for dynamically served html where the base URI needs to be
2433 <refentry version="5.0" id="html.stylesheet">
2435 <refentrytitle>html.stylesheet</refentrytitle>
2436 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
2439 <refname>html.stylesheet</refname>
2440 <refpurpose>Name of the stylesheet(s) to use in the generated HTML</refpurpose>
2444 <programlisting id="html.stylesheet.frag">
2445 <xsl:param name="html.stylesheet"></xsl:param>
2449 <refsection><info><title>Description</title></info>
2451 <para>The <parameter>html.stylesheet</parameter> parameter is either
2452 empty, indicating that no stylesheet <tag>link</tag> tag should be
2453 generated in the html output, or it is a list of one or more
2454 stylesheet files.</para>
2456 <para>Multiple stylesheets are space-delimited. If you need to
2457 reference a stylesheet URI that includes a space, encode it with
2458 <literal>%20</literal>. A separate html <literal>link</literal> element will
2459 be generated for each stylesheet in the order they are listed in the
2465 <refentry version="5.0" id="html.stylesheet.type">
2467 <refentrytitle>html.stylesheet.type</refentrytitle>
2468 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
2471 <refname>html.stylesheet.type</refname>
2472 <refpurpose>The type of the stylesheet used in the generated HTML</refpurpose>
2476 <programlisting id="html.stylesheet.type.frag"><xsl:param name="html.stylesheet.type">text/css</xsl:param></programlisting>
2479 <refsection><info><title>Description</title></info>
2481 <para>The type of the stylesheet to place in the HTML <tag>link</tag> tag.
2487 <refentry version="5.0" id="css.decoration">
2489 <refentrytitle>css.decoration</refentrytitle>
2490 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
2493 <refname>css.decoration</refname>
2494 <refpurpose>Enable CSS decoration of elements</refpurpose>
2498 <programlisting id="css.decoration.frag">
2499 <xsl:param name="css.decoration" select="1"></xsl:param>
2503 <refsection><info><title>Description</title></info>
2506 If non-zero, then html elements produced by the stylesheet may be
2507 decorated with <literal>style</literal> attributes. For example, the
2508 <literal>li</literal> tags produced for list items may include a
2509 fragment of CSS in the <literal>style</literal> attribute which sets
2510 the CSS property "list-style-type".
2516 <refentry version="5.0" id="html.script">
2518 <refentrytitle>html.script</refentrytitle>
2519 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
2522 <refname>html.script</refname>
2523 <refpurpose>Name of the script(s) to use in the generated HTML</refpurpose>
2527 <programlisting id="html.script.frag">
2528 <xsl:param name="html.script"></xsl:param>
2532 <refsection><info><title>Description</title></info>
2534 <para>The <parameter>html.script</parameter> parameter is either
2535 empty (default), indicating that no <tag>script</tag> element should be
2536 generated in the html output, or it is a list of one or more
2537 script locations.</para>
2539 <para>Multiple script locations are space-delimited. If you need to
2540 reference a script URI that includes a space, encode it with
2541 <literal>%20</literal>. A separate html <literal>script</literal> element will
2542 be generated for each script in the order they are listed in the
2548 <refentry version="5.0" id="html.script.type">
2550 <refentrytitle>html.script.type</refentrytitle>
2551 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
2554 <refname>html.script.type</refname>
2555 <refpurpose>The type of script used in the generated HTML</refpurpose>
2559 <programlisting id="html.script.type.frag"><xsl:param name="html.script.type">text/javascript</xsl:param></programlisting>
2562 <refsection><info><title>Description</title></info>
2564 <para>The type of script to place in the HTML <tag>script</tag> element.
2565 Specifically, the value of the <tag>script</tag> element's <tag>type</tag>
2567 The default value is <literal>text/javascript</literal>.
2568 This param is used only when the stylesheet parameter
2569 <tag>html.script</tag> is non-blank and specifies the location of a script.</para>
2575 <refentry version="5.0" id="spacing.paras">
2577 <refentrytitle>spacing.paras</refentrytitle>
2578 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
2581 <refname>spacing.paras</refname>
2582 <refpurpose>Insert additional <p> elements for spacing?</refpurpose>
2586 <programlisting id="spacing.paras.frag">
2587 <xsl:param name="spacing.paras" select="0"></xsl:param>
2591 <refsection><info><title>Description</title></info>
2593 <para>When non-zero, additional, empty paragraphs are inserted in
2594 several contexts (for example, around informal figures), to create a
2595 more pleasing visual appearance in many browsers.
2601 <refentry version="5.0" id="emphasis.propagates.style">
2603 <refentrytitle>emphasis.propagates.style</refentrytitle>
2604 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
2607 <refname>emphasis.propagates.style</refname>
2608 <refpurpose>Pass emphasis role attribute through to HTML?</refpurpose>
2611 <programlisting id="emphasis.propagates.style.frag">
2612 <xsl:param name="emphasis.propagates.style" select="1"></xsl:param>
2615 <refsection><info><title>Description</title></info>
2616 <para>If non-zero, the <literal>role</literal> attribute of
2617 <tag>emphasis</tag> elements will be passed through to the HTML as a
2618 class attribute on a <literal>span</literal> that surrounds the
2623 <refentry version="5.0" id="para.propagates.style">
2625 <refentrytitle>para.propagates.style</refentrytitle>
2626 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
2629 <refname>para.propagates.style</refname>
2630 <refpurpose>Pass para role attribute through to HTML?</refpurpose>
2634 <programlisting id="para.propagates.style.frag">
2635 <xsl:param name="para.propagates.style" select="1"></xsl:param>
2639 <refsection><info><title>Description</title></info>
2641 <para>If true, the role attribute of <tag>para</tag> elements
2642 will be passed through to the HTML as a class attribute on the
2643 <tag>p</tag> generated for the paragraph.</para>
2648 <refentry version="5.0" id="phrase.propagates.style">
2650 <refentrytitle>phrase.propagates.style</refentrytitle>
2651 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
2654 <refname>phrase.propagates.style</refname>
2655 <refpurpose>Pass phrase role attribute through to HTML?</refpurpose>
2659 <programlisting id="phrase.propagates.style.frag">
2660 <xsl:param name="phrase.propagates.style" select="1"></xsl:param></programlisting>
2663 <refsection><info><title>Description</title></info>
2665 <para>If non-zero, the role attribute of <tag>phrase</tag> elements
2666 will be passed through to the HTML as a <literal>class</literal>
2667 attribute on a <literal>span</literal> that surrounds the
2673 <refentry version="5.0" id="entry.propagates.style">
2675 <refentrytitle>entry.propagates.style</refentrytitle>
2676 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
2679 <refname>entry.propagates.style</refname>
2680 <refpurpose>Pass entry role attribute through to HTML?</refpurpose>
2684 <programlisting id="entry.propagates.style.frag">
2685 <xsl:param name="entry.propagates.style" select="1"></xsl:param>
2689 <refsection><info><title>Description</title></info>
2691 <para>If true, the role attribute of <tag>entry</tag> elements
2692 will be passed through to the HTML as a class attribute on the
2693 <tag>td</tag> or <tag>th</tag> generated for the table
2699 <refentry version="5.0" id="html.longdesc">
2701 <refentrytitle>html.longdesc</refentrytitle>
2702 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
2705 <refname>html.longdesc</refname>
2706 <refpurpose>Should longdesc URIs be created?</refpurpose>
2709 <programlisting id="html.longdesc.frag">
2710 <xsl:param name="html.longdesc" select="1"></xsl:param>
2713 <refsection><info><title>Description</title></info>
2714 <para>If non-zero, HTML files will be created for the
2715 <literal>longdesc</literal> attribute. These files
2716 are created from the <tag>textobject</tag>s in
2717 <tag>mediaobject</tag>s and
2718 <tag>inlinemediaobject</tag>.
2723 <refentry version="5.0" id="html.longdesc.link">
2725 <refentrytitle>html.longdesc.link</refentrytitle>
2726 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
2729 <refname>html.longdesc.link</refname>
2730 <refpurpose>Should a link to the longdesc be included in the HTML?</refpurpose>
2734 <programlisting id="html.longdesc.link.frag">
2735 <xsl:param name="html.longdesc.link" select="$html.longdesc"></xsl:param>
2739 <refsection><info><title>Description</title></info>
2741 <para>If non-zero, links will be created to the
2742 HTML files created for the
2743 <literal>longdesc</literal> attribute. It makes no
2744 sense to enable this option without also enabling the
2745 <parameter>html.longdesc</parameter> parameter.</para>
2752 <refentry version="5.0" id="make.valid.html">
2754 <refentrytitle>make.valid.html</refentrytitle>
2755 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
2758 <refname>make.valid.html</refname>
2759 <refpurpose>Attempt to make sure the HTML output is valid HTML</refpurpose>
2763 <programlisting id="make.valid.html.frag">
2764 <xsl:param name="make.valid.html" select="0"></xsl:param>
2768 <refsection><info><title>Description</title></info>
2770 <para>If <parameter>make.valid.html</parameter> is true, the stylesheets take
2771 extra effort to ensure that the resulting HTML is valid. This may mean that some
2772 <tag>para</tag> tags are translated into HTML <tag>div</tag>s or
2773 that other substitutions occur.</para>
2775 <para>This parameter is different from <parameter>html.cleanup</parameter>
2776 because it changes the resulting markup; it does not use extension functions
2777 to manipulate result-tree-fragments and is therefore applicable to any
2778 XSLT processor.</para>
2783 <refentry version="5.0" id="html.cleanup">
2785 <refentrytitle>html.cleanup</refentrytitle>
2786 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
2789 <refname>html.cleanup</refname>
2790 <refpurpose>Attempt to clean up the resulting HTML?</refpurpose>
2794 <programlisting id="html.cleanup.frag">
2795 <xsl:param name="html.cleanup" select="1"></xsl:param>
2799 <refsection><info><title>Description</title></info>
2801 <para>If non-zero, and if the <link xlink:href="http://www.exslt.org/">EXSLT</link>
2802 extensions are supported by your processor, the resulting HTML will be
2803 <quote>cleaned up</quote>. This improves the chances that the
2804 resulting HTML will be valid. It may also improve the formatting of
2805 some elements.</para>
2807 <para>This parameter is different from <parameter>make.valid.html</parameter>
2808 because it uses extension functions to manipulate result-tree-fragments.</para>
2813 <refentry version="5.0" id="html.append">
2815 <refentrytitle>html.append</refentrytitle>
2816 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
2819 <refname>html.append</refname>
2820 <refpurpose>Specifies content to append to HTML output</refpurpose>
2824 <programlisting id="html.append.frag"><xsl:param name="html.append"></xsl:param></programlisting>
2827 <refsection><info><title>Description</title></info>
2829 <para>Specifies content to append to the end of HTML files output by
2830 the <filename>html/docbook.xsl</filename> stylesheet, after the
2831 closing <code><html></code> tag. You probably don’t want to set any
2832 value for this parameter; but if you do, the only value it should ever
2833 be set to is a newline character: <code>&#x0a;</code> or
2834 <code>&#10;</code></para>
2839 <refentry version="5.0" id="draft.mode">
2841 <refentrytitle>draft.mode</refentrytitle>
2842 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
2843 <refmiscinfo class="other" otherclass="value">no</refmiscinfo>
2844 <refmiscinfo class="other" otherclass="value">yes</refmiscinfo>
2845 <refmiscinfo class="other" otherclass="value">maybe</refmiscinfo>
2848 <refname>draft.mode</refname>
2849 <refpurpose>Select draft mode</refpurpose>
2853 <programlisting id="draft.mode.frag">
2854 <xsl:param name="draft.mode">no</xsl:param>
2858 <refsection><info><title>Description</title></info>
2860 <para>Selects draft mode. If <parameter>draft.mode</parameter> is
2861 <quote><literal>yes</literal></quote>, the entire document will be treated
2862 as a draft. If it is <quote><literal>no</literal></quote>, the entire document
2863 will be treated as a final copy. If it is <quote><literal>maybe</literal></quote>,
2864 individual sections will be treated as draft or final independently, depending
2865 on how their <literal>status</literal> attribute is set.
2871 <refentry version="5.0" id="draft.watermark.image">
2873 <refentrytitle>draft.watermark.image</refentrytitle>
2874 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
2877 <refname>draft.watermark.image</refname>
2878 <refpurpose>The URI of the image to be used for draft watermarks</refpurpose>
2882 <programlisting id="draft.watermark.image.frag">
2883 <xsl:param name="draft.watermark.image">images/draft.png</xsl:param>
2887 <refsection><info><title>Description</title></info>
2889 <para>The image to be used for draft watermarks.</para>
2894 <refentry version="5.0" id="generate.id.attributes">
2896 <refentrytitle>generate.id.attributes</refentrytitle>
2897 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
2900 <refname>generate.id.attributes</refname>
2901 <refpurpose>Generate ID attributes on container elements?</refpurpose>
2905 <programlisting id="generate.id.attributes.frag">
2906 <xsl:param name="generate.id.attributes" select="0"></xsl:param>
2910 <refsection><info><title>Description</title></info>
2912 <para>If non-zero, the HTML stylesheet will generate ID attributes on
2913 containers. For example, the markup:</para>
2915 <screen><section id="foo"><title>Some Title</title>
2916 <para>Some para.</para>
2917 </section></screen>
2919 <para>might produce:</para>
2921 <screen><div class="section" id="foo">
2922 <h2>Some Title</h2>
2923 <p>Some para.</p>
2924 </div></screen>
2926 <para>The alternative is to generate anchors:</para>
2928 <screen><div class="section">
2929 <h2><a name="foo"></a>Some Title</h2>
2930 <p>Some para.</p>
2931 </div></screen>
2933 <para>Because the <tag class="attribute">name</tag> attribute of
2934 the <tag>a</tag> element and the <tag class="attribute">id</tag>
2935 attribute of other tags are both of type <quote>ID</quote>, producing both
2936 generates invalid documents.</para>
2938 <para>As of version 1.50, you can use this switch to control which type of
2939 identifier is generated. For backwards-compatibility, generating
2940 <tag>a</tag> anchors is preferred.</para>
2942 <para>Note: at present, this switch is incompletely implemented.
2943 Disabling ID attributes will suppress them, but enabling ID attributes
2944 will not suppress the anchors.</para>
2949 <refentry version="5.0" id="generate.consistent.ids">
2951 <refentrytitle>generate.consistent.ids</refentrytitle>
2952 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
2955 <refname>generate.consistent.ids</refname>
2956 <refpurpose>Generate consistent id values if document is unchanged</refpurpose>
2960 <programlisting id="generate.consistent.ids.frag">
2961 <xsl:param name="generate.consistent.ids" select="0"></xsl:param>
2965 <refsection><info><title>Description</title></info>
2967 <para>When the stylesheet assigns an id value to an output element,
2968 the generate-id() function may be used. That function may not
2969 produce consistent values between runs. Version control
2970 systems may misidentify the changing id values as changes
2971 to the document.</para>
2973 <para>If you set this parameter's value to 1, then the
2974 template named <literal>object.id</literal> will replace
2975 the use of the function generate-id() with
2976 <literal><xsl:number level="multiple" count="*"/></literal>.
2977 This counts preceding elements to generate a unique number for
2978 the id value.</para>
2981 <para>This param does not associate permanent unique id values
2982 with particular elements.
2983 The id values are consistent only as long as the document
2984 structure does not change.
2985 If the document structure changes, then the counting
2986 of elements changes, and all id values after
2987 the first such change may be different, even when there is
2988 no change to the element itself or its output.
2992 <para>The default value of this parameter is zero, so generate-id() is used
2998 <refentry version="5.0" id="generate.meta.abstract">
3000 <refentrytitle>generate.meta.abstract</refentrytitle>
3001 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3004 <refname>generate.meta.abstract</refname>
3005 <refpurpose>Generate HTML <tag>META</tag> element from <tag>abstract</tag>?</refpurpose>
3009 <programlisting id="generate.meta.abstract.frag">
3010 <xsl:param name="generate.meta.abstract" select="1"></xsl:param>
3014 <refsection><info><title>Description</title></info>
3016 <para>If non-zero, document abstracts will be reproduced in the HTML
3017 <literal>head</literal>, with <literal>>meta name="description" content="..."</literal></para>
3023 <refentry version="5.0" id="make.clean.html">
3025 <refentrytitle>make.clean.html</refentrytitle>
3026 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3029 <refname>make.clean.html</refname>
3030 <refpurpose>Make HTML conform to modern coding standards</refpurpose>
3034 <programlisting id="make.clean.html.frag">
3035 <xsl:param name="make.clean.html" select="0"></xsl:param>
3039 <refsection><info><title>Description</title></info>
3041 <para>If <parameter>make.clean.html</parameter> is true, the stylesheets take
3042 extra effort to ensure that the resulting HTML is conforms to
3043 modern HTML coding standards. In addition to eliminating
3044 excessive and noncompliant coding, it moves presentation
3045 HTML coding to a CSS stylesheet.</para>
3047 <para>The resulting HTML is dependent on
3048 CSS for formatting, and so the stylesheet is capable of
3049 generating a supporting CSS file. The <parameter>docbook.css.source</parameter>
3050 and <parameter>custom.css.source</parameter> parameters control
3051 how a CSS file is generated.</para>
3053 <para>If you require your CSS to reside in the HTML
3054 <tag>head</tag> element, then the <parameter>generate.css.header</parameter>
3055 can be used to do that.</para>
3057 <para>The <parameter>make.clean.html</parameter> parameter is
3058 different from <parameter>html.cleanup</parameter>
3059 because the former changes the resulting markup; it does not use extension functions
3060 like the latter to manipulate result-tree-fragments,
3061 and is therefore applicable to any XSLT processor.</para>
3063 <para>If <parameter>make.clean.html</parameter> is set to zero (the default),
3064 then the stylesheet retains its original
3065 <quote>old style</quote>
3066 HTML formatting features.</para>
3070 <refentry version="5.0" id="docbook.css.source">
3072 <refentrytitle>docbook.css.source</refentrytitle>
3073 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
3076 <refname>docbook.css.source</refname>
3077 <refpurpose>Name of the default CSS input file</refpurpose>
3081 <programlisting id="docbook.css.source.frag"><xsl:param name="docbook.css.source">docbook.css.xml</xsl:param></programlisting>
3084 <refsection><info><title>Description</title></info>
3086 <para>The <parameter>docbook.css.source</parameter> parameter
3087 specifies the name of the file containing the default DocBook
3088 CSS styles. Those styles are necessary when the
3089 <parameter>make.clean.html</parameter> parameter is nonzero.</para>
3091 <para>The file is a well-formed XML file that
3092 must consist of a single <tag>style</tag> root
3093 element that contains CSS styles as its text content.
3094 The default value of the parameter (and filename)
3095 is <literal>docbook.css.xml</literal>.
3096 The stylesheets ship with the default file. You can substitute
3097 your own and specify its path in this parameter.</para>
3099 <para>If <parameter>docbook.css.source</parameter> is not blank,
3100 and <parameter>make.clean.html</parameter> is nonzero, then
3101 the stylesheet takes the following actions:</para>
3105 <para>The stylesheet uses the XSLT <literal>document()</literal>
3106 function to open the file specified by the parameter and
3107 load it into a variable.</para>
3110 <para>The stylesheet forms an output pathname consisting of the
3111 value of the <parameter>base.dir</parameter> parameter (if it is set)
3112 and the value of <parameter>docbook.css.source</parameter>,
3113 with the <literal>.xml</literal> suffix stripped off.
3117 <para>The stylesheet removes the <tag>style</tag>
3118 wrapper element and writes just the CSS text content to the output file.</para>
3121 <para>The stylesheet adds a <tag>link</tag> element to the
3122 HTML <tag>HEAD</tag> element to reference the external CSS stylesheet.
3124 <programlisting><link rel="stylesheet" href="docbook.css" type="text/css">
3126 <para>However, if the <parameter>docbook.css.link</parameter>
3127 parameter is set to zero, then no <tag>link</tag> is written
3128 for the default CSS file. That is useful if a custom
3129 CSS file will import the default CSS stylesheet to ensure
3130 proper cascading of styles.</para>
3134 <para>If the <parameter>docbook.css.source</parameter> parameter
3135 is changed from its default <literal>docbook.css.xml</literal> to blank,
3136 then no default CSS is generated. Likewise if the
3137 <parameter>make.clean.html</parameter> parameter is set to zero,
3138 then no default CSS is generated. The
3139 <parameter>custom.css.source</parameter> parameter can be used
3140 instead to generate a complete custom CSS file.</para>
3142 <para>You can use the <parameter>generate.css.header</parameter>
3143 parameter to instead write the CSS to each HTML <tag>HEAD</tag>
3144 element in a <tag>style</tag> tag instead of an external CSS file.</para>
3149 <refentry version="5.0" id="docbook.css.link">
3151 <refentrytitle>docbook.css.link</refentrytitle>
3152 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3155 <refname>docbook.css.link</refname>
3156 <refpurpose>Insert a link referencing the default CSS stylesheet</refpurpose>
3160 <programlisting id="docbook.css.link.frag">
3161 <xsl:param name="docbook.css.link" select="1"></xsl:param>
3165 <refsection><info><title>Description</title></info>
3167 <para>The stylesheets are capable of generating a default
3168 CSS stylesheet file. The parameters
3169 <parameter>make.clean.html</parameter> and
3170 <parameter>docbook.css.source</parameter> control that feature.</para>
3172 <para>Normally if a default CSS file is generated, then
3173 the stylesheet inserts a <tag>link</tag> tag in the HTML
3174 <tag>HEAD</tag> element to reference it.
3175 However, you can omit that <tag>link</tag> reference if
3176 you set the <parameter>docbook.css.link</parameter> to zero
3177 (1 is the default).</para>
3179 <para>This parameter is useful when you want to import the
3180 default CSS into a custom CSS file generated using the
3181 <parameter>custom.css.source</parameter> parameter.
3187 <refentry version="5.0" id="custom.css.source">
3189 <refentrytitle>custom.css.source</refentrytitle>
3190 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
3193 <refname>custom.css.source</refname>
3194 <refpurpose>Name of a custom CSS input file</refpurpose>
3198 <programlisting id="custom.css.source.frag"><xsl:param name="custom.css.source"></xsl:param></programlisting>
3201 <refsection><info><title>Description</title></info>
3203 <para>The <parameter>custom.css.source</parameter>
3204 parameter enables you to add CSS styles to DocBook's
3208 specifies the name of a file containing custom
3209 CSS styles. The file must be a well-formed XML file that
3210 consists of a single <tag>style</tag> root
3211 element that contains CSS styles as its text content.
3213 <programlisting><?xml version="1.0"?>
3223 <para>The filename specified by the parameter
3224 should have a <literal>.xml</literal>
3225 filename suffix, although that is not required.
3226 The default value of this parameter is blank.</para>
3228 <para>If <parameter>custom.css.source</parameter> is not blank, then
3229 the stylesheet takes the following actions.
3230 These actions take place regardless of the value of
3231 the <parameter>make.clean.html</parameter> parameter.</para>
3235 <para>The stylesheet uses the XSLT <literal>document()</literal>
3236 function to open the file specified by the parameter and
3237 load it into a variable.</para>
3240 <para>The stylesheet forms an output pathname consisting of the
3241 value of the <parameter>base.dir</parameter> parameter (if it is set)
3242 and the value of <parameter>custom.css.source</parameter>,
3243 with the <literal>.xml</literal> suffix stripped off.
3247 <para>The stylesheet removes the <tag>style</tag>
3248 wrapper element and writes just the CSS text content to the output file.</para>
3251 <para>The stylesheet adds a <tag>link</tag> element to the
3252 HTML <tag>HEAD</tag> element to reference this external CSS stylesheet.
3254 <programlisting><link rel="stylesheet" href="custom.css" type="text/css">
3262 <para>If the <parameter>make.clean.html</parameter> parameter is nonzero
3263 (the default is zero),
3264 and if the <parameter>docbook.css.source</parameter> parameter
3265 is not blank (the default is not blank),
3266 then the stylesheet will also generate a default CSS file
3267 and add a <tag>link</tag> tag to reference it.
3268 The <tag>link</tag> to the custom CSS comes after the
3269 <tag>link</tag> to the default, so it should cascade properly
3271 If you do not want two <tag>link</tag> tags, and
3272 instead want your custom CSS to import the default generated
3273 CSS file, then do the following:
3278 <para>Add a line like the following to your custom CSS source file:</para>
3279 <programlisting>@import url("docbook.css")
3283 <para>Set the <parameter>docbook.css.link</parameter> parameter
3284 to zero. This will omit the <tag>link</tag> tag
3285 that references the default CSS file.</para>
3289 <para>If you set <parameter>make.clean.html</parameter> to nonzero but
3290 you do not want the default CSS generated, then also set
3291 the <parameter>docbook.css.source</parameter> parameter to blank.
3292 Then no default CSS will be generated, and so
3293 all CSS styles must come from your custom CSS file.</para>
3295 <para>You can use the <parameter>generate.css.header</parameter>
3296 parameter to instead write the CSS to each HTML <tag>HEAD</tag>
3297 element in a <tag>style</tag> tag instead of an external CSS file.</para>
3302 <refentry version="5.0" id="generate.css.header">
3304 <refentrytitle>generate.css.header</refentrytitle>
3305 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3308 <refname>generate.css.header</refname>
3309 <refpurpose>Insert generated CSS styles in HEAD element</refpurpose>
3313 <programlisting id="generate.css.header.frag">
3314 <xsl:param name="generate.css.header" select="0"></xsl:param>
3318 <refsection><info><title>Description</title></info>
3320 <para>The stylesheets are capable of generating both default
3321 and custom CSS stylesheet files. The parameters
3322 <parameter>make.clean.html</parameter>,
3323 <parameter>docbook.css.source</parameter>, and
3324 <parameter>custom.css.source</parameter> control that feature.</para>
3326 <para>If you require that CSS styles reside in the HTML
3327 <tag>HEAD</tag> element instead of external CSS files,
3328 then set the <parameter>generate.css.header</parameter>
3329 parameter to nonzero (it is zero by default).
3330 Then instead of generating the CSS in external files,
3331 they are wrapped in <tag>style</tag> elements in
3332 the <tag>HEAD</tag> element of each HTML output file.
3338 </reference><reference id="xslt" xml:base="../html/param.xml"><title>XSLT Processing</title>
3339 <refentry version="5.0" id="rootid">
3341 <refentrytitle>rootid</refentrytitle>
3342 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
3345 <refname>rootid</refname>
3346 <refpurpose>Specify the root element to format</refpurpose>
3350 <programlisting id="rootid.frag">
3351 <xsl:param name="rootid"></xsl:param></programlisting>
3354 <refsection><info><title>Description</title></info>
3356 <para>If <parameter>rootid</parameter> is not empty, it must be the
3357 value of an ID that occurs in the document being formatted. The entire
3358 document will be loaded and parsed, but formatting will begin at the
3359 element identified, rather than at the root. For example, this allows
3360 you to process only <tag>chapter</tag> 4 of a <tag>book</tag>.</para>
3361 <para>Because the entire document is available to the processor, automatic
3362 numbering, cross references, and other dependencies are correctly
3368 <refentry version="5.0" id="suppress.navigation">
3370 <refentrytitle>suppress.navigation</refentrytitle>
3371 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3374 <refname>suppress.navigation</refname>
3375 <refpurpose>Disable header and footer navigation</refpurpose>
3379 <programlisting id="suppress.navigation.frag">
3380 <xsl:param name="suppress.navigation" select="0"></xsl:param>
3384 <refsection><info><title>Description</title></info>
3387 If non-zero, header and footer navigation will be suppressed.</para>
3392 <refentry version="5.0" id="suppress.header.navigation">
3394 <refentrytitle>suppress.header.navigation</refentrytitle>
3395 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3398 <refname>suppress.header.navigation</refname>
3399 <refpurpose>Disable header navigation</refpurpose>
3403 <programlisting id="suppress.header.navigation.frag">
3404 <xsl:param name="suppress.header.navigation" select="0"></xsl:param>
3408 <refsection><info><title>Description</title></info>
3410 <para>If non-zero, header navigation will be suppressed.</para>
3415 <refentry version="5.0" id="suppress.footer.navigation">
3417 <refentrytitle>suppress.footer.navigation</refentrytitle>
3418 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3421 <refname>suppress.footer.navigation</refname>
3422 <refpurpose>Disable footer navigation</refpurpose>
3426 <programlisting id="suppress.footer.navigation.frag"><xsl:param name="suppress.footer.navigation">0</xsl:param></programlisting>
3429 <refsection><info><title>Description</title></info>
3432 If non-zero, footer navigation will be suppressed.</para>
3437 <refentry version="5.0" id="header.rule">
3439 <refentrytitle>header.rule</refentrytitle>
3440 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3443 <refname>header.rule</refname>
3444 <refpurpose>Rule under headers?</refpurpose>
3448 <programlisting id="header.rule.frag">
3449 <xsl:param name="header.rule" select="1"></xsl:param>
3453 <refsection><info><title>Description</title></info>
3455 <para>If non-zero, a rule will be drawn below the page headers.</para>
3460 <refentry version="5.0" id="footer.rule">
3462 <refentrytitle>footer.rule</refentrytitle>
3463 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3466 <refname>footer.rule</refname>
3467 <refpurpose>Rule over footers?</refpurpose>
3471 <programlisting id="footer.rule.frag">
3472 <xsl:param name="footer.rule" select="1"></xsl:param>
3476 <refsection><info><title>Description</title></info>
3478 <para>If non-zero, a rule will be drawn above the page footers.</para>
3483 <refentry version="5.0" id="id.warnings">
3485 <refentrytitle>id.warnings</refentrytitle>
3486 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3489 <refname>id.warnings</refname>
3490 <refpurpose>Should warnings be generated for titled elements without IDs?</refpurpose>
3493 <programlisting id="id.warnings.frag">
3494 <xsl:param name="id.warnings" select="0"></xsl:param>
3497 <refsection><info><title>Description</title></info>
3498 <para>If non-zero, the stylesheet will issue a warning for any element
3499 (other than the root element) which has a <tag>title</tag> but does not have an
3504 </reference><reference id="meta" xml:base="../html/param.xml"><title>Meta/*Info and Titlepages</title>
3505 <refentry version="5.0" id="inherit.keywords">
3507 <refentrytitle>inherit.keywords</refentrytitle>
3508 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3511 <refname>inherit.keywords</refname>
3512 <refpurpose>Inherit keywords from ancestor elements?</refpurpose>
3516 <programlisting id="inherit.keywords.frag">
3517 <xsl:param name="inherit.keywords" select="1"></xsl:param></programlisting>
3520 <refsection><info><title>Description</title></info>
3522 <para>If <parameter>inherit.keywords</parameter>
3523 is non-zero, the keyword <literal>meta</literal> for each HTML
3524 <literal>head</literal> element will include all of the keywords from
3525 ancestor elements. Otherwise, only the keywords from the current section
3532 <refentry version="5.0" id="make.single.year.ranges">
3534 <refentrytitle>make.single.year.ranges</refentrytitle>
3535 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3538 <refname>make.single.year.ranges</refname>
3539 <refpurpose>Print single-year ranges (e.g., 1998-1999)</refpurpose>
3543 <programlisting id="make.single.year.ranges.frag">
3544 <xsl:param name="make.single.year.ranges" select="0"></xsl:param></programlisting>
3547 <refsection><info><title>Description</title></info>
3549 <para>If non-zero, year ranges that span a single year will be printed
3550 in range notation (1998-1999) instead of discrete notation
3551 (1998, 1999).</para>
3556 <refentry version="5.0" id="make.year.ranges">
3558 <refentrytitle>make.year.ranges</refentrytitle>
3559 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3562 <refname>make.year.ranges</refname>
3563 <refpurpose>Collate copyright years into ranges?</refpurpose>
3567 <programlisting id="make.year.ranges.frag"><xsl:param name="make.year.ranges" select="0"></xsl:param></programlisting>
3570 <refsection><info><title>Description</title></info>
3572 <para>If non-zero, multiple copyright <tag>year</tag> elements will be
3573 collated into ranges.
3574 This works only if each year number is put into a separate
3575 year element. The copyright element permits multiple
3576 year elements. If a year element contains a dash or
3577 a comma, then that year element will not be merged into
3584 <refentry version="5.0" id="author.othername.in.middle">
3586 <refentrytitle>author.othername.in.middle</refentrytitle>
3587 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3590 <refname>author.othername.in.middle</refname>
3591 <refpurpose>Is <tag>othername</tag> in <tag>author</tag> a
3592 middle name?</refpurpose>
3596 <programlisting id="author.othername.in.middle.frag">
3597 <xsl:param name="author.othername.in.middle" select="1"></xsl:param></programlisting>
3600 <refsection><info><title>Description</title></info>
3602 <para>If non-zero, the <tag>othername</tag> of an <tag>author</tag>
3603 appears between the <tag>firstname</tag> and
3604 <tag>surname</tag>. Otherwise, <tag>othername</tag>
3611 <refentry version="5.0" id="blurb.on.titlepage.enabled">
3613 <refentrytitle>blurb.on.titlepage.enabled</refentrytitle>
3614 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3617 <refname>blurb.on.titlepage.enabled</refname>
3618 <refpurpose>Display personblurb and authorblurb on title pages?</refpurpose>
3622 <programlisting id="blurb.on.titlepage.enabled.frag">
3623 <xsl:param name="blurb.on.titlepage.enabled" select="0"></xsl:param>
3627 <refsection><info><title>Description</title></info>
3629 <para>If non-zero, output from <tag>authorblurb</tag> and
3630 <tag>personblurb</tag> elements is displayed on title pages. If zero
3631 (the default), output from those elements is suppressed on title pages
3632 (unless you are using a <literal>titlepage</literal> customization
3633 that causes them to be included).</para>
3638 <refentry version="5.0" id="contrib.inline.enabled">
3640 <refentrytitle>contrib.inline.enabled</refentrytitle>
3641 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3644 <refname>contrib.inline.enabled</refname>
3645 <refpurpose>Display contrib output inline?</refpurpose>
3649 <programlisting id="contrib.inline.enabled.frag"><xsl:param name="contrib.inline.enabled">1</xsl:param></programlisting>
3652 <refsection><info><title>Description</title></info>
3654 <para>If non-zero (the default), output of the <tag>contrib</tag> element is
3655 displayed as inline content rather than as block content.</para>
3660 <refentry version="5.0" id="editedby.enabled">
3662 <refentrytitle>editedby.enabled</refentrytitle>
3663 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3666 <refname>editedby.enabled</refname>
3667 <refpurpose>Display “Edited by” heading above editor name?</refpurpose>
3671 <programlisting id="editedby.enabled.frag"><xsl:param name="editedby.enabled">1</xsl:param></programlisting>
3674 <refsection><info><title>Description</title></info>
3676 <para>If non-zero, a localized <emphasis role="bold">Edited
3677 by</emphasis> heading is displayed above editor names in output of the
3678 <tag>editor</tag> element.</para>
3683 <refentry version="5.0" id="abstract.notitle.enabled">
3685 <refentrytitle>abstract.notitle.enabled</refentrytitle>
3686 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3689 <refname>abstract.notitle.enabled</refname>
3690 <refpurpose>Suppress display of abstract titles?</refpurpose>
3693 <programlisting id="abstract.notitle.enabled.frag"><xsl:param name="abstract.notitle.enabled" select="0"></xsl:param></programlisting>
3695 <refsection><info><title>Description</title></info>
3696 <para>If non-zero, in output of the <tag>abstract</tag> element on titlepages,
3697 display of the abstract title is suppressed.</para>
3701 <refentry version="5.0" id="othercredit.like.author.enabled">
3703 <refentrytitle>othercredit.like.author.enabled</refentrytitle>
3704 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3707 <refname>othercredit.like.author.enabled</refname>
3708 <refpurpose>Display othercredit in same style as author?</refpurpose>
3712 <programlisting id="othercredit.like.author.enabled.frag"><xsl:param name="othercredit.like.author.enabled">0</xsl:param></programlisting>
3715 <refsection><info><title>Description</title></info>
3717 <para>If non-zero, output of the
3718 <tag>othercredit</tag> element on titlepages is displayed in
3719 the same style as <tag>author</tag> and
3720 <tag>editor</tag> output. If zero then
3721 <tag>othercredit</tag> output is displayed using a style
3722 different than that of <tag>author</tag> and
3723 <tag>editor</tag>.</para>
3728 <refentry version="5.0" id="generate.legalnotice.link">
3730 <refentrytitle>generate.legalnotice.link</refentrytitle>
3731 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3734 <refname>generate.legalnotice.link</refname>
3735 <refpurpose>Write legalnotice to separate chunk and generate link?</refpurpose>
3739 <programlisting id="generate.legalnotice.link.frag"><xsl:param name="generate.legalnotice.link" select="0"></xsl:param></programlisting>
3742 <refsection><info><title>Description</title></info>
3744 <para>If the value of <parameter>generate.legalnotice.link</parameter>
3745 is non-zero, the stylesheet:
3749 <para>writes the contents of <tag>legalnotice</tag> to a separate
3753 <para>inserts a hyperlink to the <tag>legalnotice</tag> file</para>
3756 <para>adds (in the HTML <literal>head</literal>) either a single
3757 <literal>link</literal> or element or multiple
3758 <literal>link</literal> elements (depending on the value of the
3759 <parameter>html.head.legalnotice.link.multiple</parameter>
3760 parameter), with the value or values derived from the
3761 <parameter>html.head.legalnotice.link.types</parameter>
3766 Otherwise, if <parameter>generate.legalnotice.link</parameter> is
3767 zero, <tag>legalnotice</tag> contents are rendered on the title
3770 <para>The name of the separate HTML file is computed as follows:
3774 <para>If a filename is given by the <tag class="xmlpi">dbhtml filename</tag>
3775 processing instruction, that filename is used.</para>
3778 <para>If the legalnotice has an <tag class="attribute">id</tag>/<tag class="attribute">xml:id</tag>
3779 attribute, and if <parameter>use.id.as.filename</parameter> != 0, the filename
3780 is the concatenation of the id value and the value of the <parameter>html.ext</parameter>
3784 <para>If the legalnotice does not have an <tag class="attribute">id</tag>/<tag class="attribute">xml:id</tag>
3785 attribute, or if <parameter>use.id.as.filename</parameter> = 0, the filename is the concatenation of "ln-",
3786 auto-generated id value, and <parameter>html.ext</parameter> value.
3796 <refentry version="5.0" id="generate.revhistory.link">
3798 <refentrytitle>generate.revhistory.link</refentrytitle>
3799 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3802 <refname>generate.revhistory.link</refname>
3803 <refpurpose>Write revhistory to separate chunk and generate link?</refpurpose>
3807 <programlisting id="generate.revhistory.link.frag"><xsl:param name="generate.revhistory.link" select="0"></xsl:param></programlisting>
3810 <refsection><info><title>Description</title></info>
3812 <para>If non-zero, the contents of <tag>revhistory</tag> are written
3813 to a separate HTML file and a link to the file is
3814 generated. Otherwise, <tag>revhistory</tag> contents are rendered on
3815 the title page.</para>
3817 <para>The name of the separate HTML file is computed as follows:
3821 <para>If a filename is given by the <tag class="xmlpi">dbhtml filename</tag> processing instruction,
3822 that filename is used.</para>
3825 <para>If the revhistory has an <tag class="attribute">id</tag>/<tag class="attribute">xml:id</tag>
3826 attribute, and if <parameter>use.id.as.filename</parameter> != 0, the filename is the concatenation of
3827 the id value and the value of the <parameter>html.ext</parameter> parameter.</para>
3830 <para>If the revhistory does not have an <tag class="attribute">id</tag>/<tag class="attribute">xml:id</tag>
3831 attribute, or if <parameter>use.id.as.filename</parameter> = 0, the filename is the concatenation of "rh-",
3832 auto-generated id value, and <parameter>html.ext</parameter> value.
3842 <refentry version="5.0" id="html.head.legalnotice.link.types">
3844 <refentrytitle>html.head.legalnotice.link.types</refentrytitle>
3845 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
3848 <refname>html.head.legalnotice.link.types</refname>
3849 <refpurpose>Specifies link types for legalnotice link in html head</refpurpose>
3853 <programlisting id="html.head.legalnotice.link.types.frag">
3854 <xsl:param name="html.head.legalnotice.link.types">copyright</xsl:param>
3858 <refsection><info><title>Description</title></info>
3861 <parameter>html.head.legalnotice.link.types</parameter> is a
3862 space-separated list of link types, as described in <link xlink:href="http://www.w3.org/TR/html401/types.html#type-links">Section 6.12
3863 of the HTML 4.01 specification</link>. If the value of the
3864 <parameter>generate.legalnotice.link</parameter> parameter is
3865 non-zero, then the stylesheet generates (in the
3866 <literal>head</literal> section of the HTML source) either a single
3867 HTML <literal>link</literal> element or, if the value of the
3868 <parameter>html.head.legalnotice.link.multiple</parameter> is
3869 non-zero, one <literal>link</literal> element for each link type
3870 specified. Each <literal>link</literal> has the following attributes:
3874 <para>a <tag class="attribute">rel</tag> attribute whose
3875 value is derived from the value of
3876 <parameter>html.head.legalnotice.link.types</parameter></para>
3879 <para>an <tag class="attribute">href</tag> attribute whose
3880 value is set to the URL of the file containing the
3881 <tag>legalnotice</tag></para>
3884 <para>a <tag class="attribute">title</tag> attribute whose
3885 value is set to the title of the corresponding
3886 <tag>legalnotice</tag> (or a title programatically
3887 determined by the stylesheet)</para>
3893 <screen> <link rel="license" href="ln-id2524073.html" title="Legal Notice"></screen>
3896 <refsection><info><title>About the default value</title></info>
3898 <para>In an ideal world, the default value of
3899 <parameter>html.head.legalnotice.link.types</parameter> would
3900 probably be “<literal>license</literal>”, since the content of the
3901 DocBook <tag>legalnotice</tag> is typically license
3902 information, not copyright information. However, the default value
3903 is “<literal>copyright</literal>” for pragmatic reasons: because
3904 that’s among the set of “recognized link types” listed in <link xlink:href="http://www.w3.org/TR/html401/types.html#type-links">Section
3905 6.12 of the HTML 4.01 specification</link>, and because certain
3906 browsers and browser extensions are preconfigured to recognize that
3913 <refentry version="5.0" id="html.head.legalnotice.link.multiple">
3915 <refentrytitle>html.head.legalnotice.link.multiple</refentrytitle>
3916 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3919 <refname>html.head.legalnotice.link.multiple</refname>
3920 <refpurpose>Generate multiple link instances in html head for legalnotice?</refpurpose>
3924 <programlisting id="html.head.legalnotice.link.multiple.frag">
3925 <xsl:param name="html.head.legalnotice.link.multiple" select="1"></xsl:param>
3929 <refsection><info><title>Description</title></info>
3931 <para>If <parameter>html.head.legalnotice.link.multiple</parameter> is
3932 non-zero and the value of
3933 <parameter>html.head.legalnotice.link.types</parameter> contains
3934 multiple link types, then the stylesheet generates (in the
3935 <literal>head</literal> section of the HTML source) one
3936 <literal>link</literal> element for each link type specified. For
3937 example, if the value of
3938 <parameter>html.head.legalnotice.link.types</parameter> is
3939 “<literal>copyright license</literal>”:
3941 <screen> <link rel="copyright" href="ln-id2524073.html" title="Legal Notice">
3942 <link rel="license" href="ln-id2524073.html" title="Legal Notice"></screen>
3944 Otherwise, the stylesheet generates generates a single
3945 <literal>link</literal> instance; for example:
3947 <screen> <link rel="copyright license" href="ln-id2524073.html" title="Legal Notice"></screen>
3953 </reference><reference id="refentry" xml:base="../html/param.xml"><title>Reference Pages</title>
3954 <refentry version="5.0" id="funcsynopsis.decoration">
3956 <refentrytitle>funcsynopsis.decoration</refentrytitle>
3957 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3960 <refname>funcsynopsis.decoration</refname>
3961 <refpurpose>Decorate elements of a <tag>funcsynopsis</tag>?</refpurpose>
3965 <programlisting id="funcsynopsis.decoration.frag">
3966 <xsl:param name="funcsynopsis.decoration" select="1"></xsl:param>
3970 <refsection><info><title>Description</title></info>
3972 <para>If non-zero, elements of the <tag>funcsynopsis</tag> will be
3973 decorated (e.g. rendered as bold or italic text). The decoration is controlled by
3974 templates that can be redefined in a customization layer.
3980 <refentry version="5.0" id="funcsynopsis.style">
3982 <refentrytitle>funcsynopsis.style</refentrytitle>
3983 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
3984 <refmiscinfo class="other" otherclass="value">ansi</refmiscinfo>
3985 <refmiscinfo class="other" otherclass="value">kr</refmiscinfo>
3988 <refname>funcsynopsis.style</refname>
3989 <refpurpose>What style of <tag>funcsynopsis</tag> should be generated?</refpurpose>
3993 <programlisting id="funcsynopsis.style.frag"><xsl:param name="funcsynopsis.style">kr</xsl:param></programlisting>
3996 <refsection><info><title>Description</title></info>
3998 <para>If <parameter>funcsynopsis.style</parameter> is <literal>ansi</literal>,
3999 ANSI-style function synopses are generated for a
4000 <tag>funcsynopsis</tag>, otherwise K&R-style
4001 function synopses are generated.
4007 <refentry version="5.0" id="function.parens">
4009 <refentrytitle>function.parens</refentrytitle>
4010 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
4013 <refname>function.parens</refname>
4014 <refpurpose>Generate parens after a function?</refpurpose>
4018 <programlisting id="function.parens.frag">
4019 <xsl:param name="function.parens" select="0"></xsl:param>
4023 <refsection><info><title>Description</title></info>
4025 <para>If non-zero, the formatting of a <tag>function</tag> element
4026 will include generated parentheses.
4032 <refentry version="5.0" id="refentry.generate.name">
4034 <refentrytitle>refentry.generate.name</refentrytitle>
4035 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
4038 <refname>refentry.generate.name</refname>
4039 <refpurpose>Output NAME header before <tag>refname</tag>s?</refpurpose>
4043 <programlisting id="refentry.generate.name.frag">
4044 <xsl:param name="refentry.generate.name" select="1"></xsl:param>
4048 <refsection><info><title>Description</title></info>
4050 <para>If non-zero, a "NAME" section title is output before the list
4051 of <tag>refname</tag>s. This parameter and
4052 <parameter>refentry.generate.title</parameter> are mutually
4053 exclusive. This means that if you change this parameter to zero, you
4054 should set <parameter>refentry.generate.title</parameter> to non-zero unless
4055 you want get quite strange output.
4061 <refentry version="5.0" id="refentry.generate.title">
4063 <refentrytitle>refentry.generate.title</refentrytitle>
4064 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
4067 <refname>refentry.generate.title</refname>
4068 <refpurpose>Output title before <tag>refname</tag>s?</refpurpose>
4072 <programlisting id="refentry.generate.title.frag">
4073 <xsl:param name="refentry.generate.title" select="0"></xsl:param>
4077 <refsection><info><title>Description</title></info>
4079 <para>If non-zero, the reference page title or first name is
4080 output before the list of <tag>refname</tag>s. This parameter and
4081 <parameter>refentry.generate.name</parameter> are mutually exclusive.
4082 This means that if you change this parameter to non-zero, you
4083 should set <parameter>refentry.generate.name</parameter> to zero unless
4084 you want get quite strange output.</para>
4090 <refentry version="5.0" id="refentry.xref.manvolnum">
4092 <refentrytitle>refentry.xref.manvolnum</refentrytitle>
4093 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
4096 <refname>refentry.xref.manvolnum</refname>
4097 <refpurpose>Output <tag>manvolnum</tag> as part of
4098 <tag>refentry</tag> cross-reference?</refpurpose>
4102 <programlisting id="refentry.xref.manvolnum.frag">
4103 <xsl:param name="refentry.xref.manvolnum" select="1"></xsl:param>
4107 <refsection><info><title>Description</title></info>
4109 <para>if non-zero, the <tag>manvolnum</tag> is used when cross-referencing
4110 <tag>refentry</tag>s, either with <tag>xref</tag>
4111 or <tag>citerefentry</tag>.
4117 <refentry version="5.0" id="citerefentry.link">
4119 <refentrytitle>citerefentry.link</refentrytitle>
4120 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
4123 <refname>citerefentry.link</refname>
4124 <refpurpose>Generate URL links when cross-referencing RefEntrys?</refpurpose>
4128 <programlisting id="citerefentry.link.frag">
4129 <xsl:param name="citerefentry.link" select="0"></xsl:param></programlisting>
4132 <refsection><info><title>Description</title></info>
4134 <para>If non-zero, a web link will be generated, presumably
4135 to an online man->HTML gateway. The text of the link is
4136 generated by the <literal>generate.citerefentry.link</literal> template.
4142 <refentry version="5.0" id="refentry.separator">
4144 <refentrytitle>refentry.separator</refentrytitle>
4145 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
4148 <refname>refentry.separator</refname>
4149 <refpurpose>Generate a separator between consecutive RefEntry elements?</refpurpose>
4153 <programlisting id="refentry.separator.frag">
4154 <xsl:param name="refentry.separator" select="1"></xsl:param>
4158 <refsection><info><title>Description</title></info>
4160 <para>If true, a separator will be generated between consecutive
4167 <refentry version="5.0" id="refclass.suppress">
4169 <refentrytitle>refclass.suppress</refentrytitle>
4170 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
4173 <refname>refclass.suppress</refname>
4174 <refpurpose>Suppress display of refclass contents?</refpurpose>
4178 <programlisting id="refclass.suppress.frag">
4179 <xsl:param name="refclass.suppress" select="0"></xsl:param></programlisting>
4182 <refsection><info><title>Description</title></info>
4184 <para>If the value of <parameter>refclass.suppress</parameter> is
4185 non-zero, then display of <tag>refclass</tag> contents is
4186 suppressed in output.</para>
4191 </reference><reference id="tables" xml:base="../html/param.xml"><title>Tables</title>
4192 <refentry version="5.0" id="default.table.width">
4194 <refentrytitle>default.table.width</refentrytitle>
4195 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
4198 <refname>default.table.width</refname>
4199 <refpurpose>The default width of tables</refpurpose>
4202 <programlisting id="default.table.width.frag">
4203 <xsl:param name="default.table.width"></xsl:param>
4206 <refsection><info><title>Description</title></info>
4207 <para>If non-zero, this value will be used for the
4208 <literal>width</literal> attribute on <tag>table</tag>s that do not specify an
4209 alternate width (with the <tag class="xmlpi">dbhtml table-width</tag> or
4210 <tag class="xmlpi">dbfo table-width</tag> processing instruction).</para>
4214 <refentry version="5.0" id="nominal.table.width">
4216 <refentrytitle>nominal.table.width</refentrytitle>
4217 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
4220 <refname>nominal.table.width</refname>
4221 <refpurpose>The (absolute) nominal width of tables</refpurpose>
4225 <programlisting id="nominal.table.width.frag">
4226 <xsl:param name="nominal.table.width">6in</xsl:param>
4230 <refsection><info><title>Description</title></info>
4232 <para>In order to convert CALS column widths into HTML column widths, it
4233 is sometimes necessary to have an absolute table width to use for conversion
4234 of mixed absolute and relative widths. This value must be an absolute
4235 length (not a percentage).</para>
4240 <refentry version="5.0" id="table.borders.with.css">
4242 <refentrytitle>table.borders.with.css</refentrytitle>
4243 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
4246 <refname>table.borders.with.css</refname>
4247 <refpurpose>Use CSS to specify table, row, and cell borders?</refpurpose>
4251 <programlisting id="table.borders.with.css.frag">
4252 <xsl:param name="table.borders.with.css" select="0"></xsl:param>
4256 <refsection><info><title>Description</title></info>
4258 <para>If non-zero, CSS will be used to draw table borders.
4264 <refentry version="5.0" id="table.cell.border.style">
4266 <refentrytitle>table.cell.border.style</refentrytitle>
4267 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
4268 <refmiscinfo class="other" otherclass="value">none</refmiscinfo>
4269 <refmiscinfo class="other" otherclass="value">solid</refmiscinfo>
4270 <refmiscinfo class="other" otherclass="value">dotted</refmiscinfo>
4271 <refmiscinfo class="other" otherclass="value">dashed</refmiscinfo>
4272 <refmiscinfo class="other" otherclass="value">double</refmiscinfo>
4273 <refmiscinfo class="other" otherclass="value">groove</refmiscinfo>
4274 <refmiscinfo class="other" otherclass="value">ridge</refmiscinfo>
4275 <refmiscinfo class="other" otherclass="value">inset</refmiscinfo>
4276 <refmiscinfo class="other" otherclass="value">outset</refmiscinfo>
4277 <refmiscinfo class="other" otherclass="value">solid</refmiscinfo>
4280 <refname>table.cell.border.style</refname>
4281 <refpurpose>Specifies the border style of table cells</refpurpose>
4285 <programlisting id="table.cell.border.style.frag">
4286 <xsl:param name="table.cell.border.style">solid</xsl:param>
4290 <refsection><info><title>Description</title></info>
4292 <para>Specifies the border style of table cells.</para>
4295 <para>To control properties of cell borders in HTML output, you must also turn on the
4296 <parameter>table.borders.with.css</parameter> parameter.</para>
4302 <refentry version="5.0" id="table.cell.border.thickness">
4304 <refentrytitle>table.cell.border.thickness</refentrytitle>
4305 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
4308 <refname>table.cell.border.thickness</refname>
4309 <refpurpose>Specifies the thickness of table cell borders</refpurpose>
4313 <programlisting id="table.cell.border.thickness.frag">
4314 <xsl:param name="table.cell.border.thickness">
4316 <xsl:when test="contains($stylesheet.result.type,'html')">1px</xsl:when>
4317 <xsl:otherwise>0.5pt</xsl:otherwise>
4323 <refsection><info><title>Description</title></info>
4325 <para>If non-zero, specifies the thickness of borders on table
4326 cells. See <link xlink:href="http://www.w3.org/TR/CSS21/box.html#border-width-properties">
4330 <para>To control properties of cell borders in HTML output, you must also turn on the
4331 <parameter>table.borders.with.css</parameter> parameter.</para>
4337 <refentry version="5.0" id="table.cell.border.color">
4339 <refentrytitle>table.cell.border.color</refentrytitle>
4340 <refmiscinfo class="other" otherclass="datatype">color</refmiscinfo>
4343 <refname>table.cell.border.color</refname>
4344 <refpurpose>Specifies the border color of table cells</refpurpose>
4348 <programlisting id="table.cell.border.color.frag">
4349 <xsl:param name="table.cell.border.color"></xsl:param>
4354 <refsection><info><title>Description</title></info>
4356 <para>Set the color of table cell borders. If non-zero, the value is used
4357 for the border coloration. See <link xlink:href="http://www.w3.org/TR/CSS21/syndata.html#value-def-color">CSS</link>. A
4358 <literal>color</literal> is either a keyword or a numerical RGB specification.
4359 Keywords are aqua, black, blue, fuchsia, gray, green, lime, maroon,
4360 navy, olive, orange, purple, red, silver, teal, white, and
4364 <para>To control properties of cell borders in HTML output, you must also turn on the
4365 <parameter>table.borders.with.css</parameter> parameter.</para>
4371 <refentry version="5.0" id="table.frame.border.style">
4373 <refentrytitle>table.frame.border.style</refentrytitle>
4374 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
4375 <refmiscinfo class="other" otherclass="value">none</refmiscinfo>
4376 <refmiscinfo class="other" otherclass="value">solid</refmiscinfo>
4377 <refmiscinfo class="other" otherclass="value">dotted</refmiscinfo>
4378 <refmiscinfo class="other" otherclass="value">dashed</refmiscinfo>
4379 <refmiscinfo class="other" otherclass="value">double</refmiscinfo>
4380 <refmiscinfo class="other" otherclass="value">groove</refmiscinfo>
4381 <refmiscinfo class="other" otherclass="value">ridge</refmiscinfo>
4382 <refmiscinfo class="other" otherclass="value">inset</refmiscinfo>
4383 <refmiscinfo class="other" otherclass="value">outset</refmiscinfo>
4384 <refmiscinfo class="other" otherclass="value">solid</refmiscinfo>
4387 <refname>table.frame.border.style</refname>
4388 <refpurpose>Specifies the border style of table frames</refpurpose>
4392 <programlisting id="table.frame.border.style.frag">
4393 <xsl:param name="table.frame.border.style">solid</xsl:param>
4397 <refsection><info><title>Description</title></info>
4399 <para>Specifies the border style of table frames.</para>
4404 <refentry version="5.0" id="table.frame.border.thickness">
4406 <refentrytitle>table.frame.border.thickness</refentrytitle>
4407 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
4410 <refname>table.frame.border.thickness</refname>
4411 <refpurpose>Specifies the thickness of the frame border</refpurpose>
4415 <programlisting id="table.frame.border.thickness.frag">
4416 <xsl:param name="table.frame.border.thickness">
4418 <xsl:when test="contains($stylesheet.result.type,'html')">1px</xsl:when>
4419 <xsl:otherwise>0.5pt</xsl:otherwise>
4425 <refsection><info><title>Description</title></info>
4427 <para>Specifies the thickness of the border on the table's frame.</para>
4432 <refentry version="5.0" id="table.frame.border.color">
4434 <refentrytitle>table.frame.border.color</refentrytitle>
4435 <refmiscinfo class="other" otherclass="datatype">color</refmiscinfo>
4438 <refname>table.frame.border.color</refname>
4439 <refpurpose>Specifies the border color of table frames</refpurpose>
4443 <programlisting id="table.frame.border.color.frag">
4444 <xsl:param name="table.frame.border.color"></xsl:param>
4449 <refsection><info><title>Description</title></info>
4451 <para>Specifies the border color of table frames.</para>
4456 <refentry version="5.0" id="default.table.frame">
4458 <refentrytitle>default.table.frame</refentrytitle>
4459 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
4462 <refname>default.table.frame</refname>
4463 <refpurpose>The default framing of tables</refpurpose>
4467 <programlisting id="default.table.frame.frag">
4468 <xsl:param name="default.table.frame">all</xsl:param>
4472 <refsection><info><title>Description</title></info>
4474 <para>This value will be used when there is no frame attribute on the
4480 <refentry version="5.0" id="html.cellspacing">
4482 <refentrytitle>html.cellspacing</refentrytitle>
4483 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
4486 <refname>html.cellspacing</refname>
4487 <refpurpose>Default value for cellspacing in HTML tables</refpurpose>
4491 <programlisting id="html.cellspacing.frag">
4492 <xsl:param name="html.cellspacing"></xsl:param>
4496 <refsection><info><title>Description</title></info>
4498 <para>If non-zero, this value will be used as the default cellspacing
4499 value in HTML tables. nn for pixels or nn% for percentage
4500 length. E.g. 5 or 5%</para>
4505 <refentry version="5.0" id="html.cellpadding">
4507 <refentrytitle>html.cellpadding</refentrytitle>
4508 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
4511 <refname>html.cellpadding</refname>
4512 <refpurpose>Default value for cellpadding in HTML tables</refpurpose>
4516 <programlisting id="html.cellpadding.frag">
4517 <xsl:param name="html.cellpadding"></xsl:param>
4521 <refsection><info><title>Description</title></info>
4523 <para>If non-zero, this value will be used as the default cellpadding value
4524 in HTML tables. nn for pixels or nn% for percentage length. E.g. 5 or
4530 </reference><reference id="qa" xml:base="../html/param.xml"><title>QAndASet</title>
4531 <refentry version="5.0" id="qanda.defaultlabel">
4533 <refentrytitle>qanda.defaultlabel</refentrytitle>
4534 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
4535 <refmiscinfo class="other" otherclass="value">number</refmiscinfo>
4536 <refmiscinfo class="other" otherclass="value">qanda</refmiscinfo>
4537 <refmiscinfo class="other" otherclass="value">none</refmiscinfo>
4540 <refname>qanda.defaultlabel</refname>
4541 <refpurpose>Sets the default for defaultlabel on QandASet.</refpurpose>
4545 <programlisting id="qanda.defaultlabel.frag">
4546 <xsl:param name="qanda.defaultlabel">number</xsl:param>
4550 <refsection><info><title>Description</title></info>
4552 <para>If no <literal>defaultlabel</literal> attribute is specified on
4553 a <tag>qandaset</tag>, this value is used. It is generally one of the legal
4554 values for the defaultlabel attribute (<literal>none</literal>,
4555 <literal>number</literal> or
4556 <literal>qanda</literal>), or one of the additional stylesheet-specific values
4557 (<literal>qnumber</literal> or <literal>qnumberanda</literal>).
4558 The default value is 'number'.
4560 <para>The values are rendered as follows:</para>
4562 <varlistentry><term><literal>qanda</literal></term>
4564 <para><tag>question</tag>s are labeled "Q:" and
4565 <tag>answer</tag>s are labeled "A:". </para>
4569 <varlistentry><term><literal>number</literal></term>
4571 <para>The questions are enumerated and the answers
4572 are not labeled. </para>
4576 <varlistentry><term><literal>qnumber</literal></term>
4578 <para>The questions are labeled "Q:" followed by a number, and answers are not
4580 When sections are numbered, adding a label
4581 to the number distinguishes the question numbers
4582 from the section numbers.
4583 This value is not allowed in the
4584 <tag class="attribute">defaultlabel</tag> attribute
4585 of a <tag>qandaset</tag> element.</para>
4589 <varlistentry><term><literal>qnumberanda</literal></term>
4591 <para>The questions are labeled "Q:" followed by a number, and
4592 the answers are labeled "A:".
4593 When sections are numbered, adding a label
4594 to the number distinguishes the question numbers
4595 from the section numbers.
4596 This value is not allowed in the
4597 <tag class="attribute">defaultlabel</tag> attribute
4598 of a <tag>qandaset</tag> element.</para>
4602 <varlistentry><term><literal>none</literal></term>
4604 <para>No distinguishing label precedes Questions or Answers.
4613 <refentry version="5.0" id="qanda.inherit.numeration">
4615 <refentrytitle>qanda.inherit.numeration</refentrytitle>
4616 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
4619 <refname>qanda.inherit.numeration</refname>
4620 <refpurpose>Does enumeration of QandASet components inherit the numeration of parent elements?</refpurpose>
4624 <programlisting id="qanda.inherit.numeration.frag">
4625 <xsl:param name="qanda.inherit.numeration" select="1"></xsl:param>
4629 <refsection><info><title>Description</title></info>
4631 <para>If non-zero, numbered <tag>qandadiv</tag> elements and
4632 <tag>question</tag> and <tag>answer</tag> inherit the enumeration of
4633 the ancestors of the <tag>qandaset</tag>.
4639 <refentry version="5.0" id="qanda.in.toc">
4641 <refentrytitle>qanda.in.toc</refentrytitle>
4642 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
4645 <refname>qanda.in.toc</refname>
4646 <refpurpose>Should qandaentry questions appear in
4647 the document table of contents?</refpurpose>
4651 <programlisting id="qanda.in.toc.frag"><xsl:param name="qanda.in.toc" select="0"></xsl:param></programlisting>
4654 <refsection><info><title>Description</title></info>
4656 <para>If true (non-zero), then the generated table of contents
4657 for a document will include <tag>qandaset</tag> titles,
4658 <tag>qandadiv</tag> titles,
4659 and <tag>question</tag> elements. The default value (zero) excludes
4662 <para>This parameter does not affect any tables of contents
4663 that may be generated inside a qandaset or qandadiv.
4669 <refentry version="5.0" id="qanda.nested.in.toc">
4671 <refentrytitle>qanda.nested.in.toc</refentrytitle>
4672 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
4675 <refname>qanda.nested.in.toc</refname>
4676 <refpurpose>Should nested answer/qandaentry instances appear in TOC?</refpurpose>
4680 <programlisting id="qanda.nested.in.toc.frag">
4681 <xsl:param name="qanda.nested.in.toc" select="0"></xsl:param>
4685 <refsection><info><title>Description</title></info>
4687 <para>If non-zero, instances of <tag>qandaentry</tag>
4688 that are children of <tag>answer</tag> elements are shown in
4694 </reference><reference id="links" xml:base="../html/param.xml"><title>Linking</title>
4695 <refentry version="5.0" id="target.database.document">
4697 <refentrytitle>target.database.document</refentrytitle>
4698 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
4701 <refname>target.database.document</refname>
4702 <refpurpose>Name of master database file for resolving
4706 <programlisting id="target.database.document.frag">
4707 <xsl:param name="target.database.document">olinkdb.xml</xsl:param>
4710 <refsection><info><title>Description</title></info>
4713 To resolve olinks between documents, the stylesheets use a master
4714 database document that identifies the target datafiles for all the
4715 documents within the scope of the olinks. This parameter value is the
4716 URI of the master document to be read during processing to resolve
4717 olinks. The default value is <filename>olinkdb.xml</filename>.</para>
4719 <para>The data structure of the file is defined in the
4720 <filename>targetdatabase.dtd</filename> DTD. The database file
4721 provides the high level elements to record the identifiers, locations,
4722 and relationships of documents. The cross reference data for
4723 individual documents is generally pulled into the database using
4724 system entity references or XIncludes. See also
4725 <parameter>targets.filename</parameter>. </para> </refsection>
4728 <refentry version="5.0" id="targets.filename">
4730 <refentrytitle>targets.filename</refentrytitle>
4731 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
4734 <refname>targets.filename</refname>
4735 <refpurpose>Name of cross reference targets data file</refpurpose>
4737 <refsynopsisdiv> <programlisting id="targets.filename.frag">
4738 <xsl:param name="targets.filename">target.db</xsl:param>
4741 <refsection><info><title>Description</title></info>
4744 In order to resolve olinks efficiently, the stylesheets can
4745 generate an external data file containing information about
4746 all potential cross reference endpoints in a document.
4747 This parameter lets you change the name of the generated
4748 file from the default name <filename>target.db</filename>.
4749 The name must agree with that used in the target database
4750 used to resolve olinks during processing.
4751 See also <parameter>target.database.document</parameter>.
4756 <refentry version="5.0" id="olink.base.uri">
4758 <refentrytitle>olink.base.uri</refentrytitle>
4759 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
4762 <refname>olink.base.uri</refname>
4763 <refpurpose>Base URI used in olink hrefs</refpurpose>
4765 <refsynopsisdiv> <programlisting id="olink.base.uri.frag">
4766 <xsl:param name="olink.base.uri"></xsl:param>
4769 <refsection><info><title>Description</title></info>
4771 <para>When cross reference data is collected for resolving olinks, it
4772 may be necessary to prepend a base URI to each target's href. This
4773 parameter lets you set that base URI when cross reference data is
4774 collected. This feature is needed when you want to link to a document
4775 that is processed without chunking. The output filename for such a
4776 document is not known to the XSL stylesheet; the only target
4777 information consists of fragment identifiers such as
4778 <literal>#idref</literal>. To enable the resolution of olinks between
4779 documents, you should pass the name of the HTML output file as the
4780 value of this parameter. Then the hrefs recorded in the cross
4781 reference data collection look like
4782 <literal>outfile.html#idref</literal>, which can be reached as links
4783 from other documents.</para>
4787 <refentry version="5.0" id="use.local.olink.style">
4789 <refentrytitle>use.local.olink.style</refentrytitle>
4790 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
4793 <refname>use.local.olink.style</refname>
4794 <refpurpose>Process olinks using xref style of current
4795 document</refpurpose>
4797 <refsynopsisdiv> <programlisting id="use.local.olink.style.frag">
4798 <xsl:param name="use.local.olink.style" select="0"></xsl:param> </programlisting>
4800 <refsection><info><title>Description</title></info>
4802 <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
4803 reference string is formed again from the target title, number, and
4804 element name, using the stylesheet processing the targeting document.
4805 Then olinks will match the xref style in the targeting document
4806 rather than in the target document. If both documents are processed
4807 with the same stylesheet, then the results will be the same.</para>
4811 <refentry version="5.0" id="current.docid">
4813 <refentrytitle>current.docid</refentrytitle>
4814 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
4817 <refname>current.docid</refname>
4818 <refpurpose>targetdoc identifier for the document being
4819 processed</refpurpose>
4821 <refsynopsisdiv> <programlisting id="current.docid.frag">
4822 <xsl:param name="current.docid"></xsl:param>
4825 <refsection><info><title>Description</title></info>
4827 <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
4828 the targetdoc identifier of the current document, since that
4829 identifier does not appear in the document itself. </para>
4830 <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>
4834 <refentry version="5.0" id="olink.doctitle">
4836 <refentrytitle>olink.doctitle</refentrytitle>
4837 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
4838 <refmiscinfo class="other" otherclass="value">no</refmiscinfo>
4839 <refmiscinfo class="other" otherclass="value">yes</refmiscinfo>
4840 <refmiscinfo class="other" otherclass="value">maybe</refmiscinfo>
4843 <refname>olink.doctitle</refname>
4844 <refpurpose>show the document title for external olinks?</refpurpose>
4847 <refsynopsisdiv> <programlisting id="olink.doctitle.frag">
4848 <xsl:param name="olink.doctitle">no</xsl:param>
4851 <refsection><info><title>Description</title></info>
4853 <para>When olinks between documents are resolved, the generated text
4854 may not make it clear that the reference is to another document.
4855 It is possible for the stylesheets to append the other document's
4856 title to external olinks. For this to happen, two parameters must
4860 <para>This <parameter>olink.doctitle</parameter> parameter
4861 should be set to either <literal>yes</literal> or <literal>maybe</literal>
4862 to enable this feature.
4866 <para>And you should also set the <parameter>current.docid</parameter>
4867 parameter to the document id for the document currently
4868 being processed for output.
4874 Then if an olink's <literal>targetdoc</literal> id differs from
4875 the <literal>current.docid</literal> value, the stylesheet knows
4876 that it is a reference to another document and can
4877 append the target document's
4878 title to the generated olink text. </para>
4880 <para>The text for the target document's title is copied from the
4881 olink database from the <tag>ttl</tag> element
4882 of the top-level <tag>div</tag> for that document.
4883 If that <tag>ttl</tag> element is missing or empty,
4887 <para>The supported values for <parameter>olink.doctitle</parameter> are:
4891 <term><literal>yes</literal></term>
4894 Always insert the title to the target document if it is not
4895 the current document.
4900 <term><literal>no</literal></term>
4903 Never insert the title to the target document, even if requested
4904 in an <tag class="attribute">xrefstyle</tag> attribute.
4909 <term><literal>maybe</literal></term>
4912 Only insert the title to the target document, if requested
4913 in an <tag class="attribute">xrefstyle</tag> attribute.
4918 <para>An <tag class="attribute">xrefstyle</tag> attribute
4919 may override the global setting for individual olinks.
4920 The following values are supported in an
4921 <tag class="attribute">xrefstyle</tag>
4922 attribute using the <literal>select:</literal> syntax:
4927 <term><literal>docname</literal></term>
4930 Insert the target document name for this olink using the
4931 <literal>docname</literal> gentext template, but only
4932 if the value of <parameter>olink.doctitle</parameter>
4933 is not <literal>no</literal>.
4938 <term><literal>docnamelong</literal></term>
4941 Insert the target document name for this olink using the
4942 <literal>docnamelong</literal> gentext template, but only
4943 if the value of <parameter>olink.doctitle</parameter>
4944 is not <literal>no</literal>.
4949 <term><literal>nodocname</literal></term>
4952 Omit the target document name even if
4953 the value of <parameter>olink.doctitle</parameter>
4954 is <literal>yes</literal>.
4959 <para>Another way of inserting the target document name
4960 for a single olink is to employ an
4961 <tag class="attribute">xrefstyle</tag>
4962 attribute using the <literal>template:</literal> syntax.
4963 The <literal>%o</literal> placeholder (the letter o, not zero)
4965 will be filled in with the target document's title when it is processed.
4966 This will occur regardless of
4967 the value of <parameter>olink.doctitle</parameter>.
4969 <para>Note that prior to version 1.66 of the XSL stylesheets,
4970 the allowed values for this parameter were 0 and 1. Those
4971 values are still supported and mapped to 'no' and 'yes', respectively.
4976 <refentry version="5.0" id="activate.external.olinks">
4978 <refentrytitle>activate.external.olinks</refentrytitle>
4979 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
4982 <refname>activate.external.olinks</refname>
4983 <refpurpose>Make external olinks into active links</refpurpose>
4987 <programlisting id="activate.external.olinks.frag">
4988 <xsl:param name="activate.external.olinks" select="1"></xsl:param>
4992 <refsection><info><title>Description</title></info>
4994 <para>If <parameter>activate.external.olinks</parameter> is nonzero
4995 (the default), then any olinks that reference another document
4996 become active links that can be clicked on to follow the link.
4997 If the parameter is set to zero, then external olinks
4998 will have the appropriate link text generated, but the link is
4999 not made active. Olinks to destinations in
5000 the current document remain active.</para>
5002 <para>To make an external olink active for HTML
5003 outputs, the link text is wrapped in an <tag>a</tag>
5004 element with an <tag>href</tag> attribute. To
5005 make an external olink active for FO outputs, the link text is
5006 wrapped in an <tag>fo:basic-link</tag> element with an
5007 <tag>external-destination</tag> attribute.</para>
5009 <para>This parameter is useful when you need external olinks
5010 to resolve but not be clickable. For example, if documents
5011 in a collection are available independently of each other,
5012 then having active links between them could lead to
5013 unresolved links when a given target document is missing.</para>
5015 <para>The epub stylesheets set this parameter to zero by default
5016 because there is no standard linking mechanism between Epub documents.</para>
5018 <para>If external links are made inactive, you should
5019 consider setting the
5020 stylesheet parameter <parameter>olink.doctitle</parameter>
5021 to <literal>yes</literal>. That will append the external document's
5022 title to the link text, making it easier for the user to
5023 locate the other document.</para>
5025 <para>An olink is considered external when the
5026 <parameter>current.docid</parameter> stylesheet parameter
5027 is set to some value, and the olink's <tag>targetdoc</tag>
5028 attribute has a different value. If the two values
5029 match, then the link is considered internal. If the
5030 <parameter>current.docid</parameter> parameter is blank, or
5031 the <tag>olink</tag> element does not have a <tag>targetdoc</tag> attribute,
5032 then the link is considered to be internal and will become
5033 an active link.</para>
5035 <para>See also <parameter>olink.doctitle</parameter>,
5036 <parameter>prefer.internal.olink</parameter>.</para>
5041 <refentry version="5.0" id="olink.debug">
5043 <refentrytitle>olink.debug</refentrytitle>
5044 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
5047 <refname>olink.debug</refname>
5048 <refpurpose>Turn on debugging messages for olinks</refpurpose>
5052 <programlisting id="olink.debug.frag">
5053 <xsl:param name="olink.debug" select="0"></xsl:param>
5057 <refsection><info><title>Description</title></info>
5059 <para>If non-zero, then each olink will generate several
5060 messages about how it is being resolved during processing.
5061 This is useful when an olink does not resolve properly
5062 and the standard error messages are not sufficient to
5066 <para>You may need to read through the olink XSL templates
5067 to understand the context for some of the debug messages.
5073 <refentry version="5.0" id="olink.properties">
5075 <refentrytitle>olink.properties</refentrytitle>
5076 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
5079 <refname>olink.properties</refname>
5080 <refpurpose>Properties associated with the cross-reference
5081 text of an olink.</refpurpose>
5085 <programlisting id="olink.properties.frag">
5086 <xsl:attribute-set name="olink.properties">
5087 <xsl:attribute name="show-destination">replace</xsl:attribute>
5088 </xsl:attribute-set>
5092 <refsection><info><title>Description</title></info>
5094 <para>This <literal>attribute set</literal> is applied to the
5095 <literal>fo:basic-link</literal> element of an olink. It is not applied to the
5096 optional page number or optional title of the external
5102 <refentry version="5.0" id="olink.lang.fallback.sequence">
5104 <refentrytitle>olink.lang.fallback.sequence</refentrytitle>
5105 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
5108 <refname>olink.lang.fallback.sequence</refname>
5109 <refpurpose>look up translated documents if olink not found?</refpurpose>
5112 <refsynopsisdiv> <programlisting id="olink.lang.fallback.sequence.frag">
5113 <xsl:param name="olink.lang.fallback.sequence"></xsl:param>
5116 <refsection><info><title>Description</title></info>
5119 <para>This parameter defines a list of lang values
5120 to search among to resolve olinks.
5123 <para>Normally an olink tries to resolve to a document in the same
5124 language as the olink itself. The language of an olink
5125 is determined by its nearest ancestor element with a
5126 <tag class="attribute">lang</tag> attribute, otherwise the
5127 value of the <parameter>l10n.gentext.default.lang</parameter>
5131 <para>An olink database can contain target data for the same
5132 document in multiple languages. Each set of data has the
5133 same value for the <tag>targetdoc</tag> attribute in
5134 the <tag>document</tag> element in the database, but with a
5135 different <tag>lang</tag> attribute value.
5138 <para>When an olink is being resolved, the target is first
5139 sought in the document with the same language as the olink.
5140 If no match is found there, then this parameter is consulted
5141 for additional languages to try.</para>
5143 <para>The <parameter>olink.lang.fallback.sequence</parameter>
5144 must be a whitespace separated list of lang values to
5145 try. The first one with a match in the olink database is used.
5146 The default value is empty.</para>
5148 <para>For example, a document might be written in German
5149 and contain an olink with
5150 <literal>targetdoc="adminguide"</literal>.
5151 When the document is processed, the processor
5152 first looks for a target dataset in the
5153 olink database starting with:</para>
5155 <literallayout><literal><document targetdoc="adminguide" lang="de"></literal>.
5158 <para>If there is no such element, then the
5159 <parameter>olink.lang.fallback.sequence</parameter>
5160 parameter is consulted.
5161 If its value is, for example, <quote>fr en</quote>, then the processor next
5162 looks for <literal>targetdoc="adminguide" lang="fr"</literal>, and
5163 then for <literal>targetdoc="adminguide" lang="en"</literal>.
5164 If there is still no match, it looks for
5165 <literal>targetdoc="adminguide"</literal> with no
5169 <para>This parameter is useful when a set of documents is only
5170 partially translated, or is in the process of being translated.
5171 If a target of an olink has not yet been translated, then this
5172 parameter permits the processor to look for the document in
5173 other languages. This assumes the reader would rather have
5174 a link to a document in a different language than to have
5181 <refentry version="5.0" id="insert.olink.page.number">
5183 <refentrytitle>insert.olink.page.number</refentrytitle>
5184 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
5185 <refmiscinfo class="other" otherclass="value">no</refmiscinfo>
5186 <refmiscinfo class="other" otherclass="value">yes</refmiscinfo>
5187 <refmiscinfo class="other" otherclass="value">maybe</refmiscinfo>
5190 <refname>insert.olink.page.number</refname>
5191 <refpurpose>Turns page numbers in olinks on and off</refpurpose>
5195 <programlisting id="insert.olink.page.number.frag">
5196 <xsl:param name="insert.olink.page.number">no</xsl:param>
5200 <refsection><info><title>Description</title></info>
5202 <para>The value of this parameter determines if
5203 cross references made between documents with
5204 <tag>olink</tag> will
5205 include page number citations.
5206 In most cases this is only applicable to references in printed output.
5208 <para>The parameter has three possible values.
5213 <listitem><para>No page number references will be generated for olinks.
5218 <listitem><para>Page number references will be generated
5219 for all <tag>olink</tag> references.
5220 The style of page reference may be changed
5221 if an <tag class="attribute">xrefstyle</tag>
5227 <listitem><para>Page number references will not be generated
5228 for an <tag>olink</tag> element unless
5230 <tag class="attribute">xrefstyle</tag>
5231 attribute whose value specifies a page reference.
5235 <para>Olinks that point to targets within the same document
5236 are treated as <tag>xref</tag>s, and controlled by
5237 the <parameter>insert.xref.page.number</parameter> parameter.
5240 <para>Page number references for olinks to
5241 external documents can only be inserted if the
5242 information exists in the olink database.
5243 This means each olink target element
5244 (<tag>div</tag> or <tag>obj</tag>)
5245 must have a <tag class="attribute">page</tag> attribute
5246 whose value is its page number in the target document.
5247 The XSL stylesheets are not able to extract that information
5248 during processing because pages have not yet been created in
5249 XSLT transformation. Only the XSL-FO processor knows what
5250 page each element is placed on.
5251 Therefore some postprocessing must take place to populate
5252 page numbers in the olink database.
5260 <refentry version="5.0" id="insert.olink.pdf.frag">
5262 <refentrytitle>insert.olink.pdf.frag</refentrytitle>
5263 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
5266 <refname>insert.olink.pdf.frag</refname>
5267 <refpurpose>Add fragment identifiers for links into PDF files</refpurpose>
5271 <programlisting id="insert.olink.pdf.frag.frag">
5272 <xsl:param name="insert.olink.pdf.frag" select="0"></xsl:param>
5276 <refsection><info><title>Description</title></info>
5278 <para>The value of this parameter determines whether
5279 the cross reference URIs to PDF documents made with
5280 <tag>olink</tag> will
5281 include fragment identifiers.
5284 <para>When forming a URI to link to a PDF document,
5285 a fragment identifier (typically a '#' followed by an
5286 id value) appended to the PDF filename can be used by
5287 the PDF viewer to open
5288 the PDF file to a location within the document instead of
5290 However, not all PDF files have id
5291 values embedded in them, and not all PDF viewers can
5292 handle fragment identifiers.
5295 <para>If <parameter>insert.olink.pdf.frag</parameter> is set
5296 to a non-zero value, then any olink targeting a
5297 PDF file will have the fragment identifier appended to the URI.
5298 The URI is formed by concatenating the value of the
5299 <parameter>olink.base.uri</parameter> parameter, the
5300 value of the <tag class="attribute">baseuri</tag>
5301 attribute from the <tag class="element">document</tag>
5302 element in the olink database with the matching
5303 <tag class="attribute">targetdoc</tag> value,
5304 and the value of the <tag class="attribute">href</tag>
5305 attribute for the targeted element in the olink database.
5306 The <tag class="attribute">href</tag> attribute
5307 contains the fragment identifier.
5310 <para>If <parameter>insert.olink.pdf.frag</parameter> is set
5311 to zero (the default value), then
5312 the <tag class="attribute">href</tag> attribute
5313 from the olink database
5314 is not appended to PDF olinks, so the fragment identifier is left off.
5315 A PDF olink is any olink for which the
5316 <tag class="attribute">baseuri</tag> attribute
5317 from the matching <tag class="element">document</tag>
5318 element in the olink database ends with '.pdf'.
5319 Any other olinks will still have the fragment identifier added.
5324 <refentry version="5.0" id="prefer.internal.olink">
5326 <refentrytitle>prefer.internal.olink</refentrytitle>
5327 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
5330 <refname>prefer.internal.olink</refname>
5331 <refpurpose>Prefer a local olink reference to an external reference</refpurpose>
5335 <programlisting id="prefer.internal.olink.frag">
5336 <xsl:param name="prefer.internal.olink" select="0"></xsl:param>
5340 <refsection><info><title>Description</title></info>
5342 <para>If you are re-using XML content modules in multiple documents,
5343 you may want to redirect some of your olinks. This parameter
5344 permits you to redirect an olink to the current document.
5347 <para>For example: you are writing documentation for a product,
5348 which includes 3 manuals: a little installation
5349 booklet (booklet.xml), a user
5350 guide (user.xml), and a reference manual (reference.xml).
5351 All 3 documents begin with the same introduction section (intro.xml) that
5352 contains a reference to the customization section (custom.xml) which is
5353 included in both user.xml and reference.xml documents.
5356 <para>How do you write the link to custom.xml in intro.xml
5357 so that it is interpreted correctly in all 3 documents?</para>
5359 <listitem><para>If you use xref, it will fail in booklet.xml.</para>
5361 <listitem><para>If you use olink (pointing to reference.xml),
5362 the reference in user.xml
5363 will point to the customization section of the reference manual, while it is
5364 actually available in user.xml.</para>
5368 <para>If you set the <parameter>prefer.internal.olink</parameter>
5369 parameter to a non-zero value, then the processor will
5370 first look in the olink database
5371 for the olink's <tag>targetptr</tag> attribute value
5372 in document matching the <parameter>current.docid</parameter>
5373 parameter value. If it isn't found there, then
5374 it tries the document in the database
5375 with the <tag>targetdoc</tag>
5376 value that matches the olink's <tag>targetdoc</tag>
5380 <para>This feature permits an olink reference to resolve to
5381 the current document if there is an element
5382 with an id matching the olink's <tag>targetptr</tag>
5383 value. The current document's olink data must be
5384 included in the target database for this to work.</para>
5387 <para>There is a potential for incorrect links if
5388 the same <tag>id</tag> attribute value is used for different
5389 content in different documents.
5390 Some of your olinks may be redirected to the current document
5391 when they shouldn't be. It is not possible to control
5392 individual olink instances.</para>
5398 <refentry version="5.0" id="link.mailto.url">
5400 <refentrytitle>link.mailto.url</refentrytitle>
5401 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
5404 <refname>link.mailto.url</refname>
5405 <refpurpose>Mailto URL for the LINK REL=made HTML HEAD element</refpurpose>
5409 <programlisting id="link.mailto.url.frag">
5410 <xsl:param name="link.mailto.url"></xsl:param>
5414 <refsection><info><title>Description</title></info>
5416 <para>If not the empty string, this address will be used for the
5417 rel=made <literal>link</literal> element in the html <literal>head</literal>
5423 <refentry version="5.0" id="ulink.target">
5425 <refentrytitle>ulink.target</refentrytitle>
5426 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
5429 <refname>ulink.target</refname>
5430 <refpurpose>The HTML anchor target for ULinks</refpurpose>
5434 <programlisting id="ulink.target.frag">
5435 <xsl:param name="ulink.target">_top</xsl:param>
5439 <refsection><info><title>Description</title></info>
5441 <para>If <parameter>ulink.target</parameter> is non-zero, its value will
5442 be used for the <literal>target</literal> attribute
5443 on anchors generated for <tag>ulink</tag>s.</para>
5448 </reference><reference id="xrefs" xml:base="../html/param.xml"><title>Cross References</title>
5449 <refentry version="5.0" id="collect.xref.targets">
5451 <refentrytitle>collect.xref.targets</refentrytitle>
5452 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
5453 <refmiscinfo class="other" otherclass="value">no</refmiscinfo>
5454 <refmiscinfo class="other" otherclass="value">yes</refmiscinfo>
5455 <refmiscinfo class="other" otherclass="value">only</refmiscinfo>
5458 <refname>collect.xref.targets</refname>
5459 <refpurpose>Controls whether cross reference data is
5460 collected</refpurpose>
5462 <refsynopsisdiv> <programlisting id="collect.xref.targets.frag">
5463 <xsl:param name="collect.xref.targets">no</xsl:param>
5466 <refsection><info><title>Description</title></info>
5469 In order to resolve olinks efficiently, the stylesheets can
5470 generate an external data file containing information about
5471 all potential cross reference endpoints in a document.
5472 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.
5473 See also <parameter>targets.filename</parameter>.
5478 <refentry version="5.0" id="insert.xref.page.number">
5480 <refentrytitle>insert.xref.page.number</refentrytitle>
5481 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
5482 <refmiscinfo class="other" otherclass="value">no</refmiscinfo>
5483 <refmiscinfo class="other" otherclass="value">yes</refmiscinfo>
5484 <refmiscinfo class="other" otherclass="value">maybe</refmiscinfo>
5487 <refname>insert.xref.page.number</refname>
5488 <refpurpose>Turns page numbers in xrefs on and off</refpurpose>
5492 <programlisting id="insert.xref.page.number.frag">
5493 <xsl:param name="insert.xref.page.number">no</xsl:param>
5497 <refsection><info><title>Description</title></info>
5499 <para>The value of this parameter determines if
5500 cross references (<tag>xref</tag>s) in
5502 include page number citations.
5503 It has three possible values.
5508 <listitem><para>No page number references will be generated.
5513 <listitem><para>Page number references will be generated
5514 for all <tag>xref</tag> elements.
5515 The style of page reference may be changed
5516 if an <tag class="attribute">xrefstyle</tag>
5522 <listitem><para>Page number references will not be generated
5523 for an <tag>xref</tag> element unless
5525 <tag class="attribute">xrefstyle</tag>
5526 attribute whose value specifies a page reference.
5534 <refentry version="5.0" id="insert.xref.page.number.para">
5536 <refentrytitle>insert.xref.page.number.para</refentrytitle>
5537 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
5538 <refmiscinfo class="other" otherclass="value">yes</refmiscinfo>
5539 <refmiscinfo class="other" otherclass="value">maybe</refmiscinfo>
5542 <refname>insert.xref.page.number.para</refname>
5543 <refpurpose>Turns page numbers in xrefs to paragraphs on and off</refpurpose>
5547 <programlisting id="insert.xref.page.number.para.frag">
5548 <xsl:param name="insert.xref.page.number.para">yes</xsl:param>
5552 <refsection><info><title>Description</title></info>
5554 <para>The value of this parameter determines if
5555 cross references (<tag>xref</tag>s) to paragraphs in
5556 printed output will include page number citations.
5558 <para>Historically, cross references to paragraphs
5559 included page number citations unconditionally, regardless
5560 of the <parameter>insert.xref.page.number</parameter>
5565 <listitem><para>Page number references will be generated
5566 for paragraphs.</para></listitem>
5570 <listitem><para>Whether page number references are generated
5571 for an <tag>xref</tag> element referring to a paragraph will
5572 be controlled by the <parameter>insert.xref.page.number</parameter>
5573 rules.</para></listitem>
5581 <refentry version="5.0" id="use.role.as.xrefstyle">
5583 <refentrytitle>use.role.as.xrefstyle</refentrytitle>
5584 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
5587 <refname>use.role.as.xrefstyle</refname>
5588 <refpurpose>Use <tag class="attribute">role</tag> attribute for
5589 <tag class="attribute">xrefstyle</tag> on <tag>xref</tag>?</refpurpose>
5593 <programlisting id="use.role.as.xrefstyle.frag">
5594 <xsl:param name="use.role.as.xrefstyle" select="1"></xsl:param>
5598 <refsection><info><title>Description</title></info>
5600 <para>In DocBook documents that conform to a schema older than V4.3, this parameter allows
5601 <tag class="attribute">role</tag> to serve the purpose of specifying the cross reference style.</para>
5603 <para>If non-zero, the <tag class="attribute">role</tag> attribute on
5604 <tag>xref</tag> will be used to select the cross reference style.
5605 In DocBook V4.3, the <tag class="attribute">xrefstyle</tag> attribute was added for this purpose.
5606 If the <tag class="attribute">xrefstyle</tag> attribute is present,
5607 <tag class="attribute">role</tag> will be ignored, regardless of the setting
5608 of this parameter.</para>
5612 <refsection><info><title>Example</title></info>
5614 <para>The following small stylesheet shows how to configure the
5615 stylesheets to make use of the cross reference style:</para>
5617 <programlisting><?xml version="1.0"?>
5618 <xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
5621 <xsl:import href="../xsl/html/docbook.xsl"/>
5623 <xsl:output method="html"/>
5625 <xsl:param name="local.l10n.xml" select="document('')"/>
5626 <l:i18n xmlns:l="http://docbook.sourceforge.net/xmlns/l10n/1.0">
5627 <l:l10n xmlns:l="http://docbook.sourceforge.net/xmlns/l10n/1.0" language="en">
5628 <l:context name="xref">
5629 <l:template name="chapter" style="title" text="Chapter %n, %t"/>
5630 <l:template name="chapter" text="Chapter %n"/>
5635 </xsl:stylesheet></programlisting>
5637 <para>With this stylesheet, the cross references in the following document:</para>
5639 <programlisting><?xml version="1.0" encoding="utf-8"?>
5640 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
5641 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
5642 <book id="book"><title>Book</title>
5645 <title>Preface</title>
5647 <para>Normal: <xref linkend="ch1"/>.</para>
5648 <para>Title: <xref xrefstyle="title" linkend="ch1"/>.</para>
5652 <chapter id="ch1">
5653 <title>First Chapter</title>
5655 <para>Irrelevant.</para>
5658 </book></programlisting>
5660 <para>will appear as:</para>
5663 <para>Normal: Chapter 1.</para>
5664 <para>Title: Chapter 1, <emphasis>First Chapter</emphasis>.</para>
5670 <refentry version="5.0" id="xref.with.number.and.title">
5672 <refentrytitle>xref.with.number.and.title</refentrytitle>
5673 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
5676 <refname>xref.with.number.and.title</refname>
5677 <refpurpose>Use number and title in cross references</refpurpose>
5681 <programlisting id="xref.with.number.and.title.frag">
5682 <xsl:param name="xref.with.number.and.title" select="1"></xsl:param>
5686 <refsection><info><title>Description</title></info>
5688 <para>A cross reference may include the number (for example, the number of
5689 an example or figure) and the <tag>title</tag> which is a required child of some
5690 targets. This parameter inserts both the relevant number as well as
5691 the title into the link. </para>
5696 <refentry version="5.0" id="xref.label-page.separator">
5698 <refentrytitle>xref.label-page.separator</refentrytitle>
5699 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
5702 <refname>xref.label-page.separator</refname>
5703 <refpurpose>Punctuation or space separating label from page number in xref</refpurpose>
5707 <programlisting id="xref.label-page.separator.frag"><xsl:param name="xref.label-page.separator"><xsl:text> </xsl:text></xsl:param></programlisting>
5710 <refsection><info><title>Description</title></info>
5713 This parameter allows you to control the punctuation of certain
5714 types of generated cross reference text.
5715 When cross reference text is generated for an
5716 <tag class="element">xref</tag> or
5717 <tag class="element">olink</tag> element
5718 using an <tag class="attribute">xrefstyle</tag> attribute
5719 that makes use of the <literal>select:</literal> feature,
5720 and the selected components include both label and page
5722 then the value of this parameter is inserted between
5723 label and page number in the output.
5724 If a title is included, then other separators are used.
5730 <refentry version="5.0" id="xref.label-title.separator">
5732 <refentrytitle>xref.label-title.separator</refentrytitle>
5733 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
5736 <refname>xref.label-title.separator</refname>
5737 <refpurpose>Punctuation or space separating label from title in xref</refpurpose>
5741 <programlisting id="xref.label-title.separator.frag"><xsl:param name="xref.label-title.separator">: </xsl:param></programlisting>
5744 <refsection><info><title>Description</title></info>
5747 This parameter allows you to control the punctuation of certain
5748 types of generated cross reference text.
5749 When cross reference text is generated for an
5750 <tag class="element">xref</tag> or
5751 <tag class="element">olink</tag> element
5752 using an <tag class="attribute">xrefstyle</tag> attribute
5753 that makes use of the <literal>select:</literal> feature,
5754 and the selected components include both label and title,
5755 then the value of this parameter is inserted between
5756 label and title in the output.
5762 <refentry version="5.0" id="xref.title-page.separator">
5764 <refentrytitle>xref.title-page.separator</refentrytitle>
5765 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
5768 <refname>xref.title-page.separator</refname>
5769 <refpurpose>Punctuation or space separating title from page number in xref</refpurpose>
5773 <programlisting id="xref.title-page.separator.frag"><xsl:param name="xref.title-page.separator"><xsl:text> </xsl:text></xsl:param></programlisting>
5776 <refsection><info><title>Description</title></info>
5779 This parameter allows you to control the punctuation of certain
5780 types of generated cross reference text.
5781 When cross reference text is generated for an
5782 <tag class="element">xref</tag> or
5783 <tag class="element">olink</tag> element
5784 using an <tag class="attribute">xrefstyle</tag> attribute
5785 that makes use of the <literal>select:</literal> feature,
5786 and the selected components include both title and page number,
5787 then the value of this parameter is inserted between
5788 title and page number in the output.
5794 </reference><reference id="lists" xml:base="../html/param.xml"><title>Lists</title>
5795 <refentry version="5.0" id="segmentedlist.as.table">
5797 <refentrytitle>segmentedlist.as.table</refentrytitle>
5798 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
5801 <refname>segmentedlist.as.table</refname>
5802 <refpurpose>Format segmented lists as tables?</refpurpose>
5806 <programlisting id="segmentedlist.as.table.frag">
5807 <xsl:param name="segmentedlist.as.table" select="0"></xsl:param>
5811 <refsection><info><title>Description</title></info>
5813 <para>If non-zero, <tag>segmentedlist</tag>s will be formatted as
5819 <refentry version="5.0" id="variablelist.as.table">
5821 <refentrytitle>variablelist.as.table</refentrytitle>
5822 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
5825 <refname>variablelist.as.table</refname>
5826 <refpurpose>Format <tag>variablelist</tag>s as tables?</refpurpose>
5830 <programlisting id="variablelist.as.table.frag">
5831 <xsl:param name="variablelist.as.table" select="0"></xsl:param>
5835 <refsection><info><title>Description</title></info>
5837 <para>If non-zero, <tag>variablelist</tag>s will be formatted as
5838 tables. A processing instruction exists to specify a particular width for the
5839 column containing the <tag>term</tag>s:
5840 <tag class="xmlpi">dbhtml term-width=".25in"</tag></para>
5842 <para>You can override this setting with a processing instruction as the
5843 child of <tag>variablelist</tag>: <tag class="xmlpi">dbhtml
5844 list-presentation="table"</tag> or <tag class="xmlpi">dbhtml
5845 list-presentation="list"</tag>.</para>
5847 <para>This parameter only applies to the HTML transformations. In the
5848 FO case, proper list markup is robust enough to handle the formatting.
5849 But see also <parameter>variablelist.as.blocks</parameter>.</para>
5851 <programlisting> <variablelist>
5852 <?dbhtml list-presentation="table"?>
5853 <?dbhtml term-width="1.5in"?>
5854 <?dbfo list-presentation="list"?>
5855 <?dbfo term-width="1in"?>
5856 <varlistentry>
5857 <term>list</term>
5860 Formatted as a table even if variablelist.as.table is set to 0.
5863 </varlistentry>
5864 </variablelist></programlisting>
5869 <refentry version="5.0" id="variablelist.term.separator">
5871 <refentrytitle>variablelist.term.separator</refentrytitle>
5872 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
5875 <refname>variablelist.term.separator</refname>
5876 <refpurpose>Text to separate <tag>term</tag>s within a multi-term
5877 <tag>varlistentry</tag></refpurpose>
5881 <programlisting id="variablelist.term.separator.frag">
5882 <xsl:param name="variablelist.term.separator">, </xsl:param></programlisting>
5885 <refsection><info><title>Description</title></info>
5887 <para>When a <tag>varlistentry</tag> contains multiple <tag>term</tag>
5888 elements, the string specified in the value of the
5889 <parameter>variablelist.term.separator</parameter> parameter is placed
5890 after each <tag>term</tag> except the last.</para>
5893 <para>To generate a line break between multiple <tag>term</tag>s in
5894 a <tag>varlistentry</tag>, set a non-zero value for the
5895 <parameter>variablelist.term.break.after</parameter> parameter. If
5896 you do so, you may also want to set the value of the
5897 <parameter>variablelist.term.separator</parameter> parameter to an
5898 empty string (to suppress rendering of the default comma and space
5899 after each <tag>term</tag>).</para>
5905 <refentry version="5.0" id="variablelist.term.break.after">
5907 <refentrytitle>variablelist.term.break.after</refentrytitle>
5908 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
5911 <refname>variablelist.term.break.after</refname>
5912 <refpurpose>Generate line break after each <tag>term</tag> within a
5913 multi-term <tag>varlistentry</tag>?</refpurpose>
5917 <programlisting id="variablelist.term.break.after.frag">
5918 <xsl:param name="variablelist.term.break.after">0</xsl:param></programlisting>
5921 <refsection><info><title>Description</title></info>
5923 <para>Set a non-zero value for the
5924 <parameter>variablelist.term.break.after</parameter> parameter to
5925 generate a line break between <tag>term</tag>s in a
5926 multi-term <tag>varlistentry</tag>.</para>
5929 <para>If you set a non-zero value for
5930 <parameter>variablelist.term.break.after</parameter>, you may also
5931 want to set the value of the
5932 <parameter>variablelist.term.separator</parameter> parameter to an
5933 empty string (to suppress rendering of the default comma and space
5934 after each <tag>term</tag>).</para>
5940 </reference><reference id="biblio" xml:base="../html/param.xml"><title>Bibliography</title>
5941 <refentry version="5.0" id="bibliography.style">
5943 <refentrytitle>bibliography.style</refentrytitle>
5944 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
5945 <refmiscinfo class="other" otherclass="value">normal</refmiscinfo>
5946 <refmiscinfo class="other" otherclass="value">iso690</refmiscinfo>
5949 <refname>bibliography.style</refname>
5950 <refpurpose>Style used for formatting of biblioentries.</refpurpose>
5954 <programlisting id="bibliography.style.frag">
5955 <xsl:param name="bibliography.style">normal</xsl:param>
5959 <refsection><info><title>Description</title></info>
5961 <para>Currently only <literal>normal</literal> and
5962 <literal>iso690</literal> styles are supported.</para>
5964 <para>In order to use ISO690 style to the full extent you might need
5965 to use additional markup described on <link xlink:href="http://wiki.docbook.org/topic/ISO690Bibliography">the
5966 following WiKi page</link>.</para>
5971 <refentry version="5.0" id="biblioentry.item.separator">
5973 <refentrytitle>biblioentry.item.separator</refentrytitle>
5974 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
5977 <refname>biblioentry.item.separator</refname>
5978 <refpurpose>Text to separate bibliography entries</refpurpose>
5982 <programlisting id="biblioentry.item.separator.frag"><xsl:param name="biblioentry.item.separator">. </xsl:param></programlisting>
5985 <refsection><info><title>Description</title></info>
5987 <para>Text to separate bibliography entries
5993 <refentry version="5.0" id="bibliography.collection">
5995 <refentrytitle>bibliography.collection</refentrytitle>
5996 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
5999 <refname>bibliography.collection</refname>
6000 <refpurpose>Name of the bibliography collection file</refpurpose>
6004 <programlisting id="bibliography.collection.frag">
6005 <xsl:param name="bibliography.collection">http://cdn.docbook.org/release/xsl/bibliography/bibliography.xml</xsl:param>
6010 <refsection><info><title>Description</title></info>
6012 <para>Maintaining bibliography entries across a set of documents is tedious, time
6013 consuming, and error prone. It makes much more sense, usually, to store all of
6014 the bibliography entries in a single place and simply <quote>extract</quote>
6015 the ones you need in each document.</para>
6017 <para>That's the purpose of the
6018 <parameter>bibliography.collection</parameter> parameter. To setup a global
6019 bibliography <quote>database</quote>, follow these steps:</para>
6021 <para>First, create a stand-alone bibliography document that contains all of
6022 the documents that you wish to reference. Make sure that each bibliography
6023 entry (whether you use <tag>biblioentry</tag> or <tag>bibliomixed</tag>)
6026 <para>My global bibliography, <filename>~/bibliography.xml</filename> begins
6030 <programlisting><!DOCTYPE bibliography
6031 PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
6032 "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
6033 <bibliography><title>References</title>
6035 <bibliomixed id="xml-rec"><abbrev>XML 1.0</abbrev>Tim Bray,
6036 Jean Paoli, C. M. Sperberg-McQueen, and Eve Maler, editors.
6037 <citetitle><ulink url="http://www.w3.org/TR/REC-xml">Extensible Markup
6038 Language (XML) 1.0 Second Edition</ulink></citetitle>.
6039 World Wide Web Consortium, 2000.
6040 </bibliomixed>
6042 <bibliomixed id="xml-names"><abbrev>Namespaces</abbrev>Tim Bray,
6044 and Andrew Layman, editors.
6045 <citetitle><ulink url="http://www.w3.org/TR/REC-xml-names/">Namespaces in
6046 XML</ulink></citetitle>.
6047 World Wide Web Consortium, 1999.
6048 </bibliomixed>
6051 </bibliography>
6055 <para>When you create a bibliography in your document, simply
6056 provide <emphasis>empty</emphasis> <tag>bibliomixed</tag>
6057 entries for each document that you wish to cite. Make sure that these
6058 elements have the same ID as the corresponding <quote>real</quote>
6059 entry in your global bibliography.</para>
6061 <para>For example:</para>
6064 <programlisting><bibliography><title>Bibliography</title>
6066 <bibliomixed id="xml-rec"/>
6067 <bibliomixed id="xml-names"/>
6068 <bibliomixed id="DKnuth86">Donald E. Knuth. <citetitle>Computers and
6069 Typesetting: Volume B, TeX: The Program</citetitle>. Addison-Wesley,
6070 1986. ISBN 0-201-13437-3.
6071 </bibliomixed>
6072 <bibliomixed id="relaxng"/>
6074 </bibliography></programlisting>
6077 <para>Note that it's perfectly acceptable to mix entries from your
6078 global bibliography with <quote>normal</quote> entries. You can use
6079 <tag>xref</tag> or other elements to cross-reference your
6080 bibliography entries in exactly the same way you do now.</para>
6082 <para>Finally, when you are ready to format your document, simply set the
6083 <parameter>bibliography.collection</parameter> parameter (in either a
6084 customization layer or directly through your processor's interface) to
6085 point to your global bibliography.</para>
6087 <para>A relative path in the parameter is interpreted in one
6089 <orderedlist numeration="loweralpha">
6091 <para>If your document contains no links to empty bibliographic elements,
6092 then the path is relative to the file containing
6093 the first <tag>bibliomixed</tag> element in the document.</para>
6096 <para>If your document does contain links to empty bibliographic elements,
6097 then the path is relative to the file containing
6098 the first such link element in the document.</para>
6101 <para>Once the collection file is opened by the first instance described
6102 above, it stays open for the current document
6103 and the relative path is not reinterpreted again.</para>
6105 <para>The stylesheets will format the bibliography in your document as if
6106 all of the entries referenced appeared there literally.</para>
6111 <refentry version="5.0" id="bibliography.numbered">
6113 <refentrytitle>bibliography.numbered</refentrytitle>
6114 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
6117 <refname>bibliography.numbered</refname>
6118 <refpurpose>Should bibliography entries be numbered?</refpurpose>
6122 <programlisting id="bibliography.numbered.frag">
6123 <xsl:param name="bibliography.numbered" select="0"></xsl:param>
6127 <refsection><info><title>Description</title></info>
6129 <para>If non-zero bibliography entries will be numbered</para>
6134 </reference><reference id="glossary" xml:base="../html/param.xml"><title>Glossary</title>
6135 <refentry version="5.0" id="glossterm.auto.link">
6137 <refentrytitle>glossterm.auto.link</refentrytitle>
6138 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
6141 <refname>glossterm.auto.link</refname>
6142 <refpurpose>Generate links from glossterm to glossentry automatically?</refpurpose>
6146 <programlisting id="glossterm.auto.link.frag">
6147 <xsl:param name="glossterm.auto.link" select="0"></xsl:param>
6151 <refsection><info><title>Description</title></info>
6153 <para>If non-zero, links from inline <tag>glossterm</tag>s to the corresponding
6154 <tag>glossentry</tag> elements in a <tag>glossary</tag> or <tag>glosslist</tag>
6155 will be automatically generated. This is useful when your glossterms are consistent
6156 and you don't want to add links manually.</para>
6158 <para>The automatic link generation feature is not used on <tag>glossterm</tag> elements
6159 that have a <tag class="attribute">linkend</tag> attribute.</para>
6164 <refentry version="5.0" id="firstterm.only.link">
6166 <refentrytitle>firstterm.only.link</refentrytitle>
6167 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
6170 <refname>firstterm.only.link</refname>
6171 <refpurpose>Does automatic glossterm linking only apply to firstterms?</refpurpose>
6175 <programlisting id="firstterm.only.link.frag">
6176 <xsl:param name="firstterm.only.link" select="0"></xsl:param>
6180 <refsection><info><title>Description</title></info>
6182 <para>If non-zero, only <tag>firstterm</tag>s will be automatically linked
6183 to the glossary. If glossary linking is not enabled, this parameter
6184 has no effect.</para>
6189 <refentry version="5.0" id="glossary.collection">
6191 <refentrytitle>glossary.collection</refentrytitle>
6192 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
6195 <refname>glossary.collection</refname>
6196 <refpurpose>Name of the glossary collection file</refpurpose>
6200 <programlisting id="glossary.collection.frag">
6201 <xsl:param name="glossary.collection"></xsl:param>
6205 <refsection><info><title>Description</title></info>
6207 <para>Glossaries maintained independently across a set of documents
6208 are likely to become inconsistent unless considerable effort is
6209 expended to keep them in sync. It makes much more sense, usually, to
6210 store all of the glossary entries in a single place and simply
6211 <quote>extract</quote> the ones you need in each document.</para>
6213 <para>That's the purpose of the
6214 <parameter>glossary.collection</parameter> parameter. To setup a global
6215 glossary <quote>database</quote>, follow these steps:</para>
6217 <refsection><info><title>Setting Up the Glossary Database</title></info>
6219 <para>First, create a stand-alone glossary document that contains all of
6220 the entries that you wish to reference. Make sure that each glossary
6221 entry has an ID.</para>
6223 <para>Here's an example glossary:</para>
6227 <?xml version="1.0" encoding="utf-8"?>
6228 <!DOCTYPE glossary
6229 PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
6230 "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
6232 <glossaryinfo>
6233 <editor><firstname>Eric</firstname><surname>Raymond</surname></editor>
6234 <title>Jargon File 4.2.3 (abridged)</title>
6235 <releaseinfo>Just some test data</releaseinfo>
6236 </glossaryinfo>
6238 <glossdiv><title>0</title>
6241 <glossterm>0</glossterm>
6243 <para>Numeric zero, as opposed to the letter `O' (the 15th letter of
6244 the English alphabet). In their unmodified forms they look a lot
6245 alike, and various kluges invented to make them visually distinct have
6246 compounded the confusion. If your zero is center-dotted and letter-O
6247 is not, or if letter-O looks almost rectangular but zero looks more
6248 like an American football stood on end (or the reverse), you're
6249 probably looking at a modern character display (though the dotted zero
6250 seems to have originated as an option on IBM 3270 controllers). If
6251 your zero is slashed but letter-O is not, you're probably looking at
6252 an old-style ASCII graphic set descended from the default typewheel on
6253 the venerable ASR-33 Teletype (Scandinavians, for whom /O is a letter,
6254 curse this arrangement). (Interestingly, the slashed zero long
6255 predates computers; Florian Cajori's monumental "A History of
6256 Mathematical Notations" notes that it was used in the twelfth and
6257 thirteenth centuries.) If letter-O has a slash across it and the zero
6258 does not, your display is tuned for a very old convention used at IBM
6259 and a few other early mainframe makers (Scandinavians curse <emphasis>this</emphasis>
6260 arrangement even more, because it means two of their letters collide).
6261 Some Burroughs/Unisys equipment displays a zero with a <emphasis>reversed</emphasis>
6262 slash. Old CDC computers rendered letter O as an unbroken oval and 0
6263 as an oval broken at upper right and lower left. And yet another
6264 convention common on early line printers left zero unornamented but
6265 added a tail or hook to the letter-O so that it resembled an inverted
6266 Q or cursive capital letter-O (this was endorsed by a draft ANSI
6267 standard for how to draw ASCII characters, but the final standard
6268 changed the distinguisher to a tick-mark in the upper-left corner).
6269 Are we sufficiently confused yet?</para>
6274 <glossterm>1TBS</glossterm>
6276 <para role="accidence">
6277 <phrase role="pronounce"></phrase>
6278 <phrase role="partsofspeach">n</phrase>
6280 <para>The "One True Brace Style"</para>
6281 <glossseealso>indent style</glossseealso>
6291 </glossary></programlisting>
6296 <refsection><info><title>Marking Up Glossary Terms</title></info>
6298 <para>That takes care of the glossary database, now you have to get the entries
6299 into your document. Unlike bibliography entries, which can be empty, creating
6300 <quote>placeholder</quote> glossary entries would be very tedious. So instead,
6301 support for <parameter>glossary.collection</parameter> relies on implicit linking.</para>
6303 <para>In your source document, simply use <tag>firstterm</tag> and
6304 <tag>glossterm</tag> to identify the terms you wish to have included
6305 in the glossary. The stylesheets assume that you will either set the
6306 <tag class="attribute">baseform</tag> attribute correctly, or that the
6307 content of the element exactly matches a term in your glossary.</para>
6309 <para>If you're using a <parameter>glossary.collection</parameter>, don't
6310 make explicit links on the terms in your document.</para>
6312 <para>So, in your document, you might write things like this:</para>
6315 <programlisting><para>This is dummy text, without any real meaning.
6316 The point is simply to reference glossary terms like <glossterm>0</glossterm>
6317 and the <firstterm baseform="1TBS">One True Brace Style (1TBS)</firstterm>.
6318 The <glossterm>1TBS</glossterm>, as you can probably imagine, is a nearly
6319 religious issue.</para></programlisting>
6322 <para>If you set the <parameter>firstterm.only.link</parameter> parameter,
6323 only the terms marked with <tag>firstterm</tag> will be links.
6324 Otherwise, all the terms will be linked.</para>
6328 <refsection><info><title>Marking Up the Glossary</title></info>
6330 <para>The glossary itself has to be identified for the stylesheets. For lack
6331 of a better choice, the <tag class="attribute">role</tag> is used.
6332 To identify the glossary as the target for automatic processing, set
6333 the role to <quote><literal>auto</literal></quote>. The title of this
6334 glossary (and any other information from the <tag>glossaryinfo</tag>
6335 that's rendered by your stylesheet) will be displayed, but the entries will
6336 come from the database.
6339 <para>Unfortunately, the glossary can't be empty, so you must put in
6340 at least one <tag>glossentry</tag>. The content of this entry
6341 is irrelevant, it will not be rendered:</para>
6344 <programlisting><glossary role="auto">
6346 <glossterm>Irrelevant</glossterm>
6348 <para>If you can see this, the document was processed incorrectly. Use
6349 the <parameter>glossary.collection</parameter> parameter.</para>
6352 </glossary></programlisting>
6355 <para>What about glossary divisions? If your glossary database has glossary
6356 divisions <emphasis>and</emphasis> your automatic glossary contains at least
6357 one <tag>glossdiv</tag>, the automic glossary will have divisions.
6358 If the <tag>glossdiv</tag> is missing from either location, no divisions
6359 will be rendered.</para>
6361 <para>Glossary entries (and divisions, if appropriate) in the glossary will
6362 occur in precisely the order they occur in your database.</para>
6366 <refsection><info><title>Formatting the Document</title></info>
6368 <para>Finally, when you are ready to format your document, simply set the
6369 <parameter>glossary.collection</parameter> parameter (in either a
6370 customization layer or directly through your processor's interface) to
6371 point to your global glossary.</para>
6373 <para>A relative path in the parameter is interpreted in one
6375 <orderedlist numeration="loweralpha">
6377 <para>If the parameter <literal>glossterm.auto.link</literal>
6378 is set to zero, then the path is relative to the file containing
6379 the empty <tag>glossary</tag> element in the document.</para>
6382 <para>If the parameter <literal>glossterm.auto.link</literal>
6383 is set to non-zero, then the path is relative to the file containing
6384 the first inline <tag>glossterm</tag> or
6385 <tag>firstterm</tag> in the document to be linked.</para>
6388 <para>Once the collection file is opened by the first instance described
6389 above, it stays open for the current document
6390 and the relative path is not reinterpreted again.</para>
6392 <para>The stylesheets will format the glossary in your document as if
6393 all of the entries implicilty referenced appeared there literally.</para>
6396 <refsection><info><title>Limitations</title></info>
6398 <para>Glossary cross-references <emphasis>within the glossary</emphasis> are
6399 not supported. For example, this <emphasis>will not</emphasis> work:</para>
6402 <programlisting><glossentry>
6403 <glossterm>gloss-1</glossterm>
6404 <glossdef><para>A description that references <glossterm>gloss-2</glossterm>.</para>
6405 <glossseealso>gloss-2</glossseealso>
6407 </glossentry></programlisting>
6410 <para>If you put glossary cross-references in your glossary that way,
6411 you'll get the cryptic error: <computeroutput>Warning:
6412 glossary.collection specified, but there are 0 automatic
6413 glossaries</computeroutput>.</para>
6415 <para>Instead, you must do two things:</para>
6419 <para>Markup your glossary using <tag>glossseealso</tag>:</para>
6422 <programlisting><glossentry>
6423 <glossterm>gloss-1</glossterm>
6424 <glossdef><para>A description that references <glossterm>gloss-2</glossterm>.</para>
6425 <glossseealso>gloss-2</glossseealso>
6427 </glossentry></programlisting>
6432 <para>Make sure there is at least one <tag>glossterm</tag> reference to
6433 <glossterm>gloss-2</glossterm> <emphasis>in your document</emphasis>. The
6434 easiest way to do that is probably within a <tag>remark</tag> in your
6435 automatic glossary:</para>
6438 <programlisting><glossary role="auto">
6439 <remark>Make sure there's a reference to <glossterm>gloss-2</glossterm>.</remark>
6441 <glossterm>Irrelevant</glossterm>
6443 <para>If you can see this, the document was processed incorrectly. Use
6444 the <parameter>glossary.collection</parameter> parameter.</para>
6447 </glossary></programlisting>
6456 <refentry version="5.0" id="glossary.sort">
6458 <refentrytitle>glossary.sort</refentrytitle>
6459 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
6462 <refname>glossary.sort</refname>
6463 <refpurpose>Sort glossentry elements?</refpurpose>
6467 <programlisting id="glossary.sort.frag">
6468 <xsl:param name="glossary.sort" select="0"></xsl:param>
6472 <refsection><info><title>Description</title></info>
6474 <para>If non-zero, then the glossentry elements within a
6475 glossary, glossdiv, or glosslist are sorted on the glossterm, using
6476 the current lang setting. If zero (the default), then
6477 glossentry elements are not sorted and are presented
6484 <refentry version="5.0" id="glossentry.show.acronym">
6486 <refentrytitle>glossentry.show.acronym</refentrytitle>
6487 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
6488 <refmiscinfo class="other" otherclass="value">no</refmiscinfo>
6489 <refmiscinfo class="other" otherclass="value">yes</refmiscinfo>
6490 <refmiscinfo class="other" otherclass="value">primary</refmiscinfo>
6493 <refname>glossentry.show.acronym</refname>
6494 <refpurpose>Display <tag>glossentry</tag> acronyms?</refpurpose>
6498 <programlisting id="glossentry.show.acronym.frag">
6499 <xsl:param name="glossentry.show.acronym">no</xsl:param>
6503 <refsection><info><title>Description</title></info>
6505 <para>A setting of <quote>yes</quote> means they should be displayed;
6506 <quote>no</quote> means they shouldn't. If <quote>primary</quote> is used,
6507 then they are shown as the primary text for the entry.</para>
6510 <para>This setting controls both <tag>acronym</tag> and
6511 <tag>abbrev</tag> elements in the <tag>glossentry</tag>.</para>
6517 </reference><reference id="misc" xml:base="../html/param.xml"><title>Miscellaneous</title>
6518 <refentry version="5.0" id="formal.procedures">
6520 <refentrytitle>formal.procedures</refentrytitle>
6521 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
6524 <refname>formal.procedures</refname>
6525 <refpurpose>Selects formal or informal procedures</refpurpose>
6529 <programlisting id="formal.procedures.frag">
6530 <xsl:param name="formal.procedures" select="1"></xsl:param>
6534 <refsection><info><title>Description</title></info>
6536 <para>Formal procedures are numbered and always have a title.
6542 <refentry version="5.0" id="formal.title.placement">
6544 <refentrytitle>formal.title.placement</refentrytitle>
6545 <refmiscinfo class="other" otherclass="datatype">table</refmiscinfo>
6548 <refname>formal.title.placement</refname>
6549 <refpurpose>Specifies where formal object titles should occur</refpurpose>
6553 <programlisting id="formal.title.placement.frag">
6554 <xsl:param name="formal.title.placement">
6565 <refsection><info><title>Description</title></info>
6567 <para>Specifies where formal object titles should occur. For each formal object
6568 type (<tag>figure</tag>,
6570 <tag>equation</tag>,
6571 <tag>table</tag>, and <tag>procedure</tag>)
6572 you can specify either the keyword
6573 <quote><literal>before</literal></quote> or
6574 <quote><literal>after</literal></quote>.</para>
6579 <refentry version="5.0" id="runinhead.default.title.end.punct">
6581 <refentrytitle>runinhead.default.title.end.punct</refentrytitle>
6582 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
6585 <refname>runinhead.default.title.end.punct</refname>
6586 <refpurpose>Default punctuation character on a run-in-head</refpurpose>
6590 <programlisting id="runinhead.default.title.end.punct.frag"><xsl:param name="runinhead.default.title.end.punct">.</xsl:param>
6594 <refsection><info><title>Description</title></info>
6596 <para>If non-zero, For a <tag>formalpara</tag>, use the specified
6597 string as the separator between the title and following text. The period is the default value.</para>
6602 <refentry version="5.0" id="runinhead.title.end.punct">
6604 <refentrytitle>runinhead.title.end.punct</refentrytitle>
6605 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
6608 <refname>runinhead.title.end.punct</refname>
6609 <refpurpose>Characters that count as punctuation on a run-in-head</refpurpose>
6613 <programlisting id="runinhead.title.end.punct.frag">
6614 <xsl:param name="runinhead.title.end.punct">.!?:</xsl:param>
6618 <refsection><info><title>Description</title></info>
6620 <para>Specify which characters are to be counted as punctuation. These
6621 characters are checked for a match with the last character of the
6622 title. If no match is found, the
6623 <parameter>runinhead.default.title.end.punct</parameter> contents are
6624 inserted. This is to avoid duplicated punctuation in the output.
6630 <refentry version="5.0" id="show.comments">
6632 <refentrytitle>show.comments</refentrytitle>
6633 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
6636 <refname>show.comments</refname>
6637 <refpurpose>Display <tag>remark</tag> elements?</refpurpose>
6641 <programlisting id="show.comments.frag">
6642 <xsl:param name="show.comments" select="1"></xsl:param>
6646 <refsection><info><title>Description</title></info>
6648 <para>If non-zero, comments will be displayed, otherwise they
6649 are suppressed. Comments here refers to the <tag>remark</tag> element
6650 (which was called <literal>comment</literal> prior to DocBook
6651 4.0), not XML comments (<-- like this -->) which are
6658 <refentry version="5.0" id="show.revisionflag">
6660 <refentrytitle>show.revisionflag</refentrytitle>
6661 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
6664 <refname>show.revisionflag</refname>
6665 <refpurpose>Enable decoration of elements that have a revisionflag</refpurpose>
6669 <programlisting id="show.revisionflag.frag">
6670 <xsl:param name="show.revisionflag" select="0"></xsl:param>
6674 <refsection><info><title>Description</title></info>
6677 If <parameter>show.revisionflag</parameter> is turned on, then the stylesheets
6678 may produce additional markup designed to allow a CSS stylesheet to
6679 highlight elements that have specific revisionflag settings.</para>
6681 <para>The markup inserted will be usually be either a <span> or
6682 <div> with an appropriate <literal>class</literal>
6683 attribute. (The value of the class attribute will be the same as the
6684 value of the revisionflag attribute). In some contexts, for example
6685 tables, where extra markup would be structurally illegal, the class
6686 attribute will be added to the appropriate container element.</para>
6688 <para>In general, the stylesheets only test for revisionflag in contexts
6689 where an importing stylesheet would have to redefine whole templates.
6690 Most of the revisionflag processing is expected to be done by another
6691 stylesheet, for example <filename>changebars.xsl</filename>.</para>
6696 <refentry version="5.0" id="shade.verbatim">
6698 <refentrytitle>shade.verbatim</refentrytitle>
6699 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
6702 <refname>shade.verbatim</refname>
6703 <refpurpose>Should verbatim environments be shaded?</refpurpose>
6707 <programlisting id="shade.verbatim.frag"><xsl:param name="shade.verbatim" select="0"></xsl:param></programlisting>
6710 <refsection><info><title>Description</title></info>
6712 <para>In the FO stylesheet, if this parameter is non-zero then the
6713 <property>shade.verbatim.style</property> properties will be applied
6714 to verbatim environments.</para>
6716 <para>In the HTML stylesheet, this parameter is now deprecated. Use
6722 <refentry version="5.0" id="shade.verbatim.style">
6724 <refentrytitle>shade.verbatim.style</refentrytitle>
6725 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
6728 <refname>shade.verbatim.style</refname>
6729 <refpurpose>Properties that specify the style of shaded verbatim listings</refpurpose>
6733 <programlisting id="shade.verbatim.style.frag">
6734 <xsl:attribute-set name="shade.verbatim.style">
6735 <xsl:attribute name="border">0</xsl:attribute>
6736 <xsl:attribute name="bgcolor">#E0E0E0</xsl:attribute>
6737 </xsl:attribute-set>
6742 <refsection><info><title>Description</title></info>
6744 <para>Properties that specify the style of shaded verbatim listings. The
6745 parameters specified (the border and background color) are added to
6746 the styling of the xsl-fo output. A border might be specified as "thin
6747 black solid" for example. See <link xlink:href="http://www.w3.org/TR/2004/WD-xsl11-20041216/#border">xsl-fo</link></para>
6752 <refentry version="5.0" id="punct.honorific">
6754 <refentrytitle>punct.honorific</refentrytitle>
6755 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
6758 <refname>punct.honorific</refname>
6759 <refpurpose>Punctuation after an honorific in a personal name.</refpurpose>
6763 <programlisting id="punct.honorific.frag">
6764 <xsl:param name="punct.honorific">.</xsl:param>
6768 <refsection><info><title>Description</title></info>
6770 <para>This parameter specifies the punctuation that should be added after an
6771 honorific in a personal name.</para>
6776 <refentry version="5.0" id="tex.math.in.alt">
6778 <refentrytitle>tex.math.in.alt</refentrytitle>
6779 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
6780 <refmiscinfo class="other" otherclass="value">plain</refmiscinfo>
6781 <refmiscinfo class="other" otherclass="value">latex</refmiscinfo>
6784 <refname>tex.math.in.alt</refname>
6785 <refpurpose>TeX notation used for equations</refpurpose>
6789 <programlisting id="tex.math.in.alt.frag">
6790 <xsl:param name="tex.math.in.alt"></xsl:param>
6794 <refsection><info><title>Description</title></info>
6796 <para>If you want type math directly in TeX notation in equations,
6797 this parameter specifies notation used. Currently are supported two
6798 values -- <literal>plain</literal> and <literal>latex</literal>. Empty
6799 value means that you are not using TeX math at all.</para>
6801 <para>Preferred way for including TeX alternative of math is inside of
6802 <tag>textobject</tag> element. Eg.:</para>
6804 <programlisting><inlineequation>
6805 <inlinemediaobject>
6807 <imagedata fileref="eq1.gif"/>
6808 </imageobject>
6809 <textobject><phrase>E=mc squared</phrase></textobject>
6810 <textobject role="tex"><phrase>E=mc^2</phrase></textobject>
6811 </inlinemediaobject>
6812 </inlineequation></programlisting>
6814 <para>If you are using <tag>graphic</tag> element, you can
6815 store TeX inside <tag>alt</tag> element:</para>
6817 <programlisting><inlineequation>
6818 <alt role="tex">a^2+b^2=c^2</alt>
6819 <graphic fileref="a2b2c2.gif"/>
6820 </inlineequation></programlisting>
6822 <para>If you want use this feature, you should process your FO with
6823 PassiveTeX, which only supports TeX math notation. When calling
6824 stylsheet, don't forget to specify also
6825 passivetex.extensions=1.</para>
6827 <para>If you want equations in HTML, just process generated file
6828 <filename>tex-math-equations.tex</filename> by TeX or LaTeX. Then run
6829 dvi2bitmap program on result DVI file. You will get images for
6830 equations in your document.</para>
6833 <para>This feature is useful for print/PDF output only if you
6834 use the obsolete and now unsupported PassiveTeX XSL-FO
6840 <refsection><info><title>Related Parameters</title></info>
6841 <para><parameter>tex.math.delims</parameter>,
6842 <parameter>passivetex.extensions</parameter>,
6843 <parameter>tex.math.file</parameter></para>
6848 <refentry version="5.0" id="tex.math.file">
6850 <refentrytitle>tex.math.file</refentrytitle>
6851 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
6854 <refname>tex.math.file</refname>
6855 <refpurpose>Name of temporary file for generating images from equations</refpurpose>
6859 <programlisting id="tex.math.file.frag">
6860 <xsl:param name="tex.math.file">tex-math-equations.tex</xsl:param>
6864 <refsection><info><title>Description</title></info>
6866 <para>Name of auxiliary file for TeX equations. This file can be
6867 processed by dvi2bitmap to get bitmap versions of equations for HTML
6871 <refsection><info><title>Related Parameters</title></info>
6872 <para><parameter>tex.math.in.alt</parameter>,
6873 <parameter>tex.math.delims</parameter>,
6876 <refsection><info><title>More information</title></info>
6877 <para>For how-to documentation on embedding TeX equations and
6878 generating output from them, see
6879 <link role="tcg" xlink:href="TexMath.html">DBTeXMath</link>.</para>
6883 <refentry version="5.0" id="tex.math.delims">
6885 <refentrytitle>tex.math.delims</refentrytitle>
6886 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
6889 <refname>tex.math.delims</refname>
6890 <refpurpose>Should equations output for processing by TeX be
6891 surrounded by math mode delimiters?</refpurpose>
6895 <programlisting id="tex.math.delims.frag">
6896 <xsl:param name="tex.math.delims" select="1"></xsl:param>
6900 <refsection><info><title>Description</title></info>
6902 <para>For compatibility with DSSSL based DBTeXMath from Allin Cottrell
6903 you should set this parameter to 0.</para>
6906 <para>This feature is useful for print/PDF output only if you
6907 use the obsolete and now unsupported PassiveTeX XSL-FO
6912 <refsection><info><title>Related Parameters</title></info>
6913 <para><parameter>tex.math.in.alt</parameter>,
6914 <parameter>passivetex.extensions</parameter></para>
6917 <refsection><info><title>See Also</title></info>
6918 <para>You can also use the <tag class="xmlpi">dbtex delims</tag> processing
6919 instruction to control whether delimiters are output.</para>
6925 <refentry version="5.0" id="pixels.per.inch">
6927 <refentrytitle>pixels.per.inch</refentrytitle>
6928 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
6931 <refname>pixels.per.inch</refname>
6932 <refpurpose>How many pixels are there per inch?</refpurpose>
6936 <programlisting id="pixels.per.inch.frag">
6937 <xsl:param name="pixels.per.inch">90</xsl:param>
6941 <refsection><info><title>Description</title></info>
6943 <para>When lengths are converted to pixels, this value is used to
6944 determine the size of a pixel. The default value is taken from the
6945 <link xlink:href="http://www.w3.org/TR/2004/WD-xsl11-20041216/">XSL
6946 Recommendation</link>.
6952 <refentry version="5.0" id="points.per.em">
6954 <refentrytitle>points.per.em</refentrytitle>
6955 <refmiscinfo class="other" otherclass="datatype">number</refmiscinfo>
6958 <refname>points.per.em</refname>
6959 <refpurpose>Specify the nominal size of an em-space in points</refpurpose>
6963 <programlisting id="points.per.em.frag">
6964 <xsl:param name="points.per.em">10</xsl:param>
6968 <refsection><info><title>Description</title></info>
6970 <para>The fixed value used for calculations based upon the size of a
6971 character. The assumption made is that ten point font is in use. This
6972 assumption may not be valid.</para>
6977 <refentry version="5.0" id="use.svg">
6979 <refentrytitle>use.svg</refentrytitle>
6980 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
6983 <refname>use.svg</refname>
6984 <refpurpose>Allow SVG in the result tree?</refpurpose>
6988 <programlisting id="use.svg.frag">
6989 <xsl:param name="use.svg" select="1"></xsl:param>
6993 <refsection><info><title>Description</title></info>
6995 <para>If non-zero, SVG will be considered an acceptable image format. SVG
6996 is passed through to the result tree, so correct rendering of the resulting
6997 diagram depends on the formatter (FO processor or web browser) that is used
6998 to process the output from the stylesheet.</para>
7003 <refentry version="5.0" id="menuchoice.separator">
7005 <refentrytitle>menuchoice.separator</refentrytitle>
7006 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
7009 <refname>menuchoice.separator</refname>
7010 <refpurpose>Separator between items of a <tag>menuchoice</tag>
7011 other than <tag>guimenuitem</tag> and
7012 <tag>guisubmenu</tag></refpurpose>
7016 <programlisting id="menuchoice.separator.frag">
7017 <xsl:param name="menuchoice.separator">+</xsl:param>
7021 <refsection><info><title>Description</title></info>
7023 <para>Separator used to connect items of a <tag>menuchoice</tag> other
7024 than <tag>guimenuitem</tag> and <tag>guisubmenu</tag>. The latter
7025 elements are linked with <parameter>menuchoice.menu.separator</parameter>.
7031 <refentry version="5.0" id="menuchoice.menu.separator">
7033 <refentrytitle>menuchoice.menu.separator</refentrytitle>
7034 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
7037 <refname>menuchoice.menu.separator</refname>
7038 <refpurpose>Separator between items of a <tag>menuchoice</tag>
7039 with <tag>guimenuitem</tag> or
7040 <tag>guisubmenu</tag></refpurpose>
7044 <programlisting id="menuchoice.menu.separator.frag">
7045 <xsl:param name="menuchoice.menu.separator"> → </xsl:param>
7049 <refsection><info><title>Description</title></info>
7051 <para>Separator used to connect items of a <tag>menuchoice</tag> with
7052 <tag>guimenuitem</tag> or <tag>guisubmenu</tag>. Other elements
7053 are linked with <parameter>menuchoice.separator</parameter>.
7055 <para>The default value is &#x2192;, which is the
7056 &rarr; (right arrow) character entity.
7057 The current FOP (0.20.5) requires setting the font-family
7060 <para>The default value also includes spaces around the arrow,
7061 which will allow a line to break. Replace the spaces with
7062 &#xA0; (nonbreaking space) if you don't want those
7069 <refentry version="5.0" id="default.float.class">
7071 <refentrytitle>default.float.class</refentrytitle>
7072 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
7075 <refname>default.float.class</refname>
7076 <refpurpose>Specifies the default float class</refpurpose>
7080 <programlisting id="default.float.class.frag">
7081 <xsl:param name="default.float.class">
7083 <xsl:when test="contains($stylesheet.result.type,'html')">left</xsl:when>
7084 <xsl:otherwise>before</xsl:otherwise>
7090 <refsection><info><title>Description</title></info>
7092 <para>Selects the direction in which a float should be placed. for
7093 xsl-fo this is before, for html it is left. For Western texts, the
7094 before direction is the top of the page.</para>
7099 <refentry version="5.0" id="footnote.number.format">
7101 <refentrytitle>footnote.number.format</refentrytitle>
7102 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
7103 <refmiscinfo class="other" otherclass="value">1<alt>1,2,3...</alt></refmiscinfo>
7104 <refmiscinfo class="other" otherclass="value">A<alt>A,B,C...</alt></refmiscinfo>
7105 <refmiscinfo class="other" otherclass="value">a<alt>a,b,c...</alt></refmiscinfo>
7106 <refmiscinfo class="other" otherclass="value">i<alt>i,ii,iii...</alt></refmiscinfo>
7107 <refmiscinfo class="other" otherclass="value">I<alt>I,II,III...</alt></refmiscinfo>
7110 <refname>footnote.number.format</refname>
7111 <refpurpose>Identifies the format used for footnote numbers</refpurpose>
7115 <programlisting id="footnote.number.format.frag">
7116 <xsl:param name="footnote.number.format">1</xsl:param>
7120 <refsection><info><title>Description</title></info>
7122 <para>The <parameter>footnote.number.format</parameter> specifies the format
7123 to use for footnote numeration (1, i, I, a, or A).</para>
7128 <refentry version="5.0" id="table.footnote.number.format">
7130 <refentrytitle>table.footnote.number.format</refentrytitle>
7131 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
7132 <refmiscinfo class="other" otherclass="value">1<alt>1,2,3...</alt></refmiscinfo>
7133 <refmiscinfo class="other" otherclass="value">A<alt>A,B,C...</alt></refmiscinfo>
7134 <refmiscinfo class="other" otherclass="value">a<alt>a,b,c...</alt></refmiscinfo>
7135 <refmiscinfo class="other" otherclass="value">i<alt>i,ii,iii...</alt></refmiscinfo>
7136 <refmiscinfo class="other" otherclass="value">I<alt>I,II,III...</alt></refmiscinfo>
7139 <refname>table.footnote.number.format</refname>
7140 <refpurpose>Identifies the format used for footnote numbers in tables</refpurpose>
7144 <programlisting id="table.footnote.number.format.frag">
7145 <xsl:param name="table.footnote.number.format">a</xsl:param>
7149 <refsection><info><title>Description</title></info>
7151 <para>The <parameter>table.footnote.number.format</parameter> specifies the format
7152 to use for footnote numeration (1, i, I, a, or A) in tables.</para>
7157 <refentry version="5.0" id="footnote.number.symbols">
7159 <refentrytitle>footnote.number.symbols</refentrytitle>
7160 <refmiscinfo class="other" otherclass="datatype"/>
7163 <refname>footnote.number.symbols</refname>
7164 <refpurpose>Special characters to use as footnote markers</refpurpose>
7168 <programlisting id="footnote.number.symbols.frag">
7169 <xsl:param name="footnote.number.symbols"></xsl:param>
7173 <refsection><info><title>Description</title></info>
7175 <para>If <parameter>footnote.number.symbols</parameter> is not the empty string,
7176 footnotes will use the characters it contains as footnote symbols. For example,
7177 <quote>*&#x2020;&#x2021;&#x25CA;&#x2720;</quote> will identify
7178 footnotes with <quote>*</quote>, <quote>†</quote>, <quote>‡</quote>,
7179 <quote>◊</quote>, and <quote>✠</quote>. If there are more footnotes
7180 than symbols, the stylesheets will fall back to numbered footnotes using
7181 <parameter>footnote.number.format</parameter>.</para>
7183 <para>The use of symbols for footnotes depends on the ability of your
7184 processor (or browser) to render the symbols you select. Not all systems are
7185 capable of displaying the full range of Unicode characters. If the quoted characters
7186 in the preceding paragraph are not displayed properly, that's a good indicator
7187 that you may have trouble using those symbols for footnotes.</para>
7192 <refentry version="5.0" id="table.footnote.number.symbols">
7194 <refentrytitle>table.footnote.number.symbols</refentrytitle>
7195 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
7198 <refname>table.footnote.number.symbols</refname>
7199 <refpurpose>Special characters to use a footnote markers in tables</refpurpose>
7203 <programlisting id="table.footnote.number.symbols.frag">
7204 <xsl:param name="table.footnote.number.symbols"></xsl:param>
7208 <refsection><info><title>Description</title></info>
7210 <para>If <parameter>table.footnote.number.symbols</parameter> is not the empty string,
7211 table footnotes will use the characters it contains as footnote symbols. For example,
7212 <quote>*&#x2020;&#x2021;&#x25CA;&#x2720;</quote> will identify
7213 footnotes with <quote>*</quote>, <quote>†</quote>, <quote>‡</quote>,
7214 <quote>◊</quote>, and <quote>✠</quote>. If there are more footnotes
7215 than symbols, the stylesheets will fall back to numbered footnotes using
7216 <parameter>table.footnote.number.format</parameter>.</para>
7218 <para>The use of symbols for footnotes depends on the ability of your
7219 processor (or browser) to render the symbols you select. Not all systems are
7220 capable of displaying the full range of Unicode characters. If the quoted characters
7221 in the preceding paragraph are not displayed properly, that's a good indicator
7222 that you may have trouble using those symbols for footnotes.</para>
7227 <refentry version="5.0" id="highlight.source">
7229 <refentrytitle>highlight.source</refentrytitle>
7230 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
7233 <refname>highlight.source</refname>
7234 <refpurpose>Should the content of <tag>programlisting</tag>
7235 be syntactically highlighted?</refpurpose>
7239 <programlisting id="highlight.source.frag">
7240 <xsl:param name="highlight.source" select="0"></xsl:param>
7244 <refsection><info><title>Description</title></info>
7246 <para>When this parameter is non-zero, the stylesheets will try to do syntax highlighting of the
7247 content of <tag>programlisting</tag> elements. You specify the language for each programlisting
7248 by using the <tag class="attribute">language</tag> attribute. The <parameter>highlight.default.language</parameter>
7249 parameter can be used to specify the language for programlistings without a <tag class="attribute">language</tag>
7250 attribute. Syntax highlighting also works for <tag>screen</tag> and <tag>synopsis</tag> elements.</para>
7252 <para>The actual highlighting work is done by the XSLTHL extension module. This is an external Java library that has to be
7253 downloaded separately (see below).</para>
7256 <para>In order to use this extension, you must</para>
7258 <listitem><para>add <filename>xslthl-2.x.x.jar</filename> to your Java classpath. The latest version is available
7259 from <link xlink:href="http://sourceforge.net/projects/xslthl">the XSLT syntax highlighting project</link>
7260 at SourceForge.</para>
7263 <para>use a customization layer in which you import one of the following stylesheet modules:
7266 <para><filename>html/highlight.xsl</filename>
7270 <para><filename>xhtml/highlight.xsl</filename>
7274 <para><filename>xhtml-1_1/highlight.xsl</filename>
7278 <para><filename>fo/highlight.xsl</filename>
7284 <listitem><para>let either the <literal>xslthl.config</literal> Java system property or the
7285 <parameter>highlight.xslthl.config</parameter> parameter point to the configuration file for syntax
7286 highlighting (using URL syntax). DocBook XSL comes with a ready-to-use configuration file,
7287 <filename>highlighting/xslthl-config.xml</filename>.</para>
7291 <para>The extension works with Saxon 6.5.x and Xalan-J. (Saxon 8.5 or later is also supported, but since it is
7292 an XSLT 2.0 processor it is not guaranteed to work with DocBook XSL in all circumstances.)</para>
7294 <para>The following is an example of a Saxon 6 command adapted for syntax highlighting, to be used on Windows:</para>
7297 <para><command>java -cp c:/Java/saxon.jar;c:/Java/xslthl-2.0.1.jar
7298 -Dxslthl.config=file:///c:/docbook-xsl/highlighting/xslthl-config.xml com.icl.saxon.StyleSheet
7299 -o test.html test.xml myhtml.xsl</command></para>
7305 <refentry version="5.0" id="highlight.xslthl.config">
7307 <refentrytitle>highlight.xslthl.config</refentrytitle>
7308 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
7311 <refname>highlight.xslthl.config</refname>
7312 <refpurpose>Location of XSLTHL configuration file</refpurpose>
7316 <programlisting id="highlight.xslthl.config.frag">
7317 <xsl:param name="highlight.xslthl.config"></xsl:param>
7321 <refsection><info><title>Description</title></info>
7323 <para>This location has precedence over the corresponding Java property.</para>
7325 <para>Please note that usually you have to specify location as URL not
7326 just as a simple path on the local
7327 filesystem. E.g. <filename>file:///home/user/xslthl/my-xslthl-config.xml</filename>.</para>
7334 <refentry version="5.0" id="highlight.default.language">
7336 <refentrytitle>highlight.default.language</refentrytitle>
7337 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
7340 <refname>highlight.default.language</refname>
7341 <refpurpose>Default language of programlisting</refpurpose>
7345 <programlisting id="highlight.default.language.frag">
7346 <xsl:param name="highlight.default.language"></xsl:param>
7350 <refsection><info><title>Description</title></info>
7352 <para>This language is used when there is no language attribute on programlisting.</para>
7357 <refentry version="5.0" id="email.delimiters.enabled">
7359 <refentrytitle>email.delimiters.enabled</refentrytitle>
7360 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
7363 <refname>email.delimiters.enabled</refname>
7364 <refpurpose>Generate delimiters around email addresses?</refpurpose>
7368 <programlisting id="email.delimiters.enabled.frag">
7369 <xsl:param name="email.delimiters.enabled" select="1"></xsl:param>
7373 <refsection><info><title>Description</title></info>
7375 <para>If non-zero, delimiters
7377 <footnote><para>For delimiters, the
7378 stylesheets are currently hard-coded to output angle
7379 brackets.</para></footnote>
7381 are generated around e-mail addresses
7382 (the output of the <tag>email</tag> element).</para>
7387 <refentry version="5.0" id="exsl.node.set.available">
7389 <refentrytitle>exsl.node.set.available</refentrytitle>
7390 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
7393 <refname>exsl.node.set.available</refname>
7394 <refpurpose>Is the test function-available('exsl:node-set') true?</refpurpose>
7398 <programlisting id="exsl.node.set.available.frag"><xsl:param name="exsl.node.set.available">
7400 <xsl:when exsl:foo="" test="function-available('exsl:node-set') or contains(system-property('xsl:vendor'), 'Apache Software Foundation')">1</xsl:when>
7401 <xsl:otherwise>0</xsl:otherwise>
7407 <refsection><info><title>Description</title></info>
7410 then the exsl:node-set() function is available to be used in
7412 If zero, then the function is not available.
7413 This param automatically detects the presence of
7414 the function and does not normally need to be set manually.</para>
7416 <para>This param was created to handle a long-standing
7417 bug in the Xalan processor that fails to detect the
7418 function even though it is available.</para>
7423 </reference><reference id="annos" xml:base="../html/param.xml"><title>Annotations</title>
7424 <refentry version="5.0" id="annotation.support">
7426 <refentrytitle>annotation.support</refentrytitle>
7427 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
7430 <refname>annotation.support</refname>
7431 <refpurpose>Enable annotations?</refpurpose>
7435 <programlisting id="annotation.support.frag">
7436 <xsl:param name="annotation.support" select="0"></xsl:param>
7440 <refsection><info><title>Description</title></info>
7442 <para>If non-zero, the stylesheets will attempt to support annotation
7443 elements in HTML by including some JavaScript (see
7444 <parameter>annotation.js</parameter>).</para>
7449 <refentry version="5.0" id="annotation.js">
7451 <refentrytitle>annotation.js</refentrytitle>
7452 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
7455 <refname>annotation.js</refname>
7456 <refpurpose>URIs identifying JavaScript files with support for annotation popups</refpurpose>
7460 <programlisting id="annotation.js.frag">
7462 <xsl:param name="annotation.js">
7463 <xsl:text>http://cdn.docbook.org/release/xsl/script/AnchorPosition.js http://cdn.docbook.org/release/xsl/script/PopupWindow.js</xsl:text></xsl:param>
7468 <refsection><info><title>Description</title></info>
7470 <para>If <property>annotation.support</property> is enabled and the
7471 document contains <tag>annotation</tag>s, then the URIs listed
7472 in this parameter will be included. These JavaScript files are required
7473 for popup annotation support.</para>
7478 <refentry version="5.0" id="annotation.css">
7480 <refentrytitle>annotation.css</refentrytitle>
7481 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
7484 <refname>annotation.css</refname>
7485 <refpurpose>CSS rules for annotations</refpurpose>
7489 <programlisting id="annotation.css.frag">
7490 <xsl:param name="annotation.css">
7491 /* ======================================================================
7495 div.annotation-list { visibility: hidden;
7498 div.annotation-nocss { position: absolute;
7502 div.annotation-popup { position: absolute;
7507 border-style: solid;
7510 background-color: white;
7513 div.annotation-title { padding: 1px;
7515 border-bottom-style: solid;
7516 border-bottom-width: 1px;
7518 background-color: black;
7521 div.annotation-body { padding: 2px;
7524 div.annotation-body p { margin-top: 0px;
7528 div.annotation-close { position: absolute;
7536 <refsection><info><title>Description</title></info>
7538 <para>If <parameter>annotation.support</parameter> is enabled and the
7539 document contains <tag>annotation</tag>s, then the CSS in this
7540 parameter will be included in the document.</para>
7545 <refentry version="5.0" id="annotation.graphic.open">
7547 <refentrytitle>annotation.graphic.open</refentrytitle>
7548 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
7551 <refname>annotation.graphic.open</refname>
7552 <refpurpose>Image for identifying a link that opens an annotation popup</refpurpose>
7556 <programlisting id="annotation.graphic.open.frag">
7557 <xsl:param name="annotation.graphic.open">http://cdn.docbook.org/release/xsl/images/annot-open.png</xsl:param>
7561 <refsection><info><title>Description</title></info>
7563 <para>This image is used inline to identify the location of
7564 annotations. It may be replaced by a user provided graphic. The size should be approximately 10x10 pixels.</para>
7569 <refentry version="5.0" id="annotation.graphic.close">
7571 <refentrytitle>annotation.graphic.close</refentrytitle>
7572 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
7575 <refname>annotation.graphic.close</refname>
7576 <refpurpose>Image for identifying a link that closes an annotation popup</refpurpose>
7580 <programlisting id="annotation.graphic.close.frag">
7581 <xsl:param name="annotation.graphic.close">
7582 http://cdn.docbook.org/release/xsl/images/annot-close.png</xsl:param>
7586 <refsection><info><title>Description</title></info>
7588 <para>This image is used on popup annotations as the “x” that the
7589 user can click to dismiss the popup.</para>
7590 <para>This image is used on popup annotations as the “x” that the user can
7591 click to dismiss the popup. It may be replaced by a user provided graphic. The size should be approximately 10x10 pixels.</para>
7596 </reference><reference id="graphics" xml:base="../html/param.xml"><title>Graphics</title>
7597 <refentry version="5.0" id="img.src.path">
7599 <refentrytitle>img.src.path</refentrytitle>
7600 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
7603 <refname>img.src.path</refname>
7604 <refpurpose>Path to HTML/FO image files</refpurpose>
7608 <programlisting id="img.src.path.frag"><xsl:param name="img.src.path"></xsl:param></programlisting>
7611 <refsection><info><title>Description</title></info>
7613 <para>Add a path prefix to the value of the <tag class="attribute">fileref</tag>
7614 attribute of <tag>graphic</tag>, <tag>inlinegraphic</tag>, and <tag>imagedata</tag> elements. The resulting
7615 compound path is used in the output as the value of the <tag class="attribute">src</tag>
7616 attribute of <tag class="element">img</tag> (HTML) or <tag class="element">external-graphic</tag> (FO).
7620 The path given by <literal>img.src.path</literal> could be relative to the directory where the HTML/FO
7621 files are created, or it could be an absolute URI.
7622 The default value is empty.
7623 Be sure to include a trailing slash if needed.
7626 <para>This prefix is not applied to any filerefs that start
7627 with "/" or contain "//:".
7633 <refentry version="5.0" id="keep.relative.image.uris">
7635 <refentrytitle>keep.relative.image.uris</refentrytitle>
7636 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
7639 <refname>keep.relative.image.uris</refname>
7640 <refpurpose>Should image URIs be resolved against xml:base?</refpurpose>
7644 <programlisting id="keep.relative.image.uris.frag">
7645 <xsl:param name="keep.relative.image.uris" select="1"></xsl:param>
7650 <refsection><info><title>Description</title></info>
7652 <para>If non-zero, relative URIs (in, for example
7653 <literal>fileref</literal> attributes) will be used in the generated
7654 output. Otherwise, the URIs will be made absolute with respect to the
7657 <para>Note that the stylesheets calculate (and use) the absolute form
7658 for some purposes, this only applies to the resulting output.</para>
7663 <refentry version="5.0" id="graphic.default.extension">
7665 <refentrytitle>graphic.default.extension</refentrytitle>
7666 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
7669 <refname>graphic.default.extension</refname>
7670 <refpurpose>Default extension for graphic filenames</refpurpose>
7674 <programlisting id="graphic.default.extension.frag"><xsl:param name="graphic.default.extension"></xsl:param></programlisting>
7677 <refsection><info><title>Description</title></info>
7679 <para>If a <tag>graphic</tag> or <tag>mediaobject</tag>
7680 includes a reference to a filename that does not include an extension,
7681 and the <tag class="attribute">format</tag> attribute is
7682 <emphasis>unspecified</emphasis>, the default extension will be used.
7688 <refentry version="5.0" id="default.image.width">
7690 <refentrytitle>default.image.width</refentrytitle>
7691 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
7694 <refname>default.image.width</refname>
7695 <refpurpose>The default width of images</refpurpose>
7699 <programlisting id="default.image.width.frag">
7700 <xsl:param name="default.image.width"></xsl:param>
7704 <refsection><info><title>Description</title></info>
7706 <para>If specified, this value will be used for the
7707 <tag class="attribute">width</tag> attribute on images that do not specify any
7708 <emphasis xlink:title="DocBook 5: The Definitive Guide" xlink:href="http://docbook.org/tdg5/en/html/imagedata.html#viewport.area">viewport dimensions</emphasis>.</para>
7713 <refentry version="5.0" id="nominal.image.width">
7715 <refentrytitle>nominal.image.width</refentrytitle>
7716 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
7719 <refname>nominal.image.width</refname>
7720 <refpurpose>The nominal image width</refpurpose>
7724 <programlisting id="nominal.image.width.frag">
7725 <xsl:param name="nominal.image.width" select="6 * $pixels.per.inch"></xsl:param>
7729 <refsection><info><title>Description</title></info>
7731 <para>Graphic widths expressed as a percentage are problematic. In the
7732 following discussion, we speak of width and contentwidth, but
7733 the same issues apply to depth and contentdepth.</para>
7735 <para>A width of 50% means "half of the available space for the image."
7736 That's fine. But note that in HTML, this is a dynamic property and
7737 the image size will vary if the browser window is resized.</para>
7739 <para>A contentwidth of 50% means "half of the actual image width".
7740 But what does that mean if the stylesheets cannot assess the image's
7741 actual size? Treating this as a width of 50% is one possibility, but
7742 it produces behavior (dynamic scaling) that seems entirely out of
7743 character with the meaning.</para>
7745 <para>Instead, the stylesheets define a
7746 <parameter>nominal.image.width</parameter> and convert percentages to
7747 actual values based on that nominal size.</para>
7752 <refentry version="5.0" id="nominal.image.depth">
7754 <refentrytitle>nominal.image.depth</refentrytitle>
7755 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
7758 <refname>nominal.image.depth</refname>
7759 <refpurpose>Nominal image depth</refpurpose>
7763 <programlisting id="nominal.image.depth.frag">
7764 <xsl:param name="nominal.image.depth" select="4 * $pixels.per.inch"></xsl:param>
7768 <refsection><info><title>Description</title></info>
7770 <para>See <parameter>nominal.image.width</parameter>.</para>
7775 <refentry version="5.0" id="use.embed.for.svg">
7777 <refentrytitle>use.embed.for.svg</refentrytitle>
7778 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
7781 <refname>use.embed.for.svg</refname>
7782 <refpurpose>Use HTML <tag>embed</tag> for SVG?</refpurpose>
7786 <programlisting id="use.embed.for.svg.frag">
7787 <xsl:param name="use.embed.for.svg" select="0"></xsl:param>
7791 <refsection><info><title>Description</title></info>
7793 <para>If non-zero, an <tag>embed</tag> element will be created for
7794 SVG figures. An <tag>object</tag> is <emphasis>always</emphasis> created,
7795 this parameter merely controls whether or not an additional <tag>embed</tag>
7796 is generated inside the <tag>object</tag>.</para>
7798 <para>On the plus side, this may be more portable among browsers and plug-ins.
7799 On the minus side, it isn't valid HTML.</para>
7804 <refentry version="5.0" id="make.graphic.viewport">
7806 <refentrytitle>make.graphic.viewport</refentrytitle>
7807 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
7810 <refname>make.graphic.viewport</refname>
7811 <refpurpose>Use tables in HTML to make viewports for graphics</refpurpose>
7815 <programlisting id="make.graphic.viewport.frag">
7816 <xsl:param name="make.graphic.viewport" select="1"></xsl:param>
7820 <refsection><info><title>Description</title></info>
7822 <para>The HTML <tag>img</tag> element only supports the notion
7823 of content-area scaling; it doesn't support the distinction between a
7824 content-area and a viewport-area, so we have to make some compromises.</para>
7826 <para>If <parameter>make.graphic.viewport</parameter> is non-zero, a table
7827 will be used to frame the image. This creates an effective viewport-area.
7830 <para>Tables and alignment don't work together, so this parameter is ignored
7831 if alignment is specified on an image.</para>
7835 <refentry version="5.0" id="preferred.mediaobject.role">
7837 <refentrytitle>preferred.mediaobject.role</refentrytitle>
7838 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
7841 <refname>preferred.mediaobject.role</refname>
7842 <refpurpose>Select which mediaobject to use based on
7843 this value of an object's <tag class="attribute">role</tag> attribute.
7848 <programlisting id="preferred.mediaobject.role.frag">
7849 <xsl:param name="preferred.mediaobject.role"></xsl:param>
7853 <refsection><info><title>Description</title></info>
7855 <para>A mediaobject may contain several objects such as imageobjects.
7856 If the parameter <parameter>use.role.for.mediaobject</parameter> is
7857 non-zero, then the <literal>role</literal> attribute on
7858 <tag>imageobject</tag>s and other objects within a
7859 <tag>mediaobject</tag> container will be used to select which object
7860 will be used. If one of the objects has a role value that matches the
7861 <parameter>preferred.mediaobject.role</parameter> parameter, then it
7862 has first priority for selection. If more than one has such a role
7863 value, the first one is used.
7866 See the <parameter>use.role.for.mediaobject</parameter> parameter
7867 for the sequence of selection.</para>
7871 <refentry version="5.0" id="link.to.self.for.mediaobject">
7873 <refentrytitle>link.to.self.for.mediaobject</refentrytitle>
7874 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
7877 <refname>link.to.self.for.mediaobject</refname>
7878 <refpurpose>Include <tag>a</tag> element to image objects itself to go to a full-size, freely-zoomable version</refpurpose>
7882 <programlisting id="link.to.self.for.mediaobject.frag">
7883 <xsl:param name="link.to.self.for.mediaobject" select="0"></xsl:param>
7889 <title>Description</title>
7891 <para>In some cases, it can be very helpful to be able to click on an embedded <tag>figure</tag>
7892 or <tag>informalfigure</tag> to get a full-size, freely-zoomable version of an image, for
7893 instance when targeting readers on smartphones. This is implemented for images only, but not
7894 for audio or video objects. </para>
7896 <para>If non-zero, the image will be wrapped in an <tag>a</tag> element, using the <tag class="attribute">href</tag>
7897 attribute pointing to the image itself: </para>
7898 <screen><a href="source/image">
7899 <!-- the image object -->
7902 <para> If the value of <parameter>link.to.self.for.mediaobject.xml</parameter> is zero
7903 (default), then no <tag>a</tag> container is added. </para>
7907 <refentry version="5.0" id="use.role.for.mediaobject">
7909 <refentrytitle>use.role.for.mediaobject</refentrytitle>
7910 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
7913 <refname>use.role.for.mediaobject</refname>
7914 <refpurpose>Use <tag class="attribute">role</tag> attribute
7915 value for selecting which of several objects within a mediaobject to use.
7920 <programlisting id="use.role.for.mediaobject.frag">
7921 <xsl:param name="use.role.for.mediaobject" select="1"></xsl:param>
7925 <refsection><info><title>Description</title></info>
7927 <para>If non-zero, the <tag class="attribute">role</tag> attribute on
7928 <tag>imageobject</tag>s or other objects within a <tag>mediaobject</tag> container will be used to select which object will be
7932 The order of selection when then parameter is non-zero is:
7936 <para>If the stylesheet parameter <parameter>preferred.mediaobject.role</parameter> has a value, then the object whose role equals that value is selected.</para>
7939 <para>Else if an object's role attribute has a value of
7940 <literal>html</literal> for HTML processing or
7941 <literal>fo</literal> for FO output, then the first
7942 of such objects is selected.
7946 <para>Else the first suitable object is selected.</para>
7951 <parameter>use.role.for.mediaobject</parameter>
7952 is zero, then role attributes are not considered
7953 and the first suitable object
7954 with or without a role value is used.
7959 <refentry version="5.0" id="ignore.image.scaling">
7961 <refentrytitle>ignore.image.scaling</refentrytitle>
7962 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
7965 <refname>ignore.image.scaling</refname>
7966 <refpurpose>Tell the stylesheets to ignore the author's image scaling attributes</refpurpose>
7970 <programlisting id="ignore.image.scaling.frag">
7971 <xsl:param name="ignore.image.scaling" select="0"></xsl:param>
7975 <refsection><info><title>Description</title></info>
7977 <para>If non-zero, the scaling attributes on graphics and media objects are
7983 </reference><reference id="chunking" xml:base="../html/param.xml"><title>Chunking</title>
7984 <refentry version="5.0" id="chunker.output.cdata-section-elements">
7986 <refentrytitle>chunker.output.cdata-section-elements</refentrytitle>
7987 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
7990 <refname>chunker.output.cdata-section-elements</refname>
7991 <refpurpose>List of elements to escape with CDATA sections</refpurpose>
7994 <programlisting id="chunker.output.cdata-section-elements.frag">
7995 <xsl:param name="chunker.output.cdata-section-elements"></xsl:param>
7998 <refsection><info><title>Description</title></info>
7999 <para>This parameter specifies the list of elements that should be escaped
8000 as CDATA sections by the chunking stylesheet. Not all processors support
8001 specification of this parameter.
8004 <para>This parameter is documented here, but the declaration is actually
8005 in the <filename>chunker.xsl</filename> stylesheet module.</para>
8010 <refentry version="5.0" id="chunker.output.doctype-public">
8012 <refentrytitle>chunker.output.doctype-public</refentrytitle>
8013 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
8016 <refname>chunker.output.doctype-public</refname>
8017 <refpurpose>Public identifer to use in the document type of generated pages</refpurpose>
8020 <programlisting id="chunker.output.doctype-public.frag">
8021 <xsl:param name="chunker.output.doctype-public"></xsl:param>
8024 <refsection><info><title>Description</title></info>
8025 <para>This parameter specifies the public identifier that should be used by
8026 the chunking stylesheet in the document type declaration of chunked pages.
8027 Not all processors support specification of
8031 <para>This parameter is documented here, but the declaration is actually
8032 in the <filename>chunker.xsl</filename> stylesheet module.</para>
8037 <refentry version="5.0" id="chunker.output.doctype-system">
8039 <refentrytitle>chunker.output.doctype-system</refentrytitle>
8040 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
8043 <refname>chunker.output.doctype-system</refname>
8044 <refpurpose>System identifier to use for the document type in generated pages</refpurpose>
8047 <programlisting id="chunker.output.doctype-system.frag">
8048 <xsl:param name="chunker.output.doctype-system"></xsl:param>
8051 <refsection><info><title>Description</title></info>
8052 <para>This parameter specifies the system identifier that should be used by
8053 the chunking stylesheet in the document type declaration of chunked pages.
8054 Not all processors support specification of
8058 <para>This parameter is documented here, but the declaration is actually
8059 in the <filename>chunker.xsl</filename> stylesheet module.</para>
8064 <refentry version="5.0" id="chunker.output.encoding">
8066 <refentrytitle>chunker.output.encoding</refentrytitle>
8067 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
8070 <refname>chunker.output.encoding</refname>
8071 <refpurpose>Encoding used in generated pages</refpurpose>
8074 <programlisting id="chunker.output.encoding.frag">
8075 <xsl:param name="chunker.output.encoding">ISO-8859-1</xsl:param>
8078 <refsection><info><title>Description</title></info>
8079 <para>This parameter specifies the encoding to be used in files
8080 generated by the chunking stylesheet. Not all processors support
8081 specification of this parameter.
8083 <para>This parameter used to be named <literal>default.encoding</literal>.</para>
8085 <para>This parameter is documented here, but the declaration is actually
8086 in the <filename>chunker.xsl</filename> stylesheet module.</para>
8091 <refentry version="5.0" id="chunker.output.indent">
8093 <refentrytitle>chunker.output.indent</refentrytitle>
8094 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
8097 <refname>chunker.output.indent</refname>
8098 <refpurpose>Specification of indentation on generated pages</refpurpose>
8101 <programlisting id="chunker.output.indent.frag">
8102 <xsl:param name="chunker.output.indent">no</xsl:param>
8105 <refsection><info><title>Description</title></info>
8106 <para>This parameter specifies the value of the indent
8107 specification for generated pages. Not all processors support
8108 specification of this parameter.
8111 <para>This parameter is documented here, but the declaration is actually
8112 in the <filename>chunker.xsl</filename> stylesheet module.</para>
8117 <refentry version="5.0" id="chunker.output.media-type">
8119 <refentrytitle>chunker.output.media-type</refentrytitle>
8120 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
8123 <refname>chunker.output.media-type</refname>
8124 <refpurpose>Media type to use in generated pages</refpurpose>
8127 <programlisting id="chunker.output.media-type.frag">
8128 <xsl:param name="chunker.output.media-type"></xsl:param>
8131 <refsection><info><title>Description</title></info>
8132 <para>This parameter specifies the media type that should be used by
8133 the chunking stylesheet. Not all processors support specification of
8136 <para>This parameter specifies the media type that should be used by the
8137 chunking stylesheet. This should be one from those defined in
8138 <link xlink:href="http://www.ietf.org/rfc/rfc2045.txt">[RFC2045]</link> and
8139 <link xlink:href="http://www.ietf.org/rfc/rfc2046.txt">[RFC2046]</link> </para>
8141 <para>This parameter is documented here, but the declaration is actually
8142 in the <filename>chunker.xsl</filename> stylesheet module.</para>
8143 <para>It must be one from html, xml or text</para>
8148 <refentry version="5.0" id="chunker.output.method">
8150 <refentrytitle>chunker.output.method</refentrytitle>
8151 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
8152 <refmiscinfo class="other" otherclass="value">html</refmiscinfo>
8153 <refmiscinfo class="other" otherclass="value">xml</refmiscinfo>
8156 <refname>chunker.output.method</refname>
8157 <refpurpose>Method used in generated pages</refpurpose>
8160 <programlisting id="chunker.output.method.frag">
8161 <xsl:param name="chunker.output.method">html</xsl:param>
8164 <refsection><info><title>Description</title></info>
8165 <para>This parameter specifies the output method to be used in files
8166 generated by the chunking stylesheet.
8168 <para>This parameter used to be named <literal>output.method</literal>.</para>
8170 <para>This parameter is documented here, but the declaration is actually
8171 in the <filename>chunker.xsl</filename> stylesheet module.</para>
8176 <refentry version="5.0" id="chunker.output.omit-xml-declaration">
8178 <refentrytitle>chunker.output.omit-xml-declaration</refentrytitle>
8179 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
8182 <refname>chunker.output.omit-xml-declaration</refname>
8183 <refpurpose>Omit-xml-declaration for generated pages</refpurpose>
8186 <programlisting id="chunker.output.omit-xml-declaration.frag">
8187 <xsl:param name="chunker.output.omit-xml-declaration">no</xsl:param>
8190 <refsection><info><title>Description</title></info>
8191 <para>This parameter specifies the value of the omit-xml-declaration
8192 specification for generated pages. Not all processors support
8193 specification of this parameter.
8196 <para>This parameter is documented here, but the declaration is actually
8197 in the <filename>chunker.xsl</filename> stylesheet module.</para>
8202 <refentry version="5.0" id="chunker.output.standalone">
8204 <refentrytitle>chunker.output.standalone</refentrytitle>
8205 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
8208 <refname>chunker.output.standalone</refname>
8209 <refpurpose>Standalone declaration for generated pages</refpurpose>
8212 <programlisting id="chunker.output.standalone.frag">
8213 <xsl:param name="chunker.output.standalone">no</xsl:param>
8216 <refsection><info><title>Description</title></info>
8217 <para>This parameter specifies the value of the standalone
8218 specification for generated pages. It must be either
8219 <literal>yes</literal> or <literal>no</literal>. Not all
8220 processors support specification of this parameter.
8223 <para>This parameter is documented here, but the declaration is actually
8224 in the <filename>chunker.xsl</filename> stylesheet module.</para>
8229 <refentry version="5.0" id="saxon.character.representation">
8231 <refentrytitle>saxon.character.representation</refentrytitle>
8232 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
8235 <refname>saxon.character.representation</refname>
8236 <refpurpose>Saxon character representation used in generated HTML pages</refpurpose>
8240 <programlisting id="saxon.character.representation.frag"><xsl:param name="saxon.character.representation" select="'entity;decimal'"></xsl:param></programlisting>
8243 <refsection><info><title>Description</title></info>
8245 <para>This parameter has effect only when Saxon 6 is used (version 6.4.2 or later).
8246 It sets the character representation in files generated by the chunking stylesheets.
8247 If you want to suppress entity references for characters with direct representations in
8248 <parameter>chunker.output.encoding</parameter>, set the parameter value to <literal>native</literal>.
8251 <para> For more information, see <link role="tcg" xlink:href="OutputEncoding.html#SaxonCharacter">Saxon output character representation</link>.</para>
8254 <para>This parameter is documented here, but the declaration is actually
8255 in the <filename>chunker.xsl</filename> stylesheet module.</para>
8262 <refentry version="5.0" id="html.ext">
8264 <refentrytitle>html.ext</refentrytitle>
8265 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
8268 <refname>html.ext</refname>
8269 <refpurpose>Identifies the extension of generated HTML files</refpurpose>
8273 <programlisting id="html.ext.frag">
8274 <xsl:param name="html.ext">.html</xsl:param>
8278 <refsection><info><title>Description</title></info>
8280 <para>The extension identified by <parameter>html.ext</parameter> will
8281 be used as the filename extension for chunks created by this
8287 <refentry version="5.0" id="use.id.as.filename">
8289 <refentrytitle>use.id.as.filename</refentrytitle>
8290 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
8293 <refname>use.id.as.filename</refname>
8294 <refpurpose>Use ID value of chunk elements as the filename?</refpurpose>
8298 <programlisting id="use.id.as.filename.frag">
8299 <xsl:param name="use.id.as.filename" select="0"></xsl:param>
8303 <refsection><info><title>Description</title></info>
8305 <para>If <parameter>use.id.as.filename</parameter>
8306 is non-zero, the filename of chunk elements that have IDs will be
8307 derived from the ID value.
8313 <refentry version="5.0" id="html.extra.head.links">
8315 <refentrytitle>html.extra.head.links</refentrytitle>
8316 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
8319 <refname>html.extra.head.links</refname>
8320 <refpurpose>Toggle extra HTML head link information</refpurpose>
8324 <programlisting id="html.extra.head.links.frag">
8325 <xsl:param name="html.extra.head.links" select="0"></xsl:param>
8329 <refsection><info><title>Description</title></info>
8331 <para>If non-zero, extra <tag>link</tag> elements will be
8332 generated in the <tag>head</tag> of chunked HTML files. These
8333 extra links point to chapters, appendixes, sections, etc. as supported
8334 by the <quote>Site Navigation Bar</quote> in Mozilla 1.0 (as of CR1, at least).
8340 <refentry version="5.0" id="root.filename">
8342 <refentrytitle>root.filename</refentrytitle>
8343 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
8346 <refname>root.filename</refname>
8347 <refpurpose>Identifies the name of the root HTML file when chunking</refpurpose>
8351 <programlisting id="root.filename.frag">
8352 <xsl:param name="root.filename">index</xsl:param>
8356 <refsection><info><title>Description</title></info>
8358 <para>The <parameter>root.filename</parameter> is the base filename for
8359 the chunk created for the root of each document processed.
8365 <refentry version="5.0" id="base.dir">
8367 <refentrytitle>base.dir</refentrytitle>
8368 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
8371 <refname>base.dir</refname>
8372 <refpurpose>The base directory of chunks</refpurpose>
8376 <programlisting id="base.dir.frag">
8377 <xsl:param name="base.dir"></xsl:param>
8381 <refsection><info><title>Description</title></info>
8383 <para>If specified, the <parameter>base.dir</parameter> parameter identifies
8384 the output directory for chunks. (If not specified, the output directory
8385 is system dependent.)</para>
8387 <para>Starting with version 1.77 of the stylesheets,
8388 the param's value will have a trailing slash added if it does
8389 not already have one.</para>
8391 <caution><para>Do not use <parameter>base.dir</parameter>
8392 to add a filename prefix string to chunked files.
8393 Instead, use the <parameter>chunked.filename.prefix</parameter>
8394 parameter.</para></caution>
8399 <refentry version="5.0" id="chunked.filename.prefix">
8401 <refentrytitle>chunked.filename.prefix</refentrytitle>
8402 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
8405 <refname>chunked.filename.prefix</refname>
8406 <refpurpose>Filename prefix for chunked files</refpurpose>
8410 <programlisting id="chunked.filename.prefix.frag">
8411 <xsl:param name="chunked.filename.prefix"></xsl:param>
8415 <refsection><info><title>Description</title></info>
8417 <para>If specified, the <parameter>chunked.filename.prefix</parameter>
8418 parameter specifies a prefix string to add to each generated chunk filename.
8420 <programlisting><xsl:param name="chunked.filename.prefix">admin-<xsl:param></programlisting>
8421 <para>will produce chunked filenames like:</para>
8422 <programlisting>admin-index.html
8428 <caution><para>Trying to use the <parameter>base.dir</parameter>
8429 parameter to add a string prefix (by omitting the trailing slash)
8430 no longer works (it never worked completely anyway). That parameter
8431 value should contain only a directory path, and
8432 now gets a trailing slash appended if it was omitted from the param.</para></caution>
8436 <refentry version="5.0" id="generate.manifest">
8438 <refentrytitle>generate.manifest</refentrytitle>
8439 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
8442 <refname>generate.manifest</refname>
8443 <refpurpose>Generate a manifest file?</refpurpose>
8447 <programlisting id="generate.manifest.frag"><xsl:param name="generate.manifest" select="0"></xsl:param></programlisting>
8450 <refsection><info><title>Description</title></info>
8452 <para>If non-zero, a list of HTML files generated by the
8453 stylesheet transformation is written to the file named by
8454 the <parameter>manifest</parameter> parameter.</para>
8459 <refentry version="5.0" id="manifest">
8461 <refentrytitle>manifest</refentrytitle>
8462 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
8465 <refname>manifest</refname>
8466 <refpurpose>Name of manifest file</refpurpose>
8470 <programlisting id="manifest.frag">
8471 <xsl:param name="manifest">HTML.manifest</xsl:param>
8475 <refsection><info><title>Description</title></info>
8477 <para>The name of the file to which a manifest is written (if the
8478 value of the <parameter>generate.manifest</parameter> parameter
8479 is non-zero).</para>
8484 <refentry version="5.0" id="manifest.in.base.dir">
8486 <refentrytitle>manifest.in.base.dir</refentrytitle>
8487 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
8490 <refname>manifest.in.base.dir</refname>
8491 <refpurpose>Should the manifest file be written into <parameter>base.dir</parameter>?</refpurpose>
8495 <programlisting id="manifest.in.base.dir.frag">
8496 <xsl:param name="manifest.in.base.dir" select="0"></xsl:param>
8500 <refsection><info><title>Description</title></info>
8502 <para>If non-zero, the manifest file as well as project files for HTML Help and
8503 Eclipse Help are written into <parameter>base.dir</parameter> instead
8504 of the current directory.</para>
8509 <refentry version="5.0" id="chunk.toc">
8511 <refentrytitle>chunk.toc</refentrytitle>
8512 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
8515 <refname>chunk.toc</refname>
8516 <refpurpose>An explicit TOC to be used for chunking</refpurpose>
8520 <programlisting id="chunk.toc.frag">
8521 <xsl:param name="chunk.toc"></xsl:param>
8525 <refsection><info><title>Description</title></info>
8527 <para>The <parameter>chunk.toc</parameter> identifies an explicit TOC that
8528 will be used for chunking. This parameter is only used by the
8529 <filename>chunktoc.xsl</filename> stylesheet (and customization layers built
8535 <refentry version="5.0" id="chunk.tocs.and.lots">
8537 <refentrytitle>chunk.tocs.and.lots</refentrytitle>
8538 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
8541 <refname>chunk.tocs.and.lots</refname>
8542 <refpurpose>Should ToC and LoTs be in separate chunks?</refpurpose>
8546 <programlisting id="chunk.tocs.and.lots.frag">
8547 <xsl:param name="chunk.tocs.and.lots" select="0"></xsl:param>
8551 <refsection><info><title>Description</title></info>
8553 <para>If non-zero, ToC and LoT (List of Examples, List of Figures, etc.)
8554 will be put in a separate chunk. At the moment, this chunk is not in the
8555 normal forward/backward navigation list. Instead, a new link is added to the
8556 navigation footer.</para>
8558 <para>This feature is still somewhat experimental. Feedback welcome.</para>
8563 <refentry version="5.0" id="chunk.separate.lots">
8565 <refentrytitle>chunk.separate.lots</refentrytitle>
8566 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
8569 <refname>chunk.separate.lots</refname>
8570 <refpurpose>Should each LoT be in its own separate chunk?</refpurpose>
8574 <programlisting id="chunk.separate.lots.frag">
8575 <xsl:param name="chunk.separate.lots" select="0"></xsl:param>
8579 <refsection><info><title>Description</title></info>
8581 <para>If non-zero, each of the ToC and LoTs
8582 (List of Examples, List of Figures, etc.)
8583 will be put in its own separate chunk.
8584 The title page includes generated links to each of the separate files.
8587 This feature depends on the
8588 <parameter>chunk.tocs.and.lots</parameter>
8589 parameter also being non-zero.
8595 <refentry version="5.0" id="chunk.tocs.and.lots.has.title">
8597 <refentrytitle>chunk.tocs.and.lots.has.title</refentrytitle>
8598 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
8601 <refname>chunk.tocs.and.lots.has.title</refname>
8602 <refpurpose>Should ToC and LoTs in a separate chunks have title?</refpurpose>
8606 <programlisting id="chunk.tocs.and.lots.has.title.frag">
8607 <xsl:param name="chunk.tocs.and.lots.has.title" select="1"></xsl:param>
8611 <refsection><info><title>Description</title></info>
8613 <para>If non-zero title of document is shown before ToC/LoT in
8614 separate chunk.</para>
8619 <refentry version="5.0" id="chunk.section.depth">
8621 <refentrytitle>chunk.section.depth</refentrytitle>
8622 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
8625 <refname>chunk.section.depth</refname>
8626 <refpurpose>Depth to which sections should be chunked</refpurpose>
8630 <programlisting id="chunk.section.depth.frag">
8631 <xsl:param name="chunk.section.depth" select="1"></xsl:param>
8635 <refsection><info><title>Description</title></info>
8637 <para>This parameter sets the depth of section chunking.</para>
8642 <refentry version="5.0" id="chunk.first.sections">
8644 <refentrytitle>chunk.first.sections</refentrytitle>
8645 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
8648 <refname>chunk.first.sections</refname>
8649 <refpurpose>Chunk the first top-level section?</refpurpose>
8653 <programlisting id="chunk.first.sections.frag">
8654 <xsl:param name="chunk.first.sections" select="0"></xsl:param>
8658 <refsection><info><title>Description</title></info>
8660 <para>If non-zero, a chunk will be created for the first top-level
8661 <tag>sect1</tag> or <tag>section</tag> elements in
8662 each component. Otherwise, that section will be part of the chunk for
8669 <refentry version="5.0" id="chunk.quietly">
8671 <refentrytitle>chunk.quietly</refentrytitle>
8672 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
8675 <refname>chunk.quietly</refname>
8676 <refpurpose>Omit the chunked filename messages.</refpurpose>
8680 <programlisting id="chunk.quietly.frag">
8681 <xsl:param name="chunk.quietly" select="0"></xsl:param>
8685 <refsection><info><title>Description</title></info>
8687 <para>If zero (the default), the XSL processor emits a message naming
8688 each separate chunk filename as it is being output.
8689 If nonzero, then the messages are suppressed.
8695 <refentry version="5.0" id="chunk.append">
8697 <refentrytitle>chunk.append</refentrytitle>
8698 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
8701 <refname>chunk.append</refname>
8702 <refpurpose>Specifies content to append to chunked HTML output</refpurpose>
8706 <programlisting id="chunk.append.frag"><xsl:param name="chunk.append"></xsl:param></programlisting>
8709 <refsection><info><title>Description</title></info>
8711 <para>Specifies content to append to the end of HTML files output by
8712 the <filename>html/chunk.xsl</filename> stylesheet, after the closing
8713 <code><html></code> tag. You probably don’t want to set any value
8714 for this parameter; but if you do, the only value it should ever be
8715 set to is a newline character: <code>&#x0a;</code> or
8716 <code>&#10;</code></para>
8721 <refentry version="5.0" id="navig.graphics">
8723 <refentrytitle>navig.graphics</refentrytitle>
8724 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
8727 <refname>navig.graphics</refname>
8728 <refpurpose>Use graphics in navigational headers and footers?</refpurpose>
8732 <programlisting id="navig.graphics.frag">
8733 <xsl:param name="navig.graphics" select="0"></xsl:param>
8737 <refsection><info><title>Description</title></info>
8739 <para>If non-zero, the navigational headers and footers in chunked
8740 HTML are presented in an alternate style that uses graphical icons for
8741 Next, Previous, Up, and Home. Default graphics are provided in the
8742 distribution. If zero, text is used instead of graphics.
8748 <refentry version="5.0" id="navig.graphics.extension">
8750 <refentrytitle>navig.graphics.extension</refentrytitle>
8751 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
8754 <refname>navig.graphics.extension</refname>
8755 <refpurpose>Extension for navigational graphics</refpurpose>
8759 <programlisting id="navig.graphics.extension.frag">
8760 <xsl:param name="navig.graphics.extension">.gif</xsl:param>
8764 <refsection><info><title>Description</title></info>
8766 <para>Sets the filename extension to use on navigational graphics used
8767 in the headers and footers of chunked HTML.</para>
8772 <refentry version="5.0" id="navig.graphics.path">
8774 <refentrytitle>navig.graphics.path</refentrytitle>
8775 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
8778 <refname>navig.graphics.path</refname>
8779 <refpurpose>Path to navigational graphics</refpurpose>
8783 <programlisting id="navig.graphics.path.frag">
8784 <xsl:param name="navig.graphics.path">images/</xsl:param>
8788 <refsection><info><title>Description</title></info>
8790 <para>Sets the path, probably relative to the directory where the HTML
8791 files are created, to the navigational graphics used in the
8792 headers and footers of chunked HTML.
8798 <refentry version="5.0" id="navig.showtitles">
8800 <refentrytitle>navig.showtitles</refentrytitle>
8801 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
8804 <refname>navig.showtitles</refname>
8805 <refpurpose>Display titles in HTML headers and footers?</refpurpose>
8809 <programlisting id="navig.showtitles.frag"><xsl:param name="navig.showtitles">1</xsl:param></programlisting>
8812 <refsection><info><title>Description</title></info>
8815 the headers and footers of chunked HTML
8816 display the titles of the next and previous chunks,
8817 along with the words 'Next' and 'Previous' (or the
8818 equivalent graphical icons if navig.graphics is true).
8819 If false (zero), then only the words 'Next' and 'Previous'
8820 (or the icons) are displayed.
8826 </reference><reference id="profiling" xml:base="../html/param.xml"><title>Profiling</title>
8827 <partintro id="partintro">
8828 <para>The following parameters can be used for attribute-based
8829 profiling of your document. For more information about profiling, see
8830 <link role="tcg" xlink:href="Profiling.html">Profiling (conditional text)</link>.</para>
8832 <refentry version="5.0" id="profile.arch">
8834 <refentrytitle>profile.arch</refentrytitle>
8835 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
8838 <refname>profile.arch</refname>
8839 <refpurpose>Target profile for <tag class="attribute">arch</tag>
8840 attribute</refpurpose>
8844 <programlisting id="profile.arch.frag">
8845 <xsl:param name="profile.arch"></xsl:param>
8850 <refsection><info><title>Description</title></info>
8852 <para>The value of this parameter specifies profiles which should be
8853 included in the output. You can specify multiple profiles by
8854 separating them by semicolon. You can change separator character by
8855 <parameter>profile.separator</parameter>
8858 <para>This parameter has effect only when you are using profiling
8859 stylesheets (<filename>profile-docbook.xsl</filename>,
8860 <filename>profile-chunk.xsl</filename>, …) instead of normal
8861 ones (<filename>docbook.xsl</filename>,
8862 <filename>chunk.xsl</filename>, …).</para>
8867 <refentry version="5.0" id="profile.audience">
8869 <refentrytitle>profile.audience</refentrytitle>
8870 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
8873 <refname>profile.audience</refname>
8874 <refpurpose>Target profile for <tag class="attribute">audience</tag>
8875 attribute</refpurpose>
8879 <programlisting id="profile.audience.frag">
8880 <xsl:param name="profile.audience"></xsl:param>
8884 <refsection><info><title>Description</title></info>
8886 <para>Value of this parameter specifies profiles which should be
8887 included in the output. You can specify multiple profiles by
8888 separating them by semicolon. You can change separator character by
8889 <parameter>profile.separator</parameter>
8892 <para>This parameter has effect only when you are using profiling
8893 stylesheets (<filename>profile-docbook.xsl</filename>,
8894 <filename>profile-chunk.xsl</filename>, …) instead of normal
8895 ones (<filename>docbook.xsl</filename>,
8896 <filename>chunk.xsl</filename>, …).</para>
8901 <refentry version="5.0" id="profile.condition">
8903 <refentrytitle>profile.condition</refentrytitle>
8904 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
8907 <refname>profile.condition</refname>
8908 <refpurpose>Target profile for <tag class="attribute">condition</tag>
8909 attribute</refpurpose>
8913 <programlisting id="profile.condition.frag">
8914 <xsl:param name="profile.condition"></xsl:param>
8918 <refsection><info><title>Description</title></info>
8920 <para>The value of this parameter specifies profiles which should be
8921 included in the output. You can specify multiple profiles by
8922 separating them by semicolon. You can change separator character by
8923 <parameter>profile.separator</parameter>
8926 <para>This parameter has effect only when you are using profiling
8927 stylesheets (<filename>profile-docbook.xsl</filename>,
8928 <filename>profile-chunk.xsl</filename>, …) instead of normal
8929 ones (<filename>docbook.xsl</filename>,
8930 <filename>chunk.xsl</filename>, …).</para>
8935 <refentry version="5.0" id="profile.conformance">
8937 <refentrytitle>profile.conformance</refentrytitle>
8938 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
8941 <refname>profile.conformance</refname>
8942 <refpurpose>Target profile for <tag class="attribute">conformance</tag>
8943 attribute</refpurpose>
8947 <programlisting id="profile.conformance.frag">
8948 <xsl:param name="profile.conformance"></xsl:param>
8952 <refsection><info><title>Description</title></info>
8954 <para>The value of this parameter specifies profiles which should be
8955 included in the output. You can specify multiple profiles by
8956 separating them by semicolon. You can change separator character by
8957 <parameter>profile.separator</parameter>
8960 <para>This parameter has effect only when you are using profiling
8961 stylesheets (<filename>profile-docbook.xsl</filename>,
8962 <filename>profile-chunk.xsl</filename>, …) instead of normal
8963 ones (<filename>docbook.xsl</filename>,
8964 <filename>chunk.xsl</filename>, …).</para>
8969 <refentry version="5.0" id="profile.lang">
8971 <refentrytitle>profile.lang</refentrytitle>
8972 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
8975 <refname>profile.lang</refname>
8976 <refpurpose>Target profile for <tag class="attribute">lang</tag>
8977 attribute</refpurpose>
8981 <programlisting id="profile.lang.frag">
8982 <xsl:param name="profile.lang"></xsl:param>
8986 <refsection><info><title>Description</title></info>
8988 <para>The value of this parameter specifies profiles which should be
8989 included in the output. You can specify multiple profiles by
8990 separating them by semicolon. You can change separator character by
8991 <parameter>profile.separator</parameter>
8994 <para>This parameter has effect only when you are using profiling
8995 stylesheets (<filename>profile-docbook.xsl</filename>,
8996 <filename>profile-chunk.xsl</filename>, …) instead of normal
8997 ones (<filename>docbook.xsl</filename>,
8998 <filename>chunk.xsl</filename>, …).</para>
9003 <refentry version="5.0" id="profile.os">
9005 <refentrytitle>profile.os</refentrytitle>
9006 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
9009 <refname>profile.os</refname>
9010 <refpurpose>Target profile for <tag class="attribute">os</tag>
9011 attribute</refpurpose>
9015 <programlisting id="profile.os.frag">
9016 <xsl:param name="profile.os"></xsl:param>
9020 <refsection><info><title>Description</title></info>
9022 <para>The value of this parameter specifies profiles which should be
9023 included in the output. You can specify multiple profiles by
9024 separating them by semicolon. You can change separator character by
9025 <parameter>profile.separator</parameter>
9028 <para>This parameter has effect only when you are using profiling
9029 stylesheets (<filename>profile-docbook.xsl</filename>,
9030 <filename>profile-chunk.xsl</filename>, …) instead of normal
9031 ones (<filename>docbook.xsl</filename>,
9032 <filename>chunk.xsl</filename>, …).</para>
9037 <refentry version="5.0" id="profile.outputformat">
9039 <refentrytitle>profile.outputformat</refentrytitle>
9040 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
9043 <refname>profile.outputformat</refname>
9044 <refpurpose>Target profile for <tag class="attribute">outputformat</tag> attribute</refpurpose>
9048 <programlisting id="profile.outputformat.frag">
9049 <xsl:param name="profile.outputformat"></xsl:param>
9053 <refsection><info><title>Description</title></info>
9055 <para>The value of this parameter specifies profiles which should be
9056 included in the output. You can specify multiple profiles by
9057 separating them by semicolon. You can change separator character by
9058 <parameter>profile.separator</parameter>
9061 <para>This parameter has effect only when you are using profiling
9062 stylesheets (<filename>profile-docbook.xsl</filename>,
9063 <filename>profile-chunk.xsl</filename>, …) instead of normal
9064 ones (<filename>docbook.xsl</filename>,
9065 <filename>chunk.xsl</filename>, …).</para>
9070 <refentry version="5.0" id="profile.revision">
9072 <refentrytitle>profile.revision</refentrytitle>
9073 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
9076 <refname>profile.revision</refname>
9077 <refpurpose>Target profile for <tag class="attribute">revision</tag>
9078 attribute</refpurpose>
9082 <programlisting id="profile.revision.frag">
9083 <xsl:param name="profile.revision"></xsl:param>
9087 <refsection><info><title>Description</title></info>
9089 <para>The value of this parameter specifies profiles which should be
9090 included in the output. You can specify multiple profiles by
9091 separating them by semicolon. You can change separator character by
9092 <parameter>profile.separator</parameter>
9095 <para>This parameter has effect only when you are using profiling
9096 stylesheets (<filename>profile-docbook.xsl</filename>,
9097 <filename>profile-chunk.xsl</filename>, …) instead of normal
9098 ones (<filename>docbook.xsl</filename>,
9099 <filename>chunk.xsl</filename>, …).</para>
9104 <refentry version="5.0" id="profile.revisionflag">
9106 <refentrytitle>profile.revisionflag</refentrytitle>
9107 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
9110 <refname>profile.revisionflag</refname>
9111 <refpurpose>Target profile for <tag class="attribute">revisionflag</tag>
9112 attribute</refpurpose>
9116 <programlisting id="profile.revisionflag.frag">
9117 <xsl:param name="profile.revisionflag"></xsl:param>
9121 <refsection><info><title>Description</title></info>
9123 <para>The value of this parameter specifies profiles which should be
9124 included in the output. You can specify multiple profiles by
9125 separating them by semicolon. You can change separator character by
9126 <parameter>profile.separator</parameter>
9129 <para>This parameter has effect only when you are using profiling
9130 stylesheets (<filename>profile-docbook.xsl</filename>,
9131 <filename>profile-chunk.xsl</filename>, …) instead of normal
9132 ones (<filename>docbook.xsl</filename>,
9133 <filename>chunk.xsl</filename>, …).</para>
9138 <refentry version="5.0" id="profile.role">
9140 <refentrytitle>profile.role</refentrytitle>
9141 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
9144 <refname>profile.role</refname>
9145 <refpurpose>Target profile for <tag class="attribute">role</tag>
9146 attribute</refpurpose>
9150 <programlisting id="profile.role.frag">
9151 <xsl:param name="profile.role"></xsl:param>
9155 <refsection><info><title>Description</title></info>
9157 <para>The value of this parameter specifies profiles which should be
9158 included in the output. You can specify multiple profiles by
9159 separating them by semicolon. You can change separator character by
9160 <parameter>profile.separator</parameter>
9163 <para>This parameter has effect only when you are using profiling
9164 stylesheets (<filename>profile-docbook.xsl</filename>,
9165 <filename>profile-chunk.xsl</filename>, …) instead of normal
9166 ones (<filename>docbook.xsl</filename>,
9167 <filename>chunk.xsl</filename>, …).</para>
9170 <para>Note that <tag class="attribute">role</tag> is often
9171 used for other purposes than profiling. For example it is commonly
9172 used to get emphasize in bold font:</para>
9174 <programlisting><emphasis role="bold">very important</emphasis></programlisting>
9176 <para>If you are using <tag class="attribute">role</tag> for
9177 these purposes do not forget to add values like <literal>bold</literal> to
9178 value of this parameter. If you forgot you will get document with
9179 small pieces missing which are very hard to track.</para>
9181 <para>For this reason it is not recommended to use <tag class="attribute">role</tag> attribute for profiling. You should
9182 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>
9188 <refentry version="5.0" id="profile.security">
9190 <refentrytitle>profile.security</refentrytitle>
9191 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
9194 <refname>profile.security</refname>
9195 <refpurpose>Target profile for <tag class="attribute">security</tag>
9196 attribute</refpurpose>
9200 <programlisting id="profile.security.frag">
9201 <xsl:param name="profile.security"></xsl:param>
9205 <refsection><info><title>Description</title></info>
9207 <para>The value of this parameter specifies profiles which should be
9208 included in the output. You can specify multiple profiles by
9209 separating them by semicolon. You can change separator character by
9210 <parameter>profile.separator</parameter>
9213 <para>This parameter has effect only when you are using profiling
9214 stylesheets (<filename>profile-docbook.xsl</filename>,
9215 <filename>profile-chunk.xsl</filename>, …) instead of normal
9216 ones (<filename>docbook.xsl</filename>,
9217 <filename>chunk.xsl</filename>, …).</para>
9222 <refentry version="5.0" id="profile.status">
9224 <refentrytitle>profile.status</refentrytitle>
9225 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
9228 <refname>profile.status</refname>
9229 <refpurpose>Target profile for <tag class="attribute">status</tag>
9230 attribute</refpurpose>
9234 <programlisting id="profile.status.frag">
9235 <xsl:param name="profile.status"></xsl:param>
9239 <refsection><info><title>Description</title></info>
9241 <para>The value of this parameter specifies profiles which should be
9242 included in the output. You can specify multiple profiles by
9243 separating them by semicolon. You can change separator character by
9244 <parameter>profile.separator</parameter>
9247 <para>This parameter has effect only when you are using profiling
9248 stylesheets (<filename>profile-docbook.xsl</filename>,
9249 <filename>profile-chunk.xsl</filename>, …) instead of normal
9250 ones (<filename>docbook.xsl</filename>,
9251 <filename>chunk.xsl</filename>, …).</para>
9256 <refentry version="5.0" id="profile.userlevel">
9258 <refentrytitle>profile.userlevel</refentrytitle>
9259 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
9262 <refname>profile.userlevel</refname>
9263 <refpurpose>Target profile for <tag class="attribute">userlevel</tag>
9264 attribute</refpurpose>
9268 <programlisting id="profile.userlevel.frag">
9269 <xsl:param name="profile.userlevel"></xsl:param>
9273 <refsection><info><title>Description</title></info>
9275 <para>The value of this parameter specifies profiles which should be
9276 included in the output. You can specify multiple profiles by
9277 separating them by semicolon. You can change separator character by
9278 <parameter>profile.separator</parameter>
9281 <para>This parameter has effect only when you are using profiling
9282 stylesheets (<filename>profile-docbook.xsl</filename>,
9283 <filename>profile-chunk.xsl</filename>, …) instead of normal
9284 ones (<filename>docbook.xsl</filename>,
9285 <filename>chunk.xsl</filename>, …).</para>
9290 <refentry version="5.0" id="profile.vendor">
9292 <refentrytitle>profile.vendor</refentrytitle>
9293 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
9296 <refname>profile.vendor</refname>
9297 <refpurpose>Target profile for <tag class="attribute">vendor</tag>
9298 attribute</refpurpose>
9302 <programlisting id="profile.vendor.frag">
9303 <xsl:param name="profile.vendor"></xsl:param>
9307 <refsection><info><title>Description</title></info>
9309 <para>The value of this parameter specifies profiles which should be
9310 included in the output. You can specify multiple profiles by
9311 separating them by semicolon. You can change separator character by
9312 <parameter>profile.separator</parameter>
9315 <para>This parameter has effect only when you are using profiling
9316 stylesheets (<filename>profile-docbook.xsl</filename>,
9317 <filename>profile-chunk.xsl</filename>, …) instead of normal
9318 ones (<filename>docbook.xsl</filename>,
9319 <filename>chunk.xsl</filename>, …).</para>
9324 <refentry version="5.0" id="profile.wordsize">
9326 <refentrytitle>profile.wordsize</refentrytitle>
9327 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
9330 <refname>profile.wordsize</refname>
9331 <refpurpose>Target profile for <tag class="attribute">wordsize</tag>
9332 attribute</refpurpose>
9336 <programlisting id="profile.wordsize.frag">
9337 <xsl:param name="profile.wordsize"></xsl:param>
9341 <refsection><info><title>Description</title></info>
9343 <para>The value of this parameter specifies profiles which should be
9344 included in the output. You can specify multiple profiles by
9345 separating them by semicolon. You can change separator character by
9346 <parameter>profile.separator</parameter>
9349 <para>This parameter has effect only when you are using profiling
9350 stylesheets (<filename>profile-docbook.xsl</filename>,
9351 <filename>profile-chunk.xsl</filename>, …) instead of normal
9352 ones (<filename>docbook.xsl</filename>,
9353 <filename>chunk.xsl</filename>, …).</para>
9358 <refentry version="5.0" id="profile.attribute">
9360 <refentrytitle>profile.attribute</refentrytitle>
9361 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
9364 <refname>profile.attribute</refname>
9365 <refpurpose>Name of user-specified profiling attribute</refpurpose>
9369 <programlisting id="profile.attribute.frag">
9370 <xsl:param name="profile.attribute"></xsl:param>
9374 <refsection><info><title>Description</title></info>
9376 <para>This parameter is used in conjuction with
9377 <parameter>profile.value</parameter>.</para>
9379 <para>This parameter has effect only when you are using profiling
9380 stylesheets (<filename>profile-docbook.xsl</filename>,
9381 <filename>profile-chunk.xsl</filename>, …) instead of normal
9382 ones (<filename>docbook.xsl</filename>,
9383 <filename>chunk.xsl</filename>, …).</para>
9388 <refentry version="5.0" id="profile.value">
9390 <refentrytitle>profile.value</refentrytitle>
9391 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
9394 <refname>profile.value</refname>
9395 <refpurpose>Target profile for user-specified attribute</refpurpose>
9399 <programlisting id="profile.value.frag">
9400 <xsl:param name="profile.value"></xsl:param>
9404 <refsection><info><title>Description</title></info>
9406 <para>When you are using this parameter you must also specify name of
9407 profiling attribute with parameter
9408 <parameter>profile.attribute</parameter>.</para>
9410 <para>The value of this parameter specifies profiles which should be
9411 included in the output. You can specify multiple profiles by
9412 separating them by semicolon. You can change separator character by
9413 <parameter>profile.separator</parameter>
9416 <para>This parameter has effect only when you are using profiling
9417 stylesheets (<filename>profile-docbook.xsl</filename>,
9418 <filename>profile-chunk.xsl</filename>, …) instead of normal
9419 ones (<filename>docbook.xsl</filename>,
9420 <filename>chunk.xsl</filename>, …).</para>
9425 <refentry version="5.0" id="profile.separator">
9427 <refentrytitle>profile.separator</refentrytitle>
9428 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
9431 <refname>profile.separator</refname>
9432 <refpurpose>Separator character for compound profile values</refpurpose>
9436 <programlisting id="profile.separator.frag">
9437 <xsl:param name="profile.separator">;</xsl:param>
9441 <refsection><info><title>Description</title></info>
9443 <para>Separator character used for compound profile values. See <parameter>profile.arch</parameter></para>
9448 </reference><reference id="htmlhelp" xml:base="../html/param.xml"><title>HTML Help</title>
9449 <refentry version="5.0" id="htmlhelp.encoding">
9451 <refentrytitle>htmlhelp.encoding</refentrytitle>
9452 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
9455 <refname>htmlhelp.encoding</refname>
9456 <refpurpose>Character encoding to use in files for HTML Help compiler.</refpurpose>
9460 <programlisting id="htmlhelp.encoding.frag">
9461 <xsl:param name="htmlhelp.encoding">iso-8859-1</xsl:param>
9465 <refsection><info><title>Description</title></info>
9467 <para>The HTML Help Compiler is not UTF-8 aware, so you should always use an
9468 appropriate single-byte encoding here. See also <link xlink:href="HtmlHelp.html#HelpProcOptions" role="tcg">Processing options</link>.</para>
9473 <refentry version="5.0" id="htmlhelp.autolabel">
9475 <refentrytitle>htmlhelp.autolabel</refentrytitle>
9476 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
9479 <refname>htmlhelp.autolabel</refname>
9480 <refpurpose>Should tree-like ToC use autonumbering feature?</refpurpose>
9484 <programlisting id="htmlhelp.autolabel.frag">
9485 <xsl:param name="htmlhelp.autolabel" select="0"></xsl:param>
9489 <refsection><info><title>Description</title></info>
9491 <para>Set this to non-zero to include chapter and section numbers into ToC
9492 in the left panel.</para>
9497 <refentry version="5.0" id="htmlhelp.chm">
9499 <refentrytitle>htmlhelp.chm</refentrytitle>
9500 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
9503 <refname>htmlhelp.chm</refname>
9504 <refpurpose>Filename of output HTML Help file.</refpurpose>
9508 <programlisting id="htmlhelp.chm.frag">
9509 <xsl:param name="htmlhelp.chm">htmlhelp.chm</xsl:param>
9513 <refsection><info><title>Description</title></info>
9515 <para>Set the name of resulting CHM file</para>
9520 <refentry version="5.0" id="htmlhelp.default.topic">
9522 <refentrytitle>htmlhelp.default.topic</refentrytitle>
9523 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
9526 <refname>htmlhelp.default.topic</refname>
9527 <refpurpose>Name of file with default topic</refpurpose>
9531 <programlisting id="htmlhelp.default.topic.frag">
9532 <xsl:param name="htmlhelp.default.topic"></xsl:param>
9536 <refsection><info><title>Description</title></info>
9538 <para>Normally first chunk of document is displayed when you open HTML
9539 Help file. If you want to display another topic, simply set its
9540 filename by this parameter.</para>
9542 <para>This is useful especially if you don't generate ToC in front of
9543 your document and you also hide root element in ToC. E.g.:</para>
9545 <programlisting><xsl:param name="generate.book.toc" select="0"/>
9546 <xsl:param name="htmlhelp.hhc.show.root" select="0"/>
9547 <xsl:param name="htmlhelp.default.topic">pr01.html</xsl:param>
9553 <refentry version="5.0" id="htmlhelp.display.progress">
9555 <refentrytitle>htmlhelp.display.progress</refentrytitle>
9556 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
9559 <refname>htmlhelp.display.progress</refname>
9560 <refpurpose>Display compile progress?</refpurpose>
9564 <programlisting id="htmlhelp.display.progress.frag">
9565 <xsl:param name="htmlhelp.display.progress" select="1"></xsl:param>
9569 <refsection><info><title>Description</title></info>
9571 <para>Set to non-zero to to display compile progress
9577 <refentry version="5.0" id="htmlhelp.hhp">
9579 <refentrytitle>htmlhelp.hhp</refentrytitle>
9580 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
9583 <refname>htmlhelp.hhp</refname>
9584 <refpurpose>Filename of project file.</refpurpose>
9588 <programlisting id="htmlhelp.hhp.frag">
9589 <xsl:param name="htmlhelp.hhp">htmlhelp.hhp</xsl:param>
9593 <refsection><info><title>Description</title></info>
9595 <para>Change this parameter if you want different name of project
9596 file than htmlhelp.hhp.</para>
9601 <refentry version="5.0" id="htmlhelp.hhc">
9603 <refentrytitle>htmlhelp.hhc</refentrytitle>
9604 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
9607 <refname>htmlhelp.hhc</refname>
9608 <refpurpose>Filename of TOC file.</refpurpose>
9612 <programlisting id="htmlhelp.hhc.frag">
9613 <xsl:param name="htmlhelp.hhc">toc.hhc</xsl:param>
9617 <refsection><info><title>Description</title></info>
9619 <para>Set the name of the TOC file. The default is <filename>toc.hhc</filename>.</para>
9624 <refentry version="5.0" id="htmlhelp.hhk">
9626 <refentrytitle>htmlhelp.hhk</refentrytitle>
9627 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
9630 <refname>htmlhelp.hhk</refname>
9631 <refpurpose>Filename of index file.</refpurpose>
9635 <programlisting id="htmlhelp.hhk.frag">
9636 <xsl:param name="htmlhelp.hhk">index.hhk</xsl:param>
9640 <refsection><info><title>Description</title></info>
9642 <para>set the name of the index file. The default is <filename>index.hhk</filename>.</para>
9647 <refentry version="5.0" id="htmlhelp.hhp.tail">
9649 <refentrytitle>htmlhelp.hhp.tail</refentrytitle>
9650 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
9653 <refname>htmlhelp.hhp.tail</refname>
9654 <refpurpose>Additional content for project file.</refpurpose>
9658 <programlisting id="htmlhelp.hhp.tail.frag">
9659 <xsl:param name="htmlhelp.hhp.tail"></xsl:param>
9663 <refsection><info><title>Description</title></info>
9665 <para>If you want to include some additional parameters into project file,
9666 store appropriate part of project file into this parameter.</para>
9671 <refentry version="5.0" id="htmlhelp.hhp.window">
9673 <refentrytitle>htmlhelp.hhp.window</refentrytitle>
9674 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
9677 <refname>htmlhelp.hhp.window</refname>
9678 <refpurpose>Name of default window.</refpurpose>
9682 <programlisting id="htmlhelp.hhp.window.frag">
9683 <xsl:param name="htmlhelp.hhp.window">Main</xsl:param>
9687 <refsection><info><title>Description</title></info>
9689 <para>Name of default window. If empty no [WINDOWS] section will be
9690 added to project file.</para>
9695 <refentry version="5.0" id="htmlhelp.hhp.windows">
9697 <refentrytitle>htmlhelp.hhp.windows</refentrytitle>
9698 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
9701 <refname>htmlhelp.hhp.windows</refname>
9702 <refpurpose>Definition of additional windows</refpurpose>
9706 <programlisting id="htmlhelp.hhp.windows.frag">
9707 <xsl:param name="htmlhelp.hhp.windows"></xsl:param>
9711 <refsection><info><title>Description</title></info>
9713 <para>Content of this parameter is placed at the end of [WINDOWS]
9714 section of project file. You can use it for defining your own
9715 addtional windows.</para>
9720 <refentry version="5.0" id="htmlhelp.enhanced.decompilation">
9722 <refentrytitle>htmlhelp.enhanced.decompilation</refentrytitle>
9723 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
9726 <refname>htmlhelp.enhanced.decompilation</refname>
9727 <refpurpose>Allow enhanced decompilation of CHM?</refpurpose>
9731 <programlisting id="htmlhelp.enhanced.decompilation.frag">
9732 <xsl:param name="htmlhelp.enhanced.decompilation" select="0"></xsl:param>
9736 <refsection><info><title>Description</title></info>
9738 <para>When non-zero this parameter enables enhanced decompilation of CHM.</para>
9743 <refentry version="5.0" id="htmlhelp.enumerate.images">
9745 <refentrytitle>htmlhelp.enumerate.images</refentrytitle>
9746 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
9749 <refname>htmlhelp.enumerate.images</refname>
9750 <refpurpose>Should the paths to all used images be added to the project file?</refpurpose>
9754 <programlisting id="htmlhelp.enumerate.images.frag">
9755 <xsl:param name="htmlhelp.enumerate.images" select="0"></xsl:param>
9759 <refsection><info><title>Description</title></info>
9761 <para>Set to non-zero if you insert images into your documents as
9762 external binary entities or if you are using absolute image paths.</para>
9767 <refentry version="5.0" id="htmlhelp.force.map.and.alias">
9769 <refentrytitle>htmlhelp.force.map.and.alias</refentrytitle>
9770 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
9773 <refname>htmlhelp.force.map.and.alias</refname>
9774 <refpurpose>Should [MAP] and [ALIAS] sections be added to the project file unconditionally?</refpurpose>
9777 <programlisting id="htmlhelp.force.map.and.alias.frag">
9778 <xsl:param name="htmlhelp.force.map.and.alias" select="0"></xsl:param>
9781 <refsection><info><title>Description</title></info>
9782 <para>Set to non-zero if you have your own
9783 <literal>alias.h</literal> and <literal>context.h</literal>
9784 files and you want to include references to them in the project
9789 <refentry version="5.0" id="htmlhelp.map.file">
9791 <refentrytitle>htmlhelp.map.file</refentrytitle>
9792 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
9795 <refname>htmlhelp.map.file</refname>
9796 <refpurpose>Filename of map file.</refpurpose>
9799 <programlisting id="htmlhelp.map.file.frag">
9800 <xsl:param name="htmlhelp.map.file">context.h</xsl:param>
9803 <refsection><info><title>Description</title></info>
9804 <para>Set the name of map file. The default is
9805 <filename>context.h</filename>. (used for context-sensitive
9810 <refentry version="5.0" id="htmlhelp.alias.file">
9812 <refentrytitle>htmlhelp.alias.file</refentrytitle>
9813 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
9816 <refname>htmlhelp.alias.file</refname>
9817 <refpurpose>Filename of alias file.</refpurpose>
9821 <programlisting id="htmlhelp.alias.file.frag">
9822 <xsl:param name="htmlhelp.alias.file">alias.h</xsl:param>
9826 <refsection><info><title>Description</title></info>
9828 <para>Specifies the filename of the alias file (used for context-sensitive help).</para>
9833 <refentry version="5.0" id="htmlhelp.hhc.section.depth">
9835 <refentrytitle>htmlhelp.hhc.section.depth</refentrytitle>
9836 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
9839 <refname>htmlhelp.hhc.section.depth</refname>
9840 <refpurpose>Depth of TOC for sections in a left pane.</refpurpose>
9844 <programlisting id="htmlhelp.hhc.section.depth.frag">
9845 <xsl:param name="htmlhelp.hhc.section.depth">5</xsl:param>
9849 <refsection><info><title>Description</title></info>
9851 <para>Set the section depth in the left pane of HTML Help viewer. </para>
9856 <refentry version="5.0" id="htmlhelp.hhc.show.root">
9858 <refentrytitle>htmlhelp.hhc.show.root</refentrytitle>
9859 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
9862 <refname>htmlhelp.hhc.show.root</refname>
9863 <refpurpose>Should there be an entry for the root element in the ToC?</refpurpose>
9867 <programlisting id="htmlhelp.hhc.show.root.frag">
9868 <xsl:param name="htmlhelp.hhc.show.root" select="1"></xsl:param>
9872 <refsection><info><title>Description</title></info>
9874 <para>If set to zero, there will be no entry for the root element in the
9875 ToC. This is useful when you want to provide the user with an expanded
9876 ToC as a default.</para>
9881 <refentry version="5.0" id="htmlhelp.hhc.folders.instead.books">
9883 <refentrytitle>htmlhelp.hhc.folders.instead.books</refentrytitle>
9884 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
9887 <refname>htmlhelp.hhc.folders.instead.books</refname>
9888 <refpurpose>Use folder icons in ToC (instead of book icons)?</refpurpose>
9892 <programlisting id="htmlhelp.hhc.folders.instead.books.frag">
9893 <xsl:param name="htmlhelp.hhc.folders.instead.books" select="1"></xsl:param>
9897 <refsection><info><title>Description</title></info>
9899 <para>Set to non-zero for folder-like icons or zero for book-like icons in the ToC.
9900 If you want to use folder-like icons, you must switch off the binary ToC using
9901 <parameter>htmlhelp.hhc.binary</parameter>.
9908 <refentry version="5.0" id="htmlhelp.hhc.binary">
9910 <refentrytitle>htmlhelp.hhc.binary</refentrytitle>
9911 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
9914 <refname>htmlhelp.hhc.binary</refname>
9915 <refpurpose>Generate binary ToC?</refpurpose>
9919 <programlisting id="htmlhelp.hhc.binary.frag">
9920 <xsl:param name="htmlhelp.hhc.binary" select="1"></xsl:param>
9924 <refsection><info><title>Description</title></info>
9926 <para>Set to non-zero to generate a binary TOC. You must create a binary TOC
9927 if you want to add Prev/Next buttons to toolbar (which is default
9928 behaviour). Files with binary TOC can't be merged.</para>
9933 <refentry version="5.0" id="htmlhelp.hhc.width">
9935 <refentrytitle>htmlhelp.hhc.width</refentrytitle>
9936 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
9939 <refname>htmlhelp.hhc.width</refname>
9940 <refpurpose>Width of navigation pane</refpurpose>
9944 <programlisting id="htmlhelp.hhc.width.frag">
9945 <xsl:param name="htmlhelp.hhc.width"></xsl:param>
9949 <refsection><info><title>Description</title></info>
9951 <para>This parameter specifies the width of the navigation pane (containing TOC and
9952 other navigation tabs) in pixels.</para>
9957 <refentry version="5.0" id="htmlhelp.title">
9959 <refentrytitle>htmlhelp.title</refentrytitle>
9960 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
9963 <refname>htmlhelp.title</refname>
9964 <refpurpose>Title of HTML Help</refpurpose>
9968 <programlisting id="htmlhelp.title.frag">
9969 <xsl:param name="htmlhelp.title"></xsl:param>
9973 <refsection><info><title>Description</title></info>
9975 <para>Content of this parameter will be used as a title for generated
9976 HTML Help. If empty, title will be automatically taken from document.</para>
9981 <refentry version="5.0" id="htmlhelp.show.menu">
9983 <refentrytitle>htmlhelp.show.menu</refentrytitle>
9984 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
9987 <refname>htmlhelp.show.menu</refname>
9988 <refpurpose>Should the menu bar be shown?</refpurpose>
9992 <programlisting id="htmlhelp.show.menu.frag">
9993 <xsl:param name="htmlhelp.show.menu" select="0"></xsl:param>
9997 <refsection><info><title>Description</title></info>
9999 <para>Set to non-zero to have an application menu bar in your HTML Help window.
10005 <refentry version="5.0" id="htmlhelp.show.toolbar.text">
10007 <refentrytitle>htmlhelp.show.toolbar.text</refentrytitle>
10008 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
10011 <refname>htmlhelp.show.toolbar.text</refname>
10012 <refpurpose>Show text under toolbar buttons?</refpurpose>
10016 <programlisting id="htmlhelp.show.toolbar.text.frag">
10017 <xsl:param name="htmlhelp.show.toolbar.text" select="1"></xsl:param>
10021 <refsection><info><title>Description</title></info>
10023 <para>Set to non-zero to display texts under toolbar buttons, zero to switch
10024 off displays.</para>
10029 <refentry version="5.0" id="htmlhelp.show.advanced.search">
10031 <refentrytitle>htmlhelp.show.advanced.search</refentrytitle>
10032 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
10035 <refname>htmlhelp.show.advanced.search</refname>
10036 <refpurpose>Should advanced search features be available?</refpurpose>
10040 <programlisting id="htmlhelp.show.advanced.search.frag">
10041 <xsl:param name="htmlhelp.show.advanced.search" select="0"></xsl:param>
10045 <refsection><info><title>Description</title></info>
10047 <para>If you want advanced search features in your help, turn this
10048 parameter to 1.</para>
10053 <refentry version="5.0" id="htmlhelp.show.favorities">
10055 <refentrytitle>htmlhelp.show.favorities</refentrytitle>
10056 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
10059 <refname>htmlhelp.show.favorities</refname>
10060 <refpurpose>Should the Favorites tab be shown?</refpurpose>
10064 <programlisting id="htmlhelp.show.favorities.frag">
10065 <xsl:param name="htmlhelp.show.favorities" select="0"></xsl:param>
10069 <refsection><info><title>Description</title></info>
10071 <para>Set to non-zero to include a Favorites tab in the navigation pane
10072 of the help window.</para>
10077 <refentry version="5.0" id="htmlhelp.button.hideshow">
10079 <refentrytitle>htmlhelp.button.hideshow</refentrytitle>
10080 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
10083 <refname>htmlhelp.button.hideshow</refname>
10084 <refpurpose>Should the Hide/Show button be shown?</refpurpose>
10088 <programlisting id="htmlhelp.button.hideshow.frag">
10089 <xsl:param name="htmlhelp.button.hideshow" select="1"></xsl:param>
10093 <refsection><info><title>Description</title></info>
10095 <para>Set to non-zero to include the Hide/Show button shown on toolbar</para>
10100 <refentry version="5.0" id="htmlhelp.button.back">
10102 <refentrytitle>htmlhelp.button.back</refentrytitle>
10103 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
10106 <refname>htmlhelp.button.back</refname>
10107 <refpurpose>Should the Back button be shown?</refpurpose>
10111 <programlisting id="htmlhelp.button.back.frag">
10112 <xsl:param name="htmlhelp.button.back" select="1"></xsl:param>
10116 <refsection><info><title>Description</title></info>
10118 <para>Set to non-zero to include the Hide/Show button shown on toolbar</para>
10123 <refentry version="5.0" id="htmlhelp.button.forward">
10125 <refentrytitle>htmlhelp.button.forward</refentrytitle>
10126 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
10129 <refname>htmlhelp.button.forward</refname>
10130 <refpurpose>Should the Forward button be shown?</refpurpose>
10134 <programlisting id="htmlhelp.button.forward.frag">
10135 <xsl:param name="htmlhelp.button.forward" select="0"></xsl:param>
10139 <refsection><info><title>Description</title></info>
10141 <para>Set to non-zero to include the Forward button on the toolbar.</para>
10146 <refentry version="5.0" id="htmlhelp.button.stop">
10148 <refentrytitle>htmlhelp.button.stop</refentrytitle>
10149 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
10152 <refname>htmlhelp.button.stop</refname>
10153 <refpurpose>Should the Stop button be shown?</refpurpose>
10157 <programlisting id="htmlhelp.button.stop.frag">
10158 <xsl:param name="htmlhelp.button.stop" select="0"></xsl:param>
10162 <refsection><info><title>Description</title></info>
10164 <para>If you want Stop button shown on toolbar, turn this
10165 parameter to 1.</para>
10170 <refentry version="5.0" id="htmlhelp.button.refresh">
10172 <refentrytitle>htmlhelp.button.refresh</refentrytitle>
10173 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
10176 <refname>htmlhelp.button.refresh</refname>
10177 <refpurpose>Should the Refresh button be shown?</refpurpose>
10181 <programlisting id="htmlhelp.button.refresh.frag">
10182 <xsl:param name="htmlhelp.button.refresh" select="0"></xsl:param>
10186 <refsection><info><title>Description</title></info>
10188 <para>Set to non-zero to include the Stop button on the toolbar.</para>
10193 <refentry version="5.0" id="htmlhelp.button.home">
10195 <refentrytitle>htmlhelp.button.home</refentrytitle>
10196 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
10199 <refname>htmlhelp.button.home</refname>
10200 <refpurpose>Should the Home button be shown?</refpurpose>
10204 <programlisting id="htmlhelp.button.home.frag">
10205 <xsl:param name="htmlhelp.button.home" select="0"></xsl:param>
10209 <refsection><info><title>Description</title></info>
10211 <para>Set to non-zero to include the Home button on the toolbar.</para>
10216 <refentry version="5.0" id="htmlhelp.button.home.url">
10218 <refentrytitle>htmlhelp.button.home.url</refentrytitle>
10219 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
10222 <refname>htmlhelp.button.home.url</refname>
10223 <refpurpose>URL address of page accessible by Home button</refpurpose>
10227 <programlisting id="htmlhelp.button.home.url.frag">
10228 <xsl:param name="htmlhelp.button.home.url"></xsl:param>
10232 <refsection><info><title>Description</title></info>
10234 <para>URL address of page accessible by Home button.</para>
10239 <refentry version="5.0" id="htmlhelp.button.options">
10241 <refentrytitle>htmlhelp.button.options</refentrytitle>
10242 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
10245 <refname>htmlhelp.button.options</refname>
10246 <refpurpose>Should the Options button be shown?</refpurpose>
10250 <programlisting id="htmlhelp.button.options.frag">
10251 <xsl:param name="htmlhelp.button.options" select="1"></xsl:param>
10255 <refsection><info><title>Description</title></info>
10257 <para>If you want Options button shown on toolbar, turn this
10258 parameter to 1.</para>
10263 <refentry version="5.0" id="htmlhelp.button.print">
10265 <refentrytitle>htmlhelp.button.print</refentrytitle>
10266 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
10269 <refname>htmlhelp.button.print</refname>
10270 <refpurpose>Should the Print button be shown?</refpurpose>
10274 <programlisting id="htmlhelp.button.print.frag">
10275 <xsl:param name="htmlhelp.button.print" select="1"></xsl:param>
10279 <refsection><info><title>Description</title></info>
10281 <para>Set to non-zero to include the Print button on the toolbar.
10287 <refentry version="5.0" id="htmlhelp.button.locate">
10289 <refentrytitle>htmlhelp.button.locate</refentrytitle>
10290 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
10293 <refname>htmlhelp.button.locate</refname>
10294 <refpurpose>Should the Locate button be shown?</refpurpose>
10298 <programlisting id="htmlhelp.button.locate.frag">
10299 <xsl:param name="htmlhelp.button.locate" select="0"></xsl:param>
10303 <refsection><info><title>Description</title></info>
10305 <para>If you want Locate button shown on toolbar, turn this
10306 parameter to 1.</para>
10311 <refentry version="5.0" id="htmlhelp.button.jump1">
10313 <refentrytitle>htmlhelp.button.jump1</refentrytitle>
10314 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
10317 <refname>htmlhelp.button.jump1</refname>
10318 <refpurpose>Should the Jump1 button be shown?</refpurpose>
10321 <programlisting id="htmlhelp.button.jump1.frag">
10322 <xsl:param name="htmlhelp.button.jump1" select="0"></xsl:param>
10325 <refsection><info><title>Description</title></info>
10326 <para>Set to non-zero to include the <literal>Jump1</literal> button on the toolbar.</para>
10330 <refentry version="5.0" id="htmlhelp.button.jump1.url">
10332 <refentrytitle>htmlhelp.button.jump1.url</refentrytitle>
10333 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
10336 <refname>htmlhelp.button.jump1.url</refname>
10337 <refpurpose>URL address of page accessible by Jump1 button</refpurpose>
10341 <programlisting id="htmlhelp.button.jump1.url.frag">
10342 <xsl:param name="htmlhelp.button.jump1.url"></xsl:param>
10346 <refsection><info><title>Description</title></info>
10348 <para>URL address of page accessible by Jump1 button.</para>
10353 <refentry version="5.0" id="htmlhelp.button.jump1.title">
10355 <refentrytitle>htmlhelp.button.jump1.title</refentrytitle>
10356 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
10359 <refname>htmlhelp.button.jump1.title</refname>
10360 <refpurpose>Title of Jump1 button</refpurpose>
10364 <programlisting id="htmlhelp.button.jump1.title.frag">
10365 <xsl:param name="htmlhelp.button.jump1.title">User1</xsl:param>
10369 <refsection><info><title>Description</title></info>
10371 <para>Title of Jump1 button.</para>
10376 <refentry version="5.0" id="htmlhelp.button.jump2">
10378 <refentrytitle>htmlhelp.button.jump2</refentrytitle>
10379 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
10382 <refname>htmlhelp.button.jump2</refname>
10383 <refpurpose>Should the Jump2 button be shown?</refpurpose>
10387 <programlisting id="htmlhelp.button.jump2.frag">
10388 <xsl:param name="htmlhelp.button.jump2" select="0"></xsl:param>
10392 <refsection><info><title>Description</title></info>
10394 <para>Set to non-zero to include the Jump2 button on the toolbar.</para>
10399 <refentry version="5.0" id="htmlhelp.button.jump2.url">
10401 <refentrytitle>htmlhelp.button.jump2.url</refentrytitle>
10402 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
10405 <refname>htmlhelp.button.jump2.url</refname>
10406 <refpurpose>URL address of page accessible by Jump2 button</refpurpose>
10410 <programlisting id="htmlhelp.button.jump2.url.frag">
10411 <xsl:param name="htmlhelp.button.jump2.url"></xsl:param>
10415 <refsection><info><title>Description</title></info>
10417 <para>URL address of page accessible by Jump2 button.</para>
10422 <refentry version="5.0" id="htmlhelp.button.jump2.title">
10424 <refentrytitle>htmlhelp.button.jump2.title</refentrytitle>
10425 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
10428 <refname>htmlhelp.button.jump2.title</refname>
10429 <refpurpose>Title of Jump2 button</refpurpose>
10433 <programlisting id="htmlhelp.button.jump2.title.frag">
10434 <xsl:param name="htmlhelp.button.jump2.title">User2</xsl:param>
10438 <refsection><info><title>Description</title></info>
10440 <para>Title of Jump2 button.</para>
10445 <refentry version="5.0" id="htmlhelp.button.next">
10447 <refentrytitle>htmlhelp.button.next</refentrytitle>
10448 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
10451 <refname>htmlhelp.button.next</refname>
10452 <refpurpose>Should the Next button be shown?</refpurpose>
10456 <programlisting id="htmlhelp.button.next.frag">
10457 <xsl:param name="htmlhelp.button.next" select="1"></xsl:param>
10461 <refsection><info><title>Description</title></info>
10463 <para>Set to non-zero to include the Next button on the toolbar.</para>
10468 <refentry version="5.0" id="htmlhelp.button.prev">
10470 <refentrytitle>htmlhelp.button.prev</refentrytitle>
10471 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
10474 <refname>htmlhelp.button.prev</refname>
10475 <refpurpose>Should the Prev button be shown?</refpurpose>
10479 <programlisting id="htmlhelp.button.prev.frag">
10480 <xsl:param name="htmlhelp.button.prev" select="1"></xsl:param>
10484 <refsection><info><title>Description</title></info>
10486 <para>Set to non-zero to include the Prev button on the toolbar.
10492 <refentry version="5.0" id="htmlhelp.button.zoom">
10494 <refentrytitle>htmlhelp.button.zoom</refentrytitle>
10495 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
10498 <refname>htmlhelp.button.zoom</refname>
10499 <refpurpose>Should the Zoom button be shown?</refpurpose>
10503 <programlisting id="htmlhelp.button.zoom.frag">
10504 <xsl:param name="htmlhelp.button.zoom" select="0"></xsl:param>
10508 <refsection><info><title>Description</title></info>
10510 <para>Set to non-zero to include the Zoom button on the toolbar.
10516 <refentry version="5.0" id="htmlhelp.remember.window.position">
10518 <refentrytitle>htmlhelp.remember.window.position</refentrytitle>
10519 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
10522 <refname>htmlhelp.remember.window.position</refname>
10523 <refpurpose>Remember help window position?</refpurpose>
10527 <programlisting id="htmlhelp.remember.window.position.frag">
10528 <xsl:param name="htmlhelp.remember.window.position" select="0"></xsl:param>
10532 <refsection><info><title>Description</title></info>
10534 <para>Set to non-zero to remember help window position between starts.</para>
10539 <refentry version="5.0" id="htmlhelp.window.geometry">
10541 <refentrytitle>htmlhelp.window.geometry</refentrytitle>
10542 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
10545 <refname>htmlhelp.window.geometry</refname>
10546 <refpurpose>Set initial geometry of help window</refpurpose>
10550 <programlisting id="htmlhelp.window.geometry.frag">
10551 <xsl:param name="htmlhelp.window.geometry"></xsl:param>
10555 <refsection><info><title>Description</title></info>
10557 <para>This parameter specifies initial position of help
10558 window. E.g.</para>
10560 <programlisting><xsl:param name="htmlhelp.window.geometry">[160,64,992,704]</xsl:param></programlisting>
10565 <refentry version="5.0" id="htmlhelp.use.hhk">
10567 <refentrytitle>htmlhelp.use.hhk</refentrytitle>
10568 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
10571 <refname>htmlhelp.use.hhk</refname>
10572 <refpurpose>Should the index be built using the HHK file?</refpurpose>
10576 <programlisting id="htmlhelp.use.hhk.frag">
10577 <xsl:param name="htmlhelp.use.hhk" select="0"></xsl:param>
10581 <refsection><info><title>Description</title></info>
10583 <para>If non-zero, the index is created using the HHK file (instead of using <tag role="html">object</tag>
10584 elements in the HTML files). For more information, see <link role="tcg" xlink:href="HtmlHelp.html#HHGenIndex">Generating an index</link>.</para>
10588 <refentry version="5.0" id="htmlhelp.only">
10590 <refentrytitle>htmlhelp.only</refentrytitle>
10591 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
10594 <refname>htmlhelp.only</refname>
10595 <refpurpose>Should only project files be generated?</refpurpose>
10599 <programlisting id="htmlhelp.only.frag">
10600 <xsl:param name="htmlhelp.only" select="0"></xsl:param>
10604 <refsection><info><title>Description</title></info>
10607 <para>Set to non-zero if you want to play with various HTML Help parameters
10608 and you don't need to regenerate all HTML files. This setting will not
10609 process whole document, only project files (hhp, hhc, hhk,...) will be
10616 </reference><reference id="eclipse_help" xml:base="../html/param.xml"><title>Eclipse Help Platform</title>
10617 <refentry version="5.0" id="eclipse.autolabel">
10619 <refentrytitle>eclipse.autolabel</refentrytitle>
10620 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
10623 <refname>eclipse.autolabel</refname>
10624 <refpurpose>Should tree-like ToC use autonumbering feature?</refpurpose>
10628 <programlisting id="eclipse.autolabel.frag">
10629 <xsl:param name="eclipse.autolabel" select="0"></xsl:param>
10633 <refsection><info><title>Description</title></info>
10635 <para>If you want to include chapter and section numbers into ToC in
10636 the left panel, set this parameter to 1.</para>
10641 <refentry version="5.0" id="eclipse.plugin.name">
10643 <refentrytitle>eclipse.plugin.name</refentrytitle>
10644 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
10647 <refname>eclipse.plugin.name</refname>
10648 <refpurpose>Eclipse Help plugin name</refpurpose>
10652 <programlisting id="eclipse.plugin.name.frag">
10653 <xsl:param name="eclipse.plugin.name">DocBook Online Help Sample</xsl:param>
10657 <refsection><info><title>Description</title></info>
10659 <para>Eclipse Help plugin name.</para>
10664 <refentry version="5.0" id="eclipse.plugin.id">
10666 <refentrytitle>eclipse.plugin.id</refentrytitle>
10667 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
10670 <refname>eclipse.plugin.id</refname>
10671 <refpurpose>Eclipse Help plugin id</refpurpose>
10675 <programlisting id="eclipse.plugin.id.frag">
10676 <xsl:param name="eclipse.plugin.id">com.example.help</xsl:param>
10680 <refsection><info><title>Description</title></info>
10682 <para>Eclipse Help plugin id. You should change this id to something
10683 unique for each help.</para>
10688 <refentry version="5.0" id="eclipse.plugin.provider">
10690 <refentrytitle>eclipse.plugin.provider</refentrytitle>
10691 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
10694 <refname>eclipse.plugin.provider</refname>
10695 <refpurpose>Eclipse Help plugin provider name</refpurpose>
10699 <programlisting id="eclipse.plugin.provider.frag">
10700 <xsl:param name="eclipse.plugin.provider">Example provider</xsl:param>
10704 <refsection><info><title>Description</title></info>
10706 <para>Eclipse Help plugin provider name.</para>
10711 </reference><reference id="webhelp" xml:base="../html/param.xml"><title>WebHelp</title>
10712 <refentry version="5.0" id="webhelp.autolabel">
10714 <refentrytitle>webhelp.autolabel</refentrytitle>
10715 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
10718 <refname>webhelp.autolabel</refname>
10719 <refpurpose>Should tree-like ToC use autonumbering feature?</refpurpose>
10723 <programlisting id="webhelp.autolabel.frag">
10724 <xsl:param name="webhelp.autolabel">0</xsl:param>
10728 <refsection><info><title>Description</title></info>
10729 <para>To include chapter and section numbers the table of contents pane, set this parameter to 1.</para>
10733 <refentry version="5.0" id="webhelp.base.dir">
10735 <refentrytitle>webhelp.base.dir</refentrytitle>
10736 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
10739 <refname>webhelp.base.dir</refname>
10740 <refpurpose>The base directory for webhelp output.</refpurpose>
10744 <programlisting id="webhelp.base.dir.frag">
10745 <xsl:param name="webhelp.base.dir">docs</xsl:param>
10749 <refsection><info><title>Description</title></info>
10750 <para>If specified, the <parameter>webhelp.base.dir</parameter>
10751 parameter identifies the output directory for webhelp. (If not
10752 specified, the output directory is system dependent.) By default, this
10753 parameter is set to <filename>docs</filename>.</para>
10758 <refentry version="5.0" id="webhelp.common.dir">
10760 <refentrytitle>webhelp.common.dir</refentrytitle>
10761 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
10764 <refname>webhelp.common.dir</refname>
10765 <refpurpose>Path to the directory for the common webhelp resources (JavaScript, css, common images, etc).</refpurpose>
10769 <programlisting id="webhelp.common.dir.frag">
10770 <xsl:param name="webhelp.common.dir">../common/</xsl:param>
10774 <refsection><info><title>Description</title></info>
10775 <para>By default, webhelp creates a common directory containing resources such as JavaScript files, css, common images, etc. In some cases you may prefer to store these files in a standard location on your site and point all webhelp documents to that location. You can use this parameter to control the urls written to these common resources. For example, you might set this parameter to <code>/common</code> and create a single common directory at the root of your web server. </para>
10779 <refentry version="5.0" id="webhelp.default.topic">
10781 <refentrytitle>webhelp.default.topic</refentrytitle>
10782 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
10785 <refname>webhelp.default.topic</refname>
10786 <refpurpose>The name of the file to which the start file in the webhelp base directory redirects</refpurpose>
10790 <programlisting id="webhelp.default.topic.frag">
10791 <xsl:param name="webhelp.default.topic">index.html</xsl:param>
10795 <refsection><info><title>Description</title></info>
10796 <para>Currently webhelp creates a base directory and puts the output
10797 files in a <filename>content</filename> subdirectory. It creates a
10798 file in the base directory that redirects to a configured file in the
10799 <filename>content</filename> directory. The
10800 <parameter>webhelp.default.topic</parameter> parameter lets you
10801 configure the name of the file that is redirected to.
10803 <para>This parameter will be removed from a future version of
10804 webhelp along with the <filename>content</filename>
10811 <refentry version="5.0" id="webhelp.include.search.tab">
10813 <refentrytitle>webhelp.include.search.tab</refentrytitle>
10814 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
10817 <refname>webhelp.include.search.tab</refname>
10818 <refpurpose>Should the webhelp output include a Search tab?</refpurpose>
10822 <programlisting id="webhelp.include.search.tab.frag">
10823 <xsl:param name="webhelp.include.search.tab">1</xsl:param>
10827 <refsection><info><title>Description</title></info>
10828 <para>Set this parameter to 0 to suppress the search tab from webhelp output.</para>
10832 <refentry version="5.0" id="webhelp.indexer.language">
10834 <refentrytitle>webhelp.indexer.language</refentrytitle>
10835 <refmiscinfo class="other" otherclass="datatype"/>
10838 <refname>webhelp.indexer.language</refname>
10839 <refpurpose>The language to use for creating the webhelp search index.</refpurpose>
10843 <programlisting id="webhelp.indexer.language.frag">
10844 <xsl:param name="webhelp.indexer.language">en</xsl:param>
10848 <refsection><info><title>Description</title></info>
10849 <para>To support stemming in the client-side webhelp stemmer, you must provide the language code. By default, the following languages are supported:
10852 <para><code>en</code>: English</para>
10855 <para><code>de</code>: German</para>
10858 <para><code>fr</code>: French</para>
10861 <para><code>zh</code>: Chinese</para>
10864 <para><code>ja</code>: Japanese</para>
10867 <para><code>ko</code>: Korean</para>
10870 See the webhelp documentation for information on adding support for additional languages.
10875 <refentry version="5.0" id="webhelp.start.filename">
10877 <refentrytitle>webhelp.start.filename</refentrytitle>
10878 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
10881 <refname>webhelp.start.filename</refname>
10882 <refpurpose>The name of the start file in the webhelp base directory.</refpurpose>
10886 <programlisting id="webhelp.start.filename.frag">
10887 <xsl:param name="webhelp.start.filename">index.html</xsl:param>
10891 <refsection><info><title>Description</title></info>
10892 <para>Currently webhelp creates a base directory and puts the output
10893 files in a <filename>content</filename> subdirectory. It creates a
10894 file in the base directory that redirects to a configured file in the
10895 <filename>content</filename> directory. The <parameter>webhelp.start.filename</parameter> parameter lets you configure the name of the redirect file.
10897 <para>This parameter will be removed from a future version of
10898 webhelp along with the <filename>content</filename>
10905 <refentry version="5.0" id="webhelp.tree.cookie.id">
10907 <refentrytitle>webhelp.tree.cookie.id</refentrytitle>
10908 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
10911 <refname>webhelp.tree.cookie.id</refname>
10912 <refpurpose>Controls how the cookie that stores the webhelp toc state is named.</refpurpose>
10916 <programlisting id="webhelp.tree.cookie.id.frag">
10917 <xsl:param name="webhelp.tree.cookie.id" select="concat( 'treeview-', count(//node()) )"></xsl:param>
10921 <refsection><info><title>Description</title></info>
10922 <para>The webhelp output does not use a frameset. Instead, the table of contents is a div on each page. To preserve the state of the table of contents as the user navigates from page to page, webhelp stores the state in a cookie and reads that cookie when you get to the next page. If you've published several webhelp documents on the same domain, it is important that each cookie have a unique id. In lieu of calling on a GUID generator, by default this parameter is just set to the number of nodes in the document on the assumption that it is unlikely that you will have more than one document with the exact number of nodes. A more optimal solution would be for the user to pass in some unique, stable identifier from the build system to use as the webhelp cookie id. For example, if you have safeguards in place to ensure that the xml:id of the root element of each document will be unique on your site, then you could set webhelptree.cookie.id as follows:
10924 <xsl:param name="webhelp.tree.cookie.id">
10926 <xsl:when test="/*/@xml:id">
10927 <xsl:value-of select="concat('treeview-',/*/@xml:id)"/>
10929 <xsl:otherwise>
10930 <xsl:value-of select="concat( 'treeview-', count(//node()) )"/>
10931 </xsl:otherwise>
10932 </xsl:choose>
10939 </reference><reference id="javahelp" xml:base="../html/param.xml"><title>JavaHelp</title>
10940 <refentry version="5.0" id="javahelp.encoding">
10942 <refentrytitle>javahelp.encoding</refentrytitle>
10943 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
10946 <refname>javahelp.encoding</refname>
10947 <refpurpose>Character encoding to use in control files for JavaHelp.</refpurpose>
10951 <programlisting id="javahelp.encoding.frag">
10952 <xsl:param name="javahelp.encoding">iso-8859-1</xsl:param>
10956 <refsection><info><title>Description</title></info>
10958 <para>JavaHelp crashes on some characters when written as character
10959 references. In that case you can use this parameter to select an appropriate encoding.</para>
10967 </reference><reference id="l10n" xml:base="../html/param.xml"><title>Localization</title>
10968 <refentry version="5.0" id="l10n.gentext.language">
10970 <refentrytitle>l10n.gentext.language</refentrytitle>
10971 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
10974 <refname>l10n.gentext.language</refname>
10975 <refpurpose>Sets the gentext language</refpurpose>
10979 <programlisting id="l10n.gentext.language.frag">
10980 <xsl:param name="l10n.gentext.language"></xsl:param>
10984 <refsection><info><title>Description</title></info>
10986 <para>If this parameter is set to any value other than the empty string, its
10987 value will be used as the value for the language when generating text. Setting
10988 <parameter>l10n.gentext.language</parameter> overrides any settings within the
10989 document being formatted.</para>
10991 <para>It's much more likely that you might want to set the
10992 <parameter>l10n.gentext.default.language</parameter> parameter.</para>
10997 <refentry version="5.0" id="l10n.gentext.default.language">
10999 <refentrytitle>l10n.gentext.default.language</refentrytitle>
11000 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
11003 <refname>l10n.gentext.default.language</refname>
11004 <refpurpose>Sets the default language for generated text</refpurpose>
11008 <programlisting id="l10n.gentext.default.language.frag">
11009 <xsl:param name="l10n.gentext.default.language">en</xsl:param>
11013 <refsection><info><title>Description</title></info>
11015 <para>The value of the <parameter>l10n.gentext.default.language</parameter>
11016 parameter is used as the language for generated text if no setting is provided
11017 in the source document.</para>
11022 <refentry version="5.0" id="l10n.gentext.use.xref.language">
11024 <refentrytitle>l10n.gentext.use.xref.language</refentrytitle>
11025 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
11028 <refname>l10n.gentext.use.xref.language</refname>
11029 <refpurpose>Use the language of target when generating cross-reference text?</refpurpose>
11033 <programlisting id="l10n.gentext.use.xref.language.frag">
11034 <xsl:param name="l10n.gentext.use.xref.language" select="0"></xsl:param>
11038 <refsection><info><title>Description</title></info>
11040 <para>If non-zero, the language of the target will be used when
11041 generating cross reference text. Usually, the <quote>current</quote>
11042 language is used when generating text (that is, the language of the
11043 element that contains the cross-reference element). But setting this parameter
11044 allows the language of the element <emphasis>pointed to</emphasis> to control
11045 the generated text.</para>
11047 <para>Consider the following example:</para>
11050 <programlisting><para lang="en">See also <xref linkend="chap3"/>.</para>
11054 <para>Suppose that Chapter 3 happens to be written in German.
11055 If <parameter>l10n.gentext.use.xref.language</parameter> is non-zero, the
11056 resulting text will be something like this:</para>
11059 <para>See also Kapital 3.</para>
11062 <para>Where the more traditional rendering would be:</para>
11065 <para>See also Chapter 3.</para>
11071 <refentry version="5.0" id="l10n.lang.value.rfc.compliant">
11073 <refentrytitle>l10n.lang.value.rfc.compliant</refentrytitle>
11074 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
11077 <refname>l10n.lang.value.rfc.compliant</refname>
11078 <refpurpose>Make value of lang attribute RFC compliant?</refpurpose>
11082 <programlisting id="l10n.lang.value.rfc.compliant.frag">
11083 <xsl:param name="l10n.lang.value.rfc.compliant" select="1"></xsl:param>
11087 <refsection><info><title>Description</title></info>
11089 <para>If non-zero, ensure that the values for all <tag class="attribute">lang</tag> attributes in HTML output are RFC
11090 compliant<footnote><para>Section 8.1.1, <link 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:
11092 <blockquote><para>[RFC1766] defines and explains the language codes
11093 that must be used in HTML documents.</para>
11094 <para>Briefly, language codes consist of a primary code and a possibly
11095 empty series of subcodes:
11097 <literallayout class="monospaced">language-code = primary-code ( "-" subcode )*</literallayout>
11099 <para>And in RFC 1766, <link xlink:href="http://www.ietf.org/rfc/rfc1766.txt">Tags for the Identification
11100 of Languages</link>, the EBNF for "language tag" is given as:
11102 <literallayout class="monospaced">Language-Tag = Primary-tag *( "-" Subtag )
11103 Primary-tag = 1*8ALPHA
11104 Subtag = 1*8ALPHA</literallayout>
11107 </para></footnote>.
11109 by taking any underscore characters in any <tag class="attribute">lang</tag> values found in source documents, and
11110 replacing them with hyphen characters in output HTML files. For
11111 example, <literal>zh_CN</literal> in a source document becomes
11112 <literal>zh-CN</literal> in the HTML output form that source.
11115 <para>This parameter does not cause any case change in <tag class="attribute">lang</tag> values, because RFC 1766
11116 explicitly states that all "language tags" (as it calls them) "are
11117 to be treated as case insensitive".</para>
11124 <refentry version="5.0" id="writing.mode">
11126 <refentrytitle>writing.mode</refentrytitle>
11127 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
11130 <refname>writing.mode</refname>
11131 <refpurpose>Direction of text flow based on locale</refpurpose>
11135 <programlisting id="writing.mode.frag">
11136 <xsl:param name="writing.mode">
11137 <xsl:call-template name="gentext">
11138 <xsl:with-param name="key">writing-mode</xsl:with-param>
11139 <xsl:with-param name="lang">
11140 <xsl:call-template name="l10n.language">
11141 <xsl:with-param name="target" select="/*[1]"></xsl:with-param>
11142 </xsl:call-template>
11143 </xsl:with-param>
11144 </xsl:call-template>
11149 <refsection><info><title>Description</title></info>
11151 <para>Sets direction of text flow and text alignment based on locale.
11152 The value is normally taken from the gentext file for the
11153 lang attribute of the document's root element, using the
11154 key name 'writing-mode' to look it up in the gentext file.
11155 But this param can also be
11156 set on the command line to override that gentext value.
11158 <para>Accepted values are:
11163 <para>Left-to-right text flow in each line, lines stack top to bottom.</para>
11169 <para>Right-to-left text flow in each line, lines stack top to bottom.</para>
11175 <para>Top-to-bottom text flow in each vertical line, lines stack right to left.
11176 Supported by only a few XSL-FO processors. Not supported in HTML output.</para>
11182 <para>Shorthand for lr-tb.</para>
11188 <para>Shorthand for rl-tb.</para>
11194 <para>Shorthand for tb-rl.</para>
11206 <?dbhtml dir="fo"?>
11207 <?dbhtml filename="index.html"?>
11208 <title xml:base="../fo/param.xml">FO Parameter Reference</title>
11209 <partintro id="fointro">
11211 <para xml:base="../fo/param.xml">This is reference documentation for all user-configurable
11212 parameters in the DocBook XSL FO stylesheets (for generating
11213 XSL-FO output destined for final print/PDF output).</para>
11216 <reference id="admons" xml:base="../fo/param.xml"><title>Admonitions</title>
11217 <refentry version="5.0" id="admon.graphics">
11219 <refentrytitle>admon.graphics</refentrytitle>
11220 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
11223 <refname>admon.graphics</refname>
11224 <refpurpose>Use graphics in admonitions?</refpurpose>
11228 <programlisting id="admon.graphics.frag">
11229 <xsl:param name="admon.graphics" select="0"></xsl:param>
11233 <refsection><info><title>Description</title></info>
11235 <para>If true (non-zero), admonitions are presented in an alternate style that uses
11236 a graphic. Default graphics are provided in the distribution.
11242 <refentry version="5.0" id="admon.graphics.extension">
11244 <refentrytitle>admon.graphics.extension</refentrytitle>
11245 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
11248 <refname>admon.graphics.extension</refname>
11249 <refpurpose>Filename extension for admonition graphics</refpurpose>
11253 <programlisting id="admon.graphics.extension.frag">
11254 <xsl:param name="admon.graphics.extension">.png</xsl:param>
11258 <refsection><info><title>Description</title></info>
11260 <para>Sets the filename extension to use on admonition graphics.</para>
11263 <para>The DocBook XSL distribution provides admonition graphics in the following formats:</para>
11264 <listitem><para>GIF (extension: <filename class="extension">.gif</filename>)</para></listitem>
11265 <listitem><para>PNG (extension: <filename class="extension">.png</filename>)</para></listitem>
11266 <listitem><para>SVG (extension: <filename class="extension">.svg</filename>)</para></listitem>
11267 <listitem><para>TIFF (extension: <filename class="extension">.tif</filename>)</para></listitem>
11273 <refentry version="5.0" id="admon.graphics.path">
11275 <refentrytitle>admon.graphics.path</refentrytitle>
11276 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
11279 <refname>admon.graphics.path</refname>
11280 <refpurpose>Path to admonition graphics</refpurpose>
11284 <programlisting id="admon.graphics.path.frag"><xsl:param name="admon.graphics.path">images/</xsl:param></programlisting>
11287 <refsection><info><title>Description</title></info>
11289 <para>Sets the path to the directory containing the admonition graphics
11290 (caution.png, important.png etc). This location is normally relative
11291 to the output html directory. See <parameter>base.dir</parameter></para>
11296 <refentry version="5.0" id="admon.textlabel">
11298 <refentrytitle>admon.textlabel</refentrytitle>
11299 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
11302 <refname>admon.textlabel</refname>
11303 <refpurpose>Use text label in admonitions?</refpurpose>
11307 <programlisting id="admon.textlabel.frag">
11308 <xsl:param name="admon.textlabel" select="1"></xsl:param>
11312 <refsection><info><title>Description</title></info>
11314 <para>If true (non-zero), admonitions are presented with a generated
11315 text label such as Note or Warning in the appropriate language.
11316 If zero, such labels are turned off, but any title child
11317 of the admonition element are still output.
11318 The default value is 1.
11324 <refentry version="5.0" id="admonition.title.properties">
11327 <refentrytitle>admonition.title.properties</refentrytitle>
11328 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
11331 <refname>admonition.title.properties</refname>
11332 <refpurpose>To set the style for admonitions titles.</refpurpose>
11336 <programlisting id="admonition.title.properties.frag">
11337 <xsl:attribute-set name="admonition.title.properties">
11338 <xsl:attribute name="font-size">14pt</xsl:attribute>
11339 <xsl:attribute name="font-weight">bold</xsl:attribute>
11340 <xsl:attribute name="hyphenate">false</xsl:attribute>
11341 <xsl:attribute name="keep-with-next.within-column">always</xsl:attribute>
11342 </xsl:attribute-set>
11345 <refsection><info><title>Description</title></info>
11346 <para>How do you want admonitions titles styled? </para>
11347 <para>Set the font-size, weight etc to the style required.</para>
11352 <refentry version="5.0" id="admonition.properties">
11354 <refentrytitle>admonition.properties</refentrytitle>
11355 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
11358 <refname>admonition.properties</refname>
11359 <refpurpose>To set the style for admonitions.</refpurpose>
11363 <programlisting id="admonition.properties.frag"><xsl:attribute-set name="admonition.properties"></xsl:attribute-set>
11366 <refsection><info><title>Description</title></info>
11367 <para>How do you want admonitions styled? </para>
11368 <para>Set the font-size, weight, etc. to the style required</para>
11373 <refentry version="5.0" id="graphical.admonition.properties">
11375 <refentrytitle>graphical.admonition.properties</refentrytitle>
11376 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
11379 <refname>graphical.admonition.properties</refname>
11380 <refpurpose>To add properties to the outer block of a graphical admonition.</refpurpose>
11384 <programlisting id="graphical.admonition.properties.frag"><xsl:attribute-set name="graphical.admonition.properties">
11385 <xsl:attribute name="space-before.optimum">1em</xsl:attribute>
11386 <xsl:attribute name="space-before.minimum">0.8em</xsl:attribute>
11387 <xsl:attribute name="space-before.maximum">1.2em</xsl:attribute>
11388 <xsl:attribute name="space-after.optimum">1em</xsl:attribute>
11389 <xsl:attribute name="space-after.minimum">0.8em</xsl:attribute>
11390 <xsl:attribute name="space-after.maximum">1.2em</xsl:attribute>
11391 </xsl:attribute-set>
11394 <refsection><info><title>Description</title></info>
11395 <para>These properties are added to the outer block containing the
11396 entire graphical admonition, including its title.
11397 It is used when the parameter
11398 <parameter>admon.graphics</parameter> is set to nonzero.
11399 Use this attribute-set to set the space above and below,
11400 and any indent for the whole admonition.</para>
11402 <para>In addition to these properties, a graphical admonition
11403 also applies the <parameter>admonition.title.properties</parameter>
11404 attribute-set to the title, and applies the
11405 <parameter>admonition.properties</parameter> attribute-set
11406 to the rest of the content.</para>
11411 <refentry version="5.0" id="nongraphical.admonition.properties">
11413 <refentrytitle>nongraphical.admonition.properties</refentrytitle>
11414 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
11417 <refname>nongraphical.admonition.properties</refname>
11418 <refpurpose>To add properties to the outer block of a nongraphical admonition.</refpurpose>
11422 <programlisting id="nongraphical.admonition.properties.frag"><xsl:attribute-set name="nongraphical.admonition.properties">
11423 <xsl:attribute name="space-before.minimum">0.8em</xsl:attribute>
11424 <xsl:attribute name="space-before.optimum">1em</xsl:attribute>
11425 <xsl:attribute name="space-before.maximum">1.2em</xsl:attribute>
11426 <xsl:attribute name="margin-{$direction.align.start}">0.25in</xsl:attribute>
11427 <xsl:attribute name="margin-{$direction.align.end}">0.25in</xsl:attribute>
11428 </xsl:attribute-set>
11431 <refsection><info><title>Description</title></info>
11432 <para>These properties are added to the outer block containing the
11433 entire nongraphical admonition, including its title.
11434 It is used when the parameter
11435 <parameter>admon.graphics</parameter> is set to zero.
11436 Use this attribute-set to set the space above and below,
11437 and any indent for the whole admonition.</para>
11439 <para>In addition to these properties, a nongraphical admonition
11440 also applies the <parameter>admonition.title.properties</parameter>
11441 attribute-set to the title, and the
11442 <parameter>admonition.properties</parameter> attribute-set
11443 to the rest of the content.</para>
11448 </reference><reference id="callouts" xml:base="../fo/param.xml"><title>Callouts</title>
11449 <refentry version="5.0" id="calloutlist.properties">
11451 <refentrytitle>calloutlist.properties</refentrytitle>
11452 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
11455 <refname>calloutlist.properties</refname>
11456 <refpurpose>Properties that apply to each list-block generated by calloutlist.</refpurpose>
11460 <programlisting id="calloutlist.properties.frag"><xsl:attribute-set name="calloutlist.properties">
11461 <xsl:attribute name="space-before.optimum">1em</xsl:attribute>
11462 <xsl:attribute name="space-before.minimum">0.8em</xsl:attribute>
11463 <xsl:attribute name="space-before.maximum">1.2em</xsl:attribute>
11464 <xsl:attribute name="provisional-distance-between-starts">2.2em</xsl:attribute>
11465 <xsl:attribute name="provisional-label-separation">0.2em</xsl:attribute>
11466 </xsl:attribute-set></programlisting>
11468 <refsection><info><title>Description</title></info>
11469 <para>Properties that apply to the fo:list-block generated by calloutlist.
11470 Typically used to adjust spacing or margins of the entire list.
11471 Change the <literal>provisional-distance-between-starts</literal> attribute to
11472 change the indent of the list paragraphs relative to the
11473 callout numbers.</para>
11477 <refentry version="5.0" id="callout.properties">
11479 <refentrytitle>callout.properties</refentrytitle>
11480 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
11483 <refname>callout.properties</refname>
11484 <refpurpose>Properties that apply to the list-item generated by each callout within a calloutlist.</refpurpose>
11488 <programlisting id="callout.properties.frag"><xsl:attribute-set name="callout.properties">
11489 </xsl:attribute-set></programlisting>
11491 <refsection><info><title>Description</title></info>
11492 <para>Properties that apply to the fo:list-item generated by each callout within a calloutlist. Typically used to add spacing properties.</para>
11496 <refentry version="5.0" id="callout.defaultcolumn">
11498 <refentrytitle>callout.defaultcolumn</refentrytitle>
11499 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
11502 <refname>callout.defaultcolumn</refname>
11503 <refpurpose>Indicates what column callouts appear in by default</refpurpose>
11507 <programlisting id="callout.defaultcolumn.frag">
11508 <xsl:param name="callout.defaultcolumn">60</xsl:param>
11512 <refsection><info><title>Description</title></info>
11514 <para>If a callout does not identify a column (for example, if it uses
11515 the <literal>linerange</literal> <tag class="attribute">unit</tag>),
11516 it will appear in the default column.
11522 <refentry version="5.0" id="callout.graphics">
11524 <refentrytitle>callout.graphics</refentrytitle>
11525 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
11528 <refname>callout.graphics</refname>
11529 <refpurpose>Use graphics for callouts?</refpurpose>
11533 <programlisting id="callout.graphics.frag">
11534 <xsl:param name="callout.graphics" select="1"></xsl:param>
11538 <refsection><info><title>Description</title></info>
11540 <para>If non-zero, callouts are presented with graphics (e.g., reverse-video
11541 circled numbers instead of "(1)", "(2)", etc.).
11542 Default graphics are provided in the distribution.
11548 <refentry version="5.0" id="callout.graphics.extension">
11550 <refentrytitle>callout.graphics.extension</refentrytitle>
11551 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
11554 <refname>callout.graphics.extension</refname>
11555 <refpurpose>Filename extension for callout graphics</refpurpose>
11559 <programlisting id="callout.graphics.extension.frag">
11561 <xsl:param name="callout.graphics.extension">.svg</xsl:param>
11565 <refsection><info><title>Description</title></info>
11566 <para>Sets the filename extension to use on callout graphics. </para>
11569 <para>The Docbook XSL distribution provides callout graphics in the following formats:</para>
11570 <listitem><para>SVG (extension: <filename class="extension">.svg</filename>)</para></listitem>
11571 <listitem><para>PNG (extension: <filename class="extension">.png</filename>)</para></listitem>
11572 <listitem><para>GIF (extension: <filename class="extension">.gif</filename>)</para></listitem>
11577 <refentry version="5.0" id="callout.graphics.number.limit">
11579 <refentrytitle>callout.graphics.number.limit</refentrytitle>
11580 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
11583 <refname>callout.graphics.number.limit</refname>
11584 <refpurpose>Number of the largest callout graphic</refpurpose>
11588 <programlisting id="callout.graphics.number.limit.frag">
11590 <xsl:param name="callout.graphics.number.limit">30</xsl:param>
11594 <refsection><info><title>Description</title></info>
11596 <para>If <parameter>callout.graphics</parameter> is non-zero, graphics
11597 are used to represent callout numbers instead of plain text. The value
11598 of <parameter>callout.graphics.number.limit</parameter> is the largest
11599 number for which a graphic exists. If the callout number exceeds this
11600 limit, the default presentation "(plain text instead of a graphic)"
11607 <refentry version="5.0" id="callout.graphics.path">
11609 <refentrytitle>callout.graphics.path</refentrytitle>
11610 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
11613 <refname>callout.graphics.path</refname>
11614 <refpurpose>Path to callout graphics</refpurpose>
11618 <programlisting id="callout.graphics.path.frag">
11619 <xsl:param name="callout.graphics.path">images/callouts/</xsl:param>
11623 <refsection><info><title>Description</title></info>
11625 <para>Sets the path to the directory holding the callout graphics. his
11626 location is normally relative to the output html directory. see
11627 base.dir. Always terminate the directory with / since the graphic file
11628 is appended to this string, hence needs the separator.
11634 <refentry version="5.0" id="callout.icon.size">
11636 <refentrytitle>callout.icon.size</refentrytitle>
11637 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
11640 <refname>callout.icon.size</refname>
11641 <refpurpose>Specifies the size of callout marker icons</refpurpose>
11645 <programlisting id="callout.icon.size.frag">
11646 <xsl:param name="callout.icon.size">7pt</xsl:param>
11650 <refsection><info><title>Description</title></info>
11652 <para>Specifies the size of the callout marker icons.
11653 The default size is 7 points.</para>
11658 <refentry version="5.0" id="callout.unicode">
11660 <refentrytitle>callout.unicode</refentrytitle>
11661 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
11664 <refname>callout.unicode</refname>
11665 <refpurpose>Use Unicode characters rather than images for callouts.</refpurpose>
11669 <programlisting id="callout.unicode.frag"><xsl:param name="callout.unicode" select="0"></xsl:param></programlisting>
11672 <refsection><info><title>Description</title></info>
11674 <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.
11680 <refentry version="5.0" id="callout.unicode.font">
11682 <refentrytitle>callout.unicode.font</refentrytitle>
11683 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
11686 <refname>callout.unicode.font</refname>
11687 <refpurpose>Specify a font for Unicode glyphs</refpurpose>
11691 <programlisting id="callout.unicode.font.frag">
11692 <xsl:param name="callout.unicode.font">ZapfDingbats</xsl:param>
11696 <refsection><info><title>Description</title></info>
11698 <para>The name of the font to specify around Unicode callout glyphs.
11699 If set to the empty string, no font change will occur.
11705 <refentry version="5.0" id="callout.unicode.number.limit">
11707 <refentrytitle>callout.unicode.number.limit</refentrytitle>
11708 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
11711 <refname>callout.unicode.number.limit</refname>
11712 <refpurpose>Number of the largest unicode callout character</refpurpose>
11716 <programlisting id="callout.unicode.number.limit.frag">
11717 <xsl:param name="callout.unicode.number.limit">10</xsl:param>
11721 <refsection><info><title>Description</title></info>
11723 <para>If <parameter>callout.unicode</parameter>
11724 is non-zero, unicode characters are used to represent
11725 callout numbers. The value of
11726 <parameter>callout.unicode.number.limit</parameter>
11728 the largest number for which a unicode character exists. If the callout number
11729 exceeds this limit, the default presentation "(nnn)" will always
11736 <refentry version="5.0" id="callout.unicode.start.character">
11738 <refentrytitle>callout.unicode.start.character</refentrytitle>
11739 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
11742 <refname>callout.unicode.start.character</refname>
11743 <refpurpose>First Unicode character to use, decimal value.</refpurpose>
11747 <programlisting id="callout.unicode.start.character.frag">
11748 <xsl:param name="callout.unicode.start.character">10102</xsl:param>
11752 <refsection><info><title>Description</title></info>
11754 <para>If <parameter>callout.graphics</parameter> is zero and <parameter>callout.unicode</parameter>
11755 is non-zero, unicode characters are used to represent
11756 callout numbers. The value of
11757 <parameter>callout.unicode.start.character</parameter>
11758 is the decimal unicode value used for callout number one. Currently,
11759 only values 9312 and 10102 are supported in the stylesheets for this parameter.
11765 <refentry version="5.0" id="callouts.extension">
11767 <refentrytitle>callouts.extension</refentrytitle>
11768 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
11771 <refname>callouts.extension</refname>
11772 <refpurpose>Enable the callout extension</refpurpose>
11776 <programlisting id="callouts.extension.frag">
11777 <xsl:param name="callouts.extension" select="1"></xsl:param>
11781 <refsection><info><title>Description</title></info>
11783 <para>The callouts extension processes <tag>areaset</tag>
11784 elements in <tag>programlistingco</tag> and other text-based
11791 </reference><reference id="toc_index" xml:base="../fo/param.xml"><title>ToC/LoT/Index Generation</title>
11792 <refentry version="5.0" id="autotoc.label.separator">
11794 <refentrytitle>autotoc.label.separator</refentrytitle>
11795 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
11798 <refname>autotoc.label.separator</refname>
11799 <refpurpose>Separator between labels and titles in the ToC</refpurpose>
11803 <programlisting id="autotoc.label.separator.frag">
11804 <xsl:param name="autotoc.label.separator">. </xsl:param>
11808 <refsection><info><title>Description</title></info>
11810 <para>String used to separate labels and titles in a table of contents.</para>
11815 <refentry version="5.0" id="process.empty.source.toc">
11817 <refentrytitle>process.empty.source.toc</refentrytitle>
11818 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
11821 <refname>process.empty.source.toc</refname>
11822 <refpurpose>Generate automated TOC if <tag>toc</tag> element occurs in a source document?</refpurpose>
11826 <programlisting id="process.empty.source.toc.frag"><xsl:param name="process.empty.source.toc" select="0"></xsl:param></programlisting>
11829 <refsection><info><title>Description</title></info>
11831 <para>Specifies that if an empty <tag>toc</tag> element is found in a
11832 source document, an automated TOC is generated at this point in the
11835 <para>Depending on what the value of the
11836 <parameter>generate.toc</parameter> parameter is, setting this
11837 parameter to <literal>1</literal> could result in generation of
11838 duplicate automated TOCs. So the
11839 <parameter>process.empty.source.toc</parameter> is primarily useful
11840 as an "override": by placing an empty <tag>toc</tag> in your
11841 document and setting this parameter to <literal>1</literal>, you can
11842 force a TOC to be generated even if <tag>generate.toc</tag>
11843 says not to.</para>
11850 <refentry version="5.0" id="process.source.toc">
11852 <refentrytitle>process.source.toc</refentrytitle>
11853 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
11856 <refname>process.source.toc</refname>
11857 <refpurpose>Process a non-empty <tag>toc</tag> element if it occurs in a source document?</refpurpose>
11861 <programlisting id="process.source.toc.frag"><xsl:param name="process.source.toc" select="0"></xsl:param></programlisting>
11864 <refsection><info><title>Description</title></info>
11866 <para>Specifies that the contents of a non-empty "hard-coded"
11867 <tag>toc</tag> element in a source document are processed to
11868 generate a TOC in output.
11870 <para>This parameter has no effect on automated generation of
11871 TOCs. An automated TOC may still be generated along with the
11872 "hard-coded" TOC. To suppress automated TOC generation, adjust the
11873 value of the <parameter>generate.toc</parameter> paramameter.</para>
11875 <para>The <tag>process.source.toc</tag> parameter also has
11876 no effect if the <tag>toc</tag> element is empty; handling
11877 for empty <tag>toc</tag> is controlled by the
11878 <parameter>process.empty.source.toc</parameter> parameter.</para>
11885 <refentry version="5.0" id="generate.toc">
11887 <refentrytitle>generate.toc</refentrytitle>
11888 <refmiscinfo class="other" otherclass="datatype">table</refmiscinfo>
11891 <refname>generate.toc</refname>
11892 <refpurpose>Control generation of ToCs and LoTs</refpurpose>
11896 <programlisting id="generate.toc.frag">
11898 <xsl:param name="generate.toc">
11899 /appendix toc,title
11900 article/appendix nop
11902 book toc,title,figure,table,example,equation
11906 reference toc,title
11918 <refsection><info><title>Description</title></info>
11920 <para>This parameter has a structured value. It is a table of space-delimited
11921 path/value pairs. Each path identifies some element in the source document
11922 using a restricted subset of XPath (only the implicit child axis, no wildcards,
11923 no predicates). Paths can be either relative or absolute.</para>
11925 <para>When processing a particular element, the stylesheets consult this table to
11926 determine if a ToC (or LoT(s)) should be generated.</para>
11928 <para>For example, consider the entry:</para>
11930 <screen>book toc,figure</screen>
11932 <para>This indicates that whenever a <tag>book</tag> is formatted, a
11933 Table Of Contents and a List of Figures should be generated. Similarly,</para>
11935 <screen>/chapter toc</screen>
11937 <para>indicates that whenever a document <emphasis>that has a root
11938 of</emphasis> <tag>chapter</tag> is formatted, a Table of
11939 Contents should be generated. The entry <literal>chapter</literal> would match
11940 all chapters, but <literal>/chapter</literal> matches only <tag>chapter</tag>
11941 document elements.</para>
11943 <para>Generally, the longest match wins. So, for example, if you want to distinguish
11944 articles in books from articles in parts, you could use these two entries:</para>
11946 <screen>book/article toc,figure
11947 part/article toc</screen>
11949 <para>Note that an article in a part can never match a <literal>book/article</literal>,
11950 so if you want nothing to be generated for articles in parts, you can simply leave
11951 that rule out.</para>
11953 <para>If you want to leave the rule in, to make it explicit that you're turning
11954 something off, use the value <quote>nop</quote>. For example, the following
11955 entry disables ToCs and LoTs for articles:</para>
11957 <screen>article nop</screen>
11959 <para>Do not simply leave the word <quote>article</quote> in the file
11960 without a matching value. That'd be just begging the silly little
11961 path/value parser to get confused.</para>
11963 <para>Section ToCs are further controlled by the
11964 <parameter>generate.section.toc.level</parameter> parameter.
11965 For a given section level to have a ToC, it must have both an entry in
11966 <parameter>generate.toc</parameter> and be within the range enabled by
11967 <parameter>generate.section.toc.level</parameter>.</para>
11971 <refentry version="5.0" id="generate.index">
11973 <refentrytitle>generate.index</refentrytitle>
11974 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
11977 <refname>generate.index</refname>
11978 <refpurpose>Do you want an index?</refpurpose>
11982 <programlisting id="generate.index.frag"><xsl:param name="generate.index" select="1"></xsl:param></programlisting>
11985 <refsection><info><title>Description</title></info>
11987 <para>Specify if an index should be generated. </para>
11992 <refentry version="5.0" id="make.index.markup">
11994 <refentrytitle>make.index.markup</refentrytitle>
11995 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
11998 <refname>make.index.markup</refname>
11999 <refpurpose>Generate XML index markup in the index?</refpurpose>
12003 <programlisting id="make.index.markup.frag">
12004 <xsl:param name="make.index.markup" select="0"></xsl:param>
12008 <refsection><info><title>Description</title></info>
12010 <para>This parameter enables a very neat trick for getting properly
12011 merged, collated back-of-the-book indexes. G. Ken Holman suggested
12012 this trick at Extreme Markup Languages 2002 and I'm indebted to him
12015 <para>Jeni Tennison's excellent code in
12016 <filename>autoidx.xsl</filename> does a great job of merging and
12017 sorting <tag>indexterm</tag>s in the document and building a
12018 back-of-the-book index. However, there's one thing that it cannot
12019 reasonably be expected to do: merge page numbers into ranges. (I would
12020 not have thought that it could collate and suppress duplicate page
12021 numbers, but in fact it appears to manage that task somehow.)</para>
12023 <para>Ken's trick is to produce a document in which the index at the
12024 back of the book is <quote>displayed</quote> in XML. Because the index
12025 is generated by the FO processor, all of the page numbers have been resolved.
12026 It's a bit hard to explain, but what it boils down to is that instead of having
12027 an index at the back of the book that looks like this:</para>
12030 <formalpara><info><title>A</title></info>
12031 <para>ap1, 1, 2, 3</para>
12035 <para>you get one that looks like this:</para>
12038 <programlisting><indexdiv>A</indexdiv>
12040 <primaryie>ap1</primaryie>,
12041 <phrase role="pageno">1</phrase>,
12042 <phrase role="pageno">2</phrase>,
12043 <phrase role="pageno">3</phrase>
12044 </indexentry></programlisting>
12047 <para>After building a PDF file with this sort of odd-looking index, you can
12048 extract the text from the PDF file and the result is a proper index expressed in
12051 <para>Now you have data that's amenable to processing and a simple Perl script
12052 (such as <filename>fo/pdf2index</filename>) can
12053 merge page ranges and generate a proper index.</para>
12055 <para>Finally, reformat your original document using this literal index instead of
12056 an automatically generated one and <quote>bingo</quote>!</para>
12061 <refentry version="5.0" id="index.method">
12063 <refentrytitle>index.method</refentrytitle>
12064 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
12065 <refmiscinfo class="other" otherclass="value">basic</refmiscinfo>
12066 <refmiscinfo class="other" otherclass="value">kosek</refmiscinfo>
12067 <refmiscinfo class="other" otherclass="value">kimber</refmiscinfo>
12070 <refname>index.method</refname>
12071 <refpurpose>Select method used to group index entries in an index</refpurpose>
12075 <programlisting id="index.method.frag">
12076 <xsl:param name="index.method">basic</xsl:param>
12080 <refsection><info><title>Description</title></info>
12082 <para>This parameter lets you select which method to use for sorting and grouping
12083 index entries in an index.
12084 Indexes in Latin-based languages that have accented characters typically
12085 sort together accented words and unaccented words.
12086 Thus <quote>Á</quote> (U+00C1 LATIN CAPITAL LETTER A WITH ACUTE) would sort together
12087 with <quote>A</quote> (U+0041 LATIN CAPITAL LETTER A), so both would appear in the <quote>A</quote>
12088 section of the index.
12089 Languages using other alphabets (such as Russian, which is written in the Cyrillic alphabet)
12090 and languages using ideographic chararacters (such as Japanese)
12091 require grouping specific to the languages and alphabets.
12094 <para>The default indexing method is limited.
12095 It can group accented characters in Latin-based languages only.
12096 It cannot handle non-Latin alphabets or ideographic languages.
12097 The other indexing methods require extensions of one type or
12098 another, and do not work with
12099 all XSLT processors, which is why they are not used by default.</para>
12101 <para>The three choices for indexing method are:</para>
12104 <term><literal>basic</literal></term>
12107 (default) Sort and groups words based only on the Latin alphabet.
12108 Words with accented Latin letters will group and sort with
12109 their respective primary letter, but
12110 words in non-Latin alphabets will be
12111 put in the <quote>Symbols</quote> section of the index.
12116 <term><literal>kosek</literal></term>
12119 This method sorts and groups words based on letter groups configured in
12120 the DocBook locale file for the given language.
12121 See, for example, the French locale file <filename>common/fr.xml</filename>.
12122 This method requires that the XSLT processor
12123 supports the EXSLT extensions (most do).
12124 It also requires support for using
12125 user-defined functions in xsl:key (xsltproc does not).
12127 <para>This method is suitable for any language for which you can
12128 list all the individual characters that should appear
12129 in each letter group in an index.
12130 It is probably not practical to use it for ideographic languages
12131 such as Chinese that have hundreds or thousands of characters.
12134 <para>To use the kosek method, you must:</para>
12138 <para>Use a processor that supports its extensions, such as
12139 Saxon 6 or Xalan (xsltproc and Saxon 8 do not).
12143 <para>Set the index.method parameter's value to <quote>kosek</quote>.
12147 <para>Import the appropriate index extensions stylesheet module
12148 <filename>fo/autoidx-kosek.xsl</filename> or
12149 <filename>html/autoidx-kosek.xsl</filename> into your
12158 <term><literal>kimber</literal></term>
12161 This method uses extensions to the Saxon processor to implement
12162 sophisticated indexing processes. It uses its own
12163 configuration file, which can include information for any number of
12164 languages. Each language's configuration can group
12165 words using one of two processes. In the
12166 enumerated process similar to that used in the kosek method,
12167 you indicate the groupings character-by-character.
12168 In the between-key process, you specify the
12169 break-points in the sort order that should start a new group.
12170 The latter configuration is useful for ideographic languages
12171 such as Chinese, Japanese, and Korean.
12172 You can also define your own collation algorithms and how you
12173 want mixed Latin-alphabet words sorted.</para>
12176 <para>For a whitepaper describing the extensions, see:
12177 <link 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>.
12181 <para>To download the extension library, see
12182 <link xlink:href="http://www.innodata-isogen.com/knowledge_center/tools_downloads/i18nsupport">http://www.innodata-isogen.com/knowledge_center/tools_downloads/i18nsupport</link>.
12187 <para>To use the kimber method, you must:</para>
12191 <para>Use Saxon (version 6 or 8) as your XSLT processor.
12195 <para>Install and configure the Innodata Isogen library, using
12196 the documentation that comes with it.
12200 <para>Set the index.method parameter's value to <quote>kimber</quote>.
12204 <para>Import the appropriate index extensions stylesheet module
12205 <filename>fo/autoidx-kimber.xsl</filename> or
12206 <filename>html/autoidx-kimber.xsl</filename> into your
12219 <refentry version="5.0" id="index.on.type">
12221 <refentrytitle>index.on.type</refentrytitle>
12222 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
12225 <refname>index.on.type</refname>
12226 <refpurpose>Select indexterms based on <tag class="attribute">type</tag>
12227 attribute value</refpurpose>
12231 <programlisting id="index.on.type.frag">
12232 <xsl:param name="index.on.type" select="0"></xsl:param>
12236 <refsection><info><title>Description</title></info>
12240 then an <tag>index</tag> element that has a
12241 <tag class="attribute">type</tag> attribute
12242 value will contain only those <tag>indexterm</tag>
12243 elements with a matching <tag class="attribute">type</tag> attribute value.
12244 If an <tag>index</tag> has no <tag class="attribute">type</tag>
12245 attribute or it is blank, then the index will contain
12246 all <tag>indexterm</tag>s in the current scope.
12250 If <literal>index.on.type</literal> is zero, then the
12251 <tag class="attribute">type</tag> attribute has no effect
12252 on selecting indexterms for an index.
12255 <para>For those using DocBook version 4.2 or earlier,
12256 the <tag class="attribute">type</tag> attribute is not available
12257 for index terms. However, you can achieve the same
12258 effect by using the <tag class="attribute">role</tag> attribute
12259 in the same manner on <tag>indexterm</tag>
12260 and <tag>index</tag>, and setting the stylesheet parameter
12261 <parameter>index.on.role</parameter> to a nonzero value.
12267 <refentry version="5.0" id="index.on.role">
12269 <refentrytitle>index.on.role</refentrytitle>
12270 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
12273 <refname>index.on.role</refname>
12274 <refpurpose>Select indexterms based on <tag class="attribute">role</tag> value</refpurpose>
12278 <programlisting id="index.on.role.frag">
12279 <xsl:param name="index.on.role" select="0"></xsl:param>
12283 <refsection><info><title>Description</title></info>
12287 then an <tag>index</tag> element that has a
12288 <tag class="attribute">role</tag> attribute
12289 value will contain only those <tag>indexterm</tag>
12290 elements with a matching role value.
12291 If an <tag>index</tag> has no <tag class="attribute">role</tag>
12292 attribute or it is blank, then the index will contain
12293 all <tag>indexterm</tag>s in the current scope.
12296 If <literal>index.on.role</literal> is zero, then the
12297 <tag class="attribute">role</tag> attribute has no effect
12298 on selecting indexterms for an index.
12301 <para>If you are using DocBook version 4.3 or later, you should
12302 use the <tag class="attribute">type</tag> attribute instead of <tag class="attribute">role</tag>
12303 on <tag>indexterm</tag> and <tag>index</tag>,
12304 and set the <parameter>index.on.type</parameter> to a nonzero
12311 <refentry version="5.0" id="index.preferred.page.properties">
12313 <refentrytitle>index.preferred.page.properties</refentrytitle>
12314 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
12317 <refname>index.preferred.page.properties</refname>
12318 <refpurpose>Properties used to emphasize page number references for
12319 significant index terms</refpurpose>
12323 <programlisting id="index.preferred.page.properties.frag">
12324 <xsl:attribute-set name="index.preferred.page.properties">
12325 <xsl:attribute name="font-weight">bold</xsl:attribute>
12326 </xsl:attribute-set>
12330 <refsection><info><title>Description</title></info>
12332 <para>Properties used to emphasize page number references for
12333 significant index terms (<tag class="attribute">significance</tag>=<tag class="attvalue">preferred</tag>). Currently works only with
12339 <refentry version="5.0" id="index.entry.properties">
12341 <refentrytitle>index.entry.properties</refentrytitle>
12342 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
12345 <refname>index.entry.properties</refname>
12346 <refpurpose>Properties applied to the formatted entries
12347 in an index</refpurpose>
12351 <programlisting id="index.entry.properties.frag">
12352 <xsl:attribute-set name="index.entry.properties">
12353 <xsl:attribute name="start-indent">0pt</xsl:attribute>
12354 </xsl:attribute-set>
12358 <refsection><info><title>Description</title></info>
12360 <para>This attribute set is applied to the block containing
12361 the entries in a letter division in an index. It can be used to set the
12362 font-size, font-family, and other inheritable properties that will be
12363 applied to all index entries.</para>
12368 <refentry version="5.0" id="index.div.title.properties">
12370 <refentrytitle>index.div.title.properties</refentrytitle>
12371 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
12374 <refname>index.div.title.properties</refname>
12375 <refpurpose>Properties associated with the letter headings in an
12380 <programlisting id="index.div.title.properties.frag">
12381 <xsl:attribute-set name="index.div.title.properties">
12382 <xsl:attribute name="margin-{$direction.align.start}">0pt</xsl:attribute>
12383 <xsl:attribute name="font-size">14.4pt</xsl:attribute>
12384 <xsl:attribute name="font-family"><xsl:value-of select="$title.fontset"></xsl:value-of></xsl:attribute>
12385 <xsl:attribute name="font-weight">bold</xsl:attribute>
12386 <xsl:attribute name="keep-with-next.within-column">always</xsl:attribute>
12387 <xsl:attribute name="space-before.optimum"><xsl:value-of select="concat($body.font.master,'pt')"></xsl:value-of></xsl:attribute>
12388 <xsl:attribute name="space-before.minimum"><xsl:value-of select="concat($body.font.master,'pt * 0.8')"></xsl:value-of></xsl:attribute>
12389 <xsl:attribute name="space-before.maximum"><xsl:value-of select="concat($body.font.master,'pt * 1.2')"></xsl:value-of></xsl:attribute>
12390 <xsl:attribute name="start-indent">0pt</xsl:attribute>
12391 </xsl:attribute-set>
12395 <refsection><info><title>Description</title></info>
12397 <para>This attribute set is used on the letter headings that separate
12398 the divisions in an index.</para>
12403 <refentry version="5.0" id="autolink.index.see">
12405 <refentrytitle>autolink.index.see</refentrytitle>
12406 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
12409 <refname>autolink.index.see</refname>
12410 <refpurpose>Link index see and seealso to index primary</refpurpose>
12414 <programlisting id="autolink.index.see.frag"><xsl:param name="autolink.index.see" select="1"></xsl:param></programlisting>
12417 <refsection><info><title>Description</title></info>
12419 <para>If this param is set to a non-zero value,
12420 (default = 1), then the
12421 stylesheet will attempt for form a link between a
12422 <tag>see</tag> or <tag>seealso</tag> element
12423 and a matching indexterm <tag>primary</tag> element.
12426 <para>The stylesheet uses an exact text match after
12427 applying the <literal>normalize-space()</literal> function.
12428 If the <tag>see</tag> or <tag>seealso</tag> text contains a comma,
12429 then only the text prior to the comma is used.
12430 This assumes the author is using the convention "see primary, secondary"
12431 to specify a subentry. Automatic links always land on the primary
12432 entry in the index, so the reader has to look down to see the
12433 secondary entry.</para>
12434 <para>If there is no match on a
12435 <tag>primary</tag>, no link is formed, but the text
12436 still displays.</para>
12438 <para>No attempt is made to automatically link to text in
12439 <tag>secondary</tag> or <tag>tertiary</tag> elements.
12440 If you want to link to such elements, you can form a
12441 manual link by adding a linkend attribute to the
12442 <tag>see</tag> or <tag>seealso</tag> element, where
12443 the linkend references an id or xml:id attribute on
12444 such a subelement. Such manual links take precedence over
12445 any automatic links.
12448 <para>If this parameter is zero, then
12449 no automatic links from see and seealso
12450 are formed within the index. Any manual links are
12451 still processed, however.</para>
12456 <refentry version="5.0" id="index.number.separator">
12458 <refentrytitle>index.number.separator</refentrytitle>
12459 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
12462 <refname>index.number.separator</refname>
12463 <refpurpose>Override for punctuation separating page numbers in index</refpurpose>
12467 <programlisting id="index.number.separator.frag">
12468 <xsl:param name="index.number.separator"></xsl:param>
12472 <refsection><info><title>Description</title></info>
12474 <para>This parameter permits you to override the text to insert between
12475 page references in a formatted index entry. Typically
12476 that would be a comma and a space.
12479 <para>Because this text may be locale dependent,
12480 this parameter's value is normally taken from a gentext
12481 template named 'number-separator' in the
12482 context 'index' in the stylesheet
12483 locale file for the language
12484 of the current document.
12485 This parameter can be used to override the gentext string,
12486 and would typically be used on the command line.
12487 This parameter would apply to all languages.
12490 <para>So this text string can be customized in two ways.
12491 You can reset the default gentext string using
12492 the <parameter>local.l10n.xml</parameter> parameter, or you can
12493 override the gentext with the content of this parameter.
12494 The content can be a simple string, or it can be
12495 something more complex such as a call-template.
12498 <para>In HTML index output, section title references are used instead of
12499 page number references. This punctuation appears between
12500 such section titles in an HTML index.
12506 <refentry version="5.0" id="index.range.separator">
12508 <refentrytitle>index.range.separator</refentrytitle>
12509 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
12512 <refname>index.range.separator</refname>
12513 <refpurpose>Override for punctuation separating the two numbers
12514 in a page range in index</refpurpose>
12518 <programlisting id="index.range.separator.frag">
12519 <xsl:param name="index.range.separator"></xsl:param>
12523 <refsection><info><title>Description</title></info>
12525 <para>This parameter permits you
12526 to override the text to insert between
12527 the two numbers of a page range in an index.
12528 This parameter is only used by those XSL-FO processors
12529 that support an extension for generating such page ranges
12530 (such as XEP).</para>
12532 <para>Because this text may be locale dependent,
12533 this parameter's value is normally taken from a gentext
12534 template named 'range-separator' in the
12535 context 'index' in the stylesheet
12536 locale file for the language
12537 of the current document.
12538 This parameter can be used to override the gentext string,
12539 and would typically be used on the command line.
12540 This parameter would apply to all languages.
12543 <para>So this text string can be customized in two ways.
12544 You can reset the default gentext string using
12545 the <parameter>local.l10n.xml</parameter> parameter, or you can
12546 override the gentext with the content of this parameter.
12547 The content can be a simple string, or it can be
12548 something more complex such as a call-template.
12551 <para>In HTML index output, section title references are used instead of
12552 page number references. So there are no page ranges
12553 and this parameter has no effect.
12559 <refentry version="5.0" id="index.term.separator">
12561 <refentrytitle>index.term.separator</refentrytitle>
12562 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
12565 <refname>index.term.separator</refname>
12566 <refpurpose>Override for punctuation separating an index term
12567 from its list of page references in an index</refpurpose>
12571 <programlisting id="index.term.separator.frag">
12572 <xsl:param name="index.term.separator"></xsl:param>
12576 <refsection><info><title>Description</title></info>
12578 <para>This parameter permits you to override
12579 the text to insert between
12580 the end of an index term and its list of page references.
12581 Typically that might be a comma and a space.
12584 <para>Because this text may be locale dependent,
12585 this parameter's value is normally taken from a gentext
12586 template named 'term-separator' in the
12587 context 'index' in the stylesheet
12588 locale file for the language
12589 of the current document.
12590 This parameter can be used to override the gentext string,
12591 and would typically be used on the command line.
12592 This parameter would apply to all languages.
12595 <para>So this text string can be customized in two ways.
12596 You can reset the default gentext string using
12597 the <parameter>local.l10n.xml</parameter> parameter, or you can
12598 fill in the content for this normally empty
12599 override parameter.
12600 The content can be a simple string, or it can be
12601 something more complex such as a call-template.
12602 For fo output, it could be an <tag>fo:leader</tag>
12603 element to provide space of a specific length, or a dot leader.
12609 <refentry version="5.0" id="xep.index.item.properties">
12611 <refentrytitle>xep.index.item.properties</refentrytitle>
12612 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
12615 <refname>xep.index.item.properties</refname>
12616 <refpurpose>Properties associated with XEP index-items</refpurpose>
12620 <programlisting id="xep.index.item.properties.frag">
12621 <xsl:attribute-set name="xep.index.item.properties" use-attribute-sets="index.page.number.properties">
12622 <xsl:attribute name="merge-subsequent-page-numbers">true</xsl:attribute>
12623 <xsl:attribute name="link-back">true</xsl:attribute>
12624 </xsl:attribute-set>
12628 <refsection><info><title>Description</title></info>
12630 <para>Properties associated with XEP index-items, which generate
12631 page numbers in an index processed by XEP. For more info see
12632 the XEP documentation section "Indexes" in
12633 <uri xlink:href="http://www.renderx.com/reference.html#Indexes">http://www.renderx.com/reference.html#Indexes</uri>.</para>
12635 <para>This attribute-set also adds by default any properties from the
12636 <tag class="attribute">index.page.number.properties</tag>
12637 attribute-set.</para>
12641 <refentry version="5.0" id="toc.section.depth">
12643 <refentrytitle>toc.section.depth</refentrytitle>
12644 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
12647 <refname>toc.section.depth</refname>
12648 <refpurpose>How deep should recursive <tag>section</tag>s appear
12649 in the TOC?</refpurpose>
12653 <programlisting id="toc.section.depth.frag"><xsl:param name="toc.section.depth">2</xsl:param></programlisting>
12656 <refsection><info><title>Description</title></info>
12658 <para>Specifies the depth to which recursive sections should appear in the
12665 <refentry version="5.0" id="toc.max.depth">
12667 <refentrytitle>toc.max.depth</refentrytitle>
12668 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
12671 <refname>toc.max.depth</refname>
12672 <refpurpose>How many levels should be created for each TOC?</refpurpose>
12676 <programlisting id="toc.max.depth.frag"><xsl:param name="toc.max.depth">8</xsl:param></programlisting>
12679 <refsection><info><title>Description</title></info>
12681 <para>Specifies the maximal depth of TOC on all levels.</para>
12686 <refentry version="5.0" id="toc.indent.width">
12688 <refentrytitle>toc.indent.width</refentrytitle>
12689 <refmiscinfo class="other" otherclass="datatype">float</refmiscinfo>
12692 <refname>toc.indent.width</refname>
12693 <refpurpose>Amount of indentation for TOC entries</refpurpose>
12697 <programlisting id="toc.indent.width.frag">
12698 <xsl:param name="toc.indent.width">24</xsl:param>
12699 <!-- inconsistant point specification? -->
12703 <refsection><info><title>Description</title></info>
12705 <para>Specifies, in points, the distance by which each level of the
12706 TOC is indented from its parent.</para>
12708 <para>This value is expressed in points, without
12709 a unit (in other words, it is a bare number). Using a bare number allows the stylesheet
12710 to perform calculations that would otherwise have to be performed by the FO processor
12711 because not all processors support expressions.</para>
12716 <refentry version="5.0" id="toc.line.properties">
12718 <refentrytitle>toc.line.properties</refentrytitle>
12719 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
12722 <refname>toc.line.properties</refname>
12723 <refpurpose>Properties for lines in ToCs and LoTs</refpurpose>
12727 <programlisting id="toc.line.properties.frag">
12728 <xsl:attribute-set name="toc.line.properties">
12729 <xsl:attribute name="text-align-last">justify</xsl:attribute>
12730 <xsl:attribute name="text-align">start</xsl:attribute>
12731 <xsl:attribute name="end-indent"><xsl:value-of select="concat($toc.indent.width, 'pt')"></xsl:value-of></xsl:attribute>
12732 <xsl:attribute name="last-line-end-indent"><xsl:value-of select="concat('-', $toc.indent.width, 'pt')"></xsl:value-of></xsl:attribute>
12733 </xsl:attribute-set>
12737 <refsection><info><title>Description</title></info>
12739 <para>Properties which are applied to every line in ToC (or LoT). You can
12740 modify them in order to change appearance of all, or some lines. For
12741 example, in order to make lines for chapters bold, specify the
12742 following in your customization layer:</para>
12744 <programlisting><xsl:attribute-set name="toc.line.properties">
12745 <xsl:attribute name="font-weight">
12747 <xsl:when test="self::chapter">bold</xsl:when>
12748 <xsl:otherwise>normal</xsl:otherwise>
12749 </xsl:choose>
12750 </xsl:attribute>
12751 </xsl:attribute-set></programlisting>
12756 <refentry version="5.0" id="toc.leader.properties">
12758 <refentrytitle>toc.leader.properties</refentrytitle>
12759 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
12762 <refname>toc.leader.properties</refname>
12763 <refpurpose>How the leaders (rows of dots) are going to look like in ToC?</refpurpose>
12767 <programlisting id="toc.leader.properties.frag">
12768 <xsl:attribute-set name="toc.leader.properties">
12769 <xsl:attribute name="leader-pattern">dots</xsl:attribute>
12770 <xsl:attribute name="leader-pattern-width">3pt</xsl:attribute>
12771 <xsl:attribute name="leader-alignment">reference-area</xsl:attribute>
12772 <xsl:attribute name="padding-left">3pt</xsl:attribute>
12773 <xsl:attribute name="padding-right">3pt</xsl:attribute>
12774 </xsl:attribute-set>
12777 <refsection><info><title>Description</title></info>
12778 <para>Specify leader pattern, </para>
12783 <refentry version="5.0" id="toc.margin.properties">
12785 <refentrytitle>toc.margin.properties</refentrytitle>
12786 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
12789 <refname>toc.margin.properties</refname>
12790 <refpurpose>Margin properties used on Tables of Contents</refpurpose>
12794 <programlisting id="toc.margin.properties.frag">
12795 <xsl:attribute-set name="toc.margin.properties">
12796 <xsl:attribute name="space-before.minimum">0.5em</xsl:attribute>
12797 <xsl:attribute name="space-before.optimum">1em</xsl:attribute>
12798 <xsl:attribute name="space-before.maximum">2em</xsl:attribute>
12799 <xsl:attribute name="space-after.minimum">0.5em</xsl:attribute>
12800 <xsl:attribute name="space-after.optimum">1em</xsl:attribute>
12801 <xsl:attribute name="space-after.maximum">2em</xsl:attribute>
12802 </xsl:attribute-set>
12806 <refsection><info><title>Description</title></info>
12807 <para>This attribute set is used on Tables of Contents. These attributes are set
12808 on the wrapper that surrounds the ToC block, not on each individual lines.</para>
12812 <refentry version="5.0" id="bridgehead.in.toc">
12814 <refentrytitle>bridgehead.in.toc</refentrytitle>
12815 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
12818 <refname>bridgehead.in.toc</refname>
12819 <refpurpose>Should bridgehead elements appear in the TOC?</refpurpose>
12823 <programlisting id="bridgehead.in.toc.frag"><xsl:param name="bridgehead.in.toc" select="0"></xsl:param></programlisting>
12826 <refsection><info><title>Description</title></info>
12828 <para>If non-zero, <tag>bridgehead</tag>s appear in the TOC. Note that
12829 this option is not fully supported and may be removed in a future
12830 version of the stylesheets.
12836 <refentry version="5.0" id="simplesect.in.toc">
12838 <refentrytitle>simplesect.in.toc</refentrytitle>
12839 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
12842 <refname>simplesect.in.toc</refname>
12843 <refpurpose>Should <tag>simplesect</tag> elements appear in the TOC?</refpurpose>
12847 <programlisting id="simplesect.in.toc.frag"><xsl:param name="simplesect.in.toc" select="0"></xsl:param></programlisting>
12850 <refsection><info><title>Description</title></info>
12852 <para>If non-zero, <tag>simplesect</tag>s will be included in the TOC.
12858 <refentry version="5.0" id="generate.section.toc.level">
12860 <refentrytitle>generate.section.toc.level</refentrytitle>
12861 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
12864 <refname>generate.section.toc.level</refname>
12865 <refpurpose>Control depth of TOC generation in sections</refpurpose>
12869 <programlisting id="generate.section.toc.level.frag">
12870 <xsl:param name="generate.section.toc.level" select="0"></xsl:param>
12874 <refsection><info><title>Description</title></info>
12876 <para>The <parameter>generate.section.toc.level</parameter> parameter
12877 controls the depth of <tag>section</tag> in which TOCs will be generated. Note
12878 that this is related to, but not the same as
12879 <parameter>toc.section.depth</parameter>, which controls the depth to
12880 which TOC entries will be generated in a given TOC.</para>
12881 <para>If, for example, <parameter>generate.section.toc.level</parameter>
12882 is <literal>3</literal>, TOCs will be generated in first, second, and third
12883 level sections, but not in fourth level sections.
12892 </reference><reference id="fo_ext" xml:base="../fo/param.xml"><title>Processor Extensions</title>
12893 <refentry version="5.0" id="arbortext.extensions">
12895 <refentrytitle>arbortext.extensions</refentrytitle>
12896 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
12899 <refname>arbortext.extensions</refname>
12900 <refpurpose>Enable Arbortext extensions?</refpurpose>
12904 <programlisting id="arbortext.extensions.frag"><xsl:param name="arbortext.extensions" select="0"></xsl:param></programlisting>
12907 <refsection><info><title>Description</title></info>
12910 <link xlink:href="http://www.arbortext.com/">Arbortext</link>
12911 extensions will be used.
12913 <para>This parameter can also affect which graphics file formats
12914 are supported</para>
12919 <refentry version="5.0" id="axf.extensions">
12921 <refentrytitle>axf.extensions</refentrytitle>
12922 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
12925 <refname>axf.extensions</refname>
12926 <refpurpose>Enable XSL Formatter extensions?</refpurpose>
12930 <programlisting id="axf.extensions.frag">
12931 <xsl:param name="axf.extensions" select="0"></xsl:param>
12935 <refsection><info><title>Description</title></info>
12938 <link xlink:href="http://www.antennahouse.com/">XSL Formatter</link>
12939 extensions will be used. XSL Formatter extensions consists of PDF bookmarks,
12940 document information and better index processing.</para>
12942 <para>This parameter can also affect which graphics file formats
12943 are supported</para>
12948 <refentry version="5.0" id="fop.extensions">
12950 <refentrytitle>fop.extensions</refentrytitle>
12951 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
12954 <refname>fop.extensions</refname>
12955 <refpurpose>Enable extensions for FOP version 0.20.5 and earlier</refpurpose>
12959 <programlisting id="fop.extensions.frag"><xsl:param name="fop.extensions" select="0"></xsl:param></programlisting>
12962 <refsection><info><title>Description</title></info>
12964 <para>If non-zero, extensions intended for
12965 <link xlink:href="http://xml.apache.org/fop/">FOP</link>
12966 version 0.20.5 and earlier will be used.
12967 At present, this consists of PDF bookmarks.
12970 <para>This parameter can also affect which graphics file formats
12971 are supported.</para>
12973 <para>If you are using a version of FOP beyond
12974 version 0.20.5, then use the <parameter>fop1.extensions</parameter> parameter
12980 <refentry version="5.0" id="fop1.extensions">
12982 <refentrytitle>fop1.extensions</refentrytitle>
12983 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
12986 <refname>fop1.extensions</refname>
12987 <refpurpose>Enable extensions for FOP version 0.90 and later</refpurpose>
12991 <programlisting id="fop1.extensions.frag"><xsl:param name="fop1.extensions" select="0"></xsl:param></programlisting>
12994 <refsection><info><title>Description</title></info>
12996 <para>If non-zero, extensions for
12997 <link xlink:href="http://xml.apache.org/fop/">FOP</link>
12998 version 0.90 and later will be used.
13001 <para>This parameter can also affect which graphics file formats
13002 are supported.</para>
13004 <para>The original <parameter>fop.extensions</parameter> parameter
13005 should still be used for FOP version 0.20.5 and earlier.
13010 <refentry version="5.0" id="passivetex.extensions">
13012 <refentrytitle>passivetex.extensions</refentrytitle>
13013 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
13016 <refname>passivetex.extensions</refname>
13017 <refpurpose>Enable PassiveTeX extensions?</refpurpose>
13021 <programlisting id="passivetex.extensions.frag"><xsl:param name="passivetex.extensions" select="0"></xsl:param></programlisting>
13024 <refsection><info><title>Description</title></info>
13026 <important><para>The PassiveTeX XSL-FO processor is
13027 no longer supported by DocBook XSL, beginning with version 1.78.</para></important>
13029 <para>PassiveTeX was never a complete implementation of
13030 XSL-FO, and development has ceased. Setting this parameter will
13031 have no effect on the output.</para>
13036 <refentry version="5.0" id="tex.math.in.alt">
13038 <refentrytitle>tex.math.in.alt</refentrytitle>
13039 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
13040 <refmiscinfo class="other" otherclass="value">plain</refmiscinfo>
13041 <refmiscinfo class="other" otherclass="value">latex</refmiscinfo>
13044 <refname>tex.math.in.alt</refname>
13045 <refpurpose>TeX notation used for equations</refpurpose>
13049 <programlisting id="tex.math.in.alt.frag">
13050 <xsl:param name="tex.math.in.alt"></xsl:param>
13054 <refsection><info><title>Description</title></info>
13056 <para>If you want type math directly in TeX notation in equations,
13057 this parameter specifies notation used. Currently are supported two
13058 values -- <literal>plain</literal> and <literal>latex</literal>. Empty
13059 value means that you are not using TeX math at all.</para>
13061 <para>Preferred way for including TeX alternative of math is inside of
13062 <tag>textobject</tag> element. Eg.:</para>
13064 <programlisting><inlineequation>
13065 <inlinemediaobject>
13066 <imageobject>
13067 <imagedata fileref="eq1.gif"/>
13068 </imageobject>
13069 <textobject><phrase>E=mc squared</phrase></textobject>
13070 <textobject role="tex"><phrase>E=mc^2</phrase></textobject>
13071 </inlinemediaobject>
13072 </inlineequation></programlisting>
13074 <para>If you are using <tag>graphic</tag> element, you can
13075 store TeX inside <tag>alt</tag> element:</para>
13077 <programlisting><inlineequation>
13078 <alt role="tex">a^2+b^2=c^2</alt>
13079 <graphic fileref="a2b2c2.gif"/>
13080 </inlineequation></programlisting>
13082 <para>If you want use this feature, you should process your FO with
13083 PassiveTeX, which only supports TeX math notation. When calling
13084 stylsheet, don't forget to specify also
13085 passivetex.extensions=1.</para>
13087 <para>If you want equations in HTML, just process generated file
13088 <filename>tex-math-equations.tex</filename> by TeX or LaTeX. Then run
13089 dvi2bitmap program on result DVI file. You will get images for
13090 equations in your document.</para>
13093 <para>This feature is useful for print/PDF output only if you
13094 use the obsolete and now unsupported PassiveTeX XSL-FO
13100 <refsection><info><title>Related Parameters</title></info>
13101 <para><parameter>tex.math.delims</parameter>,
13102 <parameter>passivetex.extensions</parameter>,
13103 <parameter>tex.math.file</parameter></para>
13108 <refentry version="5.0" id="tex.math.delims">
13110 <refentrytitle>tex.math.delims</refentrytitle>
13111 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
13114 <refname>tex.math.delims</refname>
13115 <refpurpose>Should equations output for processing by TeX be
13116 surrounded by math mode delimiters?</refpurpose>
13120 <programlisting id="tex.math.delims.frag">
13121 <xsl:param name="tex.math.delims" select="1"></xsl:param>
13125 <refsection><info><title>Description</title></info>
13127 <para>For compatibility with DSSSL based DBTeXMath from Allin Cottrell
13128 you should set this parameter to 0.</para>
13131 <para>This feature is useful for print/PDF output only if you
13132 use the obsolete and now unsupported PassiveTeX XSL-FO
13137 <refsection><info><title>Related Parameters</title></info>
13138 <para><parameter>tex.math.in.alt</parameter>,
13139 <parameter>passivetex.extensions</parameter></para>
13142 <refsection><info><title>See Also</title></info>
13143 <para>You can also use the <tag class="xmlpi">dbtex delims</tag> processing
13144 instruction to control whether delimiters are output.</para>
13150 <refentry version="5.0" id="xep.extensions">
13152 <refentrytitle>xep.extensions</refentrytitle>
13153 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
13156 <refname>xep.extensions</refname>
13157 <refpurpose>Enable XEP extensions?</refpurpose>
13161 <programlisting id="xep.extensions.frag"><xsl:param name="xep.extensions" select="0"></xsl:param></programlisting>
13164 <refsection><info><title>Description</title></info>
13167 <link xlink:href="http://www.renderx.com/">XEP</link>
13168 extensions will be used. XEP extensions consists of PDF bookmarks,
13169 document information and better index processing.
13172 <para>This parameter can also affect which graphics file formats
13173 are supported</para>
13177 </reference><reference id="dbk_ext" xml:base="../fo/param.xml"><title>Stylesheet Extensions</title>
13178 <refentry version="5.0" id="linenumbering.everyNth">
13180 <refentrytitle>linenumbering.everyNth</refentrytitle>
13181 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
13184 <refname>linenumbering.everyNth</refname>
13185 <refpurpose>Indicate which lines should be numbered</refpurpose>
13189 <programlisting id="linenumbering.everyNth.frag">
13190 <xsl:param name="linenumbering.everyNth">5</xsl:param>
13194 <refsection><info><title>Description</title></info>
13196 <para>If line numbering is enabled, everyNth line will be
13197 numbered. Note that numbering is one based, not zero based.
13199 <para>See also <parameter>linenumbering.extension</parameter>,
13200 <parameter>linenumbering.separator</parameter>,
13201 <parameter>linenumbering.width</parameter> and
13202 <parameter>use.extensions</parameter></para>
13207 <refentry version="5.0" id="linenumbering.extension">
13209 <refentrytitle>linenumbering.extension</refentrytitle>
13210 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
13213 <refname>linenumbering.extension</refname>
13214 <refpurpose>Enable the line numbering extension</refpurpose>
13218 <programlisting id="linenumbering.extension.frag">
13219 <xsl:param name="linenumbering.extension" select="1"></xsl:param>
13223 <refsection><info><title>Description</title></info>
13225 <para>If non-zero, verbatim environments (<tag>address</tag>, <tag>literallayout</tag>,
13226 <tag>programlisting</tag>, <tag>screen</tag>, <tag>synopsis</tag>) that specify line numbering will
13233 <refentry version="5.0" id="linenumbering.separator">
13235 <refentrytitle>linenumbering.separator</refentrytitle>
13236 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
13239 <refname>linenumbering.separator</refname>
13240 <refpurpose>Specify a separator between line numbers and lines</refpurpose>
13244 <programlisting id="linenumbering.separator.frag">
13245 <xsl:param name="linenumbering.separator"><xsl:text> </xsl:text></xsl:param>
13249 <refsection><info><title>Description</title></info>
13251 <para>The separator is inserted between line numbers and lines in the
13252 verbatim environment. The default value is a single white space.
13253 Note the interaction with <parameter>linenumbering.width</parameter>
13259 <refentry version="5.0" id="linenumbering.width">
13261 <refentrytitle>linenumbering.width</refentrytitle>
13262 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
13265 <refname>linenumbering.width</refname>
13266 <refpurpose>Indicates the width of line numbers</refpurpose>
13270 <programlisting id="linenumbering.width.frag">
13271 <xsl:param name="linenumbering.width">3</xsl:param>
13275 <refsection><info><title>Description</title></info>
13277 <para>If line numbering is enabled, line numbers will appear right
13278 justified in a field "width" characters wide.
13284 <refentry version="5.0" id="tablecolumns.extension">
13286 <refentrytitle>tablecolumns.extension</refentrytitle>
13287 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
13290 <refname>tablecolumns.extension</refname>
13291 <refpurpose>Enable the table columns extension function</refpurpose>
13295 <programlisting id="tablecolumns.extension.frag">
13296 <xsl:param name="tablecolumns.extension" select="1"></xsl:param>
13300 <refsection><info><title>Description</title></info>
13302 <para>The table columns extension function adjusts the widths of table
13303 columns in the HTML result to more accurately reflect the specifications
13310 <refentry version="5.0" id="textinsert.extension">
13312 <refentrytitle>textinsert.extension</refentrytitle>
13313 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
13316 <refname>textinsert.extension</refname>
13317 <refpurpose>Enables the textinsert extension element</refpurpose>
13320 <programlisting id="textinsert.extension.frag">
13321 <xsl:param name="textinsert.extension" select="1"></xsl:param>
13324 <refsection><info><title>Description</title></info>
13325 <para>The textinsert extension element inserts the contents of
13326 a file into the result tree (as text).</para>
13328 <para>To use the textinsert extension element, you must use
13329 either Saxon or Xalan as your XSLT processor (it doesn’t
13330 work with xsltproc), along with either the DocBook Saxon
13331 extensions or DocBook Xalan extensions (for more
13332 information about those extensions, see <link role="tcg" xlink:href="InstallingAProcessor.html#SaxonExtensions">DocBook Saxon Extensions</link> and <link role="tcg" xlink:href="InstallingAProcessor.html#XalanExtensions">DocBook Xalan Extensions</link>), and you must set both
13333 the <parameter>use.extensions</parameter> and
13334 <parameter>textinsert.extension</parameter> parameters to
13335 <literal>1</literal>.</para>
13336 <para>As an alternative to using the textinsert element,
13337 consider using an Xinclude element with the
13338 <literal>parse="text"</literal> attribute and value
13339 specified, as detailed in <link role="tcg" xlink:href="ExternalCode.html#XIncludeCode">Using XInclude for text inclusions</link>.</para>
13342 <refsection><info><title>See Also</title></info>
13343 <para>You can also use the <tag class="xmlpi">dbhtml-include href</tag> processing
13344 instruction to insert external files — both files containing
13345 plain text and files with markup content (including HTML
13348 <refsection><info><title>More information</title></info>
13349 <para>For how-to documentation on inserting contents of
13350 external code files and other text files into output, see
13351 <link role="tcg" xlink:href="ExternalCode.html">External code files</link>.</para>
13352 <para>For guidelines on inserting contents of
13353 HTML files into output, see <link role="tcg" xlink:href="InsertExtHtml.html">Inserting external HTML code</link>.</para>
13357 <refentry version="5.0" id="textdata.default.encoding">
13359 <refentrytitle>textdata.default.encoding</refentrytitle>
13360 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
13363 <refname>textdata.default.encoding</refname>
13364 <refpurpose>Default encoding of external text files which are included
13365 using textdata element</refpurpose>
13369 <programlisting id="textdata.default.encoding.frag">
13370 <xsl:param name="textdata.default.encoding"></xsl:param>
13374 <refsection><info><title>Description</title></info>
13376 <para>Specifies the encoding of any external text files included using
13377 <tag>textdata</tag> element. This value is used only when you do
13378 not specify encoding by the appropriate attribute
13379 directly on textdata. An empty string is interpreted as the system
13380 default encoding.</para>
13385 <refentry version="5.0" id="use.extensions">
13387 <refentrytitle>use.extensions</refentrytitle>
13388 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
13391 <refname>use.extensions</refname>
13392 <refpurpose>Enable extensions</refpurpose>
13396 <programlisting id="use.extensions.frag">
13397 <xsl:param name="use.extensions" select="0"></xsl:param>
13401 <refsection><info><title>Description</title></info>
13403 <para>If non-zero, extensions may be used. Each extension is
13404 further controlled by its own parameter. But if
13405 <parameter>use.extensions</parameter> is zero, no extensions will
13412 </reference><reference id="labels" xml:base="../fo/param.xml"><title>Automatic labelling</title>
13413 <refentry version="5.0" id="appendix.autolabel">
13415 <refentrytitle>appendix.autolabel</refentrytitle>
13416 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
13417 <refmiscinfo class="other" otherclass="value">0<alt>none</alt></refmiscinfo>
13418 <refmiscinfo class="other" otherclass="value">1<alt>1,2,3...</alt></refmiscinfo>
13419 <refmiscinfo class="other" otherclass="value">A<alt>A,B,C...</alt></refmiscinfo>
13420 <refmiscinfo class="other" otherclass="value">a<alt>a,b,c...</alt></refmiscinfo>
13421 <refmiscinfo class="other" otherclass="value">i<alt>i,ii,iii...</alt></refmiscinfo>
13422 <refmiscinfo class="other" otherclass="value">I<alt>I,II,III...</alt></refmiscinfo>
13425 <refname>appendix.autolabel</refname>
13426 <refpurpose>Specifies the labeling format for Appendix titles</refpurpose>
13430 <programlisting id="appendix.autolabel.frag">
13431 <xsl:param name="appendix.autolabel">A</xsl:param>
13435 <refsection><info><title>Description</title></info>
13437 <para>If non-zero, then appendices will be numbered using the
13438 parameter value as the number format if the value matches one of the
13444 <term>1 or arabic</term>
13446 <para>Arabic numeration (1, 2, 3 ...).</para>
13450 <term>A or upperalpha</term>
13452 <para>Uppercase letter numeration (A, B, C ...).</para>
13456 <term>a or loweralpha</term>
13458 <para>Lowercase letter numeration (a, b, c ...).</para>
13462 <term>I or upperroman</term>
13464 <para>Uppercase roman numeration (I, II, III ...).</para>
13468 <term>i or lowerroman</term>
13470 <para>Lowercase roman letter numeration (i, ii, iii ...).</para>
13475 <para>Any nonzero value other than the above will generate
13476 the default number format (upperalpha).
13482 <refentry version="5.0" id="chapter.autolabel">
13484 <refentrytitle>chapter.autolabel</refentrytitle>
13485 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
13486 <refmiscinfo class="other" otherclass="value">0<alt>none</alt></refmiscinfo>
13487 <refmiscinfo class="other" otherclass="value">1<alt>1,2,3...</alt></refmiscinfo>
13488 <refmiscinfo class="other" otherclass="value">A<alt>A,B,C...</alt></refmiscinfo>
13489 <refmiscinfo class="other" otherclass="value">a<alt>a,b,c...</alt></refmiscinfo>
13490 <refmiscinfo class="other" otherclass="value">i<alt>i,ii,iii...</alt></refmiscinfo>
13491 <refmiscinfo class="other" otherclass="value">I<alt>I,II,III...</alt></refmiscinfo>
13494 <refname>chapter.autolabel</refname>
13495 <refpurpose>Specifies the labeling format for Chapter titles</refpurpose>
13499 <programlisting id="chapter.autolabel.frag">
13500 <xsl:param name="chapter.autolabel" select="1"></xsl:param></programlisting>
13503 <refsection><info><title>Description</title></info>
13505 <para>If non-zero, then chapters will be numbered using the parameter
13506 value as the number format if the value matches one of the following:
13511 <term>1 or arabic</term>
13513 <para>Arabic numeration (1, 2, 3 ...).</para>
13517 <term>A or upperalpha</term>
13519 <para>Uppercase letter numeration (A, B, C ...).</para>
13523 <term>a or loweralpha</term>
13525 <para>Lowercase letter numeration (a, b, c ...).</para>
13529 <term>I or upperroman</term>
13531 <para>Uppercase roman numeration (I, II, III ...).</para>
13535 <term>i or lowerroman</term>
13537 <para>Lowercase roman letter numeration (i, ii, iii ...).</para>
13542 <para>Any nonzero value other than the above will generate
13543 the default number format (arabic).
13549 <refentry version="5.0" id="part.autolabel">
13551 <refentrytitle>part.autolabel</refentrytitle>
13552 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
13553 <refmiscinfo class="other" otherclass="value">0<alt>none</alt></refmiscinfo>
13554 <refmiscinfo class="other" otherclass="value">1<alt>1,2,3...</alt></refmiscinfo>
13555 <refmiscinfo class="other" otherclass="value">A<alt>A,B,C...</alt></refmiscinfo>
13556 <refmiscinfo class="other" otherclass="value">a<alt>a,b,c...</alt></refmiscinfo>
13557 <refmiscinfo class="other" otherclass="value">i<alt>i,ii,iii...</alt></refmiscinfo>
13558 <refmiscinfo class="other" otherclass="value">I<alt>I,II,III...</alt></refmiscinfo>
13561 <refname>part.autolabel</refname>
13562 <refpurpose>Specifies the labeling format for Part titles</refpurpose>
13566 <programlisting id="part.autolabel.frag">
13567 <xsl:param name="part.autolabel">I</xsl:param>
13571 <refsection><info><title>Description</title></info>
13573 <para>If non-zero, then parts will be numbered using the parameter
13574 value as the number format if the value matches one of the following:
13579 <term>1 or arabic</term>
13581 <para>Arabic numeration (1, 2, 3 ...).</para>
13585 <term>A or upperalpha</term>
13587 <para>Uppercase letter numeration (A, B, C ...).</para>
13591 <term>a or loweralpha</term>
13593 <para>Lowercase letter numeration (a, b, c ...).</para>
13597 <term>I or upperroman</term>
13599 <para>Uppercase roman numeration (I, II, III ...).</para>
13603 <term>i or lowerroman</term>
13605 <para>Lowercase roman letter numeration (i, ii, iii ...).</para>
13610 <para>Any nonzero value other than the above will generate
13611 the default number format (upperroman).
13618 <refentry version="5.0" id="reference.autolabel">
13620 <refentrytitle>reference.autolabel</refentrytitle>
13621 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
13622 <refmiscinfo class="other" otherclass="value">0<alt>none</alt></refmiscinfo>
13623 <refmiscinfo class="other" otherclass="value">1<alt>1,2,3...</alt></refmiscinfo>
13624 <refmiscinfo class="other" otherclass="value">A<alt>A,B,C...</alt></refmiscinfo>
13625 <refmiscinfo class="other" otherclass="value">a<alt>a,b,c...</alt></refmiscinfo>
13626 <refmiscinfo class="other" otherclass="value">i<alt>i,ii,iii...</alt></refmiscinfo>
13627 <refmiscinfo class="other" otherclass="value">I<alt>I,II,III...</alt></refmiscinfo>
13630 <refname>reference.autolabel</refname>
13631 <refpurpose>Specifies the labeling format for Reference titles</refpurpose>
13634 <programlisting id="reference.autolabel.frag">
13635 <xsl:param name="reference.autolabel">I</xsl:param>
13638 <refsection><info><title>Description</title></info>
13639 <para>If non-zero, references will be numbered using the parameter
13640 value as the number format if the value matches one of the
13645 <term>1 or arabic</term>
13647 <para>Arabic numeration (1, 2, 3 ...).</para>
13651 <term>A or upperalpha</term>
13653 <para>Uppercase letter numeration (A, B, C ...).</para>
13657 <term>a or loweralpha</term>
13659 <para>Lowercase letter numeration (a, b, c ...).</para>
13663 <term>I or upperroman</term>
13665 <para>Uppercase roman numeration (I, II, III ...).</para>
13669 <term>i or lowerroman</term>
13671 <para>Lowercase roman letter numeration (i, ii, iii ...).</para>
13675 <para>Any non-zero value other than the above will generate
13676 the default number format (upperroman).
13681 <refentry version="5.0" id="preface.autolabel">
13683 <refentrytitle>preface.autolabel</refentrytitle>
13684 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
13685 <refmiscinfo class="other" otherclass="value">0<alt>none</alt></refmiscinfo>
13686 <refmiscinfo class="other" otherclass="value">1<alt>1,2,3...</alt></refmiscinfo>
13687 <refmiscinfo class="other" otherclass="value">A<alt>A,B,C...</alt></refmiscinfo>
13688 <refmiscinfo class="other" otherclass="value">a<alt>a,b,c...</alt></refmiscinfo>
13689 <refmiscinfo class="other" otherclass="value">i<alt>i,ii,iii...</alt></refmiscinfo>
13690 <refmiscinfo class="other" otherclass="value">I<alt>I,II,III...</alt></refmiscinfo>
13693 <refname>preface.autolabel</refname>
13694 <refpurpose>Specifices the labeling format for Preface titles</refpurpose>
13698 <programlisting id="preface.autolabel.frag"><xsl:param name="preface.autolabel" select="0"></xsl:param></programlisting>
13701 <refsection><info><title>Description</title></info>
13703 <para>If non-zero then prefaces will be numbered using the parameter
13704 value as the number format if the value matches one of the following:
13709 <term>1 or arabic</term>
13711 <para>Arabic numeration (1, 2, 3 ...).</para>
13715 <term>A or upperalpha</term>
13717 <para>Uppercase letter numeration (A, B, C ...).</para>
13721 <term>a or loweralpha</term>
13723 <para>Lowercase letter numeration (a, b, c ...).</para>
13727 <term>I or upperroman</term>
13729 <para>Uppercase roman numeration (I, II, III ...).</para>
13733 <term>i or lowerroman</term>
13735 <para>Lowercase roman letter numeration (i, ii, iii ...).</para>
13740 <para>Any nonzero value other than the above will generate
13741 the default number format (arabic).
13748 <refentry version="5.0" id="section.autolabel">
13750 <refentrytitle>section.autolabel</refentrytitle>
13751 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
13754 <refname>section.autolabel</refname>
13755 <refpurpose>Are sections enumerated?</refpurpose>
13759 <programlisting id="section.autolabel.frag"><xsl:param name="section.autolabel" select="0"></xsl:param></programlisting>
13762 <refsection><info><title>Description</title></info>
13764 <para>If true (non-zero), unlabeled sections will be enumerated.
13770 <refentry version="5.0" id="section.autolabel.max.depth">
13772 <refentrytitle>section.autolabel.max.depth</refentrytitle>
13773 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
13776 <refname>section.autolabel.max.depth</refname>
13777 <refpurpose>The deepest level of sections that are numbered.</refpurpose>
13781 <programlisting id="section.autolabel.max.depth.frag">
13782 <xsl:param name="section.autolabel.max.depth">8</xsl:param>
13786 <refsection><info><title>Description</title></info>
13788 <para>When section numbering is turned on by the
13789 <parameter>section.autolabel</parameter> parameter, then this
13790 parameter controls the depth of <tag>section</tag> nesting that is
13791 numbered. Sections nested to a level deeper than this value will not
13798 <refentry version="5.0" id="section.label.includes.component.label">
13800 <refentrytitle>section.label.includes.component.label</refentrytitle>
13801 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
13804 <refname>section.label.includes.component.label</refname>
13805 <refpurpose>Do section labels include the component label?</refpurpose>
13809 <programlisting id="section.label.includes.component.label.frag"><xsl:param name="section.label.includes.component.label" select="0"></xsl:param></programlisting>
13812 <refsection><info><title>Description</title></info>
13814 <para>If non-zero, section labels are prefixed with the label of the
13815 component that contains them.
13821 <refentry version="5.0" id="label.from.part">
13823 <refentrytitle>label.from.part</refentrytitle>
13824 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
13827 <refname>label.from.part</refname>
13828 <refpurpose>Renumber components in each part?</refpurpose>
13832 <programlisting id="label.from.part.frag">
13833 <xsl:param name="label.from.part" select="0"></xsl:param>
13837 <refsection><info><title>Description</title></info>
13839 <para>If <parameter>label.from.part</parameter> is non-zero, then
13840 numbering of components — <tag>preface</tag>,
13841 <tag>chapter</tag>, <tag>appendix</tag>, and
13842 <tag>reference</tag> (when <tag>reference</tag> occurs at the
13843 component level) — is re-started within each
13844 <tag>part</tag>.</para>
13845 <para>If <parameter>label.from.part</parameter> is zero (the
13846 default), numbering of components is <emphasis>not</emphasis>
13847 re-started within each <tag>part</tag>; instead, components are
13848 numbered sequentially throughout each <tag>book</tag>,
13849 regardless of whether or not they occur within <tag>part</tag>
13855 <refentry version="5.0" id="component.label.includes.part.label">
13857 <refentrytitle>component.label.includes.part.label</refentrytitle>
13858 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
13861 <refname>component.label.includes.part.label</refname>
13862 <refpurpose>Do component labels include the part label?</refpurpose>
13866 <programlisting id="component.label.includes.part.label.frag"><xsl:param name="component.label.includes.part.label" select="0"></xsl:param></programlisting>
13869 <refsection><info><title>Description</title></info>
13871 <para>If non-zero, number labels for <tag>chapter</tag>,
13872 <tag>appendix</tag>, and other component elements are prefixed with
13873 the label of the part element that contains them. So you might see
13874 Chapter II.3 instead of Chapter 3. Also, the labels for formal
13875 elements such as <tag>table</tag> and <tag>figure</tag> will include
13876 the part label. If there is no part element container, then no prefix
13880 This feature is most useful when the
13881 <parameter>label.from.part</parameter> parameter is turned on.
13882 In that case, there would be more than one <tag>chapter</tag>
13883 <quote>1</quote>, and the extra part label prefix will identify
13884 each chapter unambiguously.
13890 </reference><reference id="xslt" xml:base="../fo/param.xml"><title>XSLT Processing</title>
13891 <refentry version="5.0" id="rootid">
13893 <refentrytitle>rootid</refentrytitle>
13894 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
13897 <refname>rootid</refname>
13898 <refpurpose>Specify the root element to format</refpurpose>
13902 <programlisting id="rootid.frag">
13903 <xsl:param name="rootid"></xsl:param></programlisting>
13906 <refsection><info><title>Description</title></info>
13908 <para>If <parameter>rootid</parameter> is not empty, it must be the
13909 value of an ID that occurs in the document being formatted. The entire
13910 document will be loaded and parsed, but formatting will begin at the
13911 element identified, rather than at the root. For example, this allows
13912 you to process only <tag>chapter</tag> 4 of a <tag>book</tag>.</para>
13913 <para>Because the entire document is available to the processor, automatic
13914 numbering, cross references, and other dependencies are correctly
13920 </reference><reference id="meta" xml:base="../fo/param.xml"><title>Meta/*Info</title>
13921 <refentry version="5.0" id="make.single.year.ranges">
13923 <refentrytitle>make.single.year.ranges</refentrytitle>
13924 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
13927 <refname>make.single.year.ranges</refname>
13928 <refpurpose>Print single-year ranges (e.g., 1998-1999)</refpurpose>
13932 <programlisting id="make.single.year.ranges.frag">
13933 <xsl:param name="make.single.year.ranges" select="0"></xsl:param></programlisting>
13936 <refsection><info><title>Description</title></info>
13938 <para>If non-zero, year ranges that span a single year will be printed
13939 in range notation (1998-1999) instead of discrete notation
13940 (1998, 1999).</para>
13945 <refentry version="5.0" id="make.year.ranges">
13947 <refentrytitle>make.year.ranges</refentrytitle>
13948 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
13951 <refname>make.year.ranges</refname>
13952 <refpurpose>Collate copyright years into ranges?</refpurpose>
13956 <programlisting id="make.year.ranges.frag"><xsl:param name="make.year.ranges" select="0"></xsl:param></programlisting>
13959 <refsection><info><title>Description</title></info>
13961 <para>If non-zero, multiple copyright <tag>year</tag> elements will be
13962 collated into ranges.
13963 This works only if each year number is put into a separate
13964 year element. The copyright element permits multiple
13965 year elements. If a year element contains a dash or
13966 a comma, then that year element will not be merged into
13973 <refentry version="5.0" id="author.othername.in.middle">
13975 <refentrytitle>author.othername.in.middle</refentrytitle>
13976 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
13979 <refname>author.othername.in.middle</refname>
13980 <refpurpose>Is <tag>othername</tag> in <tag>author</tag> a
13981 middle name?</refpurpose>
13985 <programlisting id="author.othername.in.middle.frag">
13986 <xsl:param name="author.othername.in.middle" select="1"></xsl:param></programlisting>
13989 <refsection><info><title>Description</title></info>
13991 <para>If non-zero, the <tag>othername</tag> of an <tag>author</tag>
13992 appears between the <tag>firstname</tag> and
13993 <tag>surname</tag>. Otherwise, <tag>othername</tag>
14000 </reference><reference id="refentry" xml:base="../fo/param.xml"><title>Reference Pages</title>
14001 <refentry version="5.0" id="funcsynopsis.decoration">
14003 <refentrytitle>funcsynopsis.decoration</refentrytitle>
14004 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
14007 <refname>funcsynopsis.decoration</refname>
14008 <refpurpose>Decorate elements of a <tag>funcsynopsis</tag>?</refpurpose>
14012 <programlisting id="funcsynopsis.decoration.frag">
14013 <xsl:param name="funcsynopsis.decoration" select="1"></xsl:param>
14017 <refsection><info><title>Description</title></info>
14019 <para>If non-zero, elements of the <tag>funcsynopsis</tag> will be
14020 decorated (e.g. rendered as bold or italic text). The decoration is controlled by
14021 templates that can be redefined in a customization layer.
14027 <refentry version="5.0" id="funcsynopsis.style">
14029 <refentrytitle>funcsynopsis.style</refentrytitle>
14030 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
14031 <refmiscinfo class="other" otherclass="value">ansi</refmiscinfo>
14032 <refmiscinfo class="other" otherclass="value">kr</refmiscinfo>
14035 <refname>funcsynopsis.style</refname>
14036 <refpurpose>What style of <tag>funcsynopsis</tag> should be generated?</refpurpose>
14040 <programlisting id="funcsynopsis.style.frag"><xsl:param name="funcsynopsis.style">kr</xsl:param></programlisting>
14043 <refsection><info><title>Description</title></info>
14045 <para>If <parameter>funcsynopsis.style</parameter> is <literal>ansi</literal>,
14046 ANSI-style function synopses are generated for a
14047 <tag>funcsynopsis</tag>, otherwise K&R-style
14048 function synopses are generated.
14054 <refentry version="5.0" id="function.parens">
14056 <refentrytitle>function.parens</refentrytitle>
14057 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
14060 <refname>function.parens</refname>
14061 <refpurpose>Generate parens after a function?</refpurpose>
14065 <programlisting id="function.parens.frag">
14066 <xsl:param name="function.parens" select="0"></xsl:param>
14070 <refsection><info><title>Description</title></info>
14072 <para>If non-zero, the formatting of a <tag>function</tag> element
14073 will include generated parentheses.
14079 <refentry version="5.0" id="refentry.generate.name">
14081 <refentrytitle>refentry.generate.name</refentrytitle>
14082 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
14085 <refname>refentry.generate.name</refname>
14086 <refpurpose>Output NAME header before <tag>refname</tag>s?</refpurpose>
14090 <programlisting id="refentry.generate.name.frag">
14091 <xsl:param name="refentry.generate.name" select="1"></xsl:param>
14095 <refsection><info><title>Description</title></info>
14097 <para>If non-zero, a "NAME" section title is output before the list
14098 of <tag>refname</tag>s. This parameter and
14099 <parameter>refentry.generate.title</parameter> are mutually
14100 exclusive. This means that if you change this parameter to zero, you
14101 should set <parameter>refentry.generate.title</parameter> to non-zero unless
14102 you want get quite strange output.
14108 <refentry version="5.0" id="refentry.generate.title">
14110 <refentrytitle>refentry.generate.title</refentrytitle>
14111 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
14114 <refname>refentry.generate.title</refname>
14115 <refpurpose>Output title before <tag>refname</tag>s?</refpurpose>
14119 <programlisting id="refentry.generate.title.frag">
14120 <xsl:param name="refentry.generate.title" select="0"></xsl:param>
14124 <refsection><info><title>Description</title></info>
14126 <para>If non-zero, the reference page title or first name is
14127 output before the list of <tag>refname</tag>s. This parameter and
14128 <parameter>refentry.generate.name</parameter> are mutually exclusive.
14129 This means that if you change this parameter to non-zero, you
14130 should set <parameter>refentry.generate.name</parameter> to zero unless
14131 you want get quite strange output.</para>
14137 <refentry version="5.0" id="refentry.pagebreak">
14139 <refentrytitle>refentry.pagebreak</refentrytitle>
14140 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
14143 <refname>refentry.pagebreak</refname>
14144 <refpurpose>Start each refentry on a new page</refpurpose>
14148 <programlisting id="refentry.pagebreak.frag"><xsl:param name="refentry.pagebreak" select="1"></xsl:param></programlisting>
14151 <refsection><info><title>Description</title></info>
14153 <para>If non-zero (the default), each <tag>refentry</tag>
14154 element will start on a new page. If zero, a page
14155 break will not be generated between <tag>refentry</tag> elements.
14156 The exception is when the <tag>refentry</tag> elements are children of
14157 a <tag>part</tag> element, in which case the page breaks are always
14158 retained. That is because a <tag>part</tag> element does not generate
14159 a page-sequence for its children, so each <tag>refentry</tag> must
14160 start its own page-sequence.
14166 <refentry version="5.0" id="refentry.title.properties">
14168 <refentrytitle>refentry.title.properties</refentrytitle>
14169 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
14172 <refname>refentry.title.properties</refname>
14173 <refpurpose>Title properties for a refentry title</refpurpose>
14177 <programlisting id="refentry.title.properties.frag">
14178 <xsl:attribute-set name="refentry.title.properties">
14179 <xsl:attribute name="font-family">
14180 <xsl:value-of select="$title.fontset"></xsl:value-of>
14181 </xsl:attribute>
14182 <xsl:attribute name="font-size">18pt</xsl:attribute>
14183 <xsl:attribute name="font-weight">bold</xsl:attribute>
14184 <xsl:attribute name="space-after">1em</xsl:attribute>
14185 <xsl:attribute name="hyphenate">false</xsl:attribute>
14186 <xsl:attribute name="keep-with-next.within-column">always</xsl:attribute>
14187 <xsl:attribute name="space-before.minimum">0.8em</xsl:attribute>
14188 <xsl:attribute name="space-before.optimum">1.0em</xsl:attribute>
14189 <xsl:attribute name="space-before.maximum">1.2em</xsl:attribute>
14190 <xsl:attribute name="space-after.optimum">0.5em</xsl:attribute>
14191 <xsl:attribute name="space-after.minimum">0.4em</xsl:attribute>
14192 <xsl:attribute name="space-after.maximum">0.6em</xsl:attribute>
14193 <xsl:attribute name="start-indent"><xsl:value-of select="$title.margin.left"></xsl:value-of></xsl:attribute>
14194 </xsl:attribute-set>
14198 <refsection><info><title>Description</title></info>
14200 <para>Formatting properties applied to the title generated for the
14201 <tag>refnamediv</tag> part of output for
14202 <tag>refentry</tag> when the value of the
14203 <parameter>refentry.generate.title</parameter> parameter is
14204 non-zero. The font size is supplied by the appropriate <parameter>section.level<replaceable>X</replaceable>.title.properties</parameter>
14205 attribute-set, computed from the location of the
14206 <tag>refentry</tag> in the section hierarchy.</para>
14209 <para>This parameter has no effect on the the title generated for
14210 the <tag>refnamediv</tag> part of output for
14211 <tag>refentry</tag> when the value of the
14212 <parameter>refentry.generate.name</parameter> parameter is
14213 non-zero. By default, that title is formatted with the same
14214 properties as the titles for all other first-level children of
14215 <tag>refentry</tag>.</para>
14221 <refentry version="5.0" id="refentry.xref.manvolnum">
14223 <refentrytitle>refentry.xref.manvolnum</refentrytitle>
14224 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
14227 <refname>refentry.xref.manvolnum</refname>
14228 <refpurpose>Output <tag>manvolnum</tag> as part of
14229 <tag>refentry</tag> cross-reference?</refpurpose>
14233 <programlisting id="refentry.xref.manvolnum.frag">
14234 <xsl:param name="refentry.xref.manvolnum" select="1"></xsl:param>
14238 <refsection><info><title>Description</title></info>
14240 <para>if non-zero, the <tag>manvolnum</tag> is used when cross-referencing
14241 <tag>refentry</tag>s, either with <tag>xref</tag>
14242 or <tag>citerefentry</tag>.
14248 <refentry version="5.0" id="refclass.suppress">
14250 <refentrytitle>refclass.suppress</refentrytitle>
14251 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
14254 <refname>refclass.suppress</refname>
14255 <refpurpose>Suppress display of refclass contents?</refpurpose>
14259 <programlisting id="refclass.suppress.frag">
14260 <xsl:param name="refclass.suppress" select="0"></xsl:param></programlisting>
14263 <refsection><info><title>Description</title></info>
14265 <para>If the value of <parameter>refclass.suppress</parameter> is
14266 non-zero, then display of <tag>refclass</tag> contents is
14267 suppressed in output.</para>
14272 </reference><reference id="tables" xml:base="../fo/param.xml"><title>Tables</title>
14273 <refentry version="5.0" id="default.table.width">
14275 <refentrytitle>default.table.width</refentrytitle>
14276 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
14279 <refname>default.table.width</refname>
14280 <refpurpose>The default width of tables</refpurpose>
14283 <programlisting id="default.table.width.frag">
14284 <xsl:param name="default.table.width"></xsl:param>
14287 <refsection><info><title>Description</title></info>
14288 <para>If non-zero, this value will be used for the
14289 <literal>width</literal> attribute on <tag>table</tag>s that do not specify an
14290 alternate width (with the <tag class="xmlpi">dbhtml table-width</tag> or
14291 <tag class="xmlpi">dbfo table-width</tag> processing instruction).</para>
14295 <refentry version="5.0" id="nominal.table.width">
14297 <refentrytitle>nominal.table.width</refentrytitle>
14298 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
14301 <refname>nominal.table.width</refname>
14302 <refpurpose>The (absolute) nominal width of tables</refpurpose>
14306 <programlisting id="nominal.table.width.frag">
14307 <xsl:param name="nominal.table.width">6in</xsl:param>
14311 <refsection><info><title>Description</title></info>
14313 <para>In order to convert CALS column widths into HTML column widths, it
14314 is sometimes necessary to have an absolute table width to use for conversion
14315 of mixed absolute and relative widths. This value must be an absolute
14316 length (not a percentage).</para>
14321 <refentry version="5.0" id="default.table.frame">
14323 <refentrytitle>default.table.frame</refentrytitle>
14324 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
14327 <refname>default.table.frame</refname>
14328 <refpurpose>The default framing of tables</refpurpose>
14332 <programlisting id="default.table.frame.frag">
14333 <xsl:param name="default.table.frame">all</xsl:param>
14337 <refsection><info><title>Description</title></info>
14339 <para>This value will be used when there is no frame attribute on the
14345 <refentry version="5.0" id="default.table.rules">
14347 <refentrytitle>default.table.rules</refentrytitle>
14348 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
14351 <refname>default.table.rules</refname>
14352 <refpurpose>The default column and row rules for tables using HTML markup</refpurpose>
14356 <programlisting id="default.table.rules.frag">
14357 <xsl:param name="default.table.rules">none</xsl:param>
14361 <refsection><info><title>Description</title></info>
14363 <para>Tables using HTML markup elements can use an attribute
14364 named <tag class="attribute">rules</tag> on the <tag>table</tag> or
14365 <tag>informaltable</tag> element
14366 to specify whether column and row border rules should be
14367 displayed. This parameter lets you specify a global default
14368 style for all HTML tables that don't otherwise have
14369 that attribute.</para>
14370 <para>These are the supported values:</para>
14373 <varlistentry><term>all</term>
14375 <para>Rules will appear between all rows and columns.</para>
14379 <varlistentry><term>rows</term>
14381 <para>Rules will appear between rows only.</para>
14385 <varlistentry><term>cols</term>
14387 <para>Rules will appear between columns only.</para>
14391 <varlistentry><term>groups</term>
14393 <para>Rules will appear between row groups (thead, tfoot, tbody).
14394 No support for rules between column groups yet.
14399 <varlistentry><term>none</term>
14401 <para>No rules. This is the default value.
14408 <para>The border after the last row and the border after
14409 the last column are not affected by
14410 this setting. Those borders are controlled by
14411 the <tag class="attribute">frame</tag> attribute on the table element.
14417 <refentry version="5.0" id="table.cell.padding">
14419 <refentrytitle>table.cell.padding</refentrytitle>
14420 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
14423 <refname>table.cell.padding</refname>
14424 <refpurpose>Specifies the padding of table cells</refpurpose>
14428 <programlisting id="table.cell.padding.frag">
14429 <xsl:attribute-set name="table.cell.padding">
14430 <xsl:attribute name="padding-start">2pt</xsl:attribute>
14431 <xsl:attribute name="padding-end">2pt</xsl:attribute>
14432 <xsl:attribute name="padding-top">2pt</xsl:attribute>
14433 <xsl:attribute name="padding-bottom">2pt</xsl:attribute>
14434 </xsl:attribute-set>
14438 <refsection><info><title>Description</title></info>
14440 <para>Specifies the padding of table cells.</para>
14445 <refentry version="5.0" id="table.frame.border.thickness">
14447 <refentrytitle>table.frame.border.thickness</refentrytitle>
14448 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
14451 <refname>table.frame.border.thickness</refname>
14452 <refpurpose>Specifies the thickness of the frame border</refpurpose>
14456 <programlisting id="table.frame.border.thickness.frag">
14457 <xsl:param name="table.frame.border.thickness">
14459 <xsl:when test="contains($stylesheet.result.type,'html')">1px</xsl:when>
14460 <xsl:otherwise>0.5pt</xsl:otherwise>
14461 </xsl:choose>
14466 <refsection><info><title>Description</title></info>
14468 <para>Specifies the thickness of the border on the table's frame.</para>
14473 <refentry version="5.0" id="table.frame.border.style">
14475 <refentrytitle>table.frame.border.style</refentrytitle>
14476 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
14477 <refmiscinfo class="other" otherclass="value">none</refmiscinfo>
14478 <refmiscinfo class="other" otherclass="value">solid</refmiscinfo>
14479 <refmiscinfo class="other" otherclass="value">dotted</refmiscinfo>
14480 <refmiscinfo class="other" otherclass="value">dashed</refmiscinfo>
14481 <refmiscinfo class="other" otherclass="value">double</refmiscinfo>
14482 <refmiscinfo class="other" otherclass="value">groove</refmiscinfo>
14483 <refmiscinfo class="other" otherclass="value">ridge</refmiscinfo>
14484 <refmiscinfo class="other" otherclass="value">inset</refmiscinfo>
14485 <refmiscinfo class="other" otherclass="value">outset</refmiscinfo>
14486 <refmiscinfo class="other" otherclass="value">solid</refmiscinfo>
14489 <refname>table.frame.border.style</refname>
14490 <refpurpose>Specifies the border style of table frames</refpurpose>
14494 <programlisting id="table.frame.border.style.frag">
14495 <xsl:param name="table.frame.border.style">solid</xsl:param>
14499 <refsection><info><title>Description</title></info>
14501 <para>Specifies the border style of table frames.</para>
14506 <refentry version="5.0" id="table.frame.border.color">
14508 <refentrytitle>table.frame.border.color</refentrytitle>
14509 <refmiscinfo class="other" otherclass="datatype">color</refmiscinfo>
14512 <refname>table.frame.border.color</refname>
14513 <refpurpose>Specifies the border color of table frames</refpurpose>
14517 <programlisting id="table.frame.border.color.frag">
14519 <xsl:param name="table.frame.border.color">black</xsl:param>
14523 <refsection><info><title>Description</title></info>
14525 <para>Specifies the border color of table frames.</para>
14530 <refentry version="5.0" id="table.cell.border.thickness">
14532 <refentrytitle>table.cell.border.thickness</refentrytitle>
14533 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
14536 <refname>table.cell.border.thickness</refname>
14537 <refpurpose>Specifies the thickness of table cell borders</refpurpose>
14541 <programlisting id="table.cell.border.thickness.frag">
14542 <xsl:param name="table.cell.border.thickness">
14544 <xsl:when test="contains($stylesheet.result.type,'html')">1px</xsl:when>
14545 <xsl:otherwise>0.5pt</xsl:otherwise>
14546 </xsl:choose>
14551 <refsection><info><title>Description</title></info>
14553 <para>If non-zero, specifies the thickness of borders on table
14554 cells. See <link xlink:href="http://www.w3.org/TR/CSS21/box.html#border-width-properties">
14558 <para>To control properties of cell borders in HTML output, you must also turn on the
14559 <parameter>table.borders.with.css</parameter> parameter.</para>
14565 <refentry version="5.0" id="table.cell.border.style">
14567 <refentrytitle>table.cell.border.style</refentrytitle>
14568 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
14569 <refmiscinfo class="other" otherclass="value">none</refmiscinfo>
14570 <refmiscinfo class="other" otherclass="value">solid</refmiscinfo>
14571 <refmiscinfo class="other" otherclass="value">dotted</refmiscinfo>
14572 <refmiscinfo class="other" otherclass="value">dashed</refmiscinfo>
14573 <refmiscinfo class="other" otherclass="value">double</refmiscinfo>
14574 <refmiscinfo class="other" otherclass="value">groove</refmiscinfo>
14575 <refmiscinfo class="other" otherclass="value">ridge</refmiscinfo>
14576 <refmiscinfo class="other" otherclass="value">inset</refmiscinfo>
14577 <refmiscinfo class="other" otherclass="value">outset</refmiscinfo>
14578 <refmiscinfo class="other" otherclass="value">solid</refmiscinfo>
14581 <refname>table.cell.border.style</refname>
14582 <refpurpose>Specifies the border style of table cells</refpurpose>
14586 <programlisting id="table.cell.border.style.frag">
14587 <xsl:param name="table.cell.border.style">solid</xsl:param>
14591 <refsection><info><title>Description</title></info>
14593 <para>Specifies the border style of table cells.</para>
14596 <para>To control properties of cell borders in HTML output, you must also turn on the
14597 <parameter>table.borders.with.css</parameter> parameter.</para>
14603 <refentry version="5.0" id="table.cell.border.color">
14605 <refentrytitle>table.cell.border.color</refentrytitle>
14606 <refmiscinfo class="other" otherclass="datatype">color</refmiscinfo>
14609 <refname>table.cell.border.color</refname>
14610 <refpurpose>Specifies the border color of table cells</refpurpose>
14614 <programlisting id="table.cell.border.color.frag">
14616 <xsl:param name="table.cell.border.color">black</xsl:param>
14620 <refsection><info><title>Description</title></info>
14622 <para>Set the color of table cell borders. If non-zero, the value is used
14623 for the border coloration. See <link xlink:href="http://www.w3.org/TR/CSS21/syndata.html#value-def-color">CSS</link>. A
14624 <literal>color</literal> is either a keyword or a numerical RGB specification.
14625 Keywords are aqua, black, blue, fuchsia, gray, green, lime, maroon,
14626 navy, olive, orange, purple, red, silver, teal, white, and
14630 <para>To control properties of cell borders in HTML output, you must also turn on the
14631 <parameter>table.borders.with.css</parameter> parameter.</para>
14637 <refentry version="5.0" id="table.table.properties">
14639 <refentrytitle>table.table.properties</refentrytitle>
14640 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
14643 <refname>table.table.properties</refname>
14644 <refpurpose>Properties associated with a table</refpurpose>
14648 <programlisting id="table.table.properties.frag">
14649 <xsl:attribute-set name="table.table.properties">
14650 <xsl:attribute name="border-before-width.conditionality">retain</xsl:attribute>
14651 <xsl:attribute name="border-collapse">collapse</xsl:attribute>
14652 </xsl:attribute-set>
14656 <refsection><info><title>Description</title></info>
14658 <para>The styling for tables. This parameter should really
14659 have been called <literal>table.properties</literal>, but that parameter
14660 name was inadvertently established for the block-level properties
14661 of the table as a whole.
14664 <para>See also <parameter>table.properties</parameter>.</para>
14669 <refentry version="5.0" id="table.caption.properties">
14671 <refentrytitle>table.caption.properties</refentrytitle>
14672 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
14675 <refname>table.caption.properties</refname>
14676 <refpurpose>Properties associated with a table caption</refpurpose>
14680 <programlisting id="table.caption.properties.frag">
14681 <xsl:attribute-set name="table.caption.properties">
14682 <xsl:attribute name="keep-together.within-column">always</xsl:attribute>
14683 </xsl:attribute-set>
14687 <refsection><info><title>Description</title></info>
14689 <para>The styling for table caption element (not the table title).</para>
14691 <para>See also <parameter>table.properties</parameter>.</para>
14696 </reference><reference id="links" xml:base="../fo/param.xml"><title>Linking</title>
14697 <refentry version="5.0" id="current.docid">
14699 <refentrytitle>current.docid</refentrytitle>
14700 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
14703 <refname>current.docid</refname>
14704 <refpurpose>targetdoc identifier for the document being
14705 processed</refpurpose>
14707 <refsynopsisdiv> <programlisting id="current.docid.frag">
14708 <xsl:param name="current.docid"></xsl:param>
14711 <refsection><info><title>Description</title></info>
14713 <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
14714 the targetdoc identifier of the current document, since that
14715 identifier does not appear in the document itself. </para>
14716 <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>
14720 <refentry version="5.0" id="activate.external.olinks">
14722 <refentrytitle>activate.external.olinks</refentrytitle>
14723 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
14726 <refname>activate.external.olinks</refname>
14727 <refpurpose>Make external olinks into active links</refpurpose>
14731 <programlisting id="activate.external.olinks.frag">
14732 <xsl:param name="activate.external.olinks" select="1"></xsl:param>
14736 <refsection><info><title>Description</title></info>
14738 <para>If <parameter>activate.external.olinks</parameter> is nonzero
14739 (the default), then any olinks that reference another document
14740 become active links that can be clicked on to follow the link.
14741 If the parameter is set to zero, then external olinks
14742 will have the appropriate link text generated, but the link is
14743 not made active. Olinks to destinations in
14744 the current document remain active.</para>
14746 <para>To make an external olink active for HTML
14747 outputs, the link text is wrapped in an <tag>a</tag>
14748 element with an <tag>href</tag> attribute. To
14749 make an external olink active for FO outputs, the link text is
14750 wrapped in an <tag>fo:basic-link</tag> element with an
14751 <tag>external-destination</tag> attribute.</para>
14753 <para>This parameter is useful when you need external olinks
14754 to resolve but not be clickable. For example, if documents
14755 in a collection are available independently of each other,
14756 then having active links between them could lead to
14757 unresolved links when a given target document is missing.</para>
14759 <para>The epub stylesheets set this parameter to zero by default
14760 because there is no standard linking mechanism between Epub documents.</para>
14762 <para>If external links are made inactive, you should
14763 consider setting the
14764 stylesheet parameter <parameter>olink.doctitle</parameter>
14765 to <literal>yes</literal>. That will append the external document's
14766 title to the link text, making it easier for the user to
14767 locate the other document.</para>
14769 <para>An olink is considered external when the
14770 <parameter>current.docid</parameter> stylesheet parameter
14771 is set to some value, and the olink's <tag>targetdoc</tag>
14772 attribute has a different value. If the two values
14773 match, then the link is considered internal. If the
14774 <parameter>current.docid</parameter> parameter is blank, or
14775 the <tag>olink</tag> element does not have a <tag>targetdoc</tag> attribute,
14776 then the link is considered to be internal and will become
14777 an active link.</para>
14779 <para>See also <parameter>olink.doctitle</parameter>,
14780 <parameter>prefer.internal.olink</parameter>.</para>
14785 <refentry version="5.0" id="collect.xref.targets">
14787 <refentrytitle>collect.xref.targets</refentrytitle>
14788 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
14789 <refmiscinfo class="other" otherclass="value">no</refmiscinfo>
14790 <refmiscinfo class="other" otherclass="value">yes</refmiscinfo>
14791 <refmiscinfo class="other" otherclass="value">only</refmiscinfo>
14794 <refname>collect.xref.targets</refname>
14795 <refpurpose>Controls whether cross reference data is
14796 collected</refpurpose>
14798 <refsynopsisdiv> <programlisting id="collect.xref.targets.frag">
14799 <xsl:param name="collect.xref.targets">no</xsl:param>
14802 <refsection><info><title>Description</title></info>
14805 In order to resolve olinks efficiently, the stylesheets can
14806 generate an external data file containing information about
14807 all potential cross reference endpoints in a document.
14808 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.
14809 See also <parameter>targets.filename</parameter>.
14814 <refentry version="5.0" id="insert.olink.page.number">
14816 <refentrytitle>insert.olink.page.number</refentrytitle>
14817 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
14818 <refmiscinfo class="other" otherclass="value">no</refmiscinfo>
14819 <refmiscinfo class="other" otherclass="value">yes</refmiscinfo>
14820 <refmiscinfo class="other" otherclass="value">maybe</refmiscinfo>
14823 <refname>insert.olink.page.number</refname>
14824 <refpurpose>Turns page numbers in olinks on and off</refpurpose>
14828 <programlisting id="insert.olink.page.number.frag">
14829 <xsl:param name="insert.olink.page.number">no</xsl:param>
14833 <refsection><info><title>Description</title></info>
14835 <para>The value of this parameter determines if
14836 cross references made between documents with
14837 <tag>olink</tag> will
14838 include page number citations.
14839 In most cases this is only applicable to references in printed output.
14841 <para>The parameter has three possible values.
14846 <listitem><para>No page number references will be generated for olinks.
14851 <listitem><para>Page number references will be generated
14852 for all <tag>olink</tag> references.
14853 The style of page reference may be changed
14854 if an <tag class="attribute">xrefstyle</tag>
14860 <listitem><para>Page number references will not be generated
14861 for an <tag>olink</tag> element unless
14863 <tag class="attribute">xrefstyle</tag>
14864 attribute whose value specifies a page reference.
14868 <para>Olinks that point to targets within the same document
14869 are treated as <tag>xref</tag>s, and controlled by
14870 the <parameter>insert.xref.page.number</parameter> parameter.
14873 <para>Page number references for olinks to
14874 external documents can only be inserted if the
14875 information exists in the olink database.
14876 This means each olink target element
14877 (<tag>div</tag> or <tag>obj</tag>)
14878 must have a <tag class="attribute">page</tag> attribute
14879 whose value is its page number in the target document.
14880 The XSL stylesheets are not able to extract that information
14881 during processing because pages have not yet been created in
14882 XSLT transformation. Only the XSL-FO processor knows what
14883 page each element is placed on.
14884 Therefore some postprocessing must take place to populate
14885 page numbers in the olink database.
14893 <refentry version="5.0" id="insert.olink.pdf.frag">
14895 <refentrytitle>insert.olink.pdf.frag</refentrytitle>
14896 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
14899 <refname>insert.olink.pdf.frag</refname>
14900 <refpurpose>Add fragment identifiers for links into PDF files</refpurpose>
14904 <programlisting id="insert.olink.pdf.frag.frag">
14905 <xsl:param name="insert.olink.pdf.frag" select="0"></xsl:param>
14909 <refsection><info><title>Description</title></info>
14911 <para>The value of this parameter determines whether
14912 the cross reference URIs to PDF documents made with
14913 <tag>olink</tag> will
14914 include fragment identifiers.
14917 <para>When forming a URI to link to a PDF document,
14918 a fragment identifier (typically a '#' followed by an
14919 id value) appended to the PDF filename can be used by
14920 the PDF viewer to open
14921 the PDF file to a location within the document instead of
14923 However, not all PDF files have id
14924 values embedded in them, and not all PDF viewers can
14925 handle fragment identifiers.
14928 <para>If <parameter>insert.olink.pdf.frag</parameter> is set
14929 to a non-zero value, then any olink targeting a
14930 PDF file will have the fragment identifier appended to the URI.
14931 The URI is formed by concatenating the value of the
14932 <parameter>olink.base.uri</parameter> parameter, the
14933 value of the <tag class="attribute">baseuri</tag>
14934 attribute from the <tag class="element">document</tag>
14935 element in the olink database with the matching
14936 <tag class="attribute">targetdoc</tag> value,
14937 and the value of the <tag class="attribute">href</tag>
14938 attribute for the targeted element in the olink database.
14939 The <tag class="attribute">href</tag> attribute
14940 contains the fragment identifier.
14943 <para>If <parameter>insert.olink.pdf.frag</parameter> is set
14944 to zero (the default value), then
14945 the <tag class="attribute">href</tag> attribute
14946 from the olink database
14947 is not appended to PDF olinks, so the fragment identifier is left off.
14948 A PDF olink is any olink for which the
14949 <tag class="attribute">baseuri</tag> attribute
14950 from the matching <tag class="element">document</tag>
14951 element in the olink database ends with '.pdf'.
14952 Any other olinks will still have the fragment identifier added.
14957 <refentry version="5.0" id="olink.base.uri">
14959 <refentrytitle>olink.base.uri</refentrytitle>
14960 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
14963 <refname>olink.base.uri</refname>
14964 <refpurpose>Base URI used in olink hrefs</refpurpose>
14966 <refsynopsisdiv> <programlisting id="olink.base.uri.frag">
14967 <xsl:param name="olink.base.uri"></xsl:param>
14970 <refsection><info><title>Description</title></info>
14972 <para>When cross reference data is collected for resolving olinks, it
14973 may be necessary to prepend a base URI to each target's href. This
14974 parameter lets you set that base URI when cross reference data is
14975 collected. This feature is needed when you want to link to a document
14976 that is processed without chunking. The output filename for such a
14977 document is not known to the XSL stylesheet; the only target
14978 information consists of fragment identifiers such as
14979 <literal>#idref</literal>. To enable the resolution of olinks between
14980 documents, you should pass the name of the HTML output file as the
14981 value of this parameter. Then the hrefs recorded in the cross
14982 reference data collection look like
14983 <literal>outfile.html#idref</literal>, which can be reached as links
14984 from other documents.</para>
14988 <refentry version="5.0" id="olink.debug">
14990 <refentrytitle>olink.debug</refentrytitle>
14991 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
14994 <refname>olink.debug</refname>
14995 <refpurpose>Turn on debugging messages for olinks</refpurpose>
14999 <programlisting id="olink.debug.frag">
15000 <xsl:param name="olink.debug" select="0"></xsl:param>
15004 <refsection><info><title>Description</title></info>
15006 <para>If non-zero, then each olink will generate several
15007 messages about how it is being resolved during processing.
15008 This is useful when an olink does not resolve properly
15009 and the standard error messages are not sufficient to
15013 <para>You may need to read through the olink XSL templates
15014 to understand the context for some of the debug messages.
15020 <refentry version="5.0" id="olink.doctitle">
15022 <refentrytitle>olink.doctitle</refentrytitle>
15023 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
15024 <refmiscinfo class="other" otherclass="value">no</refmiscinfo>
15025 <refmiscinfo class="other" otherclass="value">yes</refmiscinfo>
15026 <refmiscinfo class="other" otherclass="value">maybe</refmiscinfo>
15029 <refname>olink.doctitle</refname>
15030 <refpurpose>show the document title for external olinks?</refpurpose>
15033 <refsynopsisdiv> <programlisting id="olink.doctitle.frag">
15034 <xsl:param name="olink.doctitle">no</xsl:param>
15037 <refsection><info><title>Description</title></info>
15039 <para>When olinks between documents are resolved, the generated text
15040 may not make it clear that the reference is to another document.
15041 It is possible for the stylesheets to append the other document's
15042 title to external olinks. For this to happen, two parameters must
15046 <para>This <parameter>olink.doctitle</parameter> parameter
15047 should be set to either <literal>yes</literal> or <literal>maybe</literal>
15048 to enable this feature.
15052 <para>And you should also set the <parameter>current.docid</parameter>
15053 parameter to the document id for the document currently
15054 being processed for output.
15060 Then if an olink's <literal>targetdoc</literal> id differs from
15061 the <literal>current.docid</literal> value, the stylesheet knows
15062 that it is a reference to another document and can
15063 append the target document's
15064 title to the generated olink text. </para>
15066 <para>The text for the target document's title is copied from the
15067 olink database from the <tag>ttl</tag> element
15068 of the top-level <tag>div</tag> for that document.
15069 If that <tag>ttl</tag> element is missing or empty,
15070 no title is output.
15073 <para>The supported values for <parameter>olink.doctitle</parameter> are:
15077 <term><literal>yes</literal></term>
15080 Always insert the title to the target document if it is not
15081 the current document.
15086 <term><literal>no</literal></term>
15089 Never insert the title to the target document, even if requested
15090 in an <tag class="attribute">xrefstyle</tag> attribute.
15095 <term><literal>maybe</literal></term>
15098 Only insert the title to the target document, if requested
15099 in an <tag class="attribute">xrefstyle</tag> attribute.
15104 <para>An <tag class="attribute">xrefstyle</tag> attribute
15105 may override the global setting for individual olinks.
15106 The following values are supported in an
15107 <tag class="attribute">xrefstyle</tag>
15108 attribute using the <literal>select:</literal> syntax:
15113 <term><literal>docname</literal></term>
15116 Insert the target document name for this olink using the
15117 <literal>docname</literal> gentext template, but only
15118 if the value of <parameter>olink.doctitle</parameter>
15119 is not <literal>no</literal>.
15124 <term><literal>docnamelong</literal></term>
15127 Insert the target document name for this olink using the
15128 <literal>docnamelong</literal> gentext template, but only
15129 if the value of <parameter>olink.doctitle</parameter>
15130 is not <literal>no</literal>.
15135 <term><literal>nodocname</literal></term>
15138 Omit the target document name even if
15139 the value of <parameter>olink.doctitle</parameter>
15140 is <literal>yes</literal>.
15145 <para>Another way of inserting the target document name
15146 for a single olink is to employ an
15147 <tag class="attribute">xrefstyle</tag>
15148 attribute using the <literal>template:</literal> syntax.
15149 The <literal>%o</literal> placeholder (the letter o, not zero)
15151 will be filled in with the target document's title when it is processed.
15152 This will occur regardless of
15153 the value of <parameter>olink.doctitle</parameter>.
15155 <para>Note that prior to version 1.66 of the XSL stylesheets,
15156 the allowed values for this parameter were 0 and 1. Those
15157 values are still supported and mapped to 'no' and 'yes', respectively.
15162 <refentry version="5.0" id="olink.lang.fallback.sequence">
15164 <refentrytitle>olink.lang.fallback.sequence</refentrytitle>
15165 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
15168 <refname>olink.lang.fallback.sequence</refname>
15169 <refpurpose>look up translated documents if olink not found?</refpurpose>
15172 <refsynopsisdiv> <programlisting id="olink.lang.fallback.sequence.frag">
15173 <xsl:param name="olink.lang.fallback.sequence"></xsl:param>
15176 <refsection><info><title>Description</title></info>
15179 <para>This parameter defines a list of lang values
15180 to search among to resolve olinks.
15183 <para>Normally an olink tries to resolve to a document in the same
15184 language as the olink itself. The language of an olink
15185 is determined by its nearest ancestor element with a
15186 <tag class="attribute">lang</tag> attribute, otherwise the
15187 value of the <parameter>l10n.gentext.default.lang</parameter>
15191 <para>An olink database can contain target data for the same
15192 document in multiple languages. Each set of data has the
15193 same value for the <tag>targetdoc</tag> attribute in
15194 the <tag>document</tag> element in the database, but with a
15195 different <tag>lang</tag> attribute value.
15198 <para>When an olink is being resolved, the target is first
15199 sought in the document with the same language as the olink.
15200 If no match is found there, then this parameter is consulted
15201 for additional languages to try.</para>
15203 <para>The <parameter>olink.lang.fallback.sequence</parameter>
15204 must be a whitespace separated list of lang values to
15205 try. The first one with a match in the olink database is used.
15206 The default value is empty.</para>
15208 <para>For example, a document might be written in German
15209 and contain an olink with
15210 <literal>targetdoc="adminguide"</literal>.
15211 When the document is processed, the processor
15212 first looks for a target dataset in the
15213 olink database starting with:</para>
15215 <literallayout><literal><document targetdoc="adminguide" lang="de"></literal>.
15218 <para>If there is no such element, then the
15219 <parameter>olink.lang.fallback.sequence</parameter>
15220 parameter is consulted.
15221 If its value is, for example, <quote>fr en</quote>, then the processor next
15222 looks for <literal>targetdoc="adminguide" lang="fr"</literal>, and
15223 then for <literal>targetdoc="adminguide" lang="en"</literal>.
15224 If there is still no match, it looks for
15225 <literal>targetdoc="adminguide"</literal> with no
15229 <para>This parameter is useful when a set of documents is only
15230 partially translated, or is in the process of being translated.
15231 If a target of an olink has not yet been translated, then this
15232 parameter permits the processor to look for the document in
15233 other languages. This assumes the reader would rather have
15234 a link to a document in a different language than to have
15241 <refentry version="5.0" id="olink.properties">
15243 <refentrytitle>olink.properties</refentrytitle>
15244 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
15247 <refname>olink.properties</refname>
15248 <refpurpose>Properties associated with the cross-reference
15249 text of an olink.</refpurpose>
15253 <programlisting id="olink.properties.frag">
15254 <xsl:attribute-set name="olink.properties">
15255 <xsl:attribute name="show-destination">replace</xsl:attribute>
15256 </xsl:attribute-set>
15260 <refsection><info><title>Description</title></info>
15262 <para>This <literal>attribute set</literal> is applied to the
15263 <literal>fo:basic-link</literal> element of an olink. It is not applied to the
15264 optional page number or optional title of the external
15270 <refentry version="5.0" id="prefer.internal.olink">
15272 <refentrytitle>prefer.internal.olink</refentrytitle>
15273 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
15276 <refname>prefer.internal.olink</refname>
15277 <refpurpose>Prefer a local olink reference to an external reference</refpurpose>
15281 <programlisting id="prefer.internal.olink.frag">
15282 <xsl:param name="prefer.internal.olink" select="0"></xsl:param>
15286 <refsection><info><title>Description</title></info>
15288 <para>If you are re-using XML content modules in multiple documents,
15289 you may want to redirect some of your olinks. This parameter
15290 permits you to redirect an olink to the current document.
15293 <para>For example: you are writing documentation for a product,
15294 which includes 3 manuals: a little installation
15295 booklet (booklet.xml), a user
15296 guide (user.xml), and a reference manual (reference.xml).
15297 All 3 documents begin with the same introduction section (intro.xml) that
15298 contains a reference to the customization section (custom.xml) which is
15299 included in both user.xml and reference.xml documents.
15302 <para>How do you write the link to custom.xml in intro.xml
15303 so that it is interpreted correctly in all 3 documents?</para>
15305 <listitem><para>If you use xref, it will fail in booklet.xml.</para>
15307 <listitem><para>If you use olink (pointing to reference.xml),
15308 the reference in user.xml
15309 will point to the customization section of the reference manual, while it is
15310 actually available in user.xml.</para>
15314 <para>If you set the <parameter>prefer.internal.olink</parameter>
15315 parameter to a non-zero value, then the processor will
15316 first look in the olink database
15317 for the olink's <tag>targetptr</tag> attribute value
15318 in document matching the <parameter>current.docid</parameter>
15319 parameter value. If it isn't found there, then
15320 it tries the document in the database
15321 with the <tag>targetdoc</tag>
15322 value that matches the olink's <tag>targetdoc</tag>
15326 <para>This feature permits an olink reference to resolve to
15327 the current document if there is an element
15328 with an id matching the olink's <tag>targetptr</tag>
15329 value. The current document's olink data must be
15330 included in the target database for this to work.</para>
15333 <para>There is a potential for incorrect links if
15334 the same <tag>id</tag> attribute value is used for different
15335 content in different documents.
15336 Some of your olinks may be redirected to the current document
15337 when they shouldn't be. It is not possible to control
15338 individual olink instances.</para>
15344 <refentry version="5.0" id="target.database.document">
15346 <refentrytitle>target.database.document</refentrytitle>
15347 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
15350 <refname>target.database.document</refname>
15351 <refpurpose>Name of master database file for resolving
15352 olinks</refpurpose>
15355 <programlisting id="target.database.document.frag">
15356 <xsl:param name="target.database.document">olinkdb.xml</xsl:param>
15359 <refsection><info><title>Description</title></info>
15362 To resolve olinks between documents, the stylesheets use a master
15363 database document that identifies the target datafiles for all the
15364 documents within the scope of the olinks. This parameter value is the
15365 URI of the master document to be read during processing to resolve
15366 olinks. The default value is <filename>olinkdb.xml</filename>.</para>
15368 <para>The data structure of the file is defined in the
15369 <filename>targetdatabase.dtd</filename> DTD. The database file
15370 provides the high level elements to record the identifiers, locations,
15371 and relationships of documents. The cross reference data for
15372 individual documents is generally pulled into the database using
15373 system entity references or XIncludes. See also
15374 <parameter>targets.filename</parameter>. </para> </refsection>
15377 <refentry version="5.0" id="targets.filename">
15379 <refentrytitle>targets.filename</refentrytitle>
15380 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
15383 <refname>targets.filename</refname>
15384 <refpurpose>Name of cross reference targets data file</refpurpose>
15386 <refsynopsisdiv> <programlisting id="targets.filename.frag">
15387 <xsl:param name="targets.filename">target.db</xsl:param>
15390 <refsection><info><title>Description</title></info>
15393 In order to resolve olinks efficiently, the stylesheets can
15394 generate an external data file containing information about
15395 all potential cross reference endpoints in a document.
15396 This parameter lets you change the name of the generated
15397 file from the default name <filename>target.db</filename>.
15398 The name must agree with that used in the target database
15399 used to resolve olinks during processing.
15400 See also <parameter>target.database.document</parameter>.
15405 <refentry version="5.0" id="use.local.olink.style">
15407 <refentrytitle>use.local.olink.style</refentrytitle>
15408 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
15411 <refname>use.local.olink.style</refname>
15412 <refpurpose>Process olinks using xref style of current
15413 document</refpurpose>
15415 <refsynopsisdiv> <programlisting id="use.local.olink.style.frag">
15416 <xsl:param name="use.local.olink.style" select="0"></xsl:param> </programlisting>
15418 <refsection><info><title>Description</title></info>
15420 <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
15421 reference string is formed again from the target title, number, and
15422 element name, using the stylesheet processing the targeting document.
15423 Then olinks will match the xref style in the targeting document
15424 rather than in the target document. If both documents are processed
15425 with the same stylesheet, then the results will be the same.</para>
15429 </reference><reference id="xrefs" xml:base="../fo/param.xml"><title>Cross References</title>
15430 <refentry version="5.0" id="insert.xref.page.number">
15432 <refentrytitle>insert.xref.page.number</refentrytitle>
15433 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
15434 <refmiscinfo class="other" otherclass="value">no</refmiscinfo>
15435 <refmiscinfo class="other" otherclass="value">yes</refmiscinfo>
15436 <refmiscinfo class="other" otherclass="value">maybe</refmiscinfo>
15439 <refname>insert.xref.page.number</refname>
15440 <refpurpose>Turns page numbers in xrefs on and off</refpurpose>
15444 <programlisting id="insert.xref.page.number.frag">
15445 <xsl:param name="insert.xref.page.number">no</xsl:param>
15449 <refsection><info><title>Description</title></info>
15451 <para>The value of this parameter determines if
15452 cross references (<tag>xref</tag>s) in
15453 printed output will
15454 include page number citations.
15455 It has three possible values.
15460 <listitem><para>No page number references will be generated.
15465 <listitem><para>Page number references will be generated
15466 for all <tag>xref</tag> elements.
15467 The style of page reference may be changed
15468 if an <tag class="attribute">xrefstyle</tag>
15474 <listitem><para>Page number references will not be generated
15475 for an <tag>xref</tag> element unless
15477 <tag class="attribute">xrefstyle</tag>
15478 attribute whose value specifies a page reference.
15486 <refentry version="5.0" id="insert.xref.page.number.para">
15488 <refentrytitle>insert.xref.page.number.para</refentrytitle>
15489 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
15490 <refmiscinfo class="other" otherclass="value">yes</refmiscinfo>
15491 <refmiscinfo class="other" otherclass="value">maybe</refmiscinfo>
15494 <refname>insert.xref.page.number.para</refname>
15495 <refpurpose>Turns page numbers in xrefs to paragraphs on and off</refpurpose>
15499 <programlisting id="insert.xref.page.number.para.frag">
15500 <xsl:param name="insert.xref.page.number.para">yes</xsl:param>
15504 <refsection><info><title>Description</title></info>
15506 <para>The value of this parameter determines if
15507 cross references (<tag>xref</tag>s) to paragraphs in
15508 printed output will include page number citations.
15510 <para>Historically, cross references to paragraphs
15511 included page number citations unconditionally, regardless
15512 of the <parameter>insert.xref.page.number</parameter>
15517 <listitem><para>Page number references will be generated
15518 for paragraphs.</para></listitem>
15522 <listitem><para>Whether page number references are generated
15523 for an <tag>xref</tag> element referring to a paragraph will
15524 be controlled by the <parameter>insert.xref.page.number</parameter>
15525 rules.</para></listitem>
15533 <refentry version="5.0" id="xref.properties">
15535 <refentrytitle>xref.properties</refentrytitle>
15536 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
15539 <refname>xref.properties</refname>
15540 <refpurpose>Properties associated with cross-reference text</refpurpose>
15544 <programlisting id="xref.properties.frag">
15545 <xsl:attribute-set name="xref.properties">
15546 </xsl:attribute-set>
15550 <refsection><info><title>Description</title></info>
15552 <para>This attribute set is used to set properties
15553 on cross reference text.</para>
15558 <refentry version="5.0" id="xref.label-title.separator">
15560 <refentrytitle>xref.label-title.separator</refentrytitle>
15561 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
15564 <refname>xref.label-title.separator</refname>
15565 <refpurpose>Punctuation or space separating label from title in xref</refpurpose>
15569 <programlisting id="xref.label-title.separator.frag"><xsl:param name="xref.label-title.separator">: </xsl:param></programlisting>
15572 <refsection><info><title>Description</title></info>
15575 This parameter allows you to control the punctuation of certain
15576 types of generated cross reference text.
15577 When cross reference text is generated for an
15578 <tag class="element">xref</tag> or
15579 <tag class="element">olink</tag> element
15580 using an <tag class="attribute">xrefstyle</tag> attribute
15581 that makes use of the <literal>select:</literal> feature,
15582 and the selected components include both label and title,
15583 then the value of this parameter is inserted between
15584 label and title in the output.
15590 <refentry version="5.0" id="xref.label-page.separator">
15592 <refentrytitle>xref.label-page.separator</refentrytitle>
15593 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
15596 <refname>xref.label-page.separator</refname>
15597 <refpurpose>Punctuation or space separating label from page number in xref</refpurpose>
15601 <programlisting id="xref.label-page.separator.frag"><xsl:param name="xref.label-page.separator"><xsl:text> </xsl:text></xsl:param></programlisting>
15604 <refsection><info><title>Description</title></info>
15607 This parameter allows you to control the punctuation of certain
15608 types of generated cross reference text.
15609 When cross reference text is generated for an
15610 <tag class="element">xref</tag> or
15611 <tag class="element">olink</tag> element
15612 using an <tag class="attribute">xrefstyle</tag> attribute
15613 that makes use of the <literal>select:</literal> feature,
15614 and the selected components include both label and page
15616 then the value of this parameter is inserted between
15617 label and page number in the output.
15618 If a title is included, then other separators are used.
15624 <refentry version="5.0" id="xref.title-page.separator">
15626 <refentrytitle>xref.title-page.separator</refentrytitle>
15627 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
15630 <refname>xref.title-page.separator</refname>
15631 <refpurpose>Punctuation or space separating title from page number in xref</refpurpose>
15635 <programlisting id="xref.title-page.separator.frag"><xsl:param name="xref.title-page.separator"><xsl:text> </xsl:text></xsl:param></programlisting>
15638 <refsection><info><title>Description</title></info>
15641 This parameter allows you to control the punctuation of certain
15642 types of generated cross reference text.
15643 When cross reference text is generated for an
15644 <tag class="element">xref</tag> or
15645 <tag class="element">olink</tag> element
15646 using an <tag class="attribute">xrefstyle</tag> attribute
15647 that makes use of the <literal>select:</literal> feature,
15648 and the selected components include both title and page number,
15649 then the value of this parameter is inserted between
15650 title and page number in the output.
15656 <refentry version="5.0" id="insert.link.page.number">
15658 <refentrytitle>insert.link.page.number</refentrytitle>
15659 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
15660 <refmiscinfo class="other" otherclass="value">no</refmiscinfo>
15661 <refmiscinfo class="other" otherclass="value">yes</refmiscinfo>
15662 <refmiscinfo class="other" otherclass="value">maybe</refmiscinfo>
15665 <refname>insert.link.page.number</refname>
15666 <refpurpose>Turns page numbers in link elements on and off</refpurpose>
15670 <programlisting id="insert.link.page.number.frag">
15671 <xsl:param name="insert.link.page.number">no</xsl:param>
15675 <refsection><info><title>Description</title></info>
15677 <para>The value of this parameter determines if
15678 cross references using the <tag>link</tag> element in
15679 printed output will
15680 include standard page number citations.
15681 It has three possible values.
15686 <listitem><para>No page number references will be generated.
15691 <listitem><para>Page number references will be generated
15692 for all <tag>link</tag> elements.
15693 The style of page reference may be changed
15694 if an <tag class="attribute">xrefstyle</tag>
15700 <listitem><para>Page number references will not be generated
15701 for a <tag>link</tag> element unless
15703 <tag class="attribute">xrefstyle</tag>
15704 attribute whose value specifies a page reference.
15709 <para>Although the <tag>xrefstyle</tag> attribute
15710 can be used to turn the page reference on or off, it cannot be
15711 used to control the formatting of the page number as it
15712 can in <tag>xref</tag>.
15713 In <tag>link</tag> it will always format with
15714 the style established by the
15715 gentext template with <literal>name="page.citation"</literal>
15716 in the <literal>l:context name="xref"</literal>.
15721 </reference><reference id="lists" xml:base="../fo/param.xml"><title>Lists</title>
15722 <refentry version="5.0" id="compact.list.item.spacing">
15724 <refentrytitle>compact.list.item.spacing</refentrytitle>
15725 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
15728 <refname>compact.list.item.spacing</refname>
15729 <refpurpose>What space do you want between list items (when spacing="compact")?</refpurpose>
15733 <programlisting id="compact.list.item.spacing.frag"><xsl:attribute-set name="compact.list.item.spacing">
15734 <xsl:attribute name="space-before.optimum">0em</xsl:attribute>
15735 <xsl:attribute name="space-before.minimum">0em</xsl:attribute>
15736 <xsl:attribute name="space-before.maximum">0.2em</xsl:attribute>
15737 </xsl:attribute-set></programlisting>
15739 <refsection><info><title>Description</title></info>
15740 <para>Specify what spacing you want between each list item when
15741 <tag class="attribute">spacing</tag> is
15742 <quote><literal>compact</literal></quote>.</para>
15746 <refentry version="5.0" id="itemizedlist.properties">
15748 <refentrytitle>itemizedlist.properties</refentrytitle>
15749 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
15752 <refname>itemizedlist.properties</refname>
15753 <refpurpose>Properties that apply to each list-block generated by itemizedlist.</refpurpose>
15757 <programlisting id="itemizedlist.properties.frag"><xsl:attribute-set name="itemizedlist.properties" use-attribute-sets="list.block.properties">
15758 </xsl:attribute-set></programlisting>
15760 <refsection><info><title>Description</title></info>
15761 <para>Properties that apply to each fo:list-block generated by itemizedlist.</para>
15765 <refentry version="5.0" id="itemizedlist.label.properties">
15767 <refentrytitle>itemizedlist.label.properties</refentrytitle>
15768 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
15771 <refname>itemizedlist.label.properties</refname>
15772 <refpurpose>Properties that apply to each label inside itemized list.</refpurpose>
15776 <programlisting id="itemizedlist.label.properties.frag"><xsl:attribute-set name="itemizedlist.label.properties">
15777 </xsl:attribute-set></programlisting>
15779 <refsection><info><title>Description</title></info>
15780 <para>Properties that apply to each label inside itemized list. E.g.:</para>
15781 <programlisting><xsl:attribute-set name="itemizedlist.label.properties">
15782 <xsl:attribute name="text-align">right</xsl:attribute>
15783 </xsl:attribute-set></programlisting>
15787 <refentry version="5.0" id="itemizedlist.label.width">
15789 <refentrytitle>itemizedlist.label.width</refentrytitle>
15790 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
15793 <refname>itemizedlist.label.width</refname>
15794 <refpurpose>The default width of the label (bullet) in an itemized list.</refpurpose>
15798 <programlisting id="itemizedlist.label.width.frag">
15799 <xsl:param name="itemizedlist.label.width">1.0em</xsl:param>
15803 <refsection><info><title>Description</title></info>
15804 <para>Specifies the default width of the label (usually a bullet or other
15805 symbol) in an itemized list. You can override the default value on any
15806 particular list with the “dbfo” processing instruction using the
15807 “label-width” pseudoattribute.</para>
15811 <refentry version="5.0" id="list.block.properties">
15813 <refentrytitle>list.block.properties</refentrytitle>
15814 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
15817 <refname>list.block.properties</refname>
15818 <refpurpose>Properties that apply to each list-block generated by list.</refpurpose>
15822 <programlisting id="list.block.properties.frag"><xsl:attribute-set name="list.block.properties">
15823 <xsl:attribute name="provisional-label-separation">0.2em</xsl:attribute>
15824 <xsl:attribute name="provisional-distance-between-starts">1.5em</xsl:attribute>
15825 </xsl:attribute-set></programlisting>
15827 <refsection><info><title>Description</title></info>
15828 <para>Properties that apply to each fo:list-block generated by itemizedlist/orderedlist.</para>
15832 <refentry version="5.0" id="list.block.spacing">
15834 <refentrytitle>list.block.spacing</refentrytitle>
15835 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
15838 <refname>list.block.spacing</refname>
15839 <refpurpose>What spacing do you want before and after lists?</refpurpose>
15843 <programlisting id="list.block.spacing.frag"><xsl:attribute-set name="list.block.spacing">
15844 <xsl:attribute name="space-before.optimum">1em</xsl:attribute>
15845 <xsl:attribute name="space-before.minimum">0.8em</xsl:attribute>
15846 <xsl:attribute name="space-before.maximum">1.2em</xsl:attribute>
15847 <xsl:attribute name="space-after.optimum">1em</xsl:attribute>
15848 <xsl:attribute name="space-after.minimum">0.8em</xsl:attribute>
15849 <xsl:attribute name="space-after.maximum">1.2em</xsl:attribute>
15850 </xsl:attribute-set></programlisting>
15852 <refsection><info><title>Description</title></info>
15853 <para>Specify the spacing required before and after a list. It is necessary to specify the space after a list block because lists can come inside of paras. </para>
15854 <para>This attribute set is not applied to nested lists, so that only the
15855 <parameter>list.item.spacing</parameter> attribute-set is used, which provides
15856 consistent spacing.</para>
15860 <refentry version="5.0" id="list.item.spacing">
15862 <refentrytitle>list.item.spacing</refentrytitle>
15863 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
15866 <refname>list.item.spacing</refname>
15867 <refpurpose>What space do you want between list items?</refpurpose>
15871 <programlisting id="list.item.spacing.frag"><xsl:attribute-set name="list.item.spacing">
15872 <xsl:attribute name="space-before.optimum">1em</xsl:attribute>
15873 <xsl:attribute name="space-before.minimum">0.8em</xsl:attribute>
15874 <xsl:attribute name="space-before.maximum">1.2em</xsl:attribute>
15875 </xsl:attribute-set></programlisting>
15877 <refsection><info><title>Description</title></info>
15878 <para>Specify what spacing you want before (and optionally after) each list item.</para>
15879 <para>See also <parameter>list.block.spacing</parameter>, which sets
15880 the spacing before and after an entire list.</para>
15884 <refentry version="5.0" id="mark.optional.procedure.steps">
15886 <refentrytitle>mark.optional.procedure.steps</refentrytitle>
15887 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
15890 <refname>mark.optional.procedure.steps</refname>
15891 <refpurpose>Specifies whether to mark optional procedure steps</refpurpose>
15895 <programlisting id="mark.optional.procedure.steps.frag">
15896 <xsl:param name="mark.optional.procedure.steps">1</xsl:param>
15900 <refsection><info><title>Description</title></info>
15902 <para>This parameter specifies whether a procedure step
15903 with attribute <tag>performance</tag> set to <literal>optional</literal>
15904 should be marked. If set to 1 (the default value), then the
15905 text "(Optional)" appears at the start of the first paragraph.
15906 If set to zero, then no text is generated.</para>
15908 <para>The text can be customized in the gentext element with
15909 key="optional-step".</para>
15914 <refentry version="5.0" id="orderedlist.properties">
15916 <refentrytitle>orderedlist.properties</refentrytitle>
15917 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
15920 <refname>orderedlist.properties</refname>
15921 <refpurpose>Properties that apply to each list-block generated by orderedlist.</refpurpose>
15925 <programlisting id="orderedlist.properties.frag"><xsl:attribute-set name="orderedlist.properties" use-attribute-sets="list.block.properties">
15926 <xsl:attribute name="provisional-distance-between-starts">2em</xsl:attribute>
15927 </xsl:attribute-set></programlisting>
15929 <refsection><info><title>Description</title></info>
15930 <para>Properties that apply to each fo:list-block generated by orderedlist.</para>
15934 <refentry version="5.0" id="orderedlist.label.properties">
15936 <refentrytitle>orderedlist.label.properties</refentrytitle>
15937 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
15940 <refname>orderedlist.label.properties</refname>
15941 <refpurpose>Properties that apply to each label inside ordered list.</refpurpose>
15945 <programlisting id="orderedlist.label.properties.frag"><xsl:attribute-set name="orderedlist.label.properties">
15946 </xsl:attribute-set></programlisting>
15948 <refsection><info><title>Description</title></info>
15949 <para>Properties that apply to each label inside ordered list. E.g.:</para>
15950 <programlisting><xsl:attribute-set name="orderedlist.label.properties">
15951 <xsl:attribute name="text-align">right</xsl:attribute>
15952 </xsl:attribute-set></programlisting>
15956 <refentry version="5.0" id="orderedlist.label.width">
15958 <refentrytitle>orderedlist.label.width</refentrytitle>
15959 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
15962 <refname>orderedlist.label.width</refname>
15963 <refpurpose>The default width of the label (number) in an ordered list.</refpurpose>
15967 <programlisting id="orderedlist.label.width.frag">
15968 <xsl:param name="orderedlist.label.width">1.2em</xsl:param>
15972 <refsection><info><title>Description</title></info>
15973 <para>Specifies the default width of the label (usually a number or
15974 sequence of numbers) in an ordered list. You can override the default
15975 value on any particular list with the “dbfo” processing instruction
15976 using the “label-width” pseudoattribute.</para>
15980 <refentry version="5.0" id="variablelist.max.termlength">
15982 <refentrytitle>variablelist.max.termlength</refentrytitle>
15983 <refmiscinfo class="other" otherclass="datatype">number</refmiscinfo>
15986 <refname>variablelist.max.termlength</refname>
15987 <refpurpose>Specifies the longest term in variablelists</refpurpose>
15991 <programlisting id="variablelist.max.termlength.frag">
15992 <xsl:param name="variablelist.max.termlength">24</xsl:param>
15996 <refsection><info><title>Description</title></info>
15998 <para>In variablelists, the <tag>listitem</tag>
15999 is indented to leave room for the
16000 <tag>term</tag> elements. That indent may be computed
16001 if it is not specified with a <tag class="attribute">termlength</tag>
16002 attribute on the <tag>variablelist</tag> element.
16005 The computation counts characters in the
16006 <tag>term</tag> elements in the list
16007 to find the longest term. However, some terms are very long
16008 and would produce extreme indents. This parameter lets you
16009 set a maximum character count. Any terms longer than the maximum
16010 would line wrap. The default value is 24.
16013 The character counts are converted to physical widths
16014 by multiplying by 0.50em. There will be some variability
16015 in how many actual characters fit in the space
16016 since some characters are wider than others.
16022 <refentry version="5.0" id="variablelist.term.separator">
16024 <refentrytitle>variablelist.term.separator</refentrytitle>
16025 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
16028 <refname>variablelist.term.separator</refname>
16029 <refpurpose>Text to separate <tag>term</tag>s within a multi-term
16030 <tag>varlistentry</tag></refpurpose>
16034 <programlisting id="variablelist.term.separator.frag">
16035 <xsl:param name="variablelist.term.separator">, </xsl:param></programlisting>
16038 <refsection><info><title>Description</title></info>
16040 <para>When a <tag>varlistentry</tag> contains multiple <tag>term</tag>
16041 elements, the string specified in the value of the
16042 <parameter>variablelist.term.separator</parameter> parameter is placed
16043 after each <tag>term</tag> except the last.</para>
16046 <para>To generate a line break between multiple <tag>term</tag>s in
16047 a <tag>varlistentry</tag>, set a non-zero value for the
16048 <parameter>variablelist.term.break.after</parameter> parameter. If
16049 you do so, you may also want to set the value of the
16050 <parameter>variablelist.term.separator</parameter> parameter to an
16051 empty string (to suppress rendering of the default comma and space
16052 after each <tag>term</tag>).</para>
16058 <refentry version="5.0" id="variablelist.term.properties">
16060 <refentrytitle>variablelist.term.properties</refentrytitle>
16061 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
16064 <refname>variablelist.term.properties</refname>
16065 <refpurpose>To add properties to the term elements in a variablelist.</refpurpose>
16069 <programlisting id="variablelist.term.properties.frag">
16070 <xsl:attribute-set name="variablelist.term.properties">
16071 </xsl:attribute-set>
16074 <refsection><info><title>Description</title></info>
16075 <para>These properties are added to the block containing a
16076 term in a variablelist.
16077 Use this attribute-set to set
16078 font properties or alignment, for example.</para>
16083 <refentry version="5.0" id="variablelist.term.break.after">
16085 <refentrytitle>variablelist.term.break.after</refentrytitle>
16086 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
16089 <refname>variablelist.term.break.after</refname>
16090 <refpurpose>Generate line break after each <tag>term</tag> within a
16091 multi-term <tag>varlistentry</tag>?</refpurpose>
16095 <programlisting id="variablelist.term.break.after.frag">
16096 <xsl:param name="variablelist.term.break.after">0</xsl:param></programlisting>
16099 <refsection><info><title>Description</title></info>
16101 <para>Set a non-zero value for the
16102 <parameter>variablelist.term.break.after</parameter> parameter to
16103 generate a line break between <tag>term</tag>s in a
16104 multi-term <tag>varlistentry</tag>.</para>
16107 <para>If you set a non-zero value for
16108 <parameter>variablelist.term.break.after</parameter>, you may also
16109 want to set the value of the
16110 <parameter>variablelist.term.separator</parameter> parameter to an
16111 empty string (to suppress rendering of the default comma and space
16112 after each <tag>term</tag>).</para>
16118 </reference><reference id="qa" xml:base="../fo/param.xml"><title>QAndASet</title>
16119 <refentry version="5.0" id="qandadiv.autolabel">
16121 <refentrytitle>qandadiv.autolabel</refentrytitle>
16122 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
16125 <refname>qandadiv.autolabel</refname>
16126 <refpurpose>Are divisions in QAndASets enumerated?</refpurpose>
16130 <programlisting id="qandadiv.autolabel.frag"><xsl:param name="qandadiv.autolabel" select="1"></xsl:param></programlisting>
16133 <refsection><info><title>Description</title></info>
16135 <para>If non-zero, unlabeled qandadivs will be enumerated.
16141 <refentry version="5.0" id="qanda.inherit.numeration">
16143 <refentrytitle>qanda.inherit.numeration</refentrytitle>
16144 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
16147 <refname>qanda.inherit.numeration</refname>
16148 <refpurpose>Does enumeration of QandASet components inherit the numeration of parent elements?</refpurpose>
16152 <programlisting id="qanda.inherit.numeration.frag">
16153 <xsl:param name="qanda.inherit.numeration" select="1"></xsl:param>
16157 <refsection><info><title>Description</title></info>
16159 <para>If non-zero, numbered <tag>qandadiv</tag> elements and
16160 <tag>question</tag> and <tag>answer</tag> inherit the enumeration of
16161 the ancestors of the <tag>qandaset</tag>.
16167 <refentry version="5.0" id="qanda.defaultlabel">
16169 <refentrytitle>qanda.defaultlabel</refentrytitle>
16170 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
16171 <refmiscinfo class="other" otherclass="value">number</refmiscinfo>
16172 <refmiscinfo class="other" otherclass="value">qanda</refmiscinfo>
16173 <refmiscinfo class="other" otherclass="value">none</refmiscinfo>
16176 <refname>qanda.defaultlabel</refname>
16177 <refpurpose>Sets the default for defaultlabel on QandASet.</refpurpose>
16181 <programlisting id="qanda.defaultlabel.frag">
16182 <xsl:param name="qanda.defaultlabel">number</xsl:param>
16186 <refsection><info><title>Description</title></info>
16188 <para>If no <literal>defaultlabel</literal> attribute is specified on
16189 a <tag>qandaset</tag>, this value is used. It is generally one of the legal
16190 values for the defaultlabel attribute (<literal>none</literal>,
16191 <literal>number</literal> or
16192 <literal>qanda</literal>), or one of the additional stylesheet-specific values
16193 (<literal>qnumber</literal> or <literal>qnumberanda</literal>).
16194 The default value is 'number'.
16196 <para>The values are rendered as follows:</para>
16198 <varlistentry><term><literal>qanda</literal></term>
16200 <para><tag>question</tag>s are labeled "Q:" and
16201 <tag>answer</tag>s are labeled "A:". </para>
16205 <varlistentry><term><literal>number</literal></term>
16207 <para>The questions are enumerated and the answers
16208 are not labeled. </para>
16212 <varlistentry><term><literal>qnumber</literal></term>
16214 <para>The questions are labeled "Q:" followed by a number, and answers are not
16216 When sections are numbered, adding a label
16217 to the number distinguishes the question numbers
16218 from the section numbers.
16219 This value is not allowed in the
16220 <tag class="attribute">defaultlabel</tag> attribute
16221 of a <tag>qandaset</tag> element.</para>
16225 <varlistentry><term><literal>qnumberanda</literal></term>
16227 <para>The questions are labeled "Q:" followed by a number, and
16228 the answers are labeled "A:".
16229 When sections are numbered, adding a label
16230 to the number distinguishes the question numbers
16231 from the section numbers.
16232 This value is not allowed in the
16233 <tag class="attribute">defaultlabel</tag> attribute
16234 of a <tag>qandaset</tag> element.</para>
16238 <varlistentry><term><literal>none</literal></term>
16240 <para>No distinguishing label precedes Questions or Answers.
16249 <refentry version="5.0" id="qanda.in.toc">
16251 <refentrytitle>qanda.in.toc</refentrytitle>
16252 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
16255 <refname>qanda.in.toc</refname>
16256 <refpurpose>Should qandaentry questions appear in
16257 the document table of contents?</refpurpose>
16261 <programlisting id="qanda.in.toc.frag"><xsl:param name="qanda.in.toc" select="0"></xsl:param></programlisting>
16264 <refsection><info><title>Description</title></info>
16266 <para>If true (non-zero), then the generated table of contents
16267 for a document will include <tag>qandaset</tag> titles,
16268 <tag>qandadiv</tag> titles,
16269 and <tag>question</tag> elements. The default value (zero) excludes
16272 <para>This parameter does not affect any tables of contents
16273 that may be generated inside a qandaset or qandadiv.
16279 <refentry version="5.0" id="qanda.nested.in.toc">
16281 <refentrytitle>qanda.nested.in.toc</refentrytitle>
16282 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
16285 <refname>qanda.nested.in.toc</refname>
16286 <refpurpose>Should nested answer/qandaentry instances appear in TOC?</refpurpose>
16290 <programlisting id="qanda.nested.in.toc.frag">
16291 <xsl:param name="qanda.nested.in.toc" select="0"></xsl:param>
16295 <refsection><info><title>Description</title></info>
16297 <para>If non-zero, instances of <tag>qandaentry</tag>
16298 that are children of <tag>answer</tag> elements are shown in
16304 </reference><reference id="biblio" xml:base="../fo/param.xml"><title>Bibliography</title>
16305 <refentry version="5.0" id="bibliography.style">
16307 <refentrytitle>bibliography.style</refentrytitle>
16308 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
16309 <refmiscinfo class="other" otherclass="value">normal</refmiscinfo>
16310 <refmiscinfo class="other" otherclass="value">iso690</refmiscinfo>
16313 <refname>bibliography.style</refname>
16314 <refpurpose>Style used for formatting of biblioentries.</refpurpose>
16318 <programlisting id="bibliography.style.frag">
16319 <xsl:param name="bibliography.style">normal</xsl:param>
16323 <refsection><info><title>Description</title></info>
16325 <para>Currently only <literal>normal</literal> and
16326 <literal>iso690</literal> styles are supported.</para>
16328 <para>In order to use ISO690 style to the full extent you might need
16329 to use additional markup described on <link xlink:href="http://wiki.docbook.org/topic/ISO690Bibliography">the
16330 following WiKi page</link>.</para>
16335 <refentry version="5.0" id="biblioentry.item.separator">
16337 <refentrytitle>biblioentry.item.separator</refentrytitle>
16338 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
16341 <refname>biblioentry.item.separator</refname>
16342 <refpurpose>Text to separate bibliography entries</refpurpose>
16346 <programlisting id="biblioentry.item.separator.frag"><xsl:param name="biblioentry.item.separator">. </xsl:param></programlisting>
16349 <refsection><info><title>Description</title></info>
16351 <para>Text to separate bibliography entries
16357 <refentry version="5.0" id="bibliography.collection">
16359 <refentrytitle>bibliography.collection</refentrytitle>
16360 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
16363 <refname>bibliography.collection</refname>
16364 <refpurpose>Name of the bibliography collection file</refpurpose>
16368 <programlisting id="bibliography.collection.frag">
16369 <xsl:param name="bibliography.collection">http://cdn.docbook.org/release/xsl/bibliography/bibliography.xml</xsl:param>
16374 <refsection><info><title>Description</title></info>
16376 <para>Maintaining bibliography entries across a set of documents is tedious, time
16377 consuming, and error prone. It makes much more sense, usually, to store all of
16378 the bibliography entries in a single place and simply <quote>extract</quote>
16379 the ones you need in each document.</para>
16381 <para>That's the purpose of the
16382 <parameter>bibliography.collection</parameter> parameter. To setup a global
16383 bibliography <quote>database</quote>, follow these steps:</para>
16385 <para>First, create a stand-alone bibliography document that contains all of
16386 the documents that you wish to reference. Make sure that each bibliography
16387 entry (whether you use <tag>biblioentry</tag> or <tag>bibliomixed</tag>)
16390 <para>My global bibliography, <filename>~/bibliography.xml</filename> begins
16394 <programlisting><!DOCTYPE bibliography
16395 PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
16396 "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
16397 <bibliography><title>References</title>
16399 <bibliomixed id="xml-rec"><abbrev>XML 1.0</abbrev>Tim Bray,
16400 Jean Paoli, C. M. Sperberg-McQueen, and Eve Maler, editors.
16401 <citetitle><ulink url="http://www.w3.org/TR/REC-xml">Extensible Markup
16402 Language (XML) 1.0 Second Edition</ulink></citetitle>.
16403 World Wide Web Consortium, 2000.
16404 </bibliomixed>
16406 <bibliomixed id="xml-names"><abbrev>Namespaces</abbrev>Tim Bray,
16408 and Andrew Layman, editors.
16409 <citetitle><ulink url="http://www.w3.org/TR/REC-xml-names/">Namespaces in
16410 XML</ulink></citetitle>.
16411 World Wide Web Consortium, 1999.
16412 </bibliomixed>
16415 </bibliography>
16419 <para>When you create a bibliography in your document, simply
16420 provide <emphasis>empty</emphasis> <tag>bibliomixed</tag>
16421 entries for each document that you wish to cite. Make sure that these
16422 elements have the same ID as the corresponding <quote>real</quote>
16423 entry in your global bibliography.</para>
16425 <para>For example:</para>
16428 <programlisting><bibliography><title>Bibliography</title>
16430 <bibliomixed id="xml-rec"/>
16431 <bibliomixed id="xml-names"/>
16432 <bibliomixed id="DKnuth86">Donald E. Knuth. <citetitle>Computers and
16433 Typesetting: Volume B, TeX: The Program</citetitle>. Addison-Wesley,
16434 1986. ISBN 0-201-13437-3.
16435 </bibliomixed>
16436 <bibliomixed id="relaxng"/>
16438 </bibliography></programlisting>
16441 <para>Note that it's perfectly acceptable to mix entries from your
16442 global bibliography with <quote>normal</quote> entries. You can use
16443 <tag>xref</tag> or other elements to cross-reference your
16444 bibliography entries in exactly the same way you do now.</para>
16446 <para>Finally, when you are ready to format your document, simply set the
16447 <parameter>bibliography.collection</parameter> parameter (in either a
16448 customization layer or directly through your processor's interface) to
16449 point to your global bibliography.</para>
16451 <para>A relative path in the parameter is interpreted in one
16452 of two ways:</para>
16453 <orderedlist numeration="loweralpha">
16455 <para>If your document contains no links to empty bibliographic elements,
16456 then the path is relative to the file containing
16457 the first <tag>bibliomixed</tag> element in the document.</para>
16460 <para>If your document does contain links to empty bibliographic elements,
16461 then the path is relative to the file containing
16462 the first such link element in the document.</para>
16465 <para>Once the collection file is opened by the first instance described
16466 above, it stays open for the current document
16467 and the relative path is not reinterpreted again.</para>
16469 <para>The stylesheets will format the bibliography in your document as if
16470 all of the entries referenced appeared there literally.</para>
16475 <refentry version="5.0" id="bibliography.numbered">
16477 <refentrytitle>bibliography.numbered</refentrytitle>
16478 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
16481 <refname>bibliography.numbered</refname>
16482 <refpurpose>Should bibliography entries be numbered?</refpurpose>
16486 <programlisting id="bibliography.numbered.frag">
16487 <xsl:param name="bibliography.numbered" select="0"></xsl:param>
16491 <refsection><info><title>Description</title></info>
16493 <para>If non-zero bibliography entries will be numbered</para>
16498 <refentry version="5.0" id="biblioentry.properties">
16500 <refentrytitle>biblioentry.properties</refentrytitle>
16501 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
16504 <refname>biblioentry.properties</refname>
16505 <refpurpose>To set the style for biblioentry.</refpurpose>
16509 <programlisting id="biblioentry.properties.frag"><xsl:attribute-set name="biblioentry.properties" use-attribute-sets="normal.para.spacing">
16510 <xsl:attribute name="start-indent">0.5in</xsl:attribute>
16511 <xsl:attribute name="text-indent">-0.5in</xsl:attribute>
16512 </xsl:attribute-set>
16515 <refsection><info><title>Description</title></info>
16516 <para>How do you want biblioentry styled? </para>
16517 <para>Set the font-size, weight, space-above and space-below, indents, etc. to the style required</para>
16522 </reference><reference id="glossary" xml:base="../fo/param.xml"><title>Glossary</title>
16523 <refentry version="5.0" id="glossterm.auto.link">
16525 <refentrytitle>glossterm.auto.link</refentrytitle>
16526 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
16529 <refname>glossterm.auto.link</refname>
16530 <refpurpose>Generate links from glossterm to glossentry automatically?</refpurpose>
16534 <programlisting id="glossterm.auto.link.frag">
16535 <xsl:param name="glossterm.auto.link" select="0"></xsl:param>
16539 <refsection><info><title>Description</title></info>
16541 <para>If non-zero, links from inline <tag>glossterm</tag>s to the corresponding
16542 <tag>glossentry</tag> elements in a <tag>glossary</tag> or <tag>glosslist</tag>
16543 will be automatically generated. This is useful when your glossterms are consistent
16544 and you don't want to add links manually.</para>
16546 <para>The automatic link generation feature is not used on <tag>glossterm</tag> elements
16547 that have a <tag class="attribute">linkend</tag> attribute.</para>
16552 <refentry version="5.0" id="firstterm.only.link">
16554 <refentrytitle>firstterm.only.link</refentrytitle>
16555 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
16558 <refname>firstterm.only.link</refname>
16559 <refpurpose>Does automatic glossterm linking only apply to firstterms?</refpurpose>
16563 <programlisting id="firstterm.only.link.frag">
16564 <xsl:param name="firstterm.only.link" select="0"></xsl:param>
16568 <refsection><info><title>Description</title></info>
16570 <para>If non-zero, only <tag>firstterm</tag>s will be automatically linked
16571 to the glossary. If glossary linking is not enabled, this parameter
16572 has no effect.</para>
16577 <refentry version="5.0" id="glossary.collection">
16579 <refentrytitle>glossary.collection</refentrytitle>
16580 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
16583 <refname>glossary.collection</refname>
16584 <refpurpose>Name of the glossary collection file</refpurpose>
16588 <programlisting id="glossary.collection.frag">
16589 <xsl:param name="glossary.collection"></xsl:param>
16593 <refsection><info><title>Description</title></info>
16595 <para>Glossaries maintained independently across a set of documents
16596 are likely to become inconsistent unless considerable effort is
16597 expended to keep them in sync. It makes much more sense, usually, to
16598 store all of the glossary entries in a single place and simply
16599 <quote>extract</quote> the ones you need in each document.</para>
16601 <para>That's the purpose of the
16602 <parameter>glossary.collection</parameter> parameter. To setup a global
16603 glossary <quote>database</quote>, follow these steps:</para>
16605 <refsection><info><title>Setting Up the Glossary Database</title></info>
16607 <para>First, create a stand-alone glossary document that contains all of
16608 the entries that you wish to reference. Make sure that each glossary
16609 entry has an ID.</para>
16611 <para>Here's an example glossary:</para>
16615 <?xml version="1.0" encoding="utf-8"?>
16616 <!DOCTYPE glossary
16617 PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
16618 "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
16620 <glossaryinfo>
16621 <editor><firstname>Eric</firstname><surname>Raymond</surname></editor>
16622 <title>Jargon File 4.2.3 (abridged)</title>
16623 <releaseinfo>Just some test data</releaseinfo>
16624 </glossaryinfo>
16626 <glossdiv><title>0</title>
16629 <glossterm>0</glossterm>
16631 <para>Numeric zero, as opposed to the letter `O' (the 15th letter of
16632 the English alphabet). In their unmodified forms they look a lot
16633 alike, and various kluges invented to make them visually distinct have
16634 compounded the confusion. If your zero is center-dotted and letter-O
16635 is not, or if letter-O looks almost rectangular but zero looks more
16636 like an American football stood on end (or the reverse), you're
16637 probably looking at a modern character display (though the dotted zero
16638 seems to have originated as an option on IBM 3270 controllers). If
16639 your zero is slashed but letter-O is not, you're probably looking at
16640 an old-style ASCII graphic set descended from the default typewheel on
16641 the venerable ASR-33 Teletype (Scandinavians, for whom /O is a letter,
16642 curse this arrangement). (Interestingly, the slashed zero long
16643 predates computers; Florian Cajori's monumental "A History of
16644 Mathematical Notations" notes that it was used in the twelfth and
16645 thirteenth centuries.) If letter-O has a slash across it and the zero
16646 does not, your display is tuned for a very old convention used at IBM
16647 and a few other early mainframe makers (Scandinavians curse <emphasis>this</emphasis>
16648 arrangement even more, because it means two of their letters collide).
16649 Some Burroughs/Unisys equipment displays a zero with a <emphasis>reversed</emphasis>
16650 slash. Old CDC computers rendered letter O as an unbroken oval and 0
16651 as an oval broken at upper right and lower left. And yet another
16652 convention common on early line printers left zero unornamented but
16653 added a tail or hook to the letter-O so that it resembled an inverted
16654 Q or cursive capital letter-O (this was endorsed by a draft ANSI
16655 standard for how to draw ASCII characters, but the final standard
16656 changed the distinguisher to a tick-mark in the upper-left corner).
16657 Are we sufficiently confused yet?</para>
16659 </glossentry>
16662 <glossterm>1TBS</glossterm>
16664 <para role="accidence">
16665 <phrase role="pronounce"></phrase>
16666 <phrase role="partsofspeach">n</phrase>
16668 <para>The "One True Brace Style"</para>
16669 <glossseealso>indent style</glossseealso>
16671 </glossentry>
16679 </glossary></programlisting>
16684 <refsection><info><title>Marking Up Glossary Terms</title></info>
16686 <para>That takes care of the glossary database, now you have to get the entries
16687 into your document. Unlike bibliography entries, which can be empty, creating
16688 <quote>placeholder</quote> glossary entries would be very tedious. So instead,
16689 support for <parameter>glossary.collection</parameter> relies on implicit linking.</para>
16691 <para>In your source document, simply use <tag>firstterm</tag> and
16692 <tag>glossterm</tag> to identify the terms you wish to have included
16693 in the glossary. The stylesheets assume that you will either set the
16694 <tag class="attribute">baseform</tag> attribute correctly, or that the
16695 content of the element exactly matches a term in your glossary.</para>
16697 <para>If you're using a <parameter>glossary.collection</parameter>, don't
16698 make explicit links on the terms in your document.</para>
16700 <para>So, in your document, you might write things like this:</para>
16703 <programlisting><para>This is dummy text, without any real meaning.
16704 The point is simply to reference glossary terms like <glossterm>0</glossterm>
16705 and the <firstterm baseform="1TBS">One True Brace Style (1TBS)</firstterm>.
16706 The <glossterm>1TBS</glossterm>, as you can probably imagine, is a nearly
16707 religious issue.</para></programlisting>
16710 <para>If you set the <parameter>firstterm.only.link</parameter> parameter,
16711 only the terms marked with <tag>firstterm</tag> will be links.
16712 Otherwise, all the terms will be linked.</para>
16716 <refsection><info><title>Marking Up the Glossary</title></info>
16718 <para>The glossary itself has to be identified for the stylesheets. For lack
16719 of a better choice, the <tag class="attribute">role</tag> is used.
16720 To identify the glossary as the target for automatic processing, set
16721 the role to <quote><literal>auto</literal></quote>. The title of this
16722 glossary (and any other information from the <tag>glossaryinfo</tag>
16723 that's rendered by your stylesheet) will be displayed, but the entries will
16724 come from the database.
16727 <para>Unfortunately, the glossary can't be empty, so you must put in
16728 at least one <tag>glossentry</tag>. The content of this entry
16729 is irrelevant, it will not be rendered:</para>
16732 <programlisting><glossary role="auto">
16734 <glossterm>Irrelevant</glossterm>
16736 <para>If you can see this, the document was processed incorrectly. Use
16737 the <parameter>glossary.collection</parameter> parameter.</para>
16739 </glossentry>
16740 </glossary></programlisting>
16743 <para>What about glossary divisions? If your glossary database has glossary
16744 divisions <emphasis>and</emphasis> your automatic glossary contains at least
16745 one <tag>glossdiv</tag>, the automic glossary will have divisions.
16746 If the <tag>glossdiv</tag> is missing from either location, no divisions
16747 will be rendered.</para>
16749 <para>Glossary entries (and divisions, if appropriate) in the glossary will
16750 occur in precisely the order they occur in your database.</para>
16754 <refsection><info><title>Formatting the Document</title></info>
16756 <para>Finally, when you are ready to format your document, simply set the
16757 <parameter>glossary.collection</parameter> parameter (in either a
16758 customization layer or directly through your processor's interface) to
16759 point to your global glossary.</para>
16761 <para>A relative path in the parameter is interpreted in one
16762 of two ways:</para>
16763 <orderedlist numeration="loweralpha">
16765 <para>If the parameter <literal>glossterm.auto.link</literal>
16766 is set to zero, then the path is relative to the file containing
16767 the empty <tag>glossary</tag> element in the document.</para>
16770 <para>If the parameter <literal>glossterm.auto.link</literal>
16771 is set to non-zero, then the path is relative to the file containing
16772 the first inline <tag>glossterm</tag> or
16773 <tag>firstterm</tag> in the document to be linked.</para>
16776 <para>Once the collection file is opened by the first instance described
16777 above, it stays open for the current document
16778 and the relative path is not reinterpreted again.</para>
16780 <para>The stylesheets will format the glossary in your document as if
16781 all of the entries implicilty referenced appeared there literally.</para>
16784 <refsection><info><title>Limitations</title></info>
16786 <para>Glossary cross-references <emphasis>within the glossary</emphasis> are
16787 not supported. For example, this <emphasis>will not</emphasis> work:</para>
16790 <programlisting><glossentry>
16791 <glossterm>gloss-1</glossterm>
16792 <glossdef><para>A description that references <glossterm>gloss-2</glossterm>.</para>
16793 <glossseealso>gloss-2</glossseealso>
16795 </glossentry></programlisting>
16798 <para>If you put glossary cross-references in your glossary that way,
16799 you'll get the cryptic error: <computeroutput>Warning:
16800 glossary.collection specified, but there are 0 automatic
16801 glossaries</computeroutput>.</para>
16803 <para>Instead, you must do two things:</para>
16807 <para>Markup your glossary using <tag>glossseealso</tag>:</para>
16810 <programlisting><glossentry>
16811 <glossterm>gloss-1</glossterm>
16812 <glossdef><para>A description that references <glossterm>gloss-2</glossterm>.</para>
16813 <glossseealso>gloss-2</glossseealso>
16815 </glossentry></programlisting>
16820 <para>Make sure there is at least one <tag>glossterm</tag> reference to
16821 <glossterm>gloss-2</glossterm> <emphasis>in your document</emphasis>. The
16822 easiest way to do that is probably within a <tag>remark</tag> in your
16823 automatic glossary:</para>
16826 <programlisting><glossary role="auto">
16827 <remark>Make sure there's a reference to <glossterm>gloss-2</glossterm>.</remark>
16829 <glossterm>Irrelevant</glossterm>
16831 <para>If you can see this, the document was processed incorrectly. Use
16832 the <parameter>glossary.collection</parameter> parameter.</para>
16834 </glossentry>
16835 </glossary></programlisting>
16844 <refentry version="5.0" id="glossary.as.blocks">
16846 <refentrytitle>glossary.as.blocks</refentrytitle>
16847 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
16850 <refname>glossary.as.blocks</refname>
16851 <refpurpose>Present glossarys using blocks instead of lists?</refpurpose>
16855 <programlisting id="glossary.as.blocks.frag">
16856 <xsl:param name="glossary.as.blocks" select="0"></xsl:param>
16860 <refsection><info><title>Description</title></info>
16862 <para>If non-zero, <tag>glossary</tag>s will be formatted as
16865 <para>If you have long <tag>glossterm</tag>s, proper list
16866 markup in the FO case may produce unattractive lists. By setting this
16867 parameter, you can force the stylesheets to produce block markup
16868 instead of proper lists.</para>
16870 <para>You can override this setting with a processing instruction as the
16871 child of <tag>glossary</tag>: <tag class="xmlpi">dbfo
16872 glossary-presentation="blocks"</tag> or <tag class="xmlpi">dbfo
16873 glossary-presentation="list"</tag></para>
16878 <refentry version="5.0" id="glosslist.as.blocks">
16880 <refentrytitle>glosslist.as.blocks</refentrytitle>
16881 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
16884 <refname>glosslist.as.blocks</refname>
16885 <refpurpose>Use blocks for glosslists?</refpurpose>
16889 <programlisting id="glosslist.as.blocks.frag">
16890 <xsl:param name="glosslist.as.blocks" select="0"></xsl:param>
16894 <refsection><info><title>Description</title></info>
16896 <para>See <parameter>glossary.as.blocks</parameter>.</para>
16901 <refentry version="5.0" id="glossentry.list.item.properties">
16903 <refentrytitle>glossentry.list.item.properties</refentrytitle>
16904 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
16907 <refname>glossentry.list.item.properties</refname>
16908 <refpurpose>To add properties to each glossentry in a list.</refpurpose>
16912 <programlisting id="glossentry.list.item.properties.frag"><xsl:attribute-set name="glossentry.list.item.properties">
16913 <xsl:attribute name="space-before.optimum">1em</xsl:attribute>
16914 <xsl:attribute name="space-before.minimum">0.8em</xsl:attribute>
16915 <xsl:attribute name="space-before.maximum">1.2em</xsl:attribute>
16916 </xsl:attribute-set>
16919 <refsection><info><title>Description</title></info>
16920 <para>These properties are added to the fo:list-item containing a
16921 glossentry in a glossary when the <parameter>glossary.as.blocks</parameter> parameter
16923 Use this attribute-set to set
16924 spacing between entries, for example.</para>
16929 <refentry version="5.0" id="glossterm.block.properties">
16931 <refentrytitle>glossterm.block.properties</refentrytitle>
16932 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
16935 <refname>glossterm.block.properties</refname>
16936 <refpurpose>To add properties to the block of a glossentry's glossterm.</refpurpose>
16940 <programlisting id="glossterm.block.properties.frag"><xsl:attribute-set name="glossterm.block.properties">
16941 <xsl:attribute name="space-before.optimum">1em</xsl:attribute>
16942 <xsl:attribute name="space-before.minimum">0.8em</xsl:attribute>
16943 <xsl:attribute name="space-before.maximum">1.2em</xsl:attribute>
16944 <xsl:attribute name="keep-with-next.within-column">always</xsl:attribute>
16945 <xsl:attribute name="keep-together.within-column">always</xsl:attribute>
16946 </xsl:attribute-set>
16949 <refsection><info><title>Description</title></info>
16950 <para>These properties are added to the block containing a
16951 glossary term in a glossary when the <parameter>glossary.as.blocks</parameter> parameter
16953 Use this attribute-set to set the space above and below,
16955 and any indent for the glossary term.</para>
16960 <refentry version="5.0" id="glossdef.block.properties">
16962 <refentrytitle>glossdef.block.properties</refentrytitle>
16963 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
16966 <refname>glossdef.block.properties</refname>
16967 <refpurpose>To add properties to the block of a glossary definition.</refpurpose>
16971 <programlisting id="glossdef.block.properties.frag"><xsl:attribute-set name="glossdef.block.properties">
16972 <xsl:attribute name="margin-{$direction.align.start}">.25in</xsl:attribute>
16973 </xsl:attribute-set>
16976 <refsection><info><title>Description</title></info>
16977 <para>These properties are added to the block containing a
16978 glossary definition in a glossary when
16979 the <parameter>glossary.as.blocks</parameter> parameter
16981 Use this attribute-set to set the space above and below,
16982 any font properties,
16983 and any indent for the glossary definition.</para>
16988 <refentry version="5.0" id="glossterm.list.properties">
16990 <refentrytitle>glossterm.list.properties</refentrytitle>
16991 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
16994 <refname>glossterm.list.properties</refname>
16995 <refpurpose>To add properties to the glossterm in a list.</refpurpose>
16999 <programlisting id="glossterm.list.properties.frag">
17000 <xsl:attribute-set name="glossterm.list.properties">
17001 </xsl:attribute-set>
17004 <refsection><info><title>Description</title></info>
17005 <para>These properties are added to the block containing a
17006 glossary term in a glossary when the <parameter>glossary.as.blocks</parameter> parameter
17008 Use this attribute-set to set
17009 font properties, for example.</para>
17014 <refentry version="5.0" id="glossdef.list.properties">
17016 <refentrytitle>glossdef.list.properties</refentrytitle>
17017 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
17020 <refname>glossdef.list.properties</refname>
17021 <refpurpose>To add properties to the glossary definition in a list.</refpurpose>
17025 <programlisting id="glossdef.list.properties.frag">
17026 <xsl:attribute-set name="glossdef.list.properties">
17027 </xsl:attribute-set>
17030 <refsection><info><title>Description</title></info>
17031 <para>These properties are added to the block containing a
17032 glossary definition in a glossary when
17033 the <parameter>glossary.as.blocks</parameter> parameter
17035 Use this attribute-set to set font properties, for example.</para>
17040 <refentry version="5.0" id="glossterm.width">
17042 <refentrytitle>glossterm.width</refentrytitle>
17043 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
17046 <refname>glossterm.width</refname>
17047 <refpurpose>Width of glossterm in list presentation mode</refpurpose>
17051 <programlisting id="glossterm.width.frag">
17052 <xsl:param name="glossterm.width">2in</xsl:param>
17056 <refsection><info><title>Description</title></info>
17058 <para>This parameter specifies the width reserved for glossary terms when
17059 a list presentation is used.</para>
17064 <refentry version="5.0" id="glossterm.separation">
17066 <refentrytitle>glossterm.separation</refentrytitle>
17067 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
17070 <refname>glossterm.separation</refname>
17071 <refpurpose>Separation between glossary terms and descriptions in list mode</refpurpose>
17075 <programlisting id="glossterm.separation.frag">
17076 <xsl:param name="glossterm.separation">0.25in</xsl:param>
17080 <refsection><info><title>Description</title></info>
17082 <para>Specifies the miminum horizontal
17083 separation between glossary terms and descriptions when
17084 they are presented side-by-side using lists
17085 when the <parameter>glossary.as.blocks</parameter>
17091 <refentry version="5.0" id="glossentry.show.acronym">
17093 <refentrytitle>glossentry.show.acronym</refentrytitle>
17094 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
17095 <refmiscinfo class="other" otherclass="value">no</refmiscinfo>
17096 <refmiscinfo class="other" otherclass="value">yes</refmiscinfo>
17097 <refmiscinfo class="other" otherclass="value">primary</refmiscinfo>
17100 <refname>glossentry.show.acronym</refname>
17101 <refpurpose>Display <tag>glossentry</tag> acronyms?</refpurpose>
17105 <programlisting id="glossentry.show.acronym.frag">
17106 <xsl:param name="glossentry.show.acronym">no</xsl:param>
17110 <refsection><info><title>Description</title></info>
17112 <para>A setting of <quote>yes</quote> means they should be displayed;
17113 <quote>no</quote> means they shouldn't. If <quote>primary</quote> is used,
17114 then they are shown as the primary text for the entry.</para>
17117 <para>This setting controls both <tag>acronym</tag> and
17118 <tag>abbrev</tag> elements in the <tag>glossentry</tag>.</para>
17124 <refentry version="5.0" id="glossary.sort">
17126 <refentrytitle>glossary.sort</refentrytitle>
17127 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
17130 <refname>glossary.sort</refname>
17131 <refpurpose>Sort glossentry elements?</refpurpose>
17135 <programlisting id="glossary.sort.frag">
17136 <xsl:param name="glossary.sort" select="0"></xsl:param>
17140 <refsection><info><title>Description</title></info>
17142 <para>If non-zero, then the glossentry elements within a
17143 glossary, glossdiv, or glosslist are sorted on the glossterm, using
17144 the current lang setting. If zero (the default), then
17145 glossentry elements are not sorted and are presented
17152 </reference><reference id="misc" xml:base="../fo/param.xml"><title>Miscellaneous</title>
17153 <refentry version="5.0" id="formal.procedures">
17155 <refentrytitle>formal.procedures</refentrytitle>
17156 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
17159 <refname>formal.procedures</refname>
17160 <refpurpose>Selects formal or informal procedures</refpurpose>
17164 <programlisting id="formal.procedures.frag">
17165 <xsl:param name="formal.procedures" select="1"></xsl:param>
17169 <refsection><info><title>Description</title></info>
17171 <para>Formal procedures are numbered and always have a title.
17177 <refentry version="5.0" id="formal.title.placement">
17179 <refentrytitle>formal.title.placement</refentrytitle>
17180 <refmiscinfo class="other" otherclass="datatype">table</refmiscinfo>
17183 <refname>formal.title.placement</refname>
17184 <refpurpose>Specifies where formal object titles should occur</refpurpose>
17188 <programlisting id="formal.title.placement.frag">
17189 <xsl:param name="formal.title.placement">
17200 <refsection><info><title>Description</title></info>
17202 <para>Specifies where formal object titles should occur. For each formal object
17203 type (<tag>figure</tag>,
17204 <tag>example</tag>,
17205 <tag>equation</tag>,
17206 <tag>table</tag>, and <tag>procedure</tag>)
17207 you can specify either the keyword
17208 <quote><literal>before</literal></quote> or
17209 <quote><literal>after</literal></quote>.</para>
17214 <refentry version="5.0" id="runinhead.default.title.end.punct">
17216 <refentrytitle>runinhead.default.title.end.punct</refentrytitle>
17217 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
17220 <refname>runinhead.default.title.end.punct</refname>
17221 <refpurpose>Default punctuation character on a run-in-head</refpurpose>
17225 <programlisting id="runinhead.default.title.end.punct.frag"><xsl:param name="runinhead.default.title.end.punct">.</xsl:param>
17229 <refsection><info><title>Description</title></info>
17231 <para>If non-zero, For a <tag>formalpara</tag>, use the specified
17232 string as the separator between the title and following text. The period is the default value.</para>
17237 <refentry version="5.0" id="runinhead.title.end.punct">
17239 <refentrytitle>runinhead.title.end.punct</refentrytitle>
17240 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
17243 <refname>runinhead.title.end.punct</refname>
17244 <refpurpose>Characters that count as punctuation on a run-in-head</refpurpose>
17248 <programlisting id="runinhead.title.end.punct.frag">
17249 <xsl:param name="runinhead.title.end.punct">.!?:</xsl:param>
17253 <refsection><info><title>Description</title></info>
17255 <para>Specify which characters are to be counted as punctuation. These
17256 characters are checked for a match with the last character of the
17257 title. If no match is found, the
17258 <parameter>runinhead.default.title.end.punct</parameter> contents are
17259 inserted. This is to avoid duplicated punctuation in the output.
17265 <refentry version="5.0" id="show.comments">
17267 <refentrytitle>show.comments</refentrytitle>
17268 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
17271 <refname>show.comments</refname>
17272 <refpurpose>Display <tag>remark</tag> elements?</refpurpose>
17276 <programlisting id="show.comments.frag">
17277 <xsl:param name="show.comments" select="1"></xsl:param>
17281 <refsection><info><title>Description</title></info>
17283 <para>If non-zero, comments will be displayed, otherwise they
17284 are suppressed. Comments here refers to the <tag>remark</tag> element
17285 (which was called <literal>comment</literal> prior to DocBook
17286 4.0), not XML comments (<-- like this -->) which are
17293 <refentry version="5.0" id="punct.honorific">
17295 <refentrytitle>punct.honorific</refentrytitle>
17296 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
17299 <refname>punct.honorific</refname>
17300 <refpurpose>Punctuation after an honorific in a personal name.</refpurpose>
17304 <programlisting id="punct.honorific.frag">
17305 <xsl:param name="punct.honorific">.</xsl:param>
17309 <refsection><info><title>Description</title></info>
17311 <para>This parameter specifies the punctuation that should be added after an
17312 honorific in a personal name.</para>
17317 <refentry version="5.0" id="segmentedlist.as.table">
17319 <refentrytitle>segmentedlist.as.table</refentrytitle>
17320 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
17323 <refname>segmentedlist.as.table</refname>
17324 <refpurpose>Format segmented lists as tables?</refpurpose>
17328 <programlisting id="segmentedlist.as.table.frag">
17329 <xsl:param name="segmentedlist.as.table" select="0"></xsl:param>
17333 <refsection><info><title>Description</title></info>
17335 <para>If non-zero, <tag>segmentedlist</tag>s will be formatted as
17341 <refentry version="5.0" id="variablelist.as.blocks">
17343 <refentrytitle>variablelist.as.blocks</refentrytitle>
17344 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
17347 <refname>variablelist.as.blocks</refname>
17348 <refpurpose>Format <tag>variablelist</tag>s lists as blocks?</refpurpose>
17352 <programlisting id="variablelist.as.blocks.frag">
17353 <xsl:param name="variablelist.as.blocks" select="0"></xsl:param>
17357 <refsection><info><title>Description</title></info>
17359 <para>If non-zero, <tag>variablelist</tag>s will be formatted as
17362 <para>If you have long terms, proper list markup in the FO case may produce
17363 unattractive lists. By setting this parameter, you can force the stylesheets
17364 to produce block markup instead of proper lists.</para>
17366 <para>You can override this setting with a processing instruction as the
17367 child of <tag>variablelist</tag>: <tag class="xmlpi">dbfo
17368 list-presentation="blocks"</tag> or <tag class="xmlpi">dbfo
17369 list-presentation="list"</tag>.</para>
17371 <para>When using <literal>list-presentation="list"</literal>,
17372 you can also control the amount of space used for the <tag>term</tag>s with
17373 the <tag class="xmlpi">dbfo term-width=".25in"</tag> processing instruction,
17374 the <tag class="attribute">termlength</tag> attribute on <tag>variablelist</tag>,
17375 or allow the stylesheets to attempt to calculate the amount of space to leave based on the
17376 number of letters in the longest term.
17379 <programlisting> <variablelist>
17380 <?dbfo list-presentation="list"?>
17381 <?dbfo term-width="1.5in"?>
17382 <?dbhtml list-presentation="table"?>
17383 <?dbhtml term-width="1.5in"?>
17384 <varlistentry>
17385 <term>list</term>
17388 Formatted as a list even if variablelist.as.blocks is set to 1.
17391 </varlistentry>
17392 </variablelist></programlisting>
17399 <refentry version="5.0" id="blockquote.properties">
17401 <refentrytitle>blockquote.properties</refentrytitle>
17402 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
17405 <refname>blockquote.properties</refname>
17406 <refpurpose>To set the style for block quotations.</refpurpose>
17410 <programlisting id="blockquote.properties.frag">
17411 <xsl:attribute-set name="blockquote.properties">
17412 <xsl:attribute name="margin-{$direction.align.start}">0.5in</xsl:attribute>
17413 <xsl:attribute name="margin-{$direction.align.end}">0.5in</xsl:attribute>
17414 <xsl:attribute name="space-after.minimum">0.5em</xsl:attribute>
17415 <xsl:attribute name="space-after.optimum">1em</xsl:attribute>
17416 <xsl:attribute name="space-after.maximum">2em</xsl:attribute>
17417 </xsl:attribute-set>
17421 <refsection><info><title>Description</title></info>
17423 <para>The <parameter>blockquote.properties</parameter> attribute set specifies
17424 the formating properties of block quotations.</para>
17429 <refentry version="5.0" id="ulink.show">
17431 <refentrytitle>ulink.show</refentrytitle>
17432 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
17435 <refname>ulink.show</refname>
17436 <refpurpose>Display URLs after <tag>ulink</tag>s?</refpurpose>
17440 <programlisting id="ulink.show.frag">
17441 <xsl:param name="ulink.show" select="1"></xsl:param>
17445 <refsection><info><title>Description</title></info>
17447 <para>If non-zero, the URL of each <tag>ulink</tag> will
17448 appear after the text of the link. If the text of the link and the URL
17449 are identical, the URL is suppressed. </para>
17451 <para>See also <parameter>ulink.footnotes</parameter>.</para>
17453 <note><para>DocBook 5 does not have an <tag>ulink</tag> element. When processing
17454 DocBoook 5 documents, <parameter>ulink.show</parameter> applies to all inline
17455 elements that are marked up with <tag class="attribute">xlink:href</tag> attributes
17456 that point to external resources.</para>
17462 <refentry version="5.0" id="ulink.footnotes">
17464 <refentrytitle>ulink.footnotes</refentrytitle>
17465 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
17468 <refname>ulink.footnotes</refname>
17469 <refpurpose>Generate footnotes for <tag>ulink</tag>s?</refpurpose>
17473 <programlisting id="ulink.footnotes.frag">
17474 <xsl:param name="ulink.footnotes" select="0"></xsl:param>
17478 <refsection><info><title>Description</title></info>
17480 <para>If non-zero, and if <parameter>ulink.show</parameter> also is non-zero,
17481 the URL of each <tag>ulink</tag> will appear as a footnote.</para>
17483 <note><para>DocBook 5 does not have an <tag>ulink</tag> element. When processing
17484 DocBoook 5 documents, <parameter>ulink.footnotes</parameter> applies to all inline
17485 elements that are marked up with <tag class="attribute">xlink:href</tag> attributes
17486 that point to external resources.</para>
17492 <refentry version="5.0" id="ulink.hyphenate">
17494 <refentrytitle>ulink.hyphenate</refentrytitle>
17495 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
17498 <refname>ulink.hyphenate</refname>
17499 <refpurpose>Allow URLs to be automatically hyphenated</refpurpose>
17503 <programlisting id="ulink.hyphenate.frag">
17504 <xsl:param name="ulink.hyphenate"></xsl:param>
17508 <refsection><info><title>Description</title></info>
17510 <para>If not empty, the specified character (or more generally,
17511 content) is added to URLs after every character included in the string
17512 in the <parameter>ulink.hyphenate.chars</parameter> parameter (default
17513 is <quote>/</quote>) to enable hyphenation of ulinks. If the character
17514 in this parameter is a Unicode soft hyphen (0x00AD) or Unicode
17515 zero-width space (0x200B), some FO processors will be able to
17516 reasonably hyphenate long URLs.</para>
17518 <para>Note that this hyphenation process is only applied when the
17519 ulink element is empty and the url attribute is reused as the link
17520 text. It is not applied if the ulink has literal text content. The
17521 same applies in in DocBook 5, where ulink was replaced with link with
17522 an xlink:href attribute.</para>
17527 <refentry version="5.0" id="ulink.hyphenate.chars">
17529 <refentrytitle>ulink.hyphenate.chars</refentrytitle>
17530 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
17533 <refname>ulink.hyphenate.chars</refname>
17534 <refpurpose>List of characters to allow ulink URLs to be automatically
17535 hyphenated on</refpurpose>
17539 <programlisting id="ulink.hyphenate.chars.frag">
17540 <xsl:param name="ulink.hyphenate.chars">/</xsl:param>
17544 <refsection><info><title>Description</title></info>
17546 <para>If the <parameter>ulink.hyphenate</parameter> parameter is not
17547 empty, then hyphenation of ulinks is turned on, and any character
17548 contained in this parameter is treated as an allowable hyphenation
17549 point. This and <parameter>ulink.hyphenate</parameter> work together,
17550 one is pointless without the other being set to a non-empty value</para>
17552 <para>The default value is <quote>/</quote>, but the parameter could
17553 be customized to contain other URL characters, as for example:</para>
17555 <xsl:param name="ulink.hyphenate.chars">:/@&?.#</xsl:param>
17561 <refentry version="5.0" id="shade.verbatim">
17563 <refentrytitle>shade.verbatim</refentrytitle>
17564 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
17567 <refname>shade.verbatim</refname>
17568 <refpurpose>Should verbatim environments be shaded?</refpurpose>
17572 <programlisting id="shade.verbatim.frag"><xsl:param name="shade.verbatim" select="0"></xsl:param></programlisting>
17575 <refsection><info><title>Description</title></info>
17577 <para>In the FO stylesheet, if this parameter is non-zero then the
17578 <property>shade.verbatim.style</property> properties will be applied
17579 to verbatim environments.</para>
17581 <para>In the HTML stylesheet, this parameter is now deprecated. Use
17582 CSS instead.</para>
17587 <refentry version="5.0" id="shade.verbatim.style">
17589 <refentrytitle>shade.verbatim.style</refentrytitle>
17590 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
17593 <refname>shade.verbatim.style</refname>
17594 <refpurpose>Properties that specify the style of shaded verbatim listings</refpurpose>
17598 <programlisting id="shade.verbatim.style.frag">
17600 <xsl:attribute-set name="shade.verbatim.style">
17601 <xsl:attribute name="background-color">#E0E0E0</xsl:attribute>
17602 </xsl:attribute-set>
17606 <refsection><info><title>Description</title></info>
17608 <para>Properties that specify the style of shaded verbatim listings. The
17609 parameters specified (the border and background color) are added to
17610 the styling of the xsl-fo output. A border might be specified as "thin
17611 black solid" for example. See <link xlink:href="http://www.w3.org/TR/2004/WD-xsl11-20041216/#border">xsl-fo</link></para>
17616 <refentry version="5.0" id="hyphenate.verbatim">
17618 <refentrytitle>hyphenate.verbatim</refentrytitle>
17619 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
17622 <refname>hyphenate.verbatim</refname>
17623 <refpurpose>Should verbatim environments be hyphenated on space characters?</refpurpose>
17627 <programlisting id="hyphenate.verbatim.frag"><xsl:param name="hyphenate.verbatim" select="0"></xsl:param></programlisting>
17630 <refsection><info><title>Description</title></info>
17632 <para>If the lines of program listing are too long to fit into one
17633 line it is quite common to split them at space and indicite by hook
17634 arrow that code continues on the next line. You can turn on this
17635 behaviour for <tag>programlisting</tag>,
17636 <tag>screen</tag> and <tag>synopsis</tag> elements by
17637 using this parameter.</para>
17639 <para>Note that you must also enable line wrapping for verbatim environments and
17640 select appropriate hyphenation character (e.g. hook arrow). This can
17641 be done using <parameter>monospace.verbatim.properties</parameter>
17642 attribute set:</para>
17644 <programlisting><xsl:attribute-set name="monospace.verbatim.properties"
17645 use-attribute-sets="verbatim.properties monospace.properties">
17646 <xsl:attribute name="wrap-option">wrap</xsl:attribute>
17647 <xsl:attribute name="hyphenation-character">&#x25BA;</xsl:attribute>
17648 </xsl:attribute-set></programlisting>
17650 <para>For a list of arrows available in Unicode see <uri xlink:href="http://www.unicode.org/charts/PDF/U2190.pdf">http://www.unicode.org/charts/PDF/U2190.pdf</uri> and <uri xlink:href="http://www.unicode.org/charts/PDF/U2900.pdf">http://www.unicode.org/charts/PDF/U2900.pdf</uri> and make sure that
17651 selected character is available in the font you are using for verbatim
17652 environments.</para>
17657 <refentry version="5.0" id="hyphenate.verbatim.characters">
17659 <refentrytitle>hyphenate.verbatim.characters</refentrytitle>
17660 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
17663 <refname>hyphenate.verbatim.characters</refname>
17664 <refpurpose>List of characters after which a line break can occur in listings</refpurpose>
17668 <programlisting id="hyphenate.verbatim.characters.frag">
17669 <xsl:param name="hyphenate.verbatim.characters"></xsl:param>
17673 <refsection><info><title>Description</title></info>
17675 <para>If you enable <parameter>hyphenate.verbatim</parameter> line
17676 breaks are allowed only on space characters. If this is not enough for
17677 your document, you can specify list of additional characters after
17678 which line break is allowed in this parameter.</para>
17683 <refentry version="5.0" id="use.svg">
17685 <refentrytitle>use.svg</refentrytitle>
17686 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
17689 <refname>use.svg</refname>
17690 <refpurpose>Allow SVG in the result tree?</refpurpose>
17694 <programlisting id="use.svg.frag">
17695 <xsl:param name="use.svg" select="1"></xsl:param>
17699 <refsection><info><title>Description</title></info>
17701 <para>If non-zero, SVG will be considered an acceptable image format. SVG
17702 is passed through to the result tree, so correct rendering of the resulting
17703 diagram depends on the formatter (FO processor or web browser) that is used
17704 to process the output from the stylesheet.</para>
17709 <refentry version="5.0" id="use.role.as.xrefstyle">
17711 <refentrytitle>use.role.as.xrefstyle</refentrytitle>
17712 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
17715 <refname>use.role.as.xrefstyle</refname>
17716 <refpurpose>Use <tag class="attribute">role</tag> attribute for
17717 <tag class="attribute">xrefstyle</tag> on <tag>xref</tag>?</refpurpose>
17721 <programlisting id="use.role.as.xrefstyle.frag">
17722 <xsl:param name="use.role.as.xrefstyle" select="1"></xsl:param>
17726 <refsection><info><title>Description</title></info>
17728 <para>In DocBook documents that conform to a schema older than V4.3, this parameter allows
17729 <tag class="attribute">role</tag> to serve the purpose of specifying the cross reference style.</para>
17731 <para>If non-zero, the <tag class="attribute">role</tag> attribute on
17732 <tag>xref</tag> will be used to select the cross reference style.
17733 In DocBook V4.3, the <tag class="attribute">xrefstyle</tag> attribute was added for this purpose.
17734 If the <tag class="attribute">xrefstyle</tag> attribute is present,
17735 <tag class="attribute">role</tag> will be ignored, regardless of the setting
17736 of this parameter.</para>
17740 <refsection><info><title>Example</title></info>
17742 <para>The following small stylesheet shows how to configure the
17743 stylesheets to make use of the cross reference style:</para>
17745 <programlisting><?xml version="1.0"?>
17746 <xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
17749 <xsl:import href="../xsl/html/docbook.xsl"/>
17751 <xsl:output method="html"/>
17753 <xsl:param name="local.l10n.xml" select="document('')"/>
17754 <l:i18n xmlns:l="http://docbook.sourceforge.net/xmlns/l10n/1.0">
17755 <l:l10n xmlns:l="http://docbook.sourceforge.net/xmlns/l10n/1.0" language="en">
17756 <l:context name="xref">
17757 <l:template name="chapter" style="title" text="Chapter %n, %t"/>
17758 <l:template name="chapter" text="Chapter %n"/>
17763 </xsl:stylesheet></programlisting>
17765 <para>With this stylesheet, the cross references in the following document:</para>
17767 <programlisting><?xml version="1.0" encoding="utf-8"?>
17768 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
17769 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
17770 <book id="book"><title>Book</title>
17773 <title>Preface</title>
17775 <para>Normal: <xref linkend="ch1"/>.</para>
17776 <para>Title: <xref xrefstyle="title" linkend="ch1"/>.</para>
17780 <chapter id="ch1">
17781 <title>First Chapter</title>
17783 <para>Irrelevant.</para>
17786 </book></programlisting>
17788 <para>will appear as:</para>
17791 <para>Normal: Chapter 1.</para>
17792 <para>Title: Chapter 1, <emphasis>First Chapter</emphasis>.</para>
17798 <refentry version="5.0" id="menuchoice.separator">
17800 <refentrytitle>menuchoice.separator</refentrytitle>
17801 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
17804 <refname>menuchoice.separator</refname>
17805 <refpurpose>Separator between items of a <tag>menuchoice</tag>
17806 other than <tag>guimenuitem</tag> and
17807 <tag>guisubmenu</tag></refpurpose>
17811 <programlisting id="menuchoice.separator.frag">
17812 <xsl:param name="menuchoice.separator">+</xsl:param>
17816 <refsection><info><title>Description</title></info>
17818 <para>Separator used to connect items of a <tag>menuchoice</tag> other
17819 than <tag>guimenuitem</tag> and <tag>guisubmenu</tag>. The latter
17820 elements are linked with <parameter>menuchoice.menu.separator</parameter>.
17826 <refentry version="5.0" id="menuchoice.menu.separator">
17828 <refentrytitle>menuchoice.menu.separator</refentrytitle>
17829 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
17832 <refname>menuchoice.menu.separator</refname>
17833 <refpurpose>Separator between items of a <tag>menuchoice</tag>
17834 with <tag>guimenuitem</tag> or
17835 <tag>guisubmenu</tag></refpurpose>
17839 <programlisting id="menuchoice.menu.separator.frag">
17840 <xsl:param name="menuchoice.menu.separator"> → </xsl:param>
17844 <refsection><info><title>Description</title></info>
17846 <para>Separator used to connect items of a <tag>menuchoice</tag> with
17847 <tag>guimenuitem</tag> or <tag>guisubmenu</tag>. Other elements
17848 are linked with <parameter>menuchoice.separator</parameter>.
17850 <para>The default value is &#x2192;, which is the
17851 &rarr; (right arrow) character entity.
17852 The current FOP (0.20.5) requires setting the font-family
17855 <para>The default value also includes spaces around the arrow,
17856 which will allow a line to break. Replace the spaces with
17857 &#xA0; (nonbreaking space) if you don't want those
17864 <refentry version="5.0" id="default.float.class">
17866 <refentrytitle>default.float.class</refentrytitle>
17867 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
17870 <refname>default.float.class</refname>
17871 <refpurpose>Specifies the default float class</refpurpose>
17875 <programlisting id="default.float.class.frag">
17876 <xsl:param name="default.float.class">
17878 <xsl:when test="contains($stylesheet.result.type,'html')">left</xsl:when>
17879 <xsl:otherwise>before</xsl:otherwise>
17880 </xsl:choose>
17885 <refsection><info><title>Description</title></info>
17887 <para>Selects the direction in which a float should be placed. for
17888 xsl-fo this is before, for html it is left. For Western texts, the
17889 before direction is the top of the page.</para>
17894 <refentry version="5.0" id="footnote.number.format">
17896 <refentrytitle>footnote.number.format</refentrytitle>
17897 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
17898 <refmiscinfo class="other" otherclass="value">1<alt>1,2,3...</alt></refmiscinfo>
17899 <refmiscinfo class="other" otherclass="value">A<alt>A,B,C...</alt></refmiscinfo>
17900 <refmiscinfo class="other" otherclass="value">a<alt>a,b,c...</alt></refmiscinfo>
17901 <refmiscinfo class="other" otherclass="value">i<alt>i,ii,iii...</alt></refmiscinfo>
17902 <refmiscinfo class="other" otherclass="value">I<alt>I,II,III...</alt></refmiscinfo>
17905 <refname>footnote.number.format</refname>
17906 <refpurpose>Identifies the format used for footnote numbers</refpurpose>
17910 <programlisting id="footnote.number.format.frag">
17911 <xsl:param name="footnote.number.format">1</xsl:param>
17915 <refsection><info><title>Description</title></info>
17917 <para>The <parameter>footnote.number.format</parameter> specifies the format
17918 to use for footnote numeration (1, i, I, a, or A).</para>
17923 <refentry version="5.0" id="table.footnote.number.format">
17925 <refentrytitle>table.footnote.number.format</refentrytitle>
17926 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
17927 <refmiscinfo class="other" otherclass="value">1<alt>1,2,3...</alt></refmiscinfo>
17928 <refmiscinfo class="other" otherclass="value">A<alt>A,B,C...</alt></refmiscinfo>
17929 <refmiscinfo class="other" otherclass="value">a<alt>a,b,c...</alt></refmiscinfo>
17930 <refmiscinfo class="other" otherclass="value">i<alt>i,ii,iii...</alt></refmiscinfo>
17931 <refmiscinfo class="other" otherclass="value">I<alt>I,II,III...</alt></refmiscinfo>
17934 <refname>table.footnote.number.format</refname>
17935 <refpurpose>Identifies the format used for footnote numbers in tables</refpurpose>
17939 <programlisting id="table.footnote.number.format.frag">
17940 <xsl:param name="table.footnote.number.format">a</xsl:param>
17944 <refsection><info><title>Description</title></info>
17946 <para>The <parameter>table.footnote.number.format</parameter> specifies the format
17947 to use for footnote numeration (1, i, I, a, or A) in tables.</para>
17952 <refentry version="5.0" id="footnote.number.symbols">
17954 <refentrytitle>footnote.number.symbols</refentrytitle>
17955 <refmiscinfo class="other" otherclass="datatype"/>
17958 <refname>footnote.number.symbols</refname>
17959 <refpurpose>Special characters to use as footnote markers</refpurpose>
17963 <programlisting id="footnote.number.symbols.frag">
17964 <xsl:param name="footnote.number.symbols"></xsl:param>
17968 <refsection><info><title>Description</title></info>
17970 <para>If <parameter>footnote.number.symbols</parameter> is not the empty string,
17971 footnotes will use the characters it contains as footnote symbols. For example,
17972 <quote>*&#x2020;&#x2021;&#x25CA;&#x2720;</quote> will identify
17973 footnotes with <quote>*</quote>, <quote>†</quote>, <quote>‡</quote>,
17974 <quote>◊</quote>, and <quote>✠</quote>. If there are more footnotes
17975 than symbols, the stylesheets will fall back to numbered footnotes using
17976 <parameter>footnote.number.format</parameter>.</para>
17978 <para>The use of symbols for footnotes depends on the ability of your
17979 processor (or browser) to render the symbols you select. Not all systems are
17980 capable of displaying the full range of Unicode characters. If the quoted characters
17981 in the preceding paragraph are not displayed properly, that's a good indicator
17982 that you may have trouble using those symbols for footnotes.</para>
17987 <refentry version="5.0" id="table.footnote.number.symbols">
17989 <refentrytitle>table.footnote.number.symbols</refentrytitle>
17990 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
17993 <refname>table.footnote.number.symbols</refname>
17994 <refpurpose>Special characters to use a footnote markers in tables</refpurpose>
17998 <programlisting id="table.footnote.number.symbols.frag">
17999 <xsl:param name="table.footnote.number.symbols"></xsl:param>
18003 <refsection><info><title>Description</title></info>
18005 <para>If <parameter>table.footnote.number.symbols</parameter> is not the empty string,
18006 table footnotes will use the characters it contains as footnote symbols. For example,
18007 <quote>*&#x2020;&#x2021;&#x25CA;&#x2720;</quote> will identify
18008 footnotes with <quote>*</quote>, <quote>†</quote>, <quote>‡</quote>,
18009 <quote>◊</quote>, and <quote>✠</quote>. If there are more footnotes
18010 than symbols, the stylesheets will fall back to numbered footnotes using
18011 <parameter>table.footnote.number.format</parameter>.</para>
18013 <para>The use of symbols for footnotes depends on the ability of your
18014 processor (or browser) to render the symbols you select. Not all systems are
18015 capable of displaying the full range of Unicode characters. If the quoted characters
18016 in the preceding paragraph are not displayed properly, that's a good indicator
18017 that you may have trouble using those symbols for footnotes.</para>
18022 <refentry version="5.0" id="footnote.properties">
18024 <refentrytitle>footnote.properties</refentrytitle>
18025 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
18028 <refname>footnote.properties</refname>
18029 <refpurpose>Properties applied to each footnote body
18034 <programlisting id="footnote.properties.frag">
18035 <xsl:attribute-set name="footnote.properties">
18036 <xsl:attribute name="font-family"><xsl:value-of select="$body.fontset"></xsl:value-of></xsl:attribute>
18037 <xsl:attribute name="font-size"><xsl:value-of select="$footnote.font.size"></xsl:value-of></xsl:attribute>
18038 <xsl:attribute name="font-weight">normal</xsl:attribute>
18039 <xsl:attribute name="font-style">normal</xsl:attribute>
18040 <xsl:attribute name="text-align"><xsl:value-of select="$alignment"></xsl:value-of></xsl:attribute>
18041 <xsl:attribute name="start-indent">0pt</xsl:attribute>
18042 <xsl:attribute name="end-indent">0pt</xsl:attribute>
18043 <xsl:attribute name="text-indent">0pt</xsl:attribute>
18044 <xsl:attribute name="hyphenate"><xsl:value-of select="$hyphenate"></xsl:value-of></xsl:attribute>
18045 <xsl:attribute name="wrap-option">wrap</xsl:attribute>
18046 <xsl:attribute name="linefeed-treatment">treat-as-space</xsl:attribute>
18047 </xsl:attribute-set>
18051 <refsection><info><title>Description</title></info>
18053 <para>This attribute set is applied to the footnote-block
18055 It can be used to set the
18056 font-size, font-family, and other inheritable properties that will be
18057 applied to all footnotes.</para>
18062 <refentry version="5.0" id="table.footnote.properties">
18064 <refentrytitle>table.footnote.properties</refentrytitle>
18065 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
18068 <refname>table.footnote.properties</refname>
18069 <refpurpose>Properties applied to each table footnote body
18074 <programlisting id="table.footnote.properties.frag">
18075 <xsl:attribute-set name="table.footnote.properties">
18076 <xsl:attribute name="font-family"><xsl:value-of select="$body.fontset"></xsl:value-of></xsl:attribute>
18077 <xsl:attribute name="font-size"><xsl:value-of select="$footnote.font.size"></xsl:value-of></xsl:attribute>
18078 <xsl:attribute name="font-weight">normal</xsl:attribute>
18079 <xsl:attribute name="font-style">normal</xsl:attribute>
18080 <xsl:attribute name="space-before">2pt</xsl:attribute>
18081 <xsl:attribute name="text-align"><xsl:value-of select="$alignment"></xsl:value-of></xsl:attribute>
18082 </xsl:attribute-set>
18086 <refsection><info><title>Description</title></info>
18088 <para>This attribute set is applied to the footnote-block
18089 for each table footnote.
18090 It can be used to set the
18091 font-size, font-family, and other inheritable properties that will be
18092 applied to all table footnotes.</para>
18097 <refentry version="5.0" id="footnote.mark.properties">
18099 <refentrytitle>footnote.mark.properties</refentrytitle>
18100 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
18103 <refname>footnote.mark.properties</refname>
18104 <refpurpose>Properties applied to each footnote mark
18109 <programlisting id="footnote.mark.properties.frag">
18110 <xsl:attribute-set name="footnote.mark.properties">
18111 <xsl:attribute name="font-family"><xsl:value-of select="$body.fontset"></xsl:value-of></xsl:attribute>
18112 <xsl:attribute name="font-size">75%</xsl:attribute>
18113 <xsl:attribute name="font-weight">normal</xsl:attribute>
18114 <xsl:attribute name="font-style">normal</xsl:attribute>
18115 </xsl:attribute-set>
18119 <refsection><info><title>Description</title></info>
18121 <para>This attribute set is applied to the footnote mark used
18123 It should contain only inline properties.
18126 <para>The property to make the mark a superscript is contained in the
18127 footnote template itself, because the current version of FOP reports
18128 an error if baseline-shift is used.
18134 <refentry version="5.0" id="footnote.sep.leader.properties">
18136 <refentrytitle>footnote.sep.leader.properties</refentrytitle>
18137 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
18140 <refname>footnote.sep.leader.properties</refname>
18141 <refpurpose>Properties associated with footnote separators</refpurpose>
18145 <programlisting id="footnote.sep.leader.properties.frag">
18146 <xsl:attribute-set name="footnote.sep.leader.properties">
18147 <xsl:attribute name="color">black</xsl:attribute>
18148 <xsl:attribute name="leader-pattern">rule</xsl:attribute>
18149 <xsl:attribute name="leader-length">1in</xsl:attribute>
18150 </xsl:attribute-set>
18154 <refsection><info><title>Description</title></info>
18156 <para>The styling for the rule line that separates the
18157 footnotes from the body text.
18158 These are properties applied to the fo:leader used as
18161 <para>If you want to do more than just set properties on
18162 the leader element, then you can customize the template
18163 named <literal>footnote.separator</literal> in
18164 <filename>fo/pagesetup.xsl</filename>.</para>
18169 <refentry version="5.0" id="xref.with.number.and.title">
18171 <refentrytitle>xref.with.number.and.title</refentrytitle>
18172 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
18175 <refname>xref.with.number.and.title</refname>
18176 <refpurpose>Use number and title in cross references</refpurpose>
18180 <programlisting id="xref.with.number.and.title.frag">
18181 <xsl:param name="xref.with.number.and.title" select="1"></xsl:param>
18185 <refsection><info><title>Description</title></info>
18187 <para>A cross reference may include the number (for example, the number of
18188 an example or figure) and the <tag>title</tag> which is a required child of some
18189 targets. This parameter inserts both the relevant number as well as
18190 the title into the link. </para>
18195 <refentry version="5.0" id="superscript.properties">
18197 <refentrytitle>superscript.properties</refentrytitle>
18198 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
18201 <refname>superscript.properties</refname>
18202 <refpurpose>Properties associated with superscripts</refpurpose>
18206 <programlisting id="superscript.properties.frag">
18207 <xsl:attribute-set name="superscript.properties">
18208 <xsl:attribute name="font-size">75%</xsl:attribute>
18209 </xsl:attribute-set>
18213 <refsection><info><title>Description</title></info>
18215 <para>Specifies styling properties for superscripts.</para>
18220 <refentry version="5.0" id="subscript.properties">
18222 <refentrytitle>subscript.properties</refentrytitle>
18223 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
18226 <refname>subscript.properties</refname>
18227 <refpurpose>Properties associated with subscripts</refpurpose>
18231 <programlisting id="subscript.properties.frag">
18232 <xsl:attribute-set name="subscript.properties">
18233 <xsl:attribute name="font-size">75%</xsl:attribute>
18234 </xsl:attribute-set>
18238 <refsection><info><title>Description</title></info>
18240 <para>Specifies styling properties for subscripts.</para>
18245 <refentry version="5.0" id="pgwide.properties">
18247 <refentrytitle>pgwide.properties</refentrytitle>
18248 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
18251 <refname>pgwide.properties</refname>
18252 <refpurpose>Properties to make a figure or table page wide.
18257 <programlisting id="pgwide.properties.frag">
18258 <xsl:attribute-set name="pgwide.properties">
18259 <xsl:attribute name="start-indent">0pt</xsl:attribute>
18260 </xsl:attribute-set>
18264 <refsection><info><title>Description</title></info>
18266 <para>This attribute set is used to set the properties
18267 that make a figure or table "page wide" in fo output.
18268 It comes into effect when an attribute <literal>pgwide="1"</literal>
18273 By default, it sets <parameter>start-indent</parameter>
18274 to <literal>0pt</literal>.
18275 In a stylesheet that sets the parameter
18276 <parameter>body.start.indent</parameter>
18277 to a non-zero value in order to indent body text,
18278 this attribute set can be used to outdent pgwide
18279 figures to the start margin.
18282 <para>If a document uses a multi-column page layout,
18283 then this attribute set could try setting <parameter>span</parameter>
18284 to a value of <literal>all</literal>. However, this may
18285 not work with some processors because a span property must be on an
18286 fo:block that is a direct child of fo:flow. It may work in
18287 some processors anyway.
18293 <refentry version="5.0" id="highlight.source">
18295 <refentrytitle>highlight.source</refentrytitle>
18296 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
18299 <refname>highlight.source</refname>
18300 <refpurpose>Should the content of <tag>programlisting</tag>
18301 be syntactically highlighted?</refpurpose>
18305 <programlisting id="highlight.source.frag">
18306 <xsl:param name="highlight.source" select="0"></xsl:param>
18310 <refsection><info><title>Description</title></info>
18312 <para>When this parameter is non-zero, the stylesheets will try to do syntax highlighting of the
18313 content of <tag>programlisting</tag> elements. You specify the language for each programlisting
18314 by using the <tag class="attribute">language</tag> attribute. The <parameter>highlight.default.language</parameter>
18315 parameter can be used to specify the language for programlistings without a <tag class="attribute">language</tag>
18316 attribute. Syntax highlighting also works for <tag>screen</tag> and <tag>synopsis</tag> elements.</para>
18318 <para>The actual highlighting work is done by the XSLTHL extension module. This is an external Java library that has to be
18319 downloaded separately (see below).</para>
18322 <para>In order to use this extension, you must</para>
18324 <listitem><para>add <filename>xslthl-2.x.x.jar</filename> to your Java classpath. The latest version is available
18325 from <link xlink:href="http://sourceforge.net/projects/xslthl">the XSLT syntax highlighting project</link>
18326 at SourceForge.</para>
18329 <para>use a customization layer in which you import one of the following stylesheet modules:
18332 <para><filename>html/highlight.xsl</filename>
18336 <para><filename>xhtml/highlight.xsl</filename>
18340 <para><filename>xhtml-1_1/highlight.xsl</filename>
18344 <para><filename>fo/highlight.xsl</filename>
18350 <listitem><para>let either the <literal>xslthl.config</literal> Java system property or the
18351 <parameter>highlight.xslthl.config</parameter> parameter point to the configuration file for syntax
18352 highlighting (using URL syntax). DocBook XSL comes with a ready-to-use configuration file,
18353 <filename>highlighting/xslthl-config.xml</filename>.</para>
18357 <para>The extension works with Saxon 6.5.x and Xalan-J. (Saxon 8.5 or later is also supported, but since it is
18358 an XSLT 2.0 processor it is not guaranteed to work with DocBook XSL in all circumstances.)</para>
18360 <para>The following is an example of a Saxon 6 command adapted for syntax highlighting, to be used on Windows:</para>
18363 <para><command>java -cp c:/Java/saxon.jar;c:/Java/xslthl-2.0.1.jar
18364 -Dxslthl.config=file:///c:/docbook-xsl/highlighting/xslthl-config.xml com.icl.saxon.StyleSheet
18365 -o test.html test.xml myhtml.xsl</command></para>
18371 <refentry version="5.0" id="highlight.xslthl.config">
18373 <refentrytitle>highlight.xslthl.config</refentrytitle>
18374 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
18377 <refname>highlight.xslthl.config</refname>
18378 <refpurpose>Location of XSLTHL configuration file</refpurpose>
18382 <programlisting id="highlight.xslthl.config.frag">
18383 <xsl:param name="highlight.xslthl.config"></xsl:param>
18387 <refsection><info><title>Description</title></info>
18389 <para>This location has precedence over the corresponding Java property.</para>
18391 <para>Please note that usually you have to specify location as URL not
18392 just as a simple path on the local
18393 filesystem. E.g. <filename>file:///home/user/xslthl/my-xslthl-config.xml</filename>.</para>
18400 <refentry version="5.0" id="highlight.default.language">
18402 <refentrytitle>highlight.default.language</refentrytitle>
18403 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
18406 <refname>highlight.default.language</refname>
18407 <refpurpose>Default language of programlisting</refpurpose>
18411 <programlisting id="highlight.default.language.frag">
18412 <xsl:param name="highlight.default.language"></xsl:param>
18416 <refsection><info><title>Description</title></info>
18418 <para>This language is used when there is no language attribute on programlisting.</para>
18423 <refentry version="5.0" id="email.delimiters.enabled">
18425 <refentrytitle>email.delimiters.enabled</refentrytitle>
18426 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
18429 <refname>email.delimiters.enabled</refname>
18430 <refpurpose>Generate delimiters around email addresses?</refpurpose>
18434 <programlisting id="email.delimiters.enabled.frag">
18435 <xsl:param name="email.delimiters.enabled" select="1"></xsl:param>
18439 <refsection><info><title>Description</title></info>
18441 <para>If non-zero, delimiters
18443 <footnote><para>For delimiters, the
18444 stylesheets are currently hard-coded to output angle
18445 brackets.</para></footnote>
18447 are generated around e-mail addresses
18448 (the output of the <tag>email</tag> element).</para>
18453 <refentry version="5.0" id="email.mailto.enabled">
18455 <refentrytitle>email.mailto.enabled</refentrytitle>
18456 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
18459 <refname>email.mailto.enabled</refname>
18460 <refpurpose>Generate mailto: links for email addresses?</refpurpose>
18464 <programlisting id="email.mailto.enabled.frag">
18465 <xsl:param name="email.mailto.enabled" select="0"></xsl:param>
18469 <refsection><info><title>Description</title></info>
18471 <para>If non-zero the generated output for the <tag>email</tag> element
18472 will be a clickable mailto: link that brings up the default mail client
18473 on the system.</para>
18478 <refentry version="5.0" id="section.container.element">
18480 <refentrytitle>section.container.element</refentrytitle>
18481 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
18482 <refmiscinfo class="other" otherclass="value">block</refmiscinfo>
18483 <refmiscinfo class="other" otherclass="value">wrapper</refmiscinfo>
18486 <refname>section.container.element</refname>
18487 <refpurpose>Select XSL-FO element name to contain sections</refpurpose>
18491 <programlisting id="section.container.element.frag">
18492 <xsl:param name="section.container.element">block</xsl:param>
18496 <refsection><info><title>Description</title></info>
18498 <para>Selects the element name for outer container of
18499 each section. The choices are <literal>block</literal> (default)
18500 or <literal>wrapper</literal>.
18501 The <literal>fo:</literal> namespace prefix is added
18502 by the stylesheet to form the full element name.
18505 <para>This element receives the section <literal>id</literal>
18506 attribute and the appropriate section level attribute-set.
18509 <para>Changing this parameter to <literal>wrapper</literal>
18510 is only necessary when producing multi-column output
18511 that contains page-wide spans. Using <literal>fo:wrapper</literal>
18512 avoids the nesting of <literal>fo:block</literal>
18513 elements that prevents spans from working (the standard says
18514 a span must be on a block that is a direct child of
18515 <literal>fo:flow</literal>).
18518 <para>If set to <literal>wrapper</literal>, the
18519 section attribute-sets only support properties
18520 that are inheritable. That's because there is no
18521 block to apply them to. Properties such as
18522 font-family are inheritable, but properties such as
18526 <para>Only some XSL-FO processors need to use this parameter.
18527 The Antenna House processor, for example, will handle
18528 spans in nested blocks without changing the element name.
18529 The RenderX XEP product and FOP follow the XSL-FO standard
18530 and need to use <literal>wrapper</literal>.
18536 <refentry version="5.0" id="monospace.verbatim.font.width">
18538 <refentrytitle>monospace.verbatim.font.width</refentrytitle>
18539 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
18542 <refname>monospace.verbatim.font.width</refname>
18543 <refpurpose>Width of a single monospace font character</refpurpose>
18547 <programlisting id="monospace.verbatim.font.width.frag">
18548 <xsl:param name="monospace.verbatim.font.width">0.60em</xsl:param>
18552 <refsection><info><title>Description</title></info>
18554 <para>Specifies with em units the width of a single character
18555 of the monospace font. The default value is <literal>0.6em</literal>.</para>
18557 <para>This parameter is only used when a <tag>screen</tag>
18558 or <tag>programlisting</tag> element has a
18559 <tag class="attribute">width</tag> attribute, which is
18560 expressed as a plain integer to indicate the maximum character count
18562 To convert this character count to an actual maximum width
18563 measurement, the width of the font characters must be provided.
18564 Different monospace fonts have different character width,
18565 so this parameter should be adjusted to fit the
18566 monospace font being used.
18572 <refentry version="5.0" id="exsl.node.set.available">
18574 <refentrytitle>exsl.node.set.available</refentrytitle>
18575 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
18578 <refname>exsl.node.set.available</refname>
18579 <refpurpose>Is the test function-available('exsl:node-set') true?</refpurpose>
18583 <programlisting id="exsl.node.set.available.frag"><xsl:param name="exsl.node.set.available">
18585 <xsl:when exsl:foo="" test="function-available('exsl:node-set') or contains(system-property('xsl:vendor'), 'Apache Software Foundation')">1</xsl:when>
18586 <xsl:otherwise>0</xsl:otherwise>
18587 </xsl:choose>
18592 <refsection><info><title>Description</title></info>
18595 then the exsl:node-set() function is available to be used in
18597 If zero, then the function is not available.
18598 This param automatically detects the presence of
18599 the function and does not normally need to be set manually.</para>
18601 <para>This param was created to handle a long-standing
18602 bug in the Xalan processor that fails to detect the
18603 function even though it is available.</para>
18608 <refentry version="5.0" id="show.bookmarks">
18610 <refentrytitle>show.bookmarks</refentrytitle>
18611 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
18614 <refname>show.bookmarks</refname>
18615 <refpurpose>Display bookmarks in PDF output</refpurpose>
18619 <programlisting id="show.bookmarks.frag">
18620 <xsl:param name="show.bookmarks" select="1"></xsl:param>
18624 <refsection><info><title>Description</title></info>
18626 <para>If non-zero (default), then bookmarks are generated in PDF
18627 output. If set to zero, bookmarks are turned off.
18629 <para>See also <parameter>xsl1.1.bookmarks</parameter>.</para>
18634 <refentry version="5.0" id="bookmarks.collapse">
18636 <refentrytitle>bookmarks.collapse</refentrytitle>
18637 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
18640 <refname>bookmarks.collapse</refname>
18641 <refpurpose>Specifies the initial state of bookmarks</refpurpose>
18645 <programlisting id="bookmarks.collapse.frag">
18646 <xsl:param name="bookmarks.collapse" select="1"></xsl:param>
18650 <refsection><info><title>Description</title></info>
18652 <para>If non-zero, the bookmark tree is collapsed so that only the
18653 top-level bookmarks are displayed initially. Otherwise, the whole tree
18654 of bookmarks is displayed.</para>
18656 <para>This parameter currently works with FOP 0.93 or later.</para>
18661 <refentry version="5.0" id="xsl1.1.bookmarks">
18663 <refentrytitle>xsl1.1.bookmarks</refentrytitle>
18664 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
18667 <refname>xsl1.1.bookmarks</refname>
18668 <refpurpose>Use standard XSL 1.1 bookmark elements</refpurpose>
18672 <programlisting id="xsl1.1.bookmarks.frag"><xsl:param name="xsl1.1.bookmarks">
18674 <xsl:when test="$fop1.extensions != 0">1</xsl:when>
18675 <xsl:when test="$xep.extensions != 0">1</xsl:when>
18676 <xsl:when test="$axf.extensions != 0">1</xsl:when>
18677 <xsl:otherwise>0</xsl:otherwise>
18678 </xsl:choose></xsl:param></programlisting>
18681 <refsection><info><title>Description</title></info>
18683 <para>If non-zero (default),
18684 the stylesheet uses the
18685 <tag>fo:bookmark-tree</tag>
18687 <tag>fo:bookmark</tag> elements that are
18688 standard in XSL 1.1, instead of each XSL-FO processor's proprietary
18690 If zero, then the stylesheet uses the proprietary bookmark elements that
18697 <refentry version="5.0" id="generate.consistent.ids">
18699 <refentrytitle>generate.consistent.ids</refentrytitle>
18700 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
18703 <refname>generate.consistent.ids</refname>
18704 <refpurpose>Generate consistent id values if document is unchanged</refpurpose>
18708 <programlisting id="generate.consistent.ids.frag">
18709 <xsl:param name="generate.consistent.ids" select="0"></xsl:param>
18713 <refsection><info><title>Description</title></info>
18715 <para>When the stylesheet assigns an id value to an output element,
18716 the generate-id() function may be used. That function may not
18717 produce consistent values between runs. Version control
18718 systems may misidentify the changing id values as changes
18719 to the document.</para>
18721 <para>If you set this parameter's value to 1, then the
18722 template named <literal>object.id</literal> will replace
18723 the use of the function generate-id() with
18724 <literal><xsl:number level="multiple" count="*"/></literal>.
18725 This counts preceding elements to generate a unique number for
18726 the id value.</para>
18729 <para>This param does not associate permanent unique id values
18730 with particular elements.
18731 The id values are consistent only as long as the document
18732 structure does not change.
18733 If the document structure changes, then the counting
18734 of elements changes, and all id values after
18735 the first such change may be different, even when there is
18736 no change to the element itself or its output.
18740 <para>The default value of this parameter is zero, so generate-id() is used
18746 <refentry version="5.0" id="base.dir">
18748 <refentrytitle>base.dir</refentrytitle>
18749 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
18752 <refname>base.dir</refname>
18753 <refpurpose>The base directory of chunks</refpurpose>
18757 <programlisting id="base.dir.frag">
18758 <xsl:param name="base.dir"></xsl:param>
18762 <refsection><info><title>Description</title></info>
18764 <para>If specified, the <parameter>base.dir</parameter> parameter identifies
18765 the output directory for chunks. (If not specified, the output directory
18766 is system dependent.)</para>
18768 <para>Starting with version 1.77 of the stylesheets,
18769 the param's value will have a trailing slash added if it does
18770 not already have one.</para>
18772 <caution><para>Do not use <parameter>base.dir</parameter>
18773 to add a filename prefix string to chunked files.
18774 Instead, use the <parameter>chunked.filename.prefix</parameter>
18775 parameter.</para></caution>
18780 <refentry version="5.0" id="chunk.quietly">
18782 <refentrytitle>chunk.quietly</refentrytitle>
18783 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
18786 <refname>chunk.quietly</refname>
18787 <refpurpose>Omit the chunked filename messages.</refpurpose>
18791 <programlisting id="chunk.quietly.frag">
18792 <xsl:param name="chunk.quietly" select="0"></xsl:param>
18796 <refsection><info><title>Description</title></info>
18798 <para>If zero (the default), the XSL processor emits a message naming
18799 each separate chunk filename as it is being output.
18800 If nonzero, then the messages are suppressed.
18806 </reference><reference id="graphics" xml:base="../fo/param.xml"><title>Graphics</title>
18807 <refentry version="5.0" id="graphic.default.extension">
18809 <refentrytitle>graphic.default.extension</refentrytitle>
18810 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
18813 <refname>graphic.default.extension</refname>
18814 <refpurpose>Default extension for graphic filenames</refpurpose>
18818 <programlisting id="graphic.default.extension.frag"><xsl:param name="graphic.default.extension"></xsl:param></programlisting>
18821 <refsection><info><title>Description</title></info>
18823 <para>If a <tag>graphic</tag> or <tag>mediaobject</tag>
18824 includes a reference to a filename that does not include an extension,
18825 and the <tag class="attribute">format</tag> attribute is
18826 <emphasis>unspecified</emphasis>, the default extension will be used.
18832 <refentry version="5.0" id="default.image.width">
18834 <refentrytitle>default.image.width</refentrytitle>
18835 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
18838 <refname>default.image.width</refname>
18839 <refpurpose>The default width of images</refpurpose>
18843 <programlisting id="default.image.width.frag">
18844 <xsl:param name="default.image.width"></xsl:param>
18848 <refsection><info><title>Description</title></info>
18850 <para>If specified, this value will be used for the
18851 <tag class="attribute">width</tag> attribute on images that do not specify any
18852 <emphasis xlink:title="DocBook 5: The Definitive Guide" xlink:href="http://docbook.org/tdg5/en/html/imagedata.html#viewport.area">viewport dimensions</emphasis>.</para>
18857 <refentry version="5.0" id="preferred.mediaobject.role">
18859 <refentrytitle>preferred.mediaobject.role</refentrytitle>
18860 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
18863 <refname>preferred.mediaobject.role</refname>
18864 <refpurpose>Select which mediaobject to use based on
18865 this value of an object's <tag class="attribute">role</tag> attribute.
18870 <programlisting id="preferred.mediaobject.role.frag">
18871 <xsl:param name="preferred.mediaobject.role"></xsl:param>
18875 <refsection><info><title>Description</title></info>
18877 <para>A mediaobject may contain several objects such as imageobjects.
18878 If the parameter <parameter>use.role.for.mediaobject</parameter> is
18879 non-zero, then the <literal>role</literal> attribute on
18880 <tag>imageobject</tag>s and other objects within a
18881 <tag>mediaobject</tag> container will be used to select which object
18882 will be used. If one of the objects has a role value that matches the
18883 <parameter>preferred.mediaobject.role</parameter> parameter, then it
18884 has first priority for selection. If more than one has such a role
18885 value, the first one is used.
18888 See the <parameter>use.role.for.mediaobject</parameter> parameter
18889 for the sequence of selection.</para>
18893 <refentry version="5.0" id="use.role.for.mediaobject">
18895 <refentrytitle>use.role.for.mediaobject</refentrytitle>
18896 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
18899 <refname>use.role.for.mediaobject</refname>
18900 <refpurpose>Use <tag class="attribute">role</tag> attribute
18901 value for selecting which of several objects within a mediaobject to use.
18906 <programlisting id="use.role.for.mediaobject.frag">
18907 <xsl:param name="use.role.for.mediaobject" select="1"></xsl:param>
18911 <refsection><info><title>Description</title></info>
18913 <para>If non-zero, the <tag class="attribute">role</tag> attribute on
18914 <tag>imageobject</tag>s or other objects within a <tag>mediaobject</tag> container will be used to select which object will be
18918 The order of selection when then parameter is non-zero is:
18922 <para>If the stylesheet parameter <parameter>preferred.mediaobject.role</parameter> has a value, then the object whose role equals that value is selected.</para>
18925 <para>Else if an object's role attribute has a value of
18926 <literal>html</literal> for HTML processing or
18927 <literal>fo</literal> for FO output, then the first
18928 of such objects is selected.
18932 <para>Else the first suitable object is selected.</para>
18937 <parameter>use.role.for.mediaobject</parameter>
18938 is zero, then role attributes are not considered
18939 and the first suitable object
18940 with or without a role value is used.
18945 <refentry version="5.0" id="ignore.image.scaling">
18947 <refentrytitle>ignore.image.scaling</refentrytitle>
18948 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
18951 <refname>ignore.image.scaling</refname>
18952 <refpurpose>Tell the stylesheets to ignore the author's image scaling attributes</refpurpose>
18956 <programlisting id="ignore.image.scaling.frag">
18957 <xsl:param name="ignore.image.scaling" select="0"></xsl:param>
18961 <refsection><info><title>Description</title></info>
18963 <para>If non-zero, the scaling attributes on graphics and media objects are
18969 <refentry version="5.0" id="img.src.path">
18971 <refentrytitle>img.src.path</refentrytitle>
18972 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
18975 <refname>img.src.path</refname>
18976 <refpurpose>Path to HTML/FO image files</refpurpose>
18980 <programlisting id="img.src.path.frag"><xsl:param name="img.src.path"></xsl:param></programlisting>
18983 <refsection><info><title>Description</title></info>
18985 <para>Add a path prefix to the value of the <tag class="attribute">fileref</tag>
18986 attribute of <tag>graphic</tag>, <tag>inlinegraphic</tag>, and <tag>imagedata</tag> elements. The resulting
18987 compound path is used in the output as the value of the <tag class="attribute">src</tag>
18988 attribute of <tag class="element">img</tag> (HTML) or <tag class="element">external-graphic</tag> (FO).
18992 The path given by <literal>img.src.path</literal> could be relative to the directory where the HTML/FO
18993 files are created, or it could be an absolute URI.
18994 The default value is empty.
18995 Be sure to include a trailing slash if needed.
18998 <para>This prefix is not applied to any filerefs that start
18999 with "/" or contain "//:".
19005 <refentry version="5.0" id="keep.relative.image.uris">
19007 <refentrytitle>keep.relative.image.uris</refentrytitle>
19008 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
19011 <refname>keep.relative.image.uris</refname>
19012 <refpurpose>Should image URIs be resolved against xml:base?</refpurpose>
19016 <programlisting id="keep.relative.image.uris.frag">
19018 <xsl:param name="keep.relative.image.uris" select="0"></xsl:param>
19022 <refsection><info><title>Description</title></info>
19024 <para>If non-zero, relative URIs (in, for example
19025 <literal>fileref</literal> attributes) will be used in the generated
19026 output. Otherwise, the URIs will be made absolute with respect to the
19029 <para>Note that the stylesheets calculate (and use) the absolute form
19030 for some purposes, this only applies to the resulting output.</para>
19035 </reference><reference id="general" xml:base="../fo/param.xml"><title>Pagination and General Styles</title>
19036 <partintro id="margins_partintro">
19037 <section id="margins_intro"><title>Understanding XSL FO Margins</title>
19039 <para>To make sense of the parameters in this section, it's useful to
19040 consider <xref linkend="fig.pagemodel"/>.</para>
19042 <figure id="fig.pagemodel">
19043 <title>Page Model</title>
19044 <mediaobject id="fo-pageregions-image">
19045 <imageobject role="html">
19046 <imagedata fileref="page.png"/>
19048 <imageobject role="fo">
19049 <imagedata fileref="fo/page.png"/>
19051 <textobject><phrase>Figure showing page margins</phrase></textobject>
19053 <para>This figure shows the physical page with the various FO page regions
19059 <para>First, let's consider the regions on the page.</para>
19061 <para>The white region is the physical page. Its dimensions are determined by
19062 the <parameter>page.height</parameter> and <parameter>page.width</parameter>
19065 <para>The yellow region is the region-body. The size and placement of
19066 the region body is constrained by the dimensions labelled in the
19069 <para>The pink region at the top of the page is the region-before. The
19070 darker area inside the region-before is the header text. In XSL, the default
19071 display alignment for a region is <literal>before</literal>, but the
19072 DocBook stylesheets still explicitly make it <literal>before</literal>. That's
19073 why the darker area is at the top.</para>
19075 <para>The pink region at the bottom of the page is the region-after.
19076 The darker area is the footer text. In XSL, the default display
19077 alignment for a region is <literal>before</literal>,
19078 but the DocBook stylesheets explicitly make it
19079 <literal>after</literal>. That's why the darker area is at the bottom.</para>
19081 <para>The dimensions in the figure are:</para>
19083 <orderedlist numeration="upperalpha">
19084 <listitem><para>The page-master margin-top.
19086 <listitem><para>The region-before extent.
19088 <listitem><para>The region-body margin-top.
19090 <listitem><para>The region-after extent.
19092 <listitem><para>The page-master margin-bottom.
19094 <listitem><para>The region-body margin-bottom.
19096 <listitem><para>The sum of the page-master margin-left and the
19097 region-body margin-left. In DocBook, the region-body margin-left is
19098 zero by default, so this is simply the page-master margin-left.
19100 <listitem><para>The sum of the page-master margin-right and the
19101 region-body margin-right. In DocBook, the region-body margin-right is
19102 zero by default, so this is simply the page-master margin-right.
19109 <refentry version="5.0" id="page.height">
19111 <refentrytitle>page.height</refentrytitle>
19112 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
19115 <refname>page.height</refname>
19116 <refpurpose>The height of the physical page</refpurpose>
19120 <programlisting id="page.height.frag"><xsl:param name="page.height">
19122 <xsl:when test="$page.orientation = 'portrait'">
19123 <xsl:value-of select="$page.height.portrait"></xsl:value-of>
19125 <xsl:otherwise>
19126 <xsl:value-of select="$page.width.portrait"></xsl:value-of>
19127 </xsl:otherwise>
19128 </xsl:choose>
19129 </xsl:param></programlisting>
19132 <refsection><info><title>Description</title></info>
19134 <para>The page height is generally calculated from the
19135 <parameter>paper.type</parameter> and
19136 <parameter>page.orientation</parameter> parameters.
19142 <refentry version="5.0" id="page.height.portrait">
19144 <refentrytitle>page.height.portrait</refentrytitle>
19145 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
19148 <refname>page.height.portrait</refname>
19149 <refpurpose>Specify the physical size of the long edge of the page</refpurpose>
19153 <programlisting id="page.height.portrait.frag"><xsl:param name="page.height.portrait">
19155 <xsl:when test="$paper.type = 'A4landscape'">210mm</xsl:when>
19156 <xsl:when test="$paper.type = 'USletter'">11in</xsl:when>
19157 <xsl:when test="$paper.type = 'USlandscape'">8.5in</xsl:when>
19158 <xsl:when test="$paper.type = 'USlegal'">14in</xsl:when>
19159 <xsl:when test="$paper.type = 'USlegallandscape'">8.5in</xsl:when>
19160 <xsl:when test="$paper.type = '4A0'">2378mm</xsl:when>
19161 <xsl:when test="$paper.type = '2A0'">1682mm</xsl:when>
19162 <xsl:when test="$paper.type = 'A0'">1189mm</xsl:when>
19163 <xsl:when test="$paper.type = 'A1'">841mm</xsl:when>
19164 <xsl:when test="$paper.type = 'A2'">594mm</xsl:when>
19165 <xsl:when test="$paper.type = 'A3'">420mm</xsl:when>
19166 <xsl:when test="$paper.type = 'A4'">297mm</xsl:when>
19167 <xsl:when test="$paper.type = 'A5'">210mm</xsl:when>
19168 <xsl:when test="$paper.type = 'A6'">148mm</xsl:when>
19169 <xsl:when test="$paper.type = 'A7'">105mm</xsl:when>
19170 <xsl:when test="$paper.type = 'A8'">74mm</xsl:when>
19171 <xsl:when test="$paper.type = 'A9'">52mm</xsl:when>
19172 <xsl:when test="$paper.type = 'A10'">37mm</xsl:when>
19173 <xsl:when test="$paper.type = 'B0'">1414mm</xsl:when>
19174 <xsl:when test="$paper.type = 'B1'">1000mm</xsl:when>
19175 <xsl:when test="$paper.type = 'B2'">707mm</xsl:when>
19176 <xsl:when test="$paper.type = 'B3'">500mm</xsl:when>
19177 <xsl:when test="$paper.type = 'B4'">353mm</xsl:when>
19178 <xsl:when test="$paper.type = 'B5'">250mm</xsl:when>
19179 <xsl:when test="$paper.type = 'B6'">176mm</xsl:when>
19180 <xsl:when test="$paper.type = 'B7'">125mm</xsl:when>
19181 <xsl:when test="$paper.type = 'B8'">88mm</xsl:when>
19182 <xsl:when test="$paper.type = 'B9'">62mm</xsl:when>
19183 <xsl:when test="$paper.type = 'B10'">44mm</xsl:when>
19184 <xsl:when test="$paper.type = 'C0'">1297mm</xsl:when>
19185 <xsl:when test="$paper.type = 'C1'">917mm</xsl:when>
19186 <xsl:when test="$paper.type = 'C2'">648mm</xsl:when>
19187 <xsl:when test="$paper.type = 'C3'">458mm</xsl:when>
19188 <xsl:when test="$paper.type = 'C4'">324mm</xsl:when>
19189 <xsl:when test="$paper.type = 'C5'">229mm</xsl:when>
19190 <xsl:when test="$paper.type = 'C6'">162mm</xsl:when>
19191 <xsl:when test="$paper.type = 'C7'">114mm</xsl:when>
19192 <xsl:when test="$paper.type = 'C8'">81mm</xsl:when>
19193 <xsl:when test="$paper.type = 'C9'">57mm</xsl:when>
19194 <xsl:when test="$paper.type = 'C10'">40mm</xsl:when>
19195 <xsl:otherwise>11in</xsl:otherwise>
19196 </xsl:choose>
19197 </xsl:param></programlisting>
19200 <refsection><info><title>Description</title></info>
19202 <para>The portrait page height is the length of the long
19203 edge of the physical page.
19209 <refentry version="5.0" id="page.margin.bottom">
19211 <refentrytitle>page.margin.bottom</refentrytitle>
19212 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
19215 <refname>page.margin.bottom</refname>
19216 <refpurpose>The bottom margin of the page</refpurpose>
19220 <programlisting id="page.margin.bottom.frag">
19221 <xsl:param name="page.margin.bottom">0.5in</xsl:param>
19225 <refsection><info><title>Description</title></info>
19227 <para>The bottom page margin is the distance from the bottom of the region-after
19228 to the physical bottom of the page.
19234 <refentry version="5.0" id="page.margin.inner">
19236 <refentrytitle>page.margin.inner</refentrytitle>
19237 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
19240 <refname>page.margin.inner</refname>
19241 <refpurpose>The inner page margin</refpurpose>
19245 <programlisting id="page.margin.inner.frag"><xsl:param name="page.margin.inner">
19247 <xsl:when test="$double.sided != 0">1.25in</xsl:when>
19248 <xsl:otherwise>1in</xsl:otherwise>
19249 </xsl:choose>
19250 </xsl:param></programlisting>
19253 <refsection><info><title>Description</title></info>
19255 <para>The inner page margin is the distance from bound edge of the
19256 page to the first column of text. </para>
19258 <para>The inner page margin is the distance from bound edge of the
19259 page to the outer edge of the first column of text.</para>
19261 <para>In left-to-right text direction,
19262 this is the left margin of recto (front side) pages.
19263 For single-sided output, it is the left margin
19264 of all pages.</para>
19266 <para>In right-to-left text direction,
19267 this is the right margin of recto pages.
19268 For single-sided output, this is the
19269 right margin of all pages.</para>
19272 <para>Current versions (at least as of version 4.13)
19273 of the XEP XSL-FO processor do not
19274 correctly handle these margin settings for documents
19275 with right-to-left text direction.
19276 The workaround in that situation is to reverse
19277 the values for <parameter>page.margin.inner</parameter>
19278 and <parameter>page.margin.outer</parameter>, until
19279 this bug is fixed by RenderX. It does not affect documents
19280 with left-to-right text direction.</para>
19283 <para>See also <parameter>writing.mode</parameter>.</para>
19288 <refentry version="5.0" id="page.margin.outer">
19290 <refentrytitle>page.margin.outer</refentrytitle>
19291 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
19294 <refname>page.margin.outer</refname>
19295 <refpurpose>The outer page margin</refpurpose>
19299 <programlisting id="page.margin.outer.frag"><xsl:param name="page.margin.outer">
19301 <xsl:when test="$double.sided != 0">0.75in</xsl:when>
19302 <xsl:otherwise>1in</xsl:otherwise>
19303 </xsl:choose>
19304 </xsl:param></programlisting>
19307 <refsection><info><title>Description</title></info>
19309 <para>The outer page margin is the distance from non-bound edge of the
19310 page to the outer edge of the last column of text.</para>
19312 <para>In left-to-right text direction,
19313 this is the right margin of recto (front side) pages.
19314 For single-sided output, it is the right margin
19315 of all pages.</para>
19317 <para>In right-to-left text direction,
19318 this is the left margin of recto pages.
19319 For single-sided output, this is the
19320 left margin of all pages.</para>
19323 <para>Current versions (at least as of version 4.13)
19324 of the XEP XSL-FO processor do not
19325 correctly handle these margin settings for documents
19326 with right-to-left text direction.
19327 The workaround in that situation is to reverse
19328 the values for <parameter>page.margin.inner</parameter>
19329 and <parameter>page.margin.outer</parameter>, until
19330 this bug is fixed by RenderX. It does not affect documents
19331 with left-to-right text direction.</para>
19334 <para>See also <parameter>writing.mode</parameter>.</para>
19339 <refentry version="5.0" id="page.margin.top">
19341 <refentrytitle>page.margin.top</refentrytitle>
19342 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
19345 <refname>page.margin.top</refname>
19346 <refpurpose>The top margin of the page</refpurpose>
19350 <programlisting id="page.margin.top.frag">
19351 <xsl:param name="page.margin.top">0.5in</xsl:param>
19355 <refsection><info><title>Description</title></info>
19357 <para>The top page margin is the distance from the physical top of the
19358 page to the top of the region-before.</para>
19363 <refentry version="5.0" id="page.orientation">
19365 <refentrytitle>page.orientation</refentrytitle>
19366 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
19367 <refmiscinfo class="other" otherclass="value">portrait</refmiscinfo>
19368 <refmiscinfo class="other" otherclass="value">landscape</refmiscinfo>
19371 <refname>page.orientation</refname>
19372 <refpurpose>Select the page orientation</refpurpose>
19376 <programlisting id="page.orientation.frag">
19377 <xsl:param name="page.orientation">portrait</xsl:param>
19381 <refsection><info><title>Description</title></info>
19383 <para> Select one from portrait or landscape.
19384 In portrait orientation, the short edge is horizontal; in
19385 landscape orientation, it is vertical.
19391 <refentry version="5.0" id="page.width">
19393 <refentrytitle>page.width</refentrytitle>
19394 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
19397 <refname>page.width</refname>
19398 <refpurpose>The width of the physical page</refpurpose>
19402 <programlisting id="page.width.frag"><xsl:param name="page.width">
19404 <xsl:when test="$page.orientation = 'portrait'">
19405 <xsl:value-of select="$page.width.portrait"></xsl:value-of>
19407 <xsl:otherwise>
19408 <xsl:value-of select="$page.height.portrait"></xsl:value-of>
19409 </xsl:otherwise>
19410 </xsl:choose>
19411 </xsl:param></programlisting>
19414 <refsection><info><title>Description</title></info>
19416 <para>The page width is generally calculated from the
19417 <parameter>paper.type</parameter> and
19418 <parameter>page.orientation</parameter> parameters.</para>
19423 <refentry version="5.0" id="page.width.portrait">
19425 <refentrytitle>page.width.portrait</refentrytitle>
19426 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
19429 <refname>page.width.portrait</refname>
19430 <refpurpose>Specify the physical size of the short edge of the page</refpurpose>
19434 <programlisting id="page.width.portrait.frag"><xsl:param name="page.width.portrait">
19436 <xsl:when test="$paper.type = 'USletter'">8.5in</xsl:when>
19437 <xsl:when test="$paper.type = 'USlandscape'">11in</xsl:when>
19438 <xsl:when test="$paper.type = 'USlegal'">8.5in</xsl:when>
19439 <xsl:when test="$paper.type = 'USlegallandscape'">14in</xsl:when>
19440 <xsl:when test="$paper.type = '4A0'">1682mm</xsl:when>
19441 <xsl:when test="$paper.type = '2A0'">1189mm</xsl:when>
19442 <xsl:when test="$paper.type = 'A0'">841mm</xsl:when>
19443 <xsl:when test="$paper.type = 'A1'">594mm</xsl:when>
19444 <xsl:when test="$paper.type = 'A2'">420mm</xsl:when>
19445 <xsl:when test="$paper.type = 'A3'">297mm</xsl:when>
19446 <xsl:when test="$paper.type = 'A4'">210mm</xsl:when>
19447 <xsl:when test="$paper.type = 'A5'">148mm</xsl:when>
19448 <xsl:when test="$paper.type = 'A6'">105mm</xsl:when>
19449 <xsl:when test="$paper.type = 'A7'">74mm</xsl:when>
19450 <xsl:when test="$paper.type = 'A8'">52mm</xsl:when>
19451 <xsl:when test="$paper.type = 'A9'">37mm</xsl:when>
19452 <xsl:when test="$paper.type = 'A10'">26mm</xsl:when>
19453 <xsl:when test="$paper.type = 'B0'">1000mm</xsl:when>
19454 <xsl:when test="$paper.type = 'B1'">707mm</xsl:when>
19455 <xsl:when test="$paper.type = 'B2'">500mm</xsl:when>
19456 <xsl:when test="$paper.type = 'B3'">353mm</xsl:when>
19457 <xsl:when test="$paper.type = 'B4'">250mm</xsl:when>
19458 <xsl:when test="$paper.type = 'B5'">176mm</xsl:when>
19459 <xsl:when test="$paper.type = 'B6'">125mm</xsl:when>
19460 <xsl:when test="$paper.type = 'B7'">88mm</xsl:when>
19461 <xsl:when test="$paper.type = 'B8'">62mm</xsl:when>
19462 <xsl:when test="$paper.type = 'B9'">44mm</xsl:when>
19463 <xsl:when test="$paper.type = 'B10'">31mm</xsl:when>
19464 <xsl:when test="$paper.type = 'C0'">917mm</xsl:when>
19465 <xsl:when test="$paper.type = 'C1'">648mm</xsl:when>
19466 <xsl:when test="$paper.type = 'C2'">458mm</xsl:when>
19467 <xsl:when test="$paper.type = 'C3'">324mm</xsl:when>
19468 <xsl:when test="$paper.type = 'C4'">229mm</xsl:when>
19469 <xsl:when test="$paper.type = 'C5'">162mm</xsl:when>
19470 <xsl:when test="$paper.type = 'C6'">114mm</xsl:when>
19471 <xsl:when test="$paper.type = 'C7'">81mm</xsl:when>
19472 <xsl:when test="$paper.type = 'C8'">57mm</xsl:when>
19473 <xsl:when test="$paper.type = 'C9'">40mm</xsl:when>
19474 <xsl:when test="$paper.type = 'C10'">28mm</xsl:when>
19475 <xsl:otherwise>8.5in</xsl:otherwise>
19476 </xsl:choose>
19477 </xsl:param></programlisting>
19480 <refsection><info><title>Description</title></info>
19482 <para>The portrait page width is the length of the short
19483 edge of the physical page.
19489 <refentry version="5.0" id="paper.type">
19491 <refentrytitle>paper.type</refentrytitle>
19492 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
19493 <refmiscinfo class="other" otherclass="list-type">open</refmiscinfo>
19494 <refmiscinfo class="other" otherclass="list-type">open</refmiscinfo>
19495 <refmiscinfo class="other" otherclass="value">USletter<alt>8.5x11in</alt></refmiscinfo>
19496 <refmiscinfo class="other" otherclass="value">USlandscape<alt>11x8.5in</alt></refmiscinfo>
19497 <refmiscinfo class="other" otherclass="value">USlegal<alt>8.5inx14in</alt></refmiscinfo>
19498 <refmiscinfo class="other" otherclass="value">USlegallandscape<alt>14inx8.5in</alt></refmiscinfo>
19499 <refmiscinfo class="other" otherclass="value">4A0<alt>2378x1682mm</alt></refmiscinfo>
19500 <refmiscinfo class="other" otherclass="value">2A0<alt>1682x1189mm</alt></refmiscinfo>
19501 <refmiscinfo class="other" otherclass="value">A0<alt>1189x841mm</alt></refmiscinfo>
19502 <refmiscinfo class="other" otherclass="value">A1<alt>841x594mm</alt></refmiscinfo>
19503 <refmiscinfo class="other" otherclass="value">A2<alt>594x420mm</alt></refmiscinfo>
19504 <refmiscinfo class="other" otherclass="value">A3<alt>420x297mm</alt></refmiscinfo>
19505 <refmiscinfo class="other" otherclass="value">A4<alt>297x210mm</alt></refmiscinfo>
19506 <refmiscinfo class="other" otherclass="value">A5<alt>210x148mm</alt></refmiscinfo>
19507 <refmiscinfo class="other" otherclass="value">A6<alt>148x105mm</alt></refmiscinfo>
19508 <refmiscinfo class="other" otherclass="value">A7<alt>105x74mm</alt></refmiscinfo>
19509 <refmiscinfo class="other" otherclass="value">A8<alt>74x52mm</alt></refmiscinfo>
19510 <refmiscinfo class="other" otherclass="value">A9<alt>52x37mm</alt></refmiscinfo>
19511 <refmiscinfo class="other" otherclass="value">A10<alt>37x26mm</alt></refmiscinfo>
19512 <refmiscinfo class="other" otherclass="value">B0<alt>1414x1000mm</alt></refmiscinfo>
19513 <refmiscinfo class="other" otherclass="value">B1<alt>1000x707mm</alt></refmiscinfo>
19514 <refmiscinfo class="other" otherclass="value">B2<alt>707x500mm</alt></refmiscinfo>
19515 <refmiscinfo class="other" otherclass="value">B3<alt>500x353mm</alt></refmiscinfo>
19516 <refmiscinfo class="other" otherclass="value">B4<alt>353x250mm</alt></refmiscinfo>
19517 <refmiscinfo class="other" otherclass="value">B5<alt>250x176mm</alt></refmiscinfo>
19518 <refmiscinfo class="other" otherclass="value">B6<alt>176x125mm</alt></refmiscinfo>
19519 <refmiscinfo class="other" otherclass="value">B7<alt>125x88mm</alt></refmiscinfo>
19520 <refmiscinfo class="other" otherclass="value">B8<alt>88x62mm</alt></refmiscinfo>
19521 <refmiscinfo class="other" otherclass="value">B9<alt>62x44mm</alt></refmiscinfo>
19522 <refmiscinfo class="other" otherclass="value">B10<alt>44x31mm</alt></refmiscinfo>
19523 <refmiscinfo class="other" otherclass="value">C0<alt>1297x917mm</alt></refmiscinfo>
19524 <refmiscinfo class="other" otherclass="value">C1<alt>917x648mm</alt></refmiscinfo>
19525 <refmiscinfo class="other" otherclass="value">C2<alt>648x458mm</alt></refmiscinfo>
19526 <refmiscinfo class="other" otherclass="value">C3<alt>458x324mm</alt></refmiscinfo>
19527 <refmiscinfo class="other" otherclass="value">C4<alt>324x229mm</alt></refmiscinfo>
19528 <refmiscinfo class="other" otherclass="value">C5<alt>229x162mm</alt></refmiscinfo>
19529 <refmiscinfo class="other" otherclass="value">C6<alt>162x114mm</alt></refmiscinfo>
19530 <refmiscinfo class="other" otherclass="value">C7<alt>114x81mm</alt></refmiscinfo>
19531 <refmiscinfo class="other" otherclass="value">C8<alt>81x57mm</alt></refmiscinfo>
19532 <refmiscinfo class="other" otherclass="value">C9<alt>57x40mm</alt></refmiscinfo>
19533 <refmiscinfo class="other" otherclass="value">C10<alt>40x28mm</alt></refmiscinfo>
19536 <refname>paper.type</refname>
19537 <refpurpose>Select the paper type</refpurpose>
19541 <programlisting id="paper.type.frag">
19542 <xsl:param name="paper.type">USletter</xsl:param>
19546 <refsection><info><title>Description</title></info>
19548 <para>The paper type is a convenient way to specify the paper size.
19549 The list of known paper sizes includes USletter and most of the A,
19550 B, and C sizes. See <parameter>page.width.portrait</parameter>, for example.
19558 <refentry version="5.0" id="double.sided">
19560 <refentrytitle>double.sided</refentrytitle>
19561 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
19564 <refname>double.sided</refname>
19565 <refpurpose>Is the document to be printed double sided?</refpurpose>
19569 <programlisting id="double.sided.frag">
19570 <xsl:param name="double.sided" select="0"></xsl:param>
19574 <refsection><info><title>Description</title></info>
19576 <para>This parameter is useful when printing a document
19577 on both sides of the paper.</para>
19579 <para>if set to non-zero, documents are formatted using different page-masters
19580 for odd and even pages. These can differ by using a slightly wider margin
19581 on the binding edge of the page, and alternating left-right
19582 positions of header or footer elements.
19585 <para>If set to zero (the default), then only the 'odd' page masters
19586 are used for both even and odd numbered pages.</para>
19588 <para>See also <parameter>force.blank.pages</parameter>,
19589 <parameter>page.margin.inner</parameter> and
19590 <parameter>page.margin.outer</parameter>.</para>
19595 <refentry version="5.0" id="force.blank.pages">
19597 <refentrytitle>force.blank.pages</refentrytitle>
19598 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
19601 <refname>force.blank.pages</refname>
19602 <refpurpose>Generate blank page to end on even page number</refpurpose>
19606 <programlisting id="force.blank.pages.frag">
19607 <xsl:param name="force.blank.pages" select="1"></xsl:param>
19611 <refsection><info><title>Description</title></info>
19613 <para>If non-zero (the default), then each page sequence will be forced to
19614 end on an even-numbered page, by inserting a blank page
19615 if necessary. This will force the next page sequence to start
19616 on an odd-numbered page, which is a standard convention
19617 for printed and bound books.</para>
19619 <para>If zero, then such blank pages will not be inserted.
19620 Chapters will start on the next available page,
19621 regardless of whether it is an even or odd number.
19622 This is useful when publishing online where blank
19623 pages are not needed.
19626 <para>This param is independent of the
19627 <parameter>double.sided</parameter> parameter, which
19628 just triggers the use of even and odd page sequence
19629 masters that differ in their header and footer placement.
19630 So you can combine the two params for alternating
19631 headers/footers and no blank pages.
19637 <refentry version="5.0" id="body.margin.bottom">
19639 <refentrytitle>body.margin.bottom</refentrytitle>
19640 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
19643 <refname>body.margin.bottom</refname>
19644 <refpurpose>The bottom margin of the body text</refpurpose>
19648 <programlisting id="body.margin.bottom.frag">
19649 <xsl:param name="body.margin.bottom">0.5in</xsl:param>
19653 <refsection><info><title>Description</title></info>
19655 <para>The body bottom margin is the distance from the last line of text
19656 in the page body to the bottom of the region-after.
19662 <refentry version="5.0" id="body.margin.top">
19664 <refentrytitle>body.margin.top</refentrytitle>
19665 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
19668 <refname>body.margin.top</refname>
19669 <refpurpose>To specify the size of the top margin of a page</refpurpose>
19673 <programlisting id="body.margin.top.frag">
19674 <xsl:param name="body.margin.top">0.5in</xsl:param>
19678 <refsection><info><title>Description</title></info>
19680 <para>The body top margin is the distance from the top of the
19681 region-before to the first line of text in the page body.</para>
19686 <refentry version="5.0" id="body.margin.inner">
19688 <refentrytitle>body.margin.inner</refentrytitle>
19689 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
19692 <refname>body.margin.inner</refname>
19693 <refpurpose>Specify the size of the inner margin of the body region</refpurpose>
19697 <programlisting id="body.margin.inner.frag">
19698 <xsl:param name="body.margin.inner">0in</xsl:param>
19702 <refsection><info><title>Description</title></info>
19704 <para>The inner body margin is the extra inner side
19705 (binding side) margin taken from the body
19706 region in addition to the inner page margin.
19707 It makes room for a side region for text content whose width is
19708 specified by the <parameter>region.inner.extent</parameter>
19711 <para>For double-sided output,
19713 is <literal>fo:region-start</literal> on a odd-numbered page,
19714 and <literal>fo:region-end</literal> on an even-numbered page.</para>
19716 <para>For single-sided output,
19718 is <literal>fo:region-start</literal> for all pages.</para>
19720 <para>This correspondence applies to all languages,
19721 both left-to-right and right-to-left writing modes.</para>
19723 <para>The default value is zero.</para>
19726 <parameter>region.inner.extent</parameter>,
19727 <parameter>region.outer.extent</parameter>,
19728 <parameter>body.margin.outer</parameter>,
19729 <parameter>side.region.precedence</parameter>.
19734 <refentry version="5.0" id="body.margin.outer">
19736 <refentrytitle>body.margin.outer</refentrytitle>
19737 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
19740 <refname>body.margin.outer</refname>
19741 <refpurpose>Specify the size of the outer margin of the body region</refpurpose>
19745 <programlisting id="body.margin.outer.frag">
19746 <xsl:param name="body.margin.outer">0in</xsl:param>
19750 <refsection><info><title>Description</title></info>
19752 <para>The outer body margin is the extra outer side
19753 (opposite the binding side) margin taken
19755 region in addition to the outer page margin.
19756 It makes room for a side region for text content whose width is
19757 specified by the <parameter>region.outer.extent</parameter>
19760 <para>For double-sided output,
19762 is <literal>fo:region-end</literal> on a odd-numbered page,
19763 and <literal>fo:region-start</literal> on an even-numbered page.</para>
19765 <para>For single-sided output,
19767 is <literal>fo:region-end</literal> for all pages.</para>
19769 <para>This correspondence applies to all languages,
19770 both left-to-right and right-to-left writing modes.</para>
19772 <para>The default value is zero.</para>
19775 <parameter>region.inner.extent</parameter>,
19776 <parameter>region.outer.extent</parameter>,
19777 <parameter>body.margin.inner</parameter>,
19778 <parameter>side.region.precedence</parameter>.
19783 <refentry version="5.0" id="body.start.indent">
19785 <refentrytitle>body.start.indent</refentrytitle>
19786 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
19789 <refname>body.start.indent</refname>
19790 <refpurpose>The start-indent for the body text</refpurpose>
19794 <programlisting id="body.start.indent.frag">
19795 <xsl:param name="body.start.indent">
19797 <xsl:when test="$fop.extensions != 0">0pt</xsl:when>
19798 <xsl:when test="$passivetex.extensions != 0">0pt</xsl:when>
19799 <xsl:otherwise>4pc</xsl:otherwise>
19800 </xsl:choose>
19805 <refsection><info><title>Description</title></info>
19807 <para>This parameter provides
19808 the means of indenting the body text relative to
19810 For left-to-right text direction, it indents the left side.
19811 For right-to-left text direction, it indents the right side.
19812 It is used in place of the
19813 <parameter>title.margin.left</parameter> for
19814 all XSL-FO processors except FOP 0.25.
19815 It enables support for side floats to appear
19816 in the indented margin area.
19818 <para>This start-indent property is added to the fo:flow
19819 for certain page sequences. Which page-sequences it is
19820 applied to is determined by the template named
19821 <literal>set.flow.properties</literal>.
19822 By default, that template adds it to the flow
19823 for page-sequences using the <quote>body</quote>
19824 master-reference, as well as appendixes and prefaces.
19826 <para>If this parameter is used, section titles should have
19827 a start-indent value of 0pt if they are to be
19828 outdented relative to the body text.
19831 <para>If you are using FOP, then set this parameter to a zero
19832 width value and set the <parameter>title.margin.left</parameter>
19833 parameter to the negative value of the desired indent.
19836 <para>See also <parameter>body.end.indent</parameter> and
19837 <parameter>title.margin.left</parameter>.
19843 <refentry version="5.0" id="body.end.indent">
19845 <refentrytitle>body.end.indent</refentrytitle>
19846 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
19849 <refname>body.end.indent</refname>
19850 <refpurpose>The end-indent for the body text</refpurpose>
19854 <programlisting id="body.end.indent.frag">
19855 <xsl:param name="body.end.indent">0pt</xsl:param>
19859 <refsection><info><title>Description</title></info>
19861 <para>This end-indent property is added to the fo:flow
19862 for certain page sequences. Which page-sequences it is
19863 applied to is determined by the template named
19864 <literal>set.flow.properties</literal>.
19865 By default, that template adds it to the flow
19866 for page-sequences using the <quote>body</quote>
19867 master-reference, as well as appendixes and prefaces.
19870 <para>See also <parameter>body.start.indent</parameter>.
19876 <refentry version="5.0" id="alignment">
19878 <refentrytitle>alignment</refentrytitle>
19879 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
19880 <refmiscinfo class="other" otherclass="list-type">open</refmiscinfo>
19881 <refmiscinfo class="other" otherclass="value">left</refmiscinfo>
19882 <refmiscinfo class="other" otherclass="value">start</refmiscinfo>
19883 <refmiscinfo class="other" otherclass="value">right</refmiscinfo>
19884 <refmiscinfo class="other" otherclass="value">end</refmiscinfo>
19885 <refmiscinfo class="other" otherclass="value">center</refmiscinfo>
19886 <refmiscinfo class="other" otherclass="value">justify</refmiscinfo>
19889 <refname>alignment</refname>
19890 <refpurpose>Specify the default text alignment</refpurpose>
19894 <programlisting id="alignment.frag"><xsl:param name="alignment">justify</xsl:param></programlisting>
19897 <refsection><info><title>Description</title></info>
19899 <para>The default text alignment is used for most body text.
19901 <literal>left</literal>,
19902 <literal>right</literal>,
19903 <literal>start</literal>,
19904 <literal>end</literal>,
19905 <literal>center</literal>,
19906 <literal>justify</literal>.
19907 The default value is <literal>justify</literal>.
19913 <refentry version="5.0" id="hyphenate">
19915 <refentrytitle>hyphenate</refentrytitle>
19916 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
19917 <refmiscinfo class="other" otherclass="list-type">closed</refmiscinfo>
19918 <refmiscinfo class="other" otherclass="value">true</refmiscinfo>
19919 <refmiscinfo class="other" otherclass="value">false</refmiscinfo>
19922 <refname>hyphenate</refname>
19923 <refpurpose>Specify hyphenation behavior</refpurpose>
19927 <programlisting id="hyphenate.frag"><xsl:param name="hyphenate">true</xsl:param></programlisting>
19930 <refsection><info><title>Description</title></info>
19932 <para>If true, words may be hyphenated. Otherwise, they may not.</para>
19933 <para>See also <parameter>ulink.hyphenate.chars</parameter> </para>
19938 <refentry version="5.0" id="line-height">
19940 <refentrytitle>line-height</refentrytitle>
19941 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
19944 <refname>line-height</refname>
19945 <refpurpose>Specify the line-height property</refpurpose>
19949 <programlisting id="line-height.frag">
19950 <xsl:param name="line-height">normal</xsl:param>
19954 <refsection><info><title>Description</title></info>
19956 <para>Sets the line-height property.</para>
19961 <refentry version="5.0" id="column.count.back">
19963 <refentrytitle>column.count.back</refentrytitle>
19964 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
19967 <refname>column.count.back</refname>
19968 <refpurpose>Number of columns on back matter pages</refpurpose>
19972 <programlisting id="column.count.back.frag">
19973 <xsl:param name="column.count.back" select="1"></xsl:param>
19977 <refsection><info><title>Description</title></info>
19979 <para>Number of columns on back matter (appendix, glossary, etc.) pages.</para>
19984 <refentry version="5.0" id="column.count.body">
19986 <refentrytitle>column.count.body</refentrytitle>
19987 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
19990 <refname>column.count.body</refname>
19991 <refpurpose>Number of columns on body pages</refpurpose>
19995 <programlisting id="column.count.body.frag">
19996 <xsl:param name="column.count.body" select="1"></xsl:param>
20000 <refsection><info><title>Description</title></info>
20002 <para>Number of columns on body pages.</para>
20007 <refentry version="5.0" id="column.count.front">
20009 <refentrytitle>column.count.front</refentrytitle>
20010 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
20013 <refname>column.count.front</refname>
20014 <refpurpose>Number of columns on front matter pages</refpurpose>
20018 <programlisting id="column.count.front.frag">
20019 <xsl:param name="column.count.front" select="1"></xsl:param>
20023 <refsection><info><title>Description</title></info>
20025 <para>Number of columns on front matter (dedication, preface, etc.) pages.</para>
20030 <refentry version="5.0" id="column.count.index">
20032 <refentrytitle>column.count.index</refentrytitle>
20033 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
20036 <refname>column.count.index</refname>
20037 <refpurpose>Number of columns on index pages</refpurpose>
20041 <programlisting id="column.count.index.frag">
20042 <xsl:param name="column.count.index">2</xsl:param>
20046 <refsection><info><title>Description</title></info>
20048 <para>Number of columns on index pages.</para>
20053 <refentry version="5.0" id="column.count.lot">
20055 <refentrytitle>column.count.lot</refentrytitle>
20056 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
20059 <refname>column.count.lot</refname>
20060 <refpurpose>Number of columns on a 'List-of-Titles' page</refpurpose>
20064 <programlisting id="column.count.lot.frag">
20065 <xsl:param name="column.count.lot" select="1"></xsl:param>
20069 <refsection><info><title>Description</title></info>
20071 <para>Number of columns on a page sequence containing the Table of Contents,
20072 List of Figures, etc.</para>
20077 <refentry version="5.0" id="column.count.titlepage">
20079 <refentrytitle>column.count.titlepage</refentrytitle>
20080 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
20083 <refname>column.count.titlepage</refname>
20084 <refpurpose>Number of columns on a title page</refpurpose>
20088 <programlisting id="column.count.titlepage.frag">
20089 <xsl:param name="column.count.titlepage" select="1"></xsl:param>
20093 <refsection><info><title>Description</title></info>
20095 <para>Number of columns on a title page</para>
20100 <refentry version="5.0" id="column.gap.back">
20102 <refentrytitle>column.gap.back</refentrytitle>
20103 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
20106 <refname>column.gap.back</refname>
20107 <refpurpose>Gap between columns in back matter</refpurpose>
20111 <programlisting id="column.gap.back.frag">
20112 <xsl:param name="column.gap.back">12pt</xsl:param>
20116 <refsection><info><title>Description</title></info>
20118 <para>Specifies the gap between columns in back matter (if
20119 <parameter>column.count.back</parameter> is greater than one).</para>
20124 <refentry version="5.0" id="column.gap.body">
20126 <refentrytitle>column.gap.body</refentrytitle>
20127 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
20130 <refname>column.gap.body</refname>
20131 <refpurpose>Gap between columns in the body</refpurpose>
20135 <programlisting id="column.gap.body.frag">
20136 <xsl:param name="column.gap.body">12pt</xsl:param>
20140 <refsection><info><title>Description</title></info>
20142 <para>Specifies the gap between columns in body matter (if
20143 <parameter>column.count.body</parameter> is greater than one).</para>
20148 <refentry version="5.0" id="column.gap.front">
20150 <refentrytitle>column.gap.front</refentrytitle>
20151 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
20154 <refname>column.gap.front</refname>
20155 <refpurpose>Gap between columns in the front matter</refpurpose>
20159 <programlisting id="column.gap.front.frag">
20160 <xsl:param name="column.gap.front">12pt</xsl:param>
20164 <refsection><info><title>Description</title></info>
20166 <para>Specifies the gap between columns in front matter (if
20167 <parameter>column.count.front</parameter> is greater than one).</para>
20172 <refentry version="5.0" id="column.gap.index">
20174 <refentrytitle>column.gap.index</refentrytitle>
20175 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
20178 <refname>column.gap.index</refname>
20179 <refpurpose>Gap between columns in the index</refpurpose>
20183 <programlisting id="column.gap.index.frag">
20184 <xsl:param name="column.gap.index">12pt</xsl:param>
20188 <refsection><info><title>Description</title></info>
20190 <para>Specifies the gap between columns in indexes (if
20191 <parameter>column.count.index</parameter> is greater than one).</para>
20196 <refentry version="5.0" id="column.gap.lot">
20198 <refentrytitle>column.gap.lot</refentrytitle>
20199 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
20202 <refname>column.gap.lot</refname>
20203 <refpurpose>Gap between columns on a 'List-of-Titles' page</refpurpose>
20207 <programlisting id="column.gap.lot.frag">
20208 <xsl:param name="column.gap.lot">12pt</xsl:param>
20212 <refsection><info><title>Description</title></info>
20214 <para>Specifies the gap between columns on 'List-of-Titles' pages (if
20215 <parameter>column.count.lot</parameter> is greater than one).</para>
20220 <refentry version="5.0" id="column.gap.titlepage">
20222 <refentrytitle>column.gap.titlepage</refentrytitle>
20223 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
20226 <refname>column.gap.titlepage</refname>
20227 <refpurpose>Gap between columns on title pages</refpurpose>
20231 <programlisting id="column.gap.titlepage.frag">
20232 <xsl:param name="column.gap.titlepage">12pt</xsl:param>
20236 <refsection><info><title>Description</title></info>
20238 <para>Specifies the gap between columns on title pages (if
20239 <parameter>column.count.titlepage</parameter> is greater than one).</para>
20245 <refentry version="5.0" id="region.after.extent">
20247 <refentrytitle>region.after.extent</refentrytitle>
20248 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
20251 <refname>region.after.extent</refname>
20252 <refpurpose>Specifies the height of the footer.</refpurpose>
20256 <programlisting id="region.after.extent.frag">
20257 <xsl:param name="region.after.extent">0.4in</xsl:param>
20261 <refsection><info><title>Description</title></info>
20263 <para>The region after extent is the height of the area where footers
20270 <refentry version="5.0" id="region.before.extent">
20272 <refentrytitle>region.before.extent</refentrytitle>
20273 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
20276 <refname>region.before.extent</refname>
20277 <refpurpose>Specifies the height of the header</refpurpose>
20281 <programlisting id="region.before.extent.frag">
20282 <xsl:param name="region.before.extent">0.4in</xsl:param>
20286 <refsection><info><title>Description</title></info>
20288 <para>The region before extent is the height of the area where headers
20295 <refentry version="5.0" id="region.inner.extent">
20297 <refentrytitle>region.inner.extent</refentrytitle>
20298 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
20301 <refname>region.inner.extent</refname>
20302 <refpurpose>Specifies the width of the inner side region</refpurpose>
20306 <programlisting id="region.inner.extent.frag">
20307 <xsl:param name="region.inner.extent">0in</xsl:param>
20311 <refsection><info><title>Description</title></info>
20313 <para>The region inner extent is the width of the optional
20314 text area next to the inner side (binding side) of the
20315 body region. </para>
20317 <para>For double-sided output, this side region
20318 is <literal>fo:region-start</literal> on a odd-numbered page,
20319 and <literal>fo:region-end</literal> on an even-numbered page.</para>
20321 <para>For single-sided output, this side region
20322 is <literal>fo:region-start</literal> for all pages.</para>
20324 <para>This correspondence applies to all languages,
20325 both left-to-right and right-to-left writing modes.</para>
20327 <para>The default value of this parameter is zero. If you enlarge this extent,
20328 be sure to also enlarge the <parameter>body.margin.inner</parameter>
20329 parameter to make room for its content, otherwise any text in
20330 the side region may overlap with the body text.</para>
20333 <parameter>region.outer.extent</parameter>,
20334 <parameter>body.margin.inner</parameter>,
20335 <parameter>body.margin.outer</parameter>,
20336 <parameter>side.region.precedence</parameter>.
20342 <refentry version="5.0" id="region.outer.extent">
20344 <refentrytitle>region.outer.extent</refentrytitle>
20345 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
20348 <refname>region.outer.extent</refname>
20349 <refpurpose>Specifies the width of the outer side region</refpurpose>
20353 <programlisting id="region.outer.extent.frag">
20354 <xsl:param name="region.outer.extent">0in</xsl:param>
20358 <refsection><info><title>Description</title></info>
20360 <para>The region outer extent is the width of the optional
20361 text area next to the outer side (opposite the binding side) of the
20362 body region. </para>
20364 <para>For double-sided output, this side region
20365 is <literal>fo:region-end</literal> on a odd-numbered page,
20366 and <literal>fo:region-start</literal> on an even-numbered page.</para>
20368 <para>For single-sided output, this side region
20369 is <literal>fo:region-end</literal> for all pages.</para>
20371 <para>This correspondence applies to all languages,
20372 both left-to-right and right-to-left writing modes.</para>
20374 <para>The default value of this parameter is zero. If you enlarge this extent,
20375 be sure to also enlarge the <parameter>body.margin.outer</parameter>
20376 parameter to make room for its content, otherwise any text in
20377 the side region may overlap with the body text.</para>
20380 <parameter>region.inner.extent</parameter>,
20381 <parameter>body.margin.inner</parameter>,
20382 <parameter>body.margin.outer</parameter>,
20383 <parameter>side.region.precedence</parameter>.
20388 <refentry version="5.0" id="default.units">
20390 <refentrytitle>default.units</refentrytitle>
20391 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
20392 <refmiscinfo class="other" otherclass="value">cm</refmiscinfo>
20393 <refmiscinfo class="other" otherclass="value">mm</refmiscinfo>
20394 <refmiscinfo class="other" otherclass="value">in</refmiscinfo>
20395 <refmiscinfo class="other" otherclass="value">pt</refmiscinfo>
20396 <refmiscinfo class="other" otherclass="value">pc</refmiscinfo>
20397 <refmiscinfo class="other" otherclass="value">px</refmiscinfo>
20398 <refmiscinfo class="other" otherclass="value">em</refmiscinfo>
20401 <refname>default.units</refname>
20402 <refpurpose>Default units for an unqualified dimension</refpurpose>
20406 <programlisting id="default.units.frag">
20407 <xsl:param name="default.units">pt</xsl:param>
20411 <refsection><info><title>Description</title></info>
20413 <para>If an unqualified dimension is encountered (for example, in a
20414 graphic width), the <parameter>default.units</parameter> will be used for the
20415 units. Unqualified dimensions are not allowed in XSL Formatting Objects.
20421 <refentry version="5.0" id="normal.para.spacing">
20423 <refentrytitle>normal.para.spacing</refentrytitle>
20424 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
20427 <refname>normal.para.spacing</refname>
20428 <refpurpose>What space do you want between normal paragraphs</refpurpose>
20432 <programlisting id="normal.para.spacing.frag"><xsl:attribute-set name="normal.para.spacing">
20433 <xsl:attribute name="space-before.optimum">1em</xsl:attribute>
20434 <xsl:attribute name="space-before.minimum">0.8em</xsl:attribute>
20435 <xsl:attribute name="space-before.maximum">1.2em</xsl:attribute>
20436 </xsl:attribute-set></programlisting>
20438 <refsection><info><title>Description</title></info>
20439 <para>Specify the spacing required between normal paragraphs as well as
20440 the following block-level elements:
20442 <literallayout>ackno
20450 <para>To customize the spacing, you need to reset all three attributes.</para>
20452 <para>To specify properties on just <tag>para</tag> elements without
20453 affecting these other elements,
20455 <link linkend="para.properties">para.properties</link>
20456 attribute-set. </para>
20460 <refentry version="5.0" id="para.properties">
20462 <refentrytitle>para.properties</refentrytitle>
20463 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
20466 <refname>para.properties</refname>
20467 <refpurpose>Properties to apply to para elements</refpurpose>
20471 <programlisting id="para.properties.frag"><xsl:attribute-set name="para.properties" use-attribute-sets="normal.para.spacing">
20472 </xsl:attribute-set></programlisting>
20474 <refsection><info><title>Description</title></info>
20475 <para>Specify properties to apply to the fo:block of a para element,
20476 such as <literal>text-indent</literal>.
20477 Although the default attribute-set is empty, it uses the attribute-set
20478 named <literal>normal.para.spacing</literal> to add vertical space before
20479 each para. The <literal>para.properties</literal> attribute-set can override those
20480 spacing properties for para only.</para>
20482 <link linkend="normal.para.spacing">normal.para.spacing</link>.
20487 <refentry version="5.0" id="body.font.master">
20489 <refentrytitle>body.font.master</refentrytitle>
20490 <refmiscinfo class="other" otherclass="datatype">number</refmiscinfo>
20493 <refname>body.font.master</refname>
20494 <refpurpose>Specifies the default point size for body text</refpurpose>
20498 <programlisting id="body.font.master.frag">
20499 <xsl:param name="body.font.master">10</xsl:param>
20503 <refsection><info><title>Description</title></info>
20505 <para>The body font size is specified in two parameters
20506 (<parameter>body.font.master</parameter> and <parameter>body.font.size</parameter>)
20507 so that math can be performed on the font size by XSLT.
20513 <refentry version="5.0" id="body.font.size">
20515 <refentrytitle>body.font.size</refentrytitle>
20516 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
20519 <refname>body.font.size</refname>
20520 <refpurpose>Specifies the default font size for body text</refpurpose>
20524 <programlisting id="body.font.size.frag">
20525 <xsl:param name="body.font.size">
20526 <xsl:value-of select="$body.font.master"></xsl:value-of><xsl:text>pt</xsl:text>
20527 </xsl:param></programlisting>
20530 <refsection><info><title>Description</title></info>
20532 <para>The body font size is specified in two parameters
20533 (<parameter>body.font.master</parameter> and <parameter>body.font.size</parameter>)
20534 so that math can be performed on the font size by XSLT.
20540 <refentry version="5.0" id="footnote.font.size">
20542 <refentrytitle>footnote.font.size</refentrytitle>
20543 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
20546 <refname>footnote.font.size</refname>
20547 <refpurpose>The font size for footnotes</refpurpose>
20551 <programlisting id="footnote.font.size.frag"><xsl:param name="footnote.font.size">
20552 <xsl:value-of select="$body.font.master * 0.8"></xsl:value-of><xsl:text>pt</xsl:text>
20553 </xsl:param></programlisting>
20556 <refsection><info><title>Description</title></info>
20558 <para>The footnote font size is used for...footnotes!
20564 <refentry version="5.0" id="title.margin.left">
20566 <refentrytitle>title.margin.left</refentrytitle>
20567 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
20570 <refname>title.margin.left</refname>
20571 <refpurpose>Adjust the left margin for titles</refpurpose>
20575 <programlisting id="title.margin.left.frag">
20576 <xsl:param name="title.margin.left">
20578 <xsl:when test="$fop.extensions != 0">-4pc</xsl:when>
20579 <xsl:when test="$passivetex.extensions != 0">0pt</xsl:when>
20580 <xsl:otherwise>0pt</xsl:otherwise>
20581 </xsl:choose>
20586 <refsection><info><title>Description</title></info>
20588 <para>This parameter provides
20589 the means of adjusting the left margin for titles
20590 when the XSL-FO processor being used is
20591 an old version of FOP (0.25 and earlier).
20592 It is only useful when the <parameter>fop.extensions</parameter>
20595 <para>The left margin of the body region
20596 is calculated to include this space,
20597 and titles are outdented to the left outside
20598 the body region by this amount,
20599 effectively leaving titles at the intended left margin
20600 and the body text indented.
20601 Currently this method is only used for old FOP because
20602 it cannot properly use the <parameter>body.start.indent</parameter>
20606 The default value when the <parameter>fop.extensions</parameter>
20607 parameter is nonzero is -4pc, which means the
20608 body text is indented 4 picas relative to
20610 The default value when the <parameter>fop.extensions</parameter>
20611 parameter equals zero is 0pt, and
20612 the body indent should instead be specified
20613 using the <parameter>body.start.indent</parameter>
20617 If you set the value to zero, be sure to still include
20618 a unit indicator such as <literal>0pt</literal>, or
20619 the FO processor will report errors.
20625 <refentry version="5.0" id="draft.mode">
20627 <refentrytitle>draft.mode</refentrytitle>
20628 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
20629 <refmiscinfo class="other" otherclass="value">no</refmiscinfo>
20630 <refmiscinfo class="other" otherclass="value">yes</refmiscinfo>
20631 <refmiscinfo class="other" otherclass="value">maybe</refmiscinfo>
20634 <refname>draft.mode</refname>
20635 <refpurpose>Select draft mode</refpurpose>
20639 <programlisting id="draft.mode.frag">
20640 <xsl:param name="draft.mode">no</xsl:param>
20644 <refsection><info><title>Description</title></info>
20646 <para>Selects draft mode. If <parameter>draft.mode</parameter> is
20647 <quote><literal>yes</literal></quote>, the entire document will be treated
20648 as a draft. If it is <quote><literal>no</literal></quote>, the entire document
20649 will be treated as a final copy. If it is <quote><literal>maybe</literal></quote>,
20650 individual sections will be treated as draft or final independently, depending
20651 on how their <literal>status</literal> attribute is set.
20657 <refentry version="5.0" id="draft.watermark.image">
20659 <refentrytitle>draft.watermark.image</refentrytitle>
20660 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
20663 <refname>draft.watermark.image</refname>
20664 <refpurpose>The URI of the image to be used for draft watermarks</refpurpose>
20668 <programlisting id="draft.watermark.image.frag">
20669 <xsl:param name="draft.watermark.image">images/draft.png</xsl:param>
20673 <refsection><info><title>Description</title></info>
20675 <para>The image to be used for draft watermarks.</para>
20680 <refentry version="5.0" id="headers.on.blank.pages">
20682 <refentrytitle>headers.on.blank.pages</refentrytitle>
20683 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
20686 <refname>headers.on.blank.pages</refname>
20687 <refpurpose>Put headers on blank pages?</refpurpose>
20691 <programlisting id="headers.on.blank.pages.frag">
20692 <xsl:param name="headers.on.blank.pages" select="1"></xsl:param>
20696 <refsection><info><title>Description</title></info>
20698 <para>If non-zero, headers will be placed on blank pages.</para>
20703 <refentry version="5.0" id="footers.on.blank.pages">
20705 <refentrytitle>footers.on.blank.pages</refentrytitle>
20706 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
20709 <refname>footers.on.blank.pages</refname>
20710 <refpurpose>Put footers on blank pages?</refpurpose>
20714 <programlisting id="footers.on.blank.pages.frag">
20715 <xsl:param name="footers.on.blank.pages" select="1"></xsl:param>
20719 <refsection><info><title>Description</title></info>
20721 <para>If non-zero, footers will be placed on blank pages.</para>
20726 <refentry version="5.0" id="header.rule">
20728 <refentrytitle>header.rule</refentrytitle>
20729 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
20732 <refname>header.rule</refname>
20733 <refpurpose>Rule under headers?</refpurpose>
20737 <programlisting id="header.rule.frag">
20738 <xsl:param name="header.rule" select="1"></xsl:param>
20742 <refsection><info><title>Description</title></info>
20744 <para>If non-zero, a rule will be drawn below the page headers.</para>
20749 <refentry version="5.0" id="footer.rule">
20751 <refentrytitle>footer.rule</refentrytitle>
20752 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
20755 <refname>footer.rule</refname>
20756 <refpurpose>Rule over footers?</refpurpose>
20760 <programlisting id="footer.rule.frag">
20761 <xsl:param name="footer.rule" select="1"></xsl:param>
20765 <refsection><info><title>Description</title></info>
20767 <para>If non-zero, a rule will be drawn above the page footers.</para>
20772 <refentry version="5.0" id="header.column.widths">
20774 <refentrytitle>header.column.widths</refentrytitle>
20775 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
20778 <refname>header.column.widths</refname>
20779 <refpurpose>Specify relative widths of header areas</refpurpose>
20782 <refsynopsisdiv><programlisting id="header.column.widths.frag">
20783 <xsl:param name="header.column.widths">1 1 1</xsl:param>
20784 </programlisting></refsynopsisdiv>
20786 <refsection><info><title>Description</title></info>
20788 <para>Page headers in print output use a three column table
20789 to position text at the left, center, and right side of
20790 the header on the page.
20791 This parameter lets you specify the relative sizes of the
20792 three columns. The default value is
20795 <para>The parameter value must be three numbers, separated
20796 by white space. The first number represents the relative
20797 width of the inside header for
20798 double-sided output. The second number is the relative
20799 width of the center header. The third number is the
20800 relative width of the outside header for
20801 double-sided output.
20803 <para>For single-sided output, the first number is the
20804 relative width of left header for left-to-right
20805 text direction, or the right header for right-to-left
20807 The third number is the
20808 relative width of right header for left-to-right
20809 text direction, or the left header for right-to-left
20810 text direction.</para>
20812 <para>The numbers are used to specify the column widths
20813 for the table that makes up the header area.
20814 In the FO output, this looks like:
20818 <fo:table-column column-number="1"
20819 column-width="proportional-column-width(1)"/>
20823 The <literal>proportional-column-width()</literal>
20824 function computes a column width by dividing its
20825 argument by the total of the arguments for all the columns, and
20826 then multiplying the result by the width of the whole table
20827 (assuming all the column specs use the function).
20828 Its argument can be any positive integer or floating point number.
20829 Zero is an acceptable value, although some FO processors
20830 may warn about it, in which case using a very small number might
20831 be more satisfactory.
20834 <para>For example, the value "1 2 1" means the center
20835 header should have twice the width of the other areas.
20836 A value of "0 0 1" means the entire header area
20837 is reserved for the right (or outside) header text.
20838 Note that to keep the center area centered on
20839 the page, the left and right values must be
20840 the same. A specification like "1 2 3" means the
20841 center area is no longer centered on the page
20842 since the right area is three times the width of the left area.
20848 <refentry version="5.0" id="footer.column.widths">
20850 <refentrytitle>footer.column.widths</refentrytitle>
20851 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
20854 <refname>footer.column.widths</refname>
20855 <refpurpose>Specify relative widths of footer areas</refpurpose>
20858 <refsynopsisdiv><programlisting id="footer.column.widths.frag">
20859 <xsl:param name="footer.column.widths">1 1 1</xsl:param>
20860 </programlisting></refsynopsisdiv>
20862 <refsection><info><title>Description</title></info>
20864 <para>Page footers in print output use a three column table
20865 to position text at the left, center, and right side of
20866 the footer on the page.
20867 This parameter lets you specify the relative sizes of the
20868 three columns. The default value is
20871 <para>The parameter value must be three numbers, separated
20872 by white space. The first number represents the relative
20873 width of the inside footer for
20874 double-sided output. The second number is the relative
20875 width of the center footer. The third number is the
20876 relative width of the outside footer for
20877 double-sided output.
20879 <para>For single-sided output, the first number is the
20880 relative width of left footer for left-to-right
20881 text direction, or the right footer for right-to-left
20883 The third number is the
20884 relative width of right footer for left-to-right
20885 text direction, or the left footer for right-to-left
20886 text direction.</para>
20888 <para>The numbers are used to specify the column widths
20889 for the table that makes up the footer area.
20890 In the FO output, this looks like:
20894 <fo:table-column column-number="1"
20895 column-width="proportional-column-width(1)"/>
20899 The <literal>proportional-column-width()</literal>
20900 function computes a column width by dividing its
20901 argument by the total of the arguments for all the columns, and
20902 then multiplying the result by the width of the whole table
20903 (assuming all the column specs use the function).
20904 Its argument can be any positive integer or floating point number.
20905 Zero is an acceptable value, although some FO processors
20906 may warn about it, in which case using a very small number might
20907 be more satisfactory.
20910 <para>For example, the value "1 2 1" means the center
20911 footer should have twice the width of the other areas.
20912 A value of "0 0 1" means the entire footer area
20913 is reserved for the right (or outside) footer text.
20914 Note that to keep the center area centered on
20915 the page, the left and right values must be
20916 the same. A specification like "1 2 3" means the
20917 center area is no longer centered on the page
20918 since the right area is three times the width of the left area.
20924 <refentry version="5.0" id="header.table.properties">
20926 <refentrytitle>header.table.properties</refentrytitle>
20927 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
20930 <refname>header.table.properties</refname>
20931 <refpurpose>Apply properties to the header layout table</refpurpose>
20935 <programlisting id="header.table.properties.frag">
20936 <xsl:attribute-set name="header.table.properties">
20937 <xsl:attribute name="table-layout">fixed</xsl:attribute>
20938 <xsl:attribute name="width">100%</xsl:attribute>
20939 </xsl:attribute-set>
20943 <refsection><info><title>Description</title></info>
20945 <para>Properties applied to the table that lays out the page header.</para>
20950 <refentry version="5.0" id="header.table.height">
20952 <refentrytitle>header.table.height</refentrytitle>
20953 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
20956 <refname>header.table.height</refname>
20957 <refpurpose>Specify the minimum height of the table containing the running page headers</refpurpose>
20960 <refsynopsisdiv><programlisting id="header.table.height.frag">
20961 <xsl:param name="header.table.height">14pt</xsl:param>
20962 </programlisting></refsynopsisdiv>
20964 <refsection><info><title>Description</title></info>
20966 <para>Page headers in print output use a three column table
20967 to position text at the left, center, and right side of
20968 the header on the page.
20969 This parameter lets you specify the minimum height
20970 of the single row in the table.
20971 Since this specifies only the minimum height,
20972 the table should automatically grow to fit taller content.
20973 The default value is "14pt".</para>
20978 <refentry version="5.0" id="footer.table.properties">
20980 <refentrytitle>footer.table.properties</refentrytitle>
20981 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
20984 <refname>footer.table.properties</refname>
20985 <refpurpose>Apply properties to the footer layout table</refpurpose>
20989 <programlisting id="footer.table.properties.frag">
20990 <xsl:attribute-set name="footer.table.properties">
20991 <xsl:attribute name="table-layout">fixed</xsl:attribute>
20992 <xsl:attribute name="width">100%</xsl:attribute>
20993 </xsl:attribute-set>
20997 <refsection><info><title>Description</title></info>
20999 <para>Properties applied to the table that lays out the page footer.</para>
21004 <refentry version="5.0" id="footer.table.height">
21006 <refentrytitle>footer.table.height</refentrytitle>
21007 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
21010 <refname>footer.table.height</refname>
21011 <refpurpose>Specify the minimum height of the table containing the running page footers</refpurpose>
21014 <refsynopsisdiv><programlisting id="footer.table.height.frag">
21015 <xsl:param name="footer.table.height">14pt</xsl:param>
21016 </programlisting></refsynopsisdiv>
21018 <refsection><info><title>Description</title></info>
21020 <para>Page footers in print output use a three column table
21021 to position text at the left, center, and right side of
21022 the footer on the page.
21023 This parameter lets you specify the minimum height
21024 of the single row in the table.
21025 Since this specifies only the minimum height,
21026 the table should automatically grow to fit taller content.
21027 The default value is "14pt".</para>
21032 <refentry version="5.0" id="header.content.properties">
21034 <refentrytitle>header.content.properties</refentrytitle>
21035 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
21038 <refname>header.content.properties</refname>
21039 <refpurpose>Properties of page header content</refpurpose>
21043 <programlisting id="header.content.properties.frag">
21044 <xsl:attribute-set name="header.content.properties">
21045 <xsl:attribute name="font-family">
21046 <xsl:value-of select="$body.fontset"></xsl:value-of>
21047 </xsl:attribute>
21048 <xsl:attribute name="margin-left">
21049 <xsl:value-of select="$title.margin.left"></xsl:value-of>
21050 </xsl:attribute>
21051 </xsl:attribute-set>
21055 <refsection><info><title>Description</title></info>
21057 <para>Properties of page header content.</para>
21062 <refentry version="5.0" id="footer.content.properties">
21064 <refentrytitle>footer.content.properties</refentrytitle>
21065 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
21068 <refname>footer.content.properties</refname>
21069 <refpurpose>Properties of page footer content</refpurpose>
21073 <programlisting id="footer.content.properties.frag">
21074 <xsl:attribute-set name="footer.content.properties">
21075 <xsl:attribute name="font-family">
21076 <xsl:value-of select="$body.fontset"></xsl:value-of>
21077 </xsl:attribute>
21078 <xsl:attribute name="margin-left">
21079 <xsl:value-of select="$title.margin.left"></xsl:value-of>
21080 </xsl:attribute>
21081 </xsl:attribute-set>
21085 <refsection><info><title>Description</title></info>
21087 <para>Properties of page footer content.</para>
21092 <refentry version="5.0" id="marker.section.level">
21094 <refentrytitle>marker.section.level</refentrytitle>
21095 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
21098 <refname>marker.section.level</refname>
21099 <refpurpose>Control depth of sections shown in running headers or footers</refpurpose>
21103 <programlisting id="marker.section.level.frag">
21104 <xsl:param name="marker.section.level">2</xsl:param>
21108 <refsection><info><title>Description</title></info>
21110 <para>The <parameter>marker.section.level</parameter> parameter
21111 controls the depth of section levels that may be displayed
21112 in running headers and footers. For example, if the value
21113 is 2 (the default), then titles from <tag>sect1</tag> and
21114 <tag>sect2</tag> or equivalent <tag>section</tag>
21115 elements are candidates for use in running headers and
21118 <para>Each candidate title is marked in the FO output with a
21119 <tag><fo:marker marker-class-name="section.head.marker"></tag>
21122 <para>In order for such titles to appear in headers
21123 or footers, the <literal>header.content</literal>
21124 or <literal>footer.content</literal> template
21125 must be customized to retrieve the marker using
21126 an output element such as:
21129 <fo:retrieve-marker retrieve-class-name="section.head.marker"
21130 retrieve-position="first-including-carryover"
21131 retrieve-boundary="page-sequence"/>
21138 <refentry version="5.0" id="side.region.precedence">
21140 <refentrytitle>side.region.precedence</refentrytitle>
21141 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
21144 <refname>side.region.precedence</refname>
21145 <refpurpose>Determines side region page layout precedence</refpurpose>
21147 <refsynopsisdiv> <programlisting id="side.region.precedence.frag">
21148 <xsl:param name="side.region.precedence">false</xsl:param>
21151 <refsection><info><title>Description</title></info>
21153 <para>If optional side regions on a page
21154 are established using parameters such as
21155 <parameter>body.margin.inner</parameter>,
21156 <parameter>region.inner.extent</parameter>, etc., then this
21157 parameter determines what happens at the corners where the
21158 side regions meet the header and footer regions.</para>
21160 <para>If the value of this parameter is <literal>true</literal>,
21161 then the side regions have precedence and extend higher
21162 and lower, while the header and footer regions are narrower
21163 and fit inside the side regions.</para>
21165 <para>If the value of this parameter is <literal>false</literal>
21166 (the default value), then the header and footer regions
21167 have precedence and extend over and below the side regions.
21168 Any value other than <literal>true</literal> or
21169 <literal>false</literal> is taken to be <literal>false</literal>.</para>
21171 <para>If you need to set precedence separately for
21172 individual regions, then you can set four
21173 parameters that are normally internal to the stylesheet.
21174 These four parameters are normally set based
21175 on the value from <parameter>side.region.precedence</parameter>:</para>
21177 <programlisting>region.before.precedence
21178 region.after.precedence
21179 region.start.precedence
21180 region.end.precedence</programlisting>
21183 <parameter>region.inner.extent</parameter>,
21184 <parameter>region.outer.extent</parameter>,
21185 <parameter>body.margin.inner</parameter>,
21186 <parameter>body.margin.outer</parameter>.
21188 </refsection> </refentry>
21190 <refentry version="5.0" id="region.inner.properties">
21192 <refentrytitle>region.inner.properties</refentrytitle>
21193 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
21196 <refname>region.inner.properties</refname>
21197 <refpurpose>Properties of running inner side region</refpurpose>
21201 <programlisting id="region.inner.properties.frag">
21202 <xsl:attribute-set name="region.inner.properties">
21203 <xsl:attribute name="border-width">0</xsl:attribute>
21204 <xsl:attribute name="padding">0</xsl:attribute>
21205 <xsl:attribute name="reference-orientation">90</xsl:attribute>
21206 </xsl:attribute-set>
21210 <refsection><info><title>Description</title></info>
21212 <para>The FO stylesheet supports optional side regions
21213 similar to the header and footer regions.
21214 Any attributes declared in this attribute-set
21215 are applied to the region element in the page master
21216 on the inner side (binding side) of the page.
21217 This corresponds to <literal><fo:regin-start></literal>
21218 on odd-numbered pages and <literal><fo:region-end></literal>
21219 on even-numbered pages.
21220 For single-sided output, it always corresponds to
21221 <literal><fo:regin-start></literal>.</para>
21223 <para>You can customize the template named
21224 <literal>inner.region.content</literal> to specify
21225 the content of the inner side region.</para>
21228 <parameter>inner.region.content.properties</parameter>,
21229 <parameter>page.margin.inner</parameter>,
21230 <parameter>body.margin.inner</parameter>,
21231 and the corresponding <literal>outer</literal>
21237 <refentry version="5.0" id="region.outer.properties">
21239 <refentrytitle>region.outer.properties</refentrytitle>
21240 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
21243 <refname>region.outer.properties</refname>
21244 <refpurpose>Properties of running outer side region</refpurpose>
21248 <programlisting id="region.outer.properties.frag">
21249 <xsl:attribute-set name="region.outer.properties">
21250 <xsl:attribute name="border-width">0</xsl:attribute>
21251 <xsl:attribute name="padding">0</xsl:attribute>
21252 <xsl:attribute name="reference-orientation">90</xsl:attribute>
21253 </xsl:attribute-set>
21257 <refsection><info><title>Description</title></info>
21259 <para>The FO stylesheet supports optional side regions
21260 similar to the header and footer regions.
21261 Any attributes declared in this attribute-set
21262 are applied to the region element in the page master
21263 on the outer side (opposite the binding side) of the page.
21264 This corresponds to <literal><fo:regin-start></literal>
21265 on odd-numbered pages and <literal><fo:region-end></literal>
21266 on even-numbered pages.
21267 For single-sided output, it always corresponds to
21268 <literal><fo:regin-start></literal>.</para>
21270 <para>You can customize the template named
21271 <literal>outer.region.content</literal> to specify
21272 the content of the outer side region.</para>
21275 <parameter>outer.region.content.properties</parameter>,
21276 <parameter>page.margin.outer</parameter>,
21277 <parameter>body.margin.outer</parameter>,
21278 and the corresponding <literal>inner</literal>
21284 <refentry version="5.0" id="inner.region.content.properties">
21286 <refentrytitle>inner.region.content.properties</refentrytitle>
21287 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
21290 <refname>inner.region.content.properties</refname>
21291 <refpurpose>Properties of running inner side content</refpurpose>
21295 <programlisting id="inner.region.content.properties.frag">
21296 <xsl:attribute-set name="inner.region.content.properties">
21297 </xsl:attribute-set>
21301 <refsection><info><title>Description</title></info>
21303 <para>The FO stylesheet supports optional side regions
21304 similar to the header and footer regions.
21305 Any attributes declared in this attribute-set
21306 are applied to the fo:block in the side region
21307 on the inner side (binding side) of the page.
21308 This corresponds to the <literal>start</literal>
21309 region on odd-numbered pages and the <literal>end</literal>
21310 region on even-numbered pages.
21311 For single-sided output, it always corresponds to
21312 the <literal>start</literal> region.</para>
21314 <para>You can customize the template named
21315 <literal>inner.region.content</literal> to specify
21316 the content of the inner side region.</para>
21319 <parameter>region.inner.properties</parameter>,
21320 <parameter>page.margin.inner</parameter>,
21321 <parameter>body.margin.inner</parameter>,
21322 and the corresponding <literal>outer</literal>
21328 <refentry version="5.0" id="outer.region.content.properties">
21330 <refentrytitle>outer.region.content.properties</refentrytitle>
21331 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
21334 <refname>outer.region.content.properties</refname>
21335 <refpurpose>Properties of running outer side content</refpurpose>
21339 <programlisting id="outer.region.content.properties.frag">
21340 <xsl:attribute-set name="outer.region.content.properties">
21341 </xsl:attribute-set>
21345 <refsection><info><title>Description</title></info>
21347 <para>The FO stylesheet supports optional side regions
21348 similar to the header and footer regions.
21349 Any attributes declared in this attribute-set
21350 are applied to the fo:block in the side region
21351 on the outer side (opposite the binding side) of the page.
21352 This corresponds to the <literal>start</literal>
21353 region on odd-numbered pages and the <literal>end</literal>
21354 region on even-numbered pages.
21355 For single-sided output, it always corresponds to
21356 the <literal>start</literal> region.</para>
21358 <para>You can customize the template named
21359 <literal>outer.region.content</literal> to specify
21360 the content of the outer side region.</para>
21363 <parameter>region.outer.properties</parameter>,
21364 <parameter>page.margin.outer</parameter>,
21365 <parameter>body.margin.outer</parameter>,
21366 and the corresponding <literal>inner</literal>
21371 </reference><reference id="fonts" xml:base="../fo/param.xml"><title>Font Families</title>
21372 <refentry version="5.0" id="body.font.family">
21374 <refentrytitle>body.font.family</refentrytitle>
21375 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
21376 <refmiscinfo class="other" otherclass="list-type">open</refmiscinfo>
21377 <refmiscinfo class="other" otherclass="value">serif</refmiscinfo>
21378 <refmiscinfo class="other" otherclass="value">sans-serif</refmiscinfo>
21379 <refmiscinfo class="other" otherclass="value">monospace</refmiscinfo>
21382 <refname>body.font.family</refname>
21383 <refpurpose>The default font family for body text</refpurpose>
21387 <programlisting id="body.font.family.frag">
21388 <xsl:param name="body.font.family">serif</xsl:param>
21392 <refsection><info><title>Description</title></info>
21394 <para>The body font family is the default font used for text in the page body.</para>
21395 <para>If more than one font is required, enter the font names,
21396 separated by a comma, e.g.</para>
21398 <xsl:param name="body.font.family">Arial, SimSun, serif</xsl:param>
21405 <refentry version="5.0" id="dingbat.font.family">
21407 <refentrytitle>dingbat.font.family</refentrytitle>
21408 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
21409 <refmiscinfo class="other" otherclass="list-type">open</refmiscinfo>
21410 <refmiscinfo class="other" otherclass="value">serif</refmiscinfo>
21411 <refmiscinfo class="other" otherclass="value">sans-serif</refmiscinfo>
21412 <refmiscinfo class="other" otherclass="value">monospace</refmiscinfo>
21415 <refname>dingbat.font.family</refname>
21416 <refpurpose>The font family for copyright, quotes, and other symbols</refpurpose>
21420 <programlisting id="dingbat.font.family.frag">
21421 <xsl:param name="dingbat.font.family">serif</xsl:param>
21425 <refsection><info><title>Description</title></info>
21427 <para>The dingbat font family is used for dingbats. If it is defined
21428 as the empty string, no font change is effected around dingbats.
21434 <refentry version="5.0" id="monospace.font.family">
21436 <refentrytitle>monospace.font.family</refentrytitle>
21437 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
21440 <refname>monospace.font.family</refname>
21441 <refpurpose>The default font family for monospace environments</refpurpose>
21445 <programlisting id="monospace.font.family.frag">
21446 <xsl:param name="monospace.font.family">monospace</xsl:param>
21450 <refsection><info><title>Description</title></info>
21452 <para>The monospace font family is used for verbatim environments
21453 (program listings, screens, etc.).
21455 <para>If more than one font is required, enter the font names,
21456 separated by a comma, e.g.</para>
21458 <xsl:param name="body.font.family">Arial, SimSun, serif</xsl:param>
21464 <refentry version="5.0" id="sans.font.family">
21466 <refentrytitle>sans.font.family</refentrytitle>
21467 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
21470 <refname>sans.font.family</refname>
21471 <refpurpose>The default sans-serif font family</refpurpose>
21475 <programlisting id="sans.font.family.frag">
21476 <xsl:param name="sans.font.family">sans-serif</xsl:param>
21480 <refsection><info><title>Description</title></info>
21482 <para>The default sans-serif font family. At the present, this isn't
21483 actually used by the stylesheets.
21489 <refentry version="5.0" id="title.font.family">
21491 <refentrytitle>title.font.family</refentrytitle>
21492 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
21493 <refmiscinfo class="other" otherclass="list-type">open</refmiscinfo>
21494 <refmiscinfo class="other" otherclass="value">serif</refmiscinfo>
21495 <refmiscinfo class="other" otherclass="value">sans-serif</refmiscinfo>
21496 <refmiscinfo class="other" otherclass="value">monospace</refmiscinfo>
21499 <refname>title.font.family</refname>
21500 <refpurpose>The default font family for titles</refpurpose>
21504 <programlisting id="title.font.family.frag">
21505 <xsl:param name="title.font.family">sans-serif</xsl:param>
21509 <refsection><info><title>Description</title></info>
21511 <para>The title font family is used for titles (chapter, section, figure,
21514 <para>If more than one font is required, enter the font names,
21515 separated by a comma, e.g.</para>
21517 <xsl:param name="body.font.family">Arial, SimSun, serif</xsl:param>
21523 <refentry version="5.0" id="symbol.font.family">
21525 <refentrytitle>symbol.font.family</refentrytitle>
21526 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
21527 <refmiscinfo class="other" otherclass="list-type">open</refmiscinfo>
21528 <refmiscinfo class="other" otherclass="value">serif</refmiscinfo>
21529 <refmiscinfo class="other" otherclass="value">sans-serif</refmiscinfo>
21530 <refmiscinfo class="other" otherclass="value">monospace</refmiscinfo>
21533 <refname>symbol.font.family</refname>
21534 <refpurpose>The font families to be searched for symbols outside
21535 of the body font</refpurpose>
21539 <programlisting id="symbol.font.family.frag">
21540 <xsl:param name="symbol.font.family">Symbol,ZapfDingbats</xsl:param>
21544 <refsection><info><title>Description</title></info>
21546 <para>A typical body or title font does not contain all
21547 the character glyphs that DocBook supports. This parameter
21548 specifies additional fonts that should be searched for
21549 special characters not in the normal font.
21550 These symbol font names are automatically appended
21551 to the body or title font family name when fonts
21553 <tag class="attribute">font-family</tag>
21554 property in the FO output.
21556 <para>The symbol font names should be entered as a
21557 comma-separated list. The default value is
21558 <literal>Symbol,ZapfDingbats</literal>.
21564 </reference><reference id="propsets" xml:base="../fo/param.xml"><title>Property Sets</title>
21565 <refentry version="5.0" id="formal.object.properties">
21567 <refentrytitle>formal.object.properties</refentrytitle>
21568 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
21571 <refname>formal.object.properties</refname>
21572 <refpurpose>Properties associated with a formal object such as a figure, or other component that has a title</refpurpose>
21576 <programlisting id="formal.object.properties.frag">
21577 <xsl:attribute-set name="formal.object.properties">
21578 <xsl:attribute name="space-before.minimum">0.5em</xsl:attribute>
21579 <xsl:attribute name="space-before.optimum">1em</xsl:attribute>
21580 <xsl:attribute name="space-before.maximum">2em</xsl:attribute>
21581 <xsl:attribute name="space-after.minimum">0.5em</xsl:attribute>
21582 <xsl:attribute name="space-after.optimum">1em</xsl:attribute>
21583 <xsl:attribute name="space-after.maximum">2em</xsl:attribute>
21584 <xsl:attribute name="keep-together.within-column">always</xsl:attribute>
21585 </xsl:attribute-set>
21589 <refsection><info><title>Description</title></info>
21591 <para>The styling for formal objects in docbook. Specify the spacing
21592 before and after the object.</para>
21597 <refentry version="5.0" id="formal.title.properties">
21599 <refentrytitle>formal.title.properties</refentrytitle>
21600 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
21603 <refname>formal.title.properties</refname>
21604 <refpurpose>Style the title element of formal object such as a figure.</refpurpose>
21608 <programlisting id="formal.title.properties.frag">
21609 <xsl:attribute-set name="formal.title.properties" use-attribute-sets="normal.para.spacing">
21610 <xsl:attribute name="font-weight">bold</xsl:attribute>
21611 <xsl:attribute name="font-size">
21612 <xsl:value-of select="$body.font.master * 1.2"></xsl:value-of>
21613 <xsl:text>pt</xsl:text>
21614 </xsl:attribute>
21615 <xsl:attribute name="hyphenate">false</xsl:attribute>
21616 <xsl:attribute name="space-after.minimum">0.4em</xsl:attribute>
21617 <xsl:attribute name="space-after.optimum">0.6em</xsl:attribute>
21618 <xsl:attribute name="space-after.maximum">0.8em</xsl:attribute>
21619 </xsl:attribute-set>
21622 <refsection><info><title>Description</title></info>
21623 <para>Specify how the title should be styled. Specify the font size and weight of the title of the formal object.</para>
21627 <refentry version="5.0" id="informal.object.properties">
21629 <refentrytitle>informal.object.properties</refentrytitle>
21630 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
21633 <refname>informal.object.properties</refname>
21634 <refpurpose>Properties associated with an informal (untitled) object, such as an informalfigure</refpurpose>
21638 <programlisting id="informal.object.properties.frag"><xsl:attribute-set name="informal.object.properties">
21639 <xsl:attribute name="space-before.minimum">0.5em</xsl:attribute>
21640 <xsl:attribute name="space-before.optimum">1em</xsl:attribute>
21641 <xsl:attribute name="space-before.maximum">2em</xsl:attribute>
21642 <xsl:attribute name="space-after.minimum">0.5em</xsl:attribute>
21643 <xsl:attribute name="space-after.optimum">1em</xsl:attribute>
21644 <xsl:attribute name="space-after.maximum">2em</xsl:attribute>
21645 </xsl:attribute-set></programlisting>
21647 <refsection><info><title>Description</title></info>
21648 <para>The styling for informal objects in docbook. Specify the spacing before and after the object.</para>
21652 <refentry version="5.0" id="monospace.properties">
21654 <refentrytitle>monospace.properties</refentrytitle>
21655 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
21658 <refname>monospace.properties</refname>
21659 <refpurpose>Properties of monospaced content</refpurpose>
21663 <programlisting id="monospace.properties.frag">
21664 <xsl:attribute-set name="monospace.properties">
21665 <xsl:attribute name="font-family">
21666 <xsl:value-of select="$monospace.font.family"></xsl:value-of>
21667 </xsl:attribute>
21668 </xsl:attribute-set>
21672 <refsection><info><title>Description</title></info>
21674 <para>Specifies the font name for monospaced output. This property set
21675 used to set the font-size as well, but that doesn't work very well
21676 when different fonts are used (as they are in titles and paragraphs,
21677 for example).</para>
21679 <para>If you want to set the font-size in a customization layer, it's
21680 probably going to be more appropriate to set font-size-adjust, if your
21681 formatter supports it.</para>
21686 <refentry version="5.0" id="verbatim.properties">
21688 <refentrytitle>verbatim.properties</refentrytitle>
21689 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
21692 <refname>verbatim.properties</refname>
21693 <refpurpose>Properties associated with verbatim text</refpurpose>
21697 <programlisting id="verbatim.properties.frag">
21698 <xsl:attribute-set name="verbatim.properties">
21699 <xsl:attribute name="space-before.minimum">0.8em</xsl:attribute>
21700 <xsl:attribute name="space-before.optimum">1em</xsl:attribute>
21701 <xsl:attribute name="space-before.maximum">1.2em</xsl:attribute>
21702 <xsl:attribute name="space-after.minimum">0.8em</xsl:attribute>
21703 <xsl:attribute name="space-after.optimum">1em</xsl:attribute>
21704 <xsl:attribute name="space-after.maximum">1.2em</xsl:attribute>
21705 <xsl:attribute name="hyphenate">false</xsl:attribute>
21706 <xsl:attribute name="wrap-option">no-wrap</xsl:attribute>
21707 <xsl:attribute name="white-space-collapse">false</xsl:attribute>
21708 <xsl:attribute name="white-space-treatment">preserve</xsl:attribute>
21709 <xsl:attribute name="linefeed-treatment">preserve</xsl:attribute>
21710 <xsl:attribute name="text-align">start</xsl:attribute>
21711 </xsl:attribute-set></programlisting>
21714 <refsection><info><title>Description</title></info>
21715 <para>This attribute set is used on all verbatim environments.</para>
21720 <refentry version="5.0" id="monospace.verbatim.properties">
21722 <refentrytitle>monospace.verbatim.properties</refentrytitle>
21723 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
21726 <refname>monospace.verbatim.properties</refname>
21727 <refpurpose>What font and size do you want for monospaced content?</refpurpose>
21731 <programlisting id="monospace.verbatim.properties.frag">
21732 <xsl:attribute-set name="monospace.verbatim.properties" use-attribute-sets="verbatim.properties monospace.properties">
21733 <xsl:attribute name="text-align">start</xsl:attribute>
21734 <xsl:attribute name="wrap-option">no-wrap</xsl:attribute>
21735 </xsl:attribute-set>
21738 <refsection><info><title>Description</title></info>
21739 <para>Specify the font name and size you want for monospaced output</para>
21743 <refentry version="5.0" id="sidebar.properties">
21745 <refentrytitle>sidebar.properties</refentrytitle>
21746 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
21749 <refname>sidebar.properties</refname>
21750 <refpurpose>Attribute set for sidebar properties</refpurpose>
21754 <programlisting id="sidebar.properties.frag">
21755 <xsl:attribute-set name="sidebar.properties" use-attribute-sets="formal.object.properties">
21756 <xsl:attribute name="border-style">solid</xsl:attribute>
21757 <xsl:attribute name="border-width">1pt</xsl:attribute>
21758 <xsl:attribute name="border-color">black</xsl:attribute>
21759 <xsl:attribute name="background-color">#DDDDDD</xsl:attribute>
21760 <xsl:attribute name="padding-start">12pt</xsl:attribute>
21761 <xsl:attribute name="padding-end">12pt</xsl:attribute>
21762 <xsl:attribute name="padding-top">6pt</xsl:attribute>
21763 <xsl:attribute name="padding-bottom">6pt</xsl:attribute>
21764 <xsl:attribute name="margin-{$direction.align.start}">0pt</xsl:attribute>
21765 <xsl:attribute name="margin-{$direction.align.end}">0pt</xsl:attribute>
21767 <xsl:attribute name="margin-top">6pt</xsl:attribute>
21768 <xsl:attribute name="margin-bottom">6pt</xsl:attribute>
21770 </xsl:attribute-set>
21774 <refsection><info><title>Description</title></info>
21776 <para>The styling for sidebars.</para>
21781 <refentry version="5.0" id="sidebar.title.properties">
21783 <refentrytitle>sidebar.title.properties</refentrytitle>
21784 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
21787 <refname>sidebar.title.properties</refname>
21788 <refpurpose>Attribute set for sidebar titles</refpurpose>
21792 <programlisting id="sidebar.title.properties.frag">
21793 <xsl:attribute-set name="sidebar.title.properties">
21794 <xsl:attribute name="font-weight">bold</xsl:attribute>
21795 <xsl:attribute name="hyphenate">false</xsl:attribute>
21796 <xsl:attribute name="text-align">start</xsl:attribute>
21797 <xsl:attribute name="keep-with-next.within-column">always</xsl:attribute>
21798 </xsl:attribute-set>
21802 <refsection><info><title>Description</title></info>
21804 <para>The styling for sidebars titles.</para>
21809 <refentry version="5.0" id="sidebar.float.type">
21811 <refentrytitle>sidebar.float.type</refentrytitle>
21812 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
21813 <refmiscinfo class="other" otherclass="value">none</refmiscinfo>
21814 <refmiscinfo class="other" otherclass="value">before</refmiscinfo>
21815 <refmiscinfo class="other" otherclass="value">left</refmiscinfo>
21816 <refmiscinfo class="other" otherclass="value">start</refmiscinfo>
21817 <refmiscinfo class="other" otherclass="value">right</refmiscinfo>
21818 <refmiscinfo class="other" otherclass="value">end</refmiscinfo>
21819 <refmiscinfo class="other" otherclass="value">inside</refmiscinfo>
21820 <refmiscinfo class="other" otherclass="value">outside</refmiscinfo>
21823 <refname>sidebar.float.type</refname>
21824 <refpurpose>Select type of float for sidebar elements</refpurpose>
21828 <programlisting id="sidebar.float.type.frag">
21829 <xsl:param name="sidebar.float.type">none</xsl:param>
21833 <refsection><info><title>Description</title></info>
21835 <para>Selects the type of float for sidebar elements.
21839 <para>If <parameter>sidebar.float.type</parameter> is
21840 <quote><literal>none</literal></quote>, then
21845 <para>If <parameter>sidebar.float.type</parameter> is
21846 <quote><literal>before</literal></quote>, then
21847 the float appears at the top of the page. On some processors,
21848 that may be the next page rather than the current page.
21853 <para>If <parameter>sidebar.float.type</parameter> is
21854 <quote><literal>left</literal></quote>,
21855 then a left side float is used.
21860 <para>If <parameter>sidebar.float.type</parameter> is
21861 <quote><literal>start</literal></quote>,
21862 then when the text direction is left-to-right a left side float is used.
21863 When the text direction is right-to-left, a right side float is used.
21868 <para>If <parameter>sidebar.float.type</parameter> is
21869 <quote><literal>right</literal></quote>,
21870 then a right side float is used.
21875 <para>If <parameter>sidebar.float.type</parameter> is
21876 <quote><literal>end</literal></quote>,
21877 then when the text direction is left-to-right a right side float is used.
21878 When the text direction is right-to-left, a left side float is used.
21883 <para>If your XSL-FO processor supports floats positioned on the
21884 <quote><literal>inside</literal></quote> or
21885 <quote><literal>outside</literal></quote>
21886 of double-sided pages, then you have those two
21887 options for side floats as well.
21895 <refentry version="5.0" id="sidebar.float.width">
21897 <refentrytitle>sidebar.float.width</refentrytitle>
21898 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
21901 <refname>sidebar.float.width</refname>
21902 <refpurpose>Set the default width for sidebars</refpurpose>
21906 <programlisting id="sidebar.float.width.frag">
21907 <xsl:param name="sidebar.float.width">1in</xsl:param>
21911 <refsection><info><title>Description</title></info>
21913 <para>Sets the default width for sidebars when used as a side float.
21914 The width determines the degree to which the sidebar block intrudes into
21917 <para>If <parameter>sidebar.float.type</parameter> is
21918 <quote><literal>before</literal></quote> or
21919 <quote><literal>none</literal></quote>, then
21920 this parameter is ignored.
21926 <refentry version="5.0" id="margin.note.properties">
21928 <refentrytitle>margin.note.properties</refentrytitle>
21929 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
21932 <refname>margin.note.properties</refname>
21933 <refpurpose>Attribute set for margin.note properties</refpurpose>
21937 <programlisting id="margin.note.properties.frag">
21938 <xsl:attribute-set name="margin.note.properties">
21939 <xsl:attribute name="font-size">90%</xsl:attribute>
21940 <xsl:attribute name="text-align">start</xsl:attribute>
21941 </xsl:attribute-set>
21945 <refsection><info><title>Description</title></info>
21947 <para>The styling for margin notes.
21948 By default, margin notes are not implemented for any
21949 element. A stylesheet customization is needed to make
21950 use of this attribute-set.</para>
21952 <para>You can use a template named <quote>floater</quote>
21953 to create the customization.
21954 That template can create side floats by specifying the
21955 content and characteristics as template parameters.
21958 <para>For example:</para>
21959 <programlisting><xsl:template match="para[@role='marginnote']">
21960 <xsl:call-template name="floater">
21961 <xsl:with-param name="position">
21962 <xsl:value-of select="$margin.note.float.type"/>
21963 </xsl:with-param>
21964 <xsl:with-param name="width">
21965 <xsl:value-of select="$margin.note.width"/>
21966 </xsl:with-param>
21967 <xsl:with-param name="content">
21968 <xsl:apply-imports/>
21969 </xsl:with-param>
21970 </xsl:call-template>
21971 </xsl:template></programlisting>
21976 <refentry version="5.0" id="margin.note.title.properties">
21978 <refentrytitle>margin.note.title.properties</refentrytitle>
21979 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
21982 <refname>margin.note.title.properties</refname>
21983 <refpurpose>Attribute set for margin note titles</refpurpose>
21987 <programlisting id="margin.note.title.properties.frag">
21988 <xsl:attribute-set name="margin.note.title.properties">
21989 <xsl:attribute name="font-weight">bold</xsl:attribute>
21990 <xsl:attribute name="hyphenate">false</xsl:attribute>
21991 <xsl:attribute name="text-align">start</xsl:attribute>
21992 <xsl:attribute name="keep-with-next.within-column">always</xsl:attribute>
21993 </xsl:attribute-set>
21997 <refsection><info><title>Description</title></info>
21999 <para>The styling for margin note titles.</para>
22004 <refentry version="5.0" id="margin.note.float.type">
22006 <refentrytitle>margin.note.float.type</refentrytitle>
22007 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
22008 <refmiscinfo class="other" otherclass="value">none</refmiscinfo>
22009 <refmiscinfo class="other" otherclass="value">before</refmiscinfo>
22010 <refmiscinfo class="other" otherclass="value">left</refmiscinfo>
22011 <refmiscinfo class="other" otherclass="value">start</refmiscinfo>
22012 <refmiscinfo class="other" otherclass="value">right</refmiscinfo>
22013 <refmiscinfo class="other" otherclass="value">end</refmiscinfo>
22014 <refmiscinfo class="other" otherclass="value">inside</refmiscinfo>
22015 <refmiscinfo class="other" otherclass="value">outside</refmiscinfo>
22018 <refname>margin.note.float.type</refname>
22019 <refpurpose>Select type of float for margin note customizations</refpurpose>
22023 <programlisting id="margin.note.float.type.frag">
22024 <xsl:param name="margin.note.float.type">none</xsl:param>
22028 <refsection><info><title>Description</title></info>
22030 <para>Selects the type of float for margin notes.
22031 DocBook does not define a margin note element, so this
22032 feature must be implemented as a customization of the stylesheet.
22033 See <parameter>margin.note.properties</parameter> for
22038 <para>If <parameter>margin.note.float.type</parameter> is
22039 <quote><literal>none</literal></quote>, then
22044 <para>If <parameter>margin.note.float.type</parameter> is
22045 <quote><literal>before</literal></quote>, then
22046 the float appears at the top of the page. On some processors,
22047 that may be the next page rather than the current page.
22051 <para>If <parameter>margin.note.float.type</parameter> is
22052 <quote><literal>left</literal></quote> or
22053 <quote><literal>start</literal></quote>, then
22054 a left side float is used.
22058 <para>If <parameter>margin.note.float.type</parameter> is
22059 <quote><literal>right</literal></quote> or
22060 <quote><literal>end</literal></quote>, then
22061 a right side float is used.
22065 <para>If your XSL-FO processor supports floats positioned on the
22066 <quote><literal>inside</literal></quote> or
22067 <quote><literal>outside</literal></quote>
22068 of double-sided pages, then you have those two
22069 options for side floats as well.
22077 <refentry version="5.0" id="margin.note.width">
22079 <refentrytitle>margin.note.width</refentrytitle>
22080 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
22083 <refname>margin.note.width</refname>
22084 <refpurpose>Set the default width for margin notes</refpurpose>
22088 <programlisting id="margin.note.width.frag">
22089 <xsl:param name="margin.note.width">1in</xsl:param>
22093 <refsection><info><title>Description</title></info>
22095 <para>Sets the default width for margin notes when used as a side
22096 float. The width determines the degree to which the margin note block
22097 intrudes into the text area.
22099 <para>If <parameter>margin.note.float.type</parameter> is
22100 <quote><literal>before</literal></quote> or
22101 <quote><literal>none</literal></quote>, then
22102 this parameter is ignored.
22108 <refentry version="5.0" id="component.title.properties">
22110 <refentrytitle>component.title.properties</refentrytitle>
22111 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
22114 <refname>component.title.properties</refname>
22115 <refpurpose>Properties for component titles</refpurpose>
22119 <programlisting id="component.title.properties.frag">
22120 <xsl:attribute-set name="component.title.properties">
22121 <xsl:attribute name="keep-with-next.within-column">always</xsl:attribute>
22122 <xsl:attribute name="space-before.optimum"><xsl:value-of select="concat($body.font.master, 'pt')"></xsl:value-of></xsl:attribute>
22123 <xsl:attribute name="space-before.minimum"><xsl:value-of select="concat($body.font.master, 'pt * 0.8')"></xsl:value-of></xsl:attribute>
22124 <xsl:attribute name="space-before.maximum"><xsl:value-of select="concat($body.font.master, 'pt * 1.2')"></xsl:value-of></xsl:attribute>
22125 <xsl:attribute name="hyphenate">false</xsl:attribute>
22126 <xsl:attribute name="text-align">
22128 <xsl:when test="((parent::article | parent::articleinfo | parent::info/parent::article) and not(ancestor::book) and not(self::bibliography)) or (parent::slides | parent::slidesinfo)">center</xsl:when>
22129 <xsl:otherwise>start</xsl:otherwise>
22130 </xsl:choose>
22131 </xsl:attribute>
22132 <xsl:attribute name="start-indent"><xsl:value-of select="$title.margin.left"></xsl:value-of></xsl:attribute>
22133 </xsl:attribute-set>
22137 <refsection><info><title>Description</title></info>
22139 <para>The properties common to all component titles.</para>
22144 <refentry version="5.0" id="component.titlepage.properties">
22146 <refentrytitle>component.titlepage.properties</refentrytitle>
22147 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
22150 <refname>component.titlepage.properties</refname>
22151 <refpurpose>Properties for component titlepages</refpurpose>
22155 <programlisting id="component.titlepage.properties.frag">
22156 <xsl:attribute-set name="component.titlepage.properties">
22157 </xsl:attribute-set>
22161 <refsection><info><title>Description</title></info>
22163 <para>The properties that are applied to the outer block containing
22164 all the component title page information.
22165 Its main use is to set a <literal>span="all"</literal>
22166 property on the block that is a direct child of the flow.</para>
22168 <para>This attribute-set also applies to index titlepages. It is empty by default.</para>
22173 <refentry version="5.0" id="section.title.properties">
22175 <refentrytitle>section.title.properties</refentrytitle>
22176 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
22179 <refname>section.title.properties</refname>
22180 <refpurpose>Properties for section titles</refpurpose>
22184 <programlisting id="section.title.properties.frag">
22185 <xsl:attribute-set name="section.title.properties">
22186 <xsl:attribute name="font-family">
22187 <xsl:value-of select="$title.fontset"></xsl:value-of>
22188 </xsl:attribute>
22189 <xsl:attribute name="font-weight">bold</xsl:attribute>
22190 <!-- font size is calculated dynamically by section.heading template -->
22191 <xsl:attribute name="keep-with-next.within-column">always</xsl:attribute>
22192 <xsl:attribute name="space-before.minimum">0.8em</xsl:attribute>
22193 <xsl:attribute name="space-before.optimum">1.0em</xsl:attribute>
22194 <xsl:attribute name="space-before.maximum">1.2em</xsl:attribute>
22195 <xsl:attribute name="text-align">start</xsl:attribute>
22196 <xsl:attribute name="start-indent"><xsl:value-of select="$title.margin.left"></xsl:value-of></xsl:attribute>
22197 </xsl:attribute-set>
22201 <refsection><info><title>Description</title></info>
22203 <para>The properties common to all section titles.</para>
22208 <refentry version="5.0" id="section.title.level1.properties">
22210 <refentrytitle>section.title.level1.properties</refentrytitle>
22211 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
22214 <refname>section.title.level1.properties</refname>
22215 <refpurpose>Properties for level-1 section titles</refpurpose>
22219 <programlisting id="section.title.level1.properties.frag">
22220 <xsl:attribute-set name="section.title.level1.properties">
22221 <xsl:attribute name="font-size">
22222 <xsl:value-of select="$body.font.master * 2.0736"></xsl:value-of>
22223 <xsl:text>pt</xsl:text>
22224 </xsl:attribute>
22225 </xsl:attribute-set>
22229 <refsection><info><title>Description</title></info>
22231 <para>The properties of level-1 section titles.</para>
22237 <refentry version="5.0" id="section.title.level2.properties">
22239 <refentrytitle>section.title.level2.properties</refentrytitle>
22240 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
22243 <refname>section.title.level2.properties</refname>
22244 <refpurpose>Properties for level-2 section titles</refpurpose>
22248 <programlisting id="section.title.level2.properties.frag">
22249 <xsl:attribute-set name="section.title.level2.properties">
22250 <xsl:attribute name="font-size">
22251 <xsl:value-of select="$body.font.master * 1.728"></xsl:value-of>
22252 <xsl:text>pt</xsl:text>
22253 </xsl:attribute>
22254 </xsl:attribute-set>
22258 <refsection><info><title>Description</title></info>
22260 <para>The properties of level-2 section titles.</para>
22265 <refentry version="5.0" id="section.title.level3.properties">
22267 <refentrytitle>section.title.level3.properties</refentrytitle>
22268 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
22271 <refname>section.title.level3.properties</refname>
22272 <refpurpose>Properties for level-3 section titles</refpurpose>
22276 <programlisting id="section.title.level3.properties.frag">
22277 <xsl:attribute-set name="section.title.level3.properties">
22278 <xsl:attribute name="font-size">
22279 <xsl:value-of select="$body.font.master * 1.44"></xsl:value-of>
22280 <xsl:text>pt</xsl:text>
22281 </xsl:attribute>
22282 </xsl:attribute-set>
22286 <refsection><info><title>Description</title></info>
22288 <para>The properties of level-3 section titles.</para>
22293 <refentry version="5.0" id="section.title.level4.properties">
22295 <refentrytitle>section.title.level4.properties</refentrytitle>
22296 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
22299 <refname>section.title.level4.properties</refname>
22300 <refpurpose>Properties for level-4 section titles</refpurpose>
22304 <programlisting id="section.title.level4.properties.frag">
22305 <xsl:attribute-set name="section.title.level4.properties">
22306 <xsl:attribute name="font-size">
22307 <xsl:value-of select="$body.font.master * 1.2"></xsl:value-of>
22308 <xsl:text>pt</xsl:text>
22309 </xsl:attribute>
22310 </xsl:attribute-set>
22314 <refsection><info><title>Description</title></info>
22316 <para>The properties of level-4 section titles.</para>
22321 <refentry version="5.0" id="section.title.level5.properties">
22323 <refentrytitle>section.title.level5.properties</refentrytitle>
22324 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
22327 <refname>section.title.level5.properties</refname>
22328 <refpurpose>Properties for level-5 section titles</refpurpose>
22332 <programlisting id="section.title.level5.properties.frag">
22333 <xsl:attribute-set name="section.title.level5.properties">
22334 <xsl:attribute name="font-size">
22335 <xsl:value-of select="$body.font.master"></xsl:value-of>
22336 <xsl:text>pt</xsl:text>
22337 </xsl:attribute>
22338 </xsl:attribute-set>
22342 <refsection><info><title>Description</title></info>
22344 <para>The properties of level-5 section titles.</para>
22349 <refentry version="5.0" id="section.title.level6.properties">
22351 <refentrytitle>section.title.level6.properties</refentrytitle>
22352 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
22355 <refname>section.title.level6.properties</refname>
22356 <refpurpose>Properties for level-6 section titles</refpurpose>
22360 <programlisting id="section.title.level6.properties.frag">
22361 <xsl:attribute-set name="section.title.level6.properties">
22362 <xsl:attribute name="font-size">
22363 <xsl:value-of select="$body.font.master"></xsl:value-of>
22364 <xsl:text>pt</xsl:text>
22365 </xsl:attribute>
22366 </xsl:attribute-set>
22370 <refsection><info><title>Description</title></info>
22372 <para>The properties of level-6 section titles. This property set is actually
22373 used for all titles below level 5.</para>
22378 <refentry version="5.0" id="section.properties">
22380 <refentrytitle>section.properties</refentrytitle>
22381 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
22384 <refname>section.properties</refname>
22385 <refpurpose>Properties for all section levels</refpurpose>
22389 <programlisting id="section.properties.frag">
22390 <xsl:attribute-set name="section.properties">
22391 </xsl:attribute-set>
22395 <refsection><info><title>Description</title></info>
22397 <para>The properties that apply to the containing
22398 block of all section levels, and therefore apply to
22400 This attribute set is inherited by the
22401 more specific attribute sets such as
22402 <tag>section.level1.properties</tag>.
22403 The default is empty.
22409 <refentry version="5.0" id="section.level1.properties">
22411 <refentrytitle>section.level1.properties</refentrytitle>
22412 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
22415 <refname>section.level1.properties</refname>
22416 <refpurpose>Properties for level-1 sections</refpurpose>
22420 <programlisting id="section.level1.properties.frag">
22421 <xsl:attribute-set name="section.level1.properties" use-attribute-sets="section.properties">
22422 </xsl:attribute-set>
22426 <refsection><info><title>Description</title></info>
22428 <para>The properties that apply to the containing
22429 block of a level-1 section, and therefore apply to
22430 the whole section. This includes <tag>sect1</tag>
22431 elements and <tag>section</tag> elements at level 1.
22434 <para>For example, you could start each level-1 section on
22435 a new page by using:</para>
22436 <programlisting><xsl:attribute-set name="section.level1.properties">
22437 <xsl:attribute name="break-before">page</xsl:attribute>
22438 </xsl:attribute-set>
22441 <para>This attribute set inherits attributes from the
22442 general <tag>section.properties</tag> attribute set.
22448 <refentry version="5.0" id="section.level2.properties">
22450 <refentrytitle>section.level2.properties</refentrytitle>
22451 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
22454 <refname>section.level2.properties</refname>
22455 <refpurpose>Properties for level-2 sections</refpurpose>
22459 <programlisting id="section.level2.properties.frag">
22460 <xsl:attribute-set name="section.level2.properties" use-attribute-sets="section.properties">
22461 </xsl:attribute-set>
22465 <refsection><info><title>Description</title></info>
22467 <para>The properties that apply to the containing
22468 block of a level-2 section, and therefore apply to
22469 the whole section. This includes <tag>sect2</tag>
22470 elements and <tag>section</tag> elements at level 2.
22473 <para>For example, you could start each level-2 section on
22474 a new page by using:</para>
22475 <programlisting><xsl:attribute-set name="section.level2.properties">
22476 <xsl:attribute name="break-before">page</xsl:attribute>
22477 </xsl:attribute-set>
22480 <para>This attribute set inherits attributes from the
22481 general <tag>section.properties</tag> attribute set.
22487 <refentry version="5.0" id="section.level3.properties">
22489 <refentrytitle>section.level3.properties</refentrytitle>
22490 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
22493 <refname>section.level3.properties</refname>
22494 <refpurpose>Properties for level-3 sections</refpurpose>
22498 <programlisting id="section.level3.properties.frag">
22499 <xsl:attribute-set name="section.level3.properties" use-attribute-sets="section.properties">
22500 </xsl:attribute-set>
22504 <refsection><info><title>Description</title></info>
22506 <para>The properties that apply to the containing
22507 block of a level-3 section, and therefore apply to
22508 the whole section. This includes <tag>sect3</tag>
22509 elements and <tag>section</tag> elements at level 3.
22512 <para>For example, you could start each level-3 section on
22513 a new page by using:</para>
22514 <programlisting><xsl:attribute-set name="section.level3.properties">
22515 <xsl:attribute name="break-before">page</xsl:attribute>
22516 </xsl:attribute-set>
22519 <para>This attribute set inherits attributes from the
22520 general <tag>section.properties</tag> attribute set.
22526 <refentry version="5.0" id="section.level4.properties">
22528 <refentrytitle>section.level4.properties</refentrytitle>
22529 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
22532 <refname>section.level4.properties</refname>
22533 <refpurpose>Properties for level-4 sections</refpurpose>
22537 <programlisting id="section.level4.properties.frag">
22538 <xsl:attribute-set name="section.level4.properties" use-attribute-sets="section.properties">
22539 </xsl:attribute-set>
22543 <refsection><info><title>Description</title></info>
22545 <para>The properties that apply to the containing
22546 block of a level-4 section, and therefore apply to
22547 the whole section. This includes <tag>sect4</tag>
22548 elements and <tag>section</tag> elements at level 4.
22551 <para>For example, you could start each level-4 section on
22552 a new page by using:</para>
22553 <programlisting><xsl:attribute-set name="section.level4.properties">
22554 <xsl:attribute name="break-before">page</xsl:attribute>
22555 </xsl:attribute-set>
22558 <para>This attribute set inherits attributes from the
22559 general <tag>section.properties</tag> attribute set.
22565 <refentry version="5.0" id="section.level5.properties">
22567 <refentrytitle>section.level5.properties</refentrytitle>
22568 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
22571 <refname>section.level5.properties</refname>
22572 <refpurpose>Properties for level-5 sections</refpurpose>
22576 <programlisting id="section.level5.properties.frag">
22577 <xsl:attribute-set name="section.level5.properties" use-attribute-sets="section.properties">
22578 </xsl:attribute-set>
22582 <refsection><info><title>Description</title></info>
22584 <para>The properties that apply to the containing
22585 block of a level-5 section, and therefore apply to
22586 the whole section. This includes <tag>sect5</tag>
22587 elements and <tag>section</tag> elements at level 5.
22590 <para>For example, you could start each level-5 section on
22591 a new page by using:</para>
22592 <programlisting><xsl:attribute-set name="section.level5.properties">
22593 <xsl:attribute name="break-before">page</xsl:attribute>
22594 </xsl:attribute-set>
22597 <para>This attribute set inherits attributes from the
22598 general <tag>section.properties</tag> attribute set.
22604 <refentry version="5.0" id="section.level6.properties">
22606 <refentrytitle>section.level6.properties</refentrytitle>
22607 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
22610 <refname>section.level6.properties</refname>
22611 <refpurpose>Properties for level-6 sections</refpurpose>
22615 <programlisting id="section.level6.properties.frag">
22616 <xsl:attribute-set name="section.level6.properties" use-attribute-sets="section.properties">
22617 </xsl:attribute-set>
22621 <refsection><info><title>Description</title></info>
22623 <para>The properties that apply to the containing
22624 block of a level 6 or lower section, and therefore apply to
22625 the whole section. This includes
22626 <tag>section</tag> elements at level 6 and lower.
22629 <para>For example, you could start each level-6 section on
22630 a new page by using:</para>
22631 <programlisting><xsl:attribute-set name="section.level6.properties">
22632 <xsl:attribute name="break-before">page</xsl:attribute>
22633 </xsl:attribute-set>
22636 <para>This attribute set inherits attributes from the
22637 general <tag>section.properties</tag> attribute set.
22643 <refentry version="5.0" id="figure.properties">
22645 <refentrytitle>figure.properties</refentrytitle>
22646 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
22649 <refname>figure.properties</refname>
22650 <refpurpose>Properties associated with a figure</refpurpose>
22654 <programlisting id="figure.properties.frag">
22655 <xsl:attribute-set name="figure.properties" use-attribute-sets="formal.object.properties"></xsl:attribute-set>
22659 <refsection><info><title>Description</title></info>
22661 <para>The styling for figures.</para>
22666 <refentry version="5.0" id="example.properties">
22668 <refentrytitle>example.properties</refentrytitle>
22669 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
22672 <refname>example.properties</refname>
22673 <refpurpose>Properties associated with a example</refpurpose>
22677 <programlisting id="example.properties.frag">
22678 <xsl:attribute-set name="example.properties" use-attribute-sets="formal.object.properties">
22679 <xsl:attribute name="keep-together.within-column">auto</xsl:attribute>
22680 </xsl:attribute-set>
22684 <refsection><info><title>Description</title></info>
22686 <para>The styling for examples.</para>
22691 <refentry version="5.0" id="equation.properties">
22693 <refentrytitle>equation.properties</refentrytitle>
22694 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
22697 <refname>equation.properties</refname>
22698 <refpurpose>Properties associated with a equation</refpurpose>
22702 <programlisting id="equation.properties.frag">
22703 <xsl:attribute-set name="equation.properties" use-attribute-sets="formal.object.properties"></xsl:attribute-set>
22707 <refsection><info><title>Description</title></info>
22709 <para>The styling for equations.</para>
22714 <refentry version="5.0" id="equation.number.properties">
22716 <refentrytitle>equation.number.properties</refentrytitle>
22717 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
22720 <refname>equation.number.properties</refname>
22721 <refpurpose>Properties that apply to the <tag>fo:table-cell</tag> containing the number
22722 of an <tag>equation</tag> that does not have a title.</refpurpose>
22726 <programlisting id="equation.number.properties.frag"><xsl:attribute-set name="equation.number.properties">
22727 <xsl:attribute name="text-align">end</xsl:attribute>
22728 <xsl:attribute name="display-align">center</xsl:attribute>
22729 </xsl:attribute-set></programlisting>
22731 <refsection><info><title>Description</title></info>
22732 <para>Properties that apply to the fo:table-cell containing the number
22733 of an equation when it has no title. The number in an equation with a
22734 title is formatted along with the title, and this attribute-set does not apply.</para>
22738 <refentry version="5.0" id="table.properties">
22740 <refentrytitle>table.properties</refentrytitle>
22741 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
22744 <refname>table.properties</refname>
22745 <refpurpose>Properties associated with the block surrounding a table</refpurpose>
22749 <programlisting id="table.properties.frag">
22750 <xsl:attribute-set name="table.properties" use-attribute-sets="formal.object.properties">
22751 <xsl:attribute name="keep-together.within-column">auto</xsl:attribute>
22752 </xsl:attribute-set>
22756 <refsection><info><title>Description</title></info>
22758 <para>Block styling properties for tables. This parameter should really
22759 have been called <literal>table.block.properties</literal> or something
22760 like that, but we’re leaving it to avoid backwards-compatibility
22763 <para>See also <parameter>table.table.properties</parameter>.</para>
22768 <refentry version="5.0" id="task.properties">
22770 <refentrytitle>task.properties</refentrytitle>
22771 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
22774 <refname>task.properties</refname>
22775 <refpurpose>Properties associated with a task</refpurpose>
22779 <programlisting id="task.properties.frag">
22780 <xsl:attribute-set name="task.properties" use-attribute-sets="formal.object.properties">
22781 <xsl:attribute name="keep-together.within-column">auto</xsl:attribute>
22782 </xsl:attribute-set>
22786 <refsection><info><title>Description</title></info>
22788 <para>Properties to style the entire block containing a task element.</para>
22793 <refentry version="5.0" id="informalfigure.properties">
22795 <refentrytitle>informalfigure.properties</refentrytitle>
22796 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
22799 <refname>informalfigure.properties</refname>
22800 <refpurpose>Properties associated with an informalfigure</refpurpose>
22804 <programlisting id="informalfigure.properties.frag">
22805 <xsl:attribute-set name="informalfigure.properties" use-attribute-sets="informal.object.properties"></xsl:attribute-set>
22809 <refsection><info><title>Description</title></info>
22811 <para>The styling for informalfigures.</para>
22816 <refentry version="5.0" id="informalexample.properties">
22818 <refentrytitle>informalexample.properties</refentrytitle>
22819 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
22822 <refname>informalexample.properties</refname>
22823 <refpurpose>Properties associated with an informalexample</refpurpose>
22827 <programlisting id="informalexample.properties.frag">
22828 <xsl:attribute-set name="informalexample.properties" use-attribute-sets="informal.object.properties"></xsl:attribute-set>
22832 <refsection><info><title>Description</title></info>
22834 <para>The styling for informalexamples.</para>
22839 <refentry version="5.0" id="informalequation.properties">
22841 <refentrytitle>informalequation.properties</refentrytitle>
22842 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
22845 <refname>informalequation.properties</refname>
22846 <refpurpose>Properties associated with an informalequation</refpurpose>
22850 <programlisting id="informalequation.properties.frag">
22851 <xsl:attribute-set name="informalequation.properties" use-attribute-sets="informal.object.properties"></xsl:attribute-set>
22855 <refsection><info><title>Description</title></info>
22857 <para>The styling for informalequations.</para>
22862 <refentry version="5.0" id="informaltable.properties">
22864 <refentrytitle>informaltable.properties</refentrytitle>
22865 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
22868 <refname>informaltable.properties</refname>
22869 <refpurpose>Properties associated with the block surrounding an informaltable</refpurpose>
22873 <programlisting id="informaltable.properties.frag">
22874 <xsl:attribute-set name="informaltable.properties" use-attribute-sets="informal.object.properties"></xsl:attribute-set>
22878 <refsection><info><title>Description</title></info>
22880 <para>Block styling properties for informaltables. This parameter should really
22881 have been called <literal>informaltable.block.properties</literal> or something
22882 like that, but we’re leaving it to avoid backwards-compatibility
22885 <para>See also <parameter>table.table.properties</parameter>.</para>
22890 <refentry version="5.0" id="procedure.properties">
22892 <refentrytitle>procedure.properties</refentrytitle>
22893 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
22896 <refname>procedure.properties</refname>
22897 <refpurpose>Properties associated with a procedure</refpurpose>
22901 <programlisting id="procedure.properties.frag">
22902 <xsl:attribute-set name="procedure.properties" use-attribute-sets="formal.object.properties">
22903 <xsl:attribute name="keep-together.within-column">auto</xsl:attribute>
22904 </xsl:attribute-set>
22908 <refsection><info><title>Description</title></info>
22910 <para>The styling for procedures.</para>
22915 <refentry version="5.0" id="root.properties">
22917 <refentrytitle>root.properties</refentrytitle>
22918 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
22921 <refname>root.properties</refname>
22922 <refpurpose>The properties of the fo:root element</refpurpose>
22926 <programlisting id="root.properties.frag">
22927 <xsl:attribute-set name="root.properties">
22928 <xsl:attribute name="font-family">
22929 <xsl:value-of select="$body.fontset"></xsl:value-of>
22930 </xsl:attribute>
22931 <xsl:attribute name="font-size">
22932 <xsl:value-of select="$body.font.size"></xsl:value-of>
22933 </xsl:attribute>
22934 <xsl:attribute name="text-align">
22935 <xsl:value-of select="$alignment"></xsl:value-of>
22936 </xsl:attribute>
22937 <xsl:attribute name="line-height">
22938 <xsl:value-of select="$line-height"></xsl:value-of>
22939 </xsl:attribute>
22940 <xsl:attribute name="font-selection-strategy">character-by-character</xsl:attribute>
22941 <xsl:attribute name="line-height-shift-adjustment">disregard-shifts</xsl:attribute>
22942 <xsl:attribute name="writing-mode">
22943 <xsl:value-of select="$direction.mode"></xsl:value-of>
22944 </xsl:attribute>
22945 </xsl:attribute-set>
22949 <refsection><info><title>Description</title></info>
22951 <para>This property set is used on the <tag>fo:root</tag> element of
22952 an FO file. It defines a set of default, global parameters.</para>
22957 <refentry version="5.0" id="qanda.title.properties">
22959 <refentrytitle>qanda.title.properties</refentrytitle>
22960 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
22963 <refname>qanda.title.properties</refname>
22964 <refpurpose>Properties for qanda set titles</refpurpose>
22968 <programlisting id="qanda.title.properties.frag">
22969 <xsl:attribute-set name="qanda.title.properties">
22970 <xsl:attribute name="font-family">
22971 <xsl:value-of select="$title.fontset"></xsl:value-of>
22972 </xsl:attribute>
22973 <xsl:attribute name="font-weight">bold</xsl:attribute>
22974 <!-- font size is calculated dynamically by qanda.heading template -->
22975 <xsl:attribute name="keep-with-next.within-column">always</xsl:attribute>
22976 <xsl:attribute name="space-before.minimum">0.8em</xsl:attribute>
22977 <xsl:attribute name="space-before.optimum">1.0em</xsl:attribute>
22978 <xsl:attribute name="space-before.maximum">1.2em</xsl:attribute>
22979 </xsl:attribute-set>
22983 <refsection><info><title>Description</title></info>
22985 <para>The properties common to all qanda set titles.</para>
22990 <refentry version="5.0" id="qanda.title.level1.properties">
22992 <refentrytitle>qanda.title.level1.properties</refentrytitle>
22993 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
22996 <refname>qanda.title.level1.properties</refname>
22997 <refpurpose>Properties for level-1 qanda set titles</refpurpose>
23001 <programlisting id="qanda.title.level1.properties.frag">
23002 <xsl:attribute-set name="qanda.title.level1.properties">
23003 <xsl:attribute name="font-size">
23004 <xsl:value-of select="$body.font.master * 2.0736"></xsl:value-of>
23005 <xsl:text>pt</xsl:text>
23006 </xsl:attribute>
23007 </xsl:attribute-set>
23011 <refsection><info><title>Description</title></info>
23013 <para>The properties of level-1 qanda set titles.</para>
23018 <refentry version="5.0" id="qanda.title.level2.properties">
23020 <refentrytitle>qanda.title.level2.properties</refentrytitle>
23021 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
23024 <refname>qanda.title.level2.properties</refname>
23025 <refpurpose>Properties for level-2 qanda set titles</refpurpose>
23029 <programlisting id="qanda.title.level2.properties.frag">
23030 <xsl:attribute-set name="qanda.title.level2.properties">
23031 <xsl:attribute name="font-size">
23032 <xsl:value-of select="$body.font.master * 1.728"></xsl:value-of>
23033 <xsl:text>pt</xsl:text>
23034 </xsl:attribute>
23035 </xsl:attribute-set>
23039 <refsection><info><title>Description</title></info>
23041 <para>The properties of level-2 qanda set titles.</para>
23046 <refentry version="5.0" id="qanda.title.level3.properties">
23048 <refentrytitle>qanda.title.level3.properties</refentrytitle>
23049 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
23052 <refname>qanda.title.level3.properties</refname>
23053 <refpurpose>Properties for level-3 qanda set titles</refpurpose>
23057 <programlisting id="qanda.title.level3.properties.frag">
23058 <xsl:attribute-set name="qanda.title.level3.properties">
23059 <xsl:attribute name="font-size">
23060 <xsl:value-of select="$body.font.master * 1.44"></xsl:value-of>
23061 <xsl:text>pt</xsl:text>
23062 </xsl:attribute>
23063 </xsl:attribute-set>
23067 <refsection><info><title>Description</title></info>
23069 <para>The properties of level-3 qanda set titles.</para>
23074 <refentry version="5.0" id="qanda.title.level4.properties">
23076 <refentrytitle>qanda.title.level4.properties</refentrytitle>
23077 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
23080 <refname>qanda.title.level4.properties</refname>
23081 <refpurpose>Properties for level-4 qanda set titles</refpurpose>
23085 <programlisting id="qanda.title.level4.properties.frag">
23086 <xsl:attribute-set name="qanda.title.level4.properties">
23087 <xsl:attribute name="font-size">
23088 <xsl:value-of select="$body.font.master * 1.2"></xsl:value-of>
23089 <xsl:text>pt</xsl:text>
23090 </xsl:attribute>
23091 </xsl:attribute-set>
23095 <refsection><info><title>Description</title></info>
23097 <para>The properties of level-4 qanda set titles.</para>
23102 <refentry version="5.0" id="qanda.title.level5.properties">
23104 <refentrytitle>qanda.title.level5.properties</refentrytitle>
23105 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
23108 <refname>qanda.title.level5.properties</refname>
23109 <refpurpose>Properties for level-5 qanda set titles</refpurpose>
23113 <programlisting id="qanda.title.level5.properties.frag">
23114 <xsl:attribute-set name="qanda.title.level5.properties">
23115 <xsl:attribute name="font-size">
23116 <xsl:value-of select="$body.font.master"></xsl:value-of>
23117 <xsl:text>pt</xsl:text>
23118 </xsl:attribute>
23119 </xsl:attribute-set>
23123 <refsection><info><title>Description</title></info>
23125 <para>The properties of level-5 qanda set titles.</para>
23130 <refentry version="5.0" id="qanda.title.level6.properties">
23132 <refentrytitle>qanda.title.level6.properties</refentrytitle>
23133 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
23136 <refname>qanda.title.level6.properties</refname>
23137 <refpurpose>Properties for level-6 qanda set titles</refpurpose>
23141 <programlisting id="qanda.title.level6.properties.frag">
23142 <xsl:attribute-set name="qanda.title.level6.properties">
23143 <xsl:attribute name="font-size">
23144 <xsl:value-of select="$body.font.master"></xsl:value-of>
23145 <xsl:text>pt</xsl:text>
23146 </xsl:attribute>
23147 </xsl:attribute-set>
23151 <refsection><info><title>Description</title></info>
23153 <para>The properties of level-6 qanda set titles.
23154 This property set is actually
23155 used for all titles below level 5.</para>
23160 <refentry version="5.0" id="article.appendix.title.properties">
23162 <refentrytitle>article.appendix.title.properties</refentrytitle>
23163 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
23166 <refname>article.appendix.title.properties</refname>
23167 <refpurpose>Properties for appendix titles that appear in an article</refpurpose>
23171 <programlisting id="article.appendix.title.properties.frag">
23172 <xsl:attribute-set name="article.appendix.title.properties" use-attribute-sets="section.title.properties section.title.level1.properties">
23173 </xsl:attribute-set>
23177 <refsection><info><title>Description</title></info>
23179 <para>The properties for the title of an appendix that
23180 appears inside an article. The default is to use
23181 the properties of sect1 titles.</para>
23186 <refentry version="5.0" id="abstract.properties">
23188 <refentrytitle>abstract.properties</refentrytitle>
23189 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
23192 <refname>abstract.properties</refname>
23193 <refpurpose>Properties associated with the block surrounding an abstract</refpurpose>
23197 <programlisting id="abstract.properties.frag">
23198 <xsl:attribute-set name="abstract.properties">
23199 <xsl:attribute name="start-indent">0.0in</xsl:attribute>
23200 <xsl:attribute name="end-indent">0.0in</xsl:attribute>
23201 </xsl:attribute-set>
23205 <refsection><info><title>Description</title></info>
23207 <para>Block styling properties for abstract.</para>
23209 <para>See also <parameter>abstract.title.properties</parameter>.</para>
23214 <refentry version="5.0" id="abstract.title.properties">
23216 <refentrytitle>abstract.title.properties</refentrytitle>
23217 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
23220 <refname>abstract.title.properties</refname>
23221 <refpurpose>Properties for abstract titles</refpurpose>
23225 <programlisting id="abstract.title.properties.frag">
23226 <xsl:attribute-set name="abstract.title.properties">
23227 <xsl:attribute name="font-family"><xsl:value-of select="$title.fontset"></xsl:value-of></xsl:attribute>
23228 <xsl:attribute name="font-weight">bold</xsl:attribute>
23229 <xsl:attribute name="keep-with-next.within-column">always</xsl:attribute>
23230 <xsl:attribute name="keep-with-next.within-column">always</xsl:attribute>
23231 <xsl:attribute name="space-before.optimum"><xsl:value-of select="concat($body.font.master, 'pt')"></xsl:value-of></xsl:attribute>
23232 <xsl:attribute name="space-before.minimum"><xsl:value-of select="concat($body.font.master, 'pt * 0.8')"></xsl:value-of></xsl:attribute>
23233 <xsl:attribute name="space-before.maximum"><xsl:value-of select="concat($body.font.master, 'pt * 1.2')"></xsl:value-of></xsl:attribute>
23234 <xsl:attribute name="hyphenate">false</xsl:attribute>
23235 <xsl:attribute name="text-align">center</xsl:attribute>
23236 </xsl:attribute-set>
23240 <refsection><info><title>Description</title></info>
23242 <para>The properties for abstract titles.</para>
23244 <para>See also <parameter>abstract.properties</parameter>.</para>
23249 <refentry version="5.0" id="index.page.number.properties">
23251 <refentrytitle>index.page.number.properties</refentrytitle>
23252 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
23255 <refname>index.page.number.properties</refname>
23256 <refpurpose>Properties associated with index page numbers</refpurpose>
23260 <programlisting id="index.page.number.properties.frag">
23261 <xsl:attribute-set name="index.page.number.properties">
23262 </xsl:attribute-set>
23266 <refsection><info><title>Description</title></info>
23268 <para>Properties associated with page numbers in indexes.
23269 Changing color to indicate the page number is a link is
23276 <refentry version="5.0" id="revhistory.table.properties">
23278 <refentrytitle>revhistory.table.properties</refentrytitle>
23279 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
23282 <refname>revhistory.table.properties</refname>
23283 <refpurpose>The properties of table used for formatting revhistory</refpurpose>
23287 <programlisting id="revhistory.table.properties.frag">
23288 <xsl:attribute-set name="revhistory.table.properties">
23289 </xsl:attribute-set>
23293 <refsection><info><title>Description</title></info>
23295 <para>This property set defines appearance of revhistory table.</para>
23300 <refentry version="5.0" id="revhistory.table.cell.properties">
23302 <refentrytitle>revhistory.table.cell.properties</refentrytitle>
23303 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
23306 <refname>revhistory.table.cell.properties</refname>
23307 <refpurpose>The properties of table cells used for formatting revhistory</refpurpose>
23311 <programlisting id="revhistory.table.cell.properties.frag">
23312 <xsl:attribute-set name="revhistory.table.cell.properties">
23313 </xsl:attribute-set>
23317 <refsection><info><title>Description</title></info>
23319 <para>This property set defines appearance of individual cells in revhistory table.</para>
23324 <refentry version="5.0" id="revhistory.title.properties">
23326 <refentrytitle>revhistory.title.properties</refentrytitle>
23327 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
23330 <refname>revhistory.title.properties</refname>
23331 <refpurpose>The properties of revhistory title</refpurpose>
23335 <programlisting id="revhistory.title.properties.frag">
23336 <xsl:attribute-set name="revhistory.title.properties">
23337 </xsl:attribute-set>
23341 <refsection><info><title>Description</title></info>
23343 <para>This property set defines appearance of revhistory title.</para>
23348 </reference><reference id="profiling" xml:base="../fo/param.xml"><title>Profiling</title>
23349 <partintro id="profiling_partintro">
23350 <para>The following parameters can be used for attribute-based
23351 profiling of your document. For more information about profiling, see
23352 <link role="tcg" xlink:href="Profiling.html">Profiling (conditional text)</link>.</para>
23354 <refentry version="5.0" id="profile.arch">
23356 <refentrytitle>profile.arch</refentrytitle>
23357 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
23360 <refname>profile.arch</refname>
23361 <refpurpose>Target profile for <tag class="attribute">arch</tag>
23362 attribute</refpurpose>
23366 <programlisting id="profile.arch.frag">
23367 <xsl:param name="profile.arch"></xsl:param>
23372 <refsection><info><title>Description</title></info>
23374 <para>The value of this parameter specifies profiles which should be
23375 included in the output. You can specify multiple profiles by
23376 separating them by semicolon. You can change separator character by
23377 <parameter>profile.separator</parameter>
23380 <para>This parameter has effect only when you are using profiling
23381 stylesheets (<filename>profile-docbook.xsl</filename>,
23382 <filename>profile-chunk.xsl</filename>, …) instead of normal
23383 ones (<filename>docbook.xsl</filename>,
23384 <filename>chunk.xsl</filename>, …).</para>
23389 <refentry version="5.0" id="profile.audience">
23391 <refentrytitle>profile.audience</refentrytitle>
23392 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
23395 <refname>profile.audience</refname>
23396 <refpurpose>Target profile for <tag class="attribute">audience</tag>
23397 attribute</refpurpose>
23401 <programlisting id="profile.audience.frag">
23402 <xsl:param name="profile.audience"></xsl:param>
23406 <refsection><info><title>Description</title></info>
23408 <para>Value of this parameter specifies profiles which should be
23409 included in the output. You can specify multiple profiles by
23410 separating them by semicolon. You can change separator character by
23411 <parameter>profile.separator</parameter>
23414 <para>This parameter has effect only when you are using profiling
23415 stylesheets (<filename>profile-docbook.xsl</filename>,
23416 <filename>profile-chunk.xsl</filename>, …) instead of normal
23417 ones (<filename>docbook.xsl</filename>,
23418 <filename>chunk.xsl</filename>, …).</para>
23423 <refentry version="5.0" id="profile.condition">
23425 <refentrytitle>profile.condition</refentrytitle>
23426 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
23429 <refname>profile.condition</refname>
23430 <refpurpose>Target profile for <tag class="attribute">condition</tag>
23431 attribute</refpurpose>
23435 <programlisting id="profile.condition.frag">
23436 <xsl:param name="profile.condition"></xsl:param>
23440 <refsection><info><title>Description</title></info>
23442 <para>The value of this parameter specifies profiles which should be
23443 included in the output. You can specify multiple profiles by
23444 separating them by semicolon. You can change separator character by
23445 <parameter>profile.separator</parameter>
23448 <para>This parameter has effect only when you are using profiling
23449 stylesheets (<filename>profile-docbook.xsl</filename>,
23450 <filename>profile-chunk.xsl</filename>, …) instead of normal
23451 ones (<filename>docbook.xsl</filename>,
23452 <filename>chunk.xsl</filename>, …).</para>
23457 <refentry version="5.0" id="profile.conformance">
23459 <refentrytitle>profile.conformance</refentrytitle>
23460 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
23463 <refname>profile.conformance</refname>
23464 <refpurpose>Target profile for <tag class="attribute">conformance</tag>
23465 attribute</refpurpose>
23469 <programlisting id="profile.conformance.frag">
23470 <xsl:param name="profile.conformance"></xsl:param>
23474 <refsection><info><title>Description</title></info>
23476 <para>The value of this parameter specifies profiles which should be
23477 included in the output. You can specify multiple profiles by
23478 separating them by semicolon. You can change separator character by
23479 <parameter>profile.separator</parameter>
23482 <para>This parameter has effect only when you are using profiling
23483 stylesheets (<filename>profile-docbook.xsl</filename>,
23484 <filename>profile-chunk.xsl</filename>, …) instead of normal
23485 ones (<filename>docbook.xsl</filename>,
23486 <filename>chunk.xsl</filename>, …).</para>
23491 <refentry version="5.0" id="profile.lang">
23493 <refentrytitle>profile.lang</refentrytitle>
23494 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
23497 <refname>profile.lang</refname>
23498 <refpurpose>Target profile for <tag class="attribute">lang</tag>
23499 attribute</refpurpose>
23503 <programlisting id="profile.lang.frag">
23504 <xsl:param name="profile.lang"></xsl:param>
23508 <refsection><info><title>Description</title></info>
23510 <para>The value of this parameter specifies profiles which should be
23511 included in the output. You can specify multiple profiles by
23512 separating them by semicolon. You can change separator character by
23513 <parameter>profile.separator</parameter>
23516 <para>This parameter has effect only when you are using profiling
23517 stylesheets (<filename>profile-docbook.xsl</filename>,
23518 <filename>profile-chunk.xsl</filename>, …) instead of normal
23519 ones (<filename>docbook.xsl</filename>,
23520 <filename>chunk.xsl</filename>, …).</para>
23525 <refentry version="5.0" id="profile.os">
23527 <refentrytitle>profile.os</refentrytitle>
23528 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
23531 <refname>profile.os</refname>
23532 <refpurpose>Target profile for <tag class="attribute">os</tag>
23533 attribute</refpurpose>
23537 <programlisting id="profile.os.frag">
23538 <xsl:param name="profile.os"></xsl:param>
23542 <refsection><info><title>Description</title></info>
23544 <para>The value of this parameter specifies profiles which should be
23545 included in the output. You can specify multiple profiles by
23546 separating them by semicolon. You can change separator character by
23547 <parameter>profile.separator</parameter>
23550 <para>This parameter has effect only when you are using profiling
23551 stylesheets (<filename>profile-docbook.xsl</filename>,
23552 <filename>profile-chunk.xsl</filename>, …) instead of normal
23553 ones (<filename>docbook.xsl</filename>,
23554 <filename>chunk.xsl</filename>, …).</para>
23559 <refentry version="5.0" id="profile.outputformat">
23561 <refentrytitle>profile.outputformat</refentrytitle>
23562 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
23565 <refname>profile.outputformat</refname>
23566 <refpurpose>Target profile for <tag class="attribute">outputformat</tag> attribute</refpurpose>
23570 <programlisting id="profile.outputformat.frag">
23571 <xsl:param name="profile.outputformat"></xsl:param>
23575 <refsection><info><title>Description</title></info>
23577 <para>The value of this parameter specifies profiles which should be
23578 included in the output. You can specify multiple profiles by
23579 separating them by semicolon. You can change separator character by
23580 <parameter>profile.separator</parameter>
23583 <para>This parameter has effect only when you are using profiling
23584 stylesheets (<filename>profile-docbook.xsl</filename>,
23585 <filename>profile-chunk.xsl</filename>, …) instead of normal
23586 ones (<filename>docbook.xsl</filename>,
23587 <filename>chunk.xsl</filename>, …).</para>
23592 <refentry version="5.0" id="profile.revision">
23594 <refentrytitle>profile.revision</refentrytitle>
23595 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
23598 <refname>profile.revision</refname>
23599 <refpurpose>Target profile for <tag class="attribute">revision</tag>
23600 attribute</refpurpose>
23604 <programlisting id="profile.revision.frag">
23605 <xsl:param name="profile.revision"></xsl:param>
23609 <refsection><info><title>Description</title></info>
23611 <para>The value of this parameter specifies profiles which should be
23612 included in the output. You can specify multiple profiles by
23613 separating them by semicolon. You can change separator character by
23614 <parameter>profile.separator</parameter>
23617 <para>This parameter has effect only when you are using profiling
23618 stylesheets (<filename>profile-docbook.xsl</filename>,
23619 <filename>profile-chunk.xsl</filename>, …) instead of normal
23620 ones (<filename>docbook.xsl</filename>,
23621 <filename>chunk.xsl</filename>, …).</para>
23626 <refentry version="5.0" id="profile.revisionflag">
23628 <refentrytitle>profile.revisionflag</refentrytitle>
23629 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
23632 <refname>profile.revisionflag</refname>
23633 <refpurpose>Target profile for <tag class="attribute">revisionflag</tag>
23634 attribute</refpurpose>
23638 <programlisting id="profile.revisionflag.frag">
23639 <xsl:param name="profile.revisionflag"></xsl:param>
23643 <refsection><info><title>Description</title></info>
23645 <para>The value of this parameter specifies profiles which should be
23646 included in the output. You can specify multiple profiles by
23647 separating them by semicolon. You can change separator character by
23648 <parameter>profile.separator</parameter>
23651 <para>This parameter has effect only when you are using profiling
23652 stylesheets (<filename>profile-docbook.xsl</filename>,
23653 <filename>profile-chunk.xsl</filename>, …) instead of normal
23654 ones (<filename>docbook.xsl</filename>,
23655 <filename>chunk.xsl</filename>, …).</para>
23660 <refentry version="5.0" id="profile.role">
23662 <refentrytitle>profile.role</refentrytitle>
23663 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
23666 <refname>profile.role</refname>
23667 <refpurpose>Target profile for <tag class="attribute">role</tag>
23668 attribute</refpurpose>
23672 <programlisting id="profile.role.frag">
23673 <xsl:param name="profile.role"></xsl:param>
23677 <refsection><info><title>Description</title></info>
23679 <para>The value of this parameter specifies profiles which should be
23680 included in the output. You can specify multiple profiles by
23681 separating them by semicolon. You can change separator character by
23682 <parameter>profile.separator</parameter>
23685 <para>This parameter has effect only when you are using profiling
23686 stylesheets (<filename>profile-docbook.xsl</filename>,
23687 <filename>profile-chunk.xsl</filename>, …) instead of normal
23688 ones (<filename>docbook.xsl</filename>,
23689 <filename>chunk.xsl</filename>, …).</para>
23692 <para>Note that <tag class="attribute">role</tag> is often
23693 used for other purposes than profiling. For example it is commonly
23694 used to get emphasize in bold font:</para>
23696 <programlisting><emphasis role="bold">very important</emphasis></programlisting>
23698 <para>If you are using <tag class="attribute">role</tag> for
23699 these purposes do not forget to add values like <literal>bold</literal> to
23700 value of this parameter. If you forgot you will get document with
23701 small pieces missing which are very hard to track.</para>
23703 <para>For this reason it is not recommended to use <tag class="attribute">role</tag> attribute for profiling. You should
23704 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>
23710 <refentry version="5.0" id="profile.security">
23712 <refentrytitle>profile.security</refentrytitle>
23713 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
23716 <refname>profile.security</refname>
23717 <refpurpose>Target profile for <tag class="attribute">security</tag>
23718 attribute</refpurpose>
23722 <programlisting id="profile.security.frag">
23723 <xsl:param name="profile.security"></xsl:param>
23727 <refsection><info><title>Description</title></info>
23729 <para>The value of this parameter specifies profiles which should be
23730 included in the output. You can specify multiple profiles by
23731 separating them by semicolon. You can change separator character by
23732 <parameter>profile.separator</parameter>
23735 <para>This parameter has effect only when you are using profiling
23736 stylesheets (<filename>profile-docbook.xsl</filename>,
23737 <filename>profile-chunk.xsl</filename>, …) instead of normal
23738 ones (<filename>docbook.xsl</filename>,
23739 <filename>chunk.xsl</filename>, …).</para>
23744 <refentry version="5.0" id="profile.status">
23746 <refentrytitle>profile.status</refentrytitle>
23747 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
23750 <refname>profile.status</refname>
23751 <refpurpose>Target profile for <tag class="attribute">status</tag>
23752 attribute</refpurpose>
23756 <programlisting id="profile.status.frag">
23757 <xsl:param name="profile.status"></xsl:param>
23761 <refsection><info><title>Description</title></info>
23763 <para>The value of this parameter specifies profiles which should be
23764 included in the output. You can specify multiple profiles by
23765 separating them by semicolon. You can change separator character by
23766 <parameter>profile.separator</parameter>
23769 <para>This parameter has effect only when you are using profiling
23770 stylesheets (<filename>profile-docbook.xsl</filename>,
23771 <filename>profile-chunk.xsl</filename>, …) instead of normal
23772 ones (<filename>docbook.xsl</filename>,
23773 <filename>chunk.xsl</filename>, …).</para>
23778 <refentry version="5.0" id="profile.userlevel">
23780 <refentrytitle>profile.userlevel</refentrytitle>
23781 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
23784 <refname>profile.userlevel</refname>
23785 <refpurpose>Target profile for <tag class="attribute">userlevel</tag>
23786 attribute</refpurpose>
23790 <programlisting id="profile.userlevel.frag">
23791 <xsl:param name="profile.userlevel"></xsl:param>
23795 <refsection><info><title>Description</title></info>
23797 <para>The value of this parameter specifies profiles which should be
23798 included in the output. You can specify multiple profiles by
23799 separating them by semicolon. You can change separator character by
23800 <parameter>profile.separator</parameter>
23803 <para>This parameter has effect only when you are using profiling
23804 stylesheets (<filename>profile-docbook.xsl</filename>,
23805 <filename>profile-chunk.xsl</filename>, …) instead of normal
23806 ones (<filename>docbook.xsl</filename>,
23807 <filename>chunk.xsl</filename>, …).</para>
23812 <refentry version="5.0" id="profile.vendor">
23814 <refentrytitle>profile.vendor</refentrytitle>
23815 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
23818 <refname>profile.vendor</refname>
23819 <refpurpose>Target profile for <tag class="attribute">vendor</tag>
23820 attribute</refpurpose>
23824 <programlisting id="profile.vendor.frag">
23825 <xsl:param name="profile.vendor"></xsl:param>
23829 <refsection><info><title>Description</title></info>
23831 <para>The value of this parameter specifies profiles which should be
23832 included in the output. You can specify multiple profiles by
23833 separating them by semicolon. You can change separator character by
23834 <parameter>profile.separator</parameter>
23837 <para>This parameter has effect only when you are using profiling
23838 stylesheets (<filename>profile-docbook.xsl</filename>,
23839 <filename>profile-chunk.xsl</filename>, …) instead of normal
23840 ones (<filename>docbook.xsl</filename>,
23841 <filename>chunk.xsl</filename>, …).</para>
23846 <refentry version="5.0" id="profile.wordsize">
23848 <refentrytitle>profile.wordsize</refentrytitle>
23849 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
23852 <refname>profile.wordsize</refname>
23853 <refpurpose>Target profile for <tag class="attribute">wordsize</tag>
23854 attribute</refpurpose>
23858 <programlisting id="profile.wordsize.frag">
23859 <xsl:param name="profile.wordsize"></xsl:param>
23863 <refsection><info><title>Description</title></info>
23865 <para>The value of this parameter specifies profiles which should be
23866 included in the output. You can specify multiple profiles by
23867 separating them by semicolon. You can change separator character by
23868 <parameter>profile.separator</parameter>
23871 <para>This parameter has effect only when you are using profiling
23872 stylesheets (<filename>profile-docbook.xsl</filename>,
23873 <filename>profile-chunk.xsl</filename>, …) instead of normal
23874 ones (<filename>docbook.xsl</filename>,
23875 <filename>chunk.xsl</filename>, …).</para>
23880 <refentry version="5.0" id="profile.attribute">
23882 <refentrytitle>profile.attribute</refentrytitle>
23883 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
23886 <refname>profile.attribute</refname>
23887 <refpurpose>Name of user-specified profiling attribute</refpurpose>
23891 <programlisting id="profile.attribute.frag">
23892 <xsl:param name="profile.attribute"></xsl:param>
23896 <refsection><info><title>Description</title></info>
23898 <para>This parameter is used in conjuction with
23899 <parameter>profile.value</parameter>.</para>
23901 <para>This parameter has effect only when you are using profiling
23902 stylesheets (<filename>profile-docbook.xsl</filename>,
23903 <filename>profile-chunk.xsl</filename>, …) instead of normal
23904 ones (<filename>docbook.xsl</filename>,
23905 <filename>chunk.xsl</filename>, …).</para>
23910 <refentry version="5.0" id="profile.value">
23912 <refentrytitle>profile.value</refentrytitle>
23913 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
23916 <refname>profile.value</refname>
23917 <refpurpose>Target profile for user-specified attribute</refpurpose>
23921 <programlisting id="profile.value.frag">
23922 <xsl:param name="profile.value"></xsl:param>
23926 <refsection><info><title>Description</title></info>
23928 <para>When you are using this parameter you must also specify name of
23929 profiling attribute with parameter
23930 <parameter>profile.attribute</parameter>.</para>
23932 <para>The value of this parameter specifies profiles which should be
23933 included in the output. You can specify multiple profiles by
23934 separating them by semicolon. You can change separator character by
23935 <parameter>profile.separator</parameter>
23938 <para>This parameter has effect only when you are using profiling
23939 stylesheets (<filename>profile-docbook.xsl</filename>,
23940 <filename>profile-chunk.xsl</filename>, …) instead of normal
23941 ones (<filename>docbook.xsl</filename>,
23942 <filename>chunk.xsl</filename>, …).</para>
23947 <refentry version="5.0" id="profile.separator">
23949 <refentrytitle>profile.separator</refentrytitle>
23950 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
23953 <refname>profile.separator</refname>
23954 <refpurpose>Separator character for compound profile values</refpurpose>
23958 <programlisting id="profile.separator.frag">
23959 <xsl:param name="profile.separator">;</xsl:param>
23963 <refsection><info><title>Description</title></info>
23965 <para>Separator character used for compound profile values. See <parameter>profile.arch</parameter></para>
23970 </reference><reference id="l10n" xml:base="../fo/param.xml"><title>Localization</title>
23971 <refentry version="5.0" id="l10n.gentext.language">
23973 <refentrytitle>l10n.gentext.language</refentrytitle>
23974 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
23977 <refname>l10n.gentext.language</refname>
23978 <refpurpose>Sets the gentext language</refpurpose>
23982 <programlisting id="l10n.gentext.language.frag">
23983 <xsl:param name="l10n.gentext.language"></xsl:param>
23987 <refsection><info><title>Description</title></info>
23989 <para>If this parameter is set to any value other than the empty string, its
23990 value will be used as the value for the language when generating text. Setting
23991 <parameter>l10n.gentext.language</parameter> overrides any settings within the
23992 document being formatted.</para>
23994 <para>It's much more likely that you might want to set the
23995 <parameter>l10n.gentext.default.language</parameter> parameter.</para>
24000 <refentry version="5.0" id="l10n.gentext.default.language">
24002 <refentrytitle>l10n.gentext.default.language</refentrytitle>
24003 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
24006 <refname>l10n.gentext.default.language</refname>
24007 <refpurpose>Sets the default language for generated text</refpurpose>
24011 <programlisting id="l10n.gentext.default.language.frag">
24012 <xsl:param name="l10n.gentext.default.language">en</xsl:param>
24016 <refsection><info><title>Description</title></info>
24018 <para>The value of the <parameter>l10n.gentext.default.language</parameter>
24019 parameter is used as the language for generated text if no setting is provided
24020 in the source document.</para>
24025 <refentry version="5.0" id="l10n.gentext.use.xref.language">
24027 <refentrytitle>l10n.gentext.use.xref.language</refentrytitle>
24028 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
24031 <refname>l10n.gentext.use.xref.language</refname>
24032 <refpurpose>Use the language of target when generating cross-reference text?</refpurpose>
24036 <programlisting id="l10n.gentext.use.xref.language.frag">
24037 <xsl:param name="l10n.gentext.use.xref.language" select="0"></xsl:param>
24041 <refsection><info><title>Description</title></info>
24043 <para>If non-zero, the language of the target will be used when
24044 generating cross reference text. Usually, the <quote>current</quote>
24045 language is used when generating text (that is, the language of the
24046 element that contains the cross-reference element). But setting this parameter
24047 allows the language of the element <emphasis>pointed to</emphasis> to control
24048 the generated text.</para>
24050 <para>Consider the following example:</para>
24053 <programlisting><para lang="en">See also <xref linkend="chap3"/>.</para>
24057 <para>Suppose that Chapter 3 happens to be written in German.
24058 If <parameter>l10n.gentext.use.xref.language</parameter> is non-zero, the
24059 resulting text will be something like this:</para>
24062 <para>See also Kapital 3.</para>
24065 <para>Where the more traditional rendering would be:</para>
24068 <para>See also Chapter 3.</para>
24074 <refentry version="5.0" id="l10n.lang.value.rfc.compliant">
24076 <refentrytitle>l10n.lang.value.rfc.compliant</refentrytitle>
24077 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
24080 <refname>l10n.lang.value.rfc.compliant</refname>
24081 <refpurpose>Make value of lang attribute RFC compliant?</refpurpose>
24085 <programlisting id="l10n.lang.value.rfc.compliant.frag">
24086 <xsl:param name="l10n.lang.value.rfc.compliant" select="1"></xsl:param>
24090 <refsection><info><title>Description</title></info>
24092 <para>If non-zero, ensure that the values for all <tag class="attribute">lang</tag> attributes in HTML output are RFC
24093 compliant<footnote><para>Section 8.1.1, <link 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:
24095 <blockquote><para>[RFC1766] defines and explains the language codes
24096 that must be used in HTML documents.</para>
24097 <para>Briefly, language codes consist of a primary code and a possibly
24098 empty series of subcodes:
24100 <literallayout class="monospaced">language-code = primary-code ( "-" subcode )*</literallayout>
24102 <para>And in RFC 1766, <link xlink:href="http://www.ietf.org/rfc/rfc1766.txt">Tags for the Identification
24103 of Languages</link>, the EBNF for "language tag" is given as:
24105 <literallayout class="monospaced">Language-Tag = Primary-tag *( "-" Subtag )
24106 Primary-tag = 1*8ALPHA
24107 Subtag = 1*8ALPHA</literallayout>
24110 </para></footnote>.
24112 by taking any underscore characters in any <tag class="attribute">lang</tag> values found in source documents, and
24113 replacing them with hyphen characters in output HTML files. For
24114 example, <literal>zh_CN</literal> in a source document becomes
24115 <literal>zh-CN</literal> in the HTML output form that source.
24118 <para>This parameter does not cause any case change in <tag class="attribute">lang</tag> values, because RFC 1766
24119 explicitly states that all "language tags" (as it calls them) "are
24120 to be treated as case insensitive".</para>
24127 <refentry version="5.0" id="writing.mode">
24129 <refentrytitle>writing.mode</refentrytitle>
24130 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
24133 <refname>writing.mode</refname>
24134 <refpurpose>Direction of text flow based on locale</refpurpose>
24138 <programlisting id="writing.mode.frag">
24139 <xsl:param name="writing.mode">
24140 <xsl:call-template name="gentext">
24141 <xsl:with-param name="key">writing-mode</xsl:with-param>
24142 <xsl:with-param name="lang">
24143 <xsl:call-template name="l10n.language">
24144 <xsl:with-param name="target" select="/*[1]"></xsl:with-param>
24145 </xsl:call-template>
24146 </xsl:with-param>
24147 </xsl:call-template>
24152 <refsection><info><title>Description</title></info>
24154 <para>Sets direction of text flow and text alignment based on locale.
24155 The value is normally taken from the gentext file for the
24156 lang attribute of the document's root element, using the
24157 key name 'writing-mode' to look it up in the gentext file.
24158 But this param can also be
24159 set on the command line to override that gentext value.
24161 <para>Accepted values are:
24166 <para>Left-to-right text flow in each line, lines stack top to bottom.</para>
24172 <para>Right-to-left text flow in each line, lines stack top to bottom.</para>
24178 <para>Top-to-bottom text flow in each vertical line, lines stack right to left.
24179 Supported by only a few XSL-FO processors. Not supported in HTML output.</para>
24185 <para>Shorthand for lr-tb.</para>
24191 <para>Shorthand for rl-tb.</para>
24197 <para>Shorthand for tb-rl.</para>
24206 </reference><reference id="ebnf" xml:base="../fo/param.xml"><title>EBNF</title>
24207 <refentry version="5.0" id="ebnf.assignment">
24209 <refentrytitle>ebnf.assignment</refentrytitle>
24210 <refmiscinfo class="other" otherclass="datatype">rtf</refmiscinfo>
24213 <refname>ebnf.assignment</refname>
24214 <refpurpose>The EBNF production assignment operator</refpurpose>
24218 <programlisting id="ebnf.assignment.frag">
24220 <xsl:param name="ebnf.assignment">
24221 <fo:inline font-family="{$monospace.font.family}">
24222 <xsl:text>::=</xsl:text>
24228 <refsection><info><title>Description</title></info>
24230 <para>The <parameter>ebnf.assignment</parameter> parameter determines what
24231 text is used to show <quote>assignment</quote> in <tag>production</tag>s
24232 in <tag>productionset</tag>s.</para>
24234 <para>While <quote><literal>::=</literal></quote> is common, so are several
24235 other operators.</para>
24240 <refentry version="5.0" id="ebnf.statement.terminator">
24242 <refentrytitle>ebnf.statement.terminator</refentrytitle>
24243 <refmiscinfo class="other" otherclass="datatype">rtf</refmiscinfo>
24246 <refname>ebnf.statement.terminator</refname>
24247 <refpurpose>Punctuation that ends an EBNF statement.</refpurpose>
24251 <programlisting id="ebnf.statement.terminator.frag">
24253 <xsl:param name="ebnf.statement.terminator"></xsl:param>
24257 <refsection><info><title>Description</title></info>
24259 <para>The <parameter>ebnf.statement.terminator</parameter> parameter determines what
24260 text is used to terminate each <tag>production</tag>
24261 in <tag>productionset</tag>.</para>
24263 <para>Some notations end each statement with a period.</para>
24268 </reference><reference id="prepress" xml:base="../fo/param.xml"><title>Prepress</title>
24269 <refentry version="5.0" id="crop.marks">
24271 <refentrytitle>crop.marks</refentrytitle>
24272 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
24275 <refname>crop.marks</refname>
24276 <refpurpose>Output crop marks?</refpurpose>
24280 <programlisting id="crop.marks.frag">
24281 <xsl:param name="crop.marks" select="0"></xsl:param>
24285 <refsection><info><title>Description</title></info>
24287 <para>If non-zero, crop marks will be added to each page. Currently this
24288 works only with XEP if you have <parameter>xep.extensions</parameter> set.</para>
24293 <refentry version="5.0" id="crop.mark.width">
24295 <refentrytitle>crop.mark.width</refentrytitle>
24296 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
24299 <refname>crop.mark.width</refname>
24300 <refpurpose>Width of crop marks.</refpurpose>
24304 <programlisting id="crop.mark.width.frag">
24305 <xsl:param name="crop.mark.width">0.5pt</xsl:param>
24309 <refsection><info><title>Description</title></info>
24311 <para>Width of crop marks. Crop marks are controlled by
24312 <parameter>crop.marks</parameter> parameter.</para>
24317 <refentry version="5.0" id="crop.mark.offset">
24319 <refentrytitle>crop.mark.offset</refentrytitle>
24320 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
24323 <refname>crop.mark.offset</refname>
24324 <refpurpose>Length of crop marks.</refpurpose>
24328 <programlisting id="crop.mark.offset.frag">
24329 <xsl:param name="crop.mark.offset">24pt</xsl:param>
24333 <refsection><info><title>Description</title></info>
24335 <para>Length of crop marks. Crop marks are controlled by
24336 <parameter>crop.marks</parameter> parameter.</para>
24341 <refentry version="5.0" id="crop.mark.bleed">
24343 <refentrytitle>crop.mark.bleed</refentrytitle>
24344 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
24347 <refname>crop.mark.bleed</refname>
24348 <refpurpose>Length of invisible part of crop marks.</refpurpose>
24352 <programlisting id="crop.mark.bleed.frag">
24353 <xsl:param name="crop.mark.bleed">6pt</xsl:param>
24357 <refsection><info><title>Description</title></info>
24359 <para>Length of invisible part of crop marks. Crop marks are controlled by
24360 <parameter>crop.marks</parameter> parameter.</para>
24365 </reference><reference id="publishers" xml:base="../fo/param.xml"><title>DocBook Publishers</title>
24366 <refentry version="5.0" id="publishers.properties">
24368 <refentrytitle>publishers.properties</refentrytitle>
24369 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
24372 <refname>publishers.properties</refname>
24373 <refpurpose>Properties shared with the DocBook Publishers
24374 elements drama, poetry, and dialogue. </refpurpose>
24378 <programlisting id="publishers.properties.frag">
24379 <xsl:attribute-set name="publishers.properties">
24380 <xsl:attribute name="space-before">1em</xsl:attribute>
24381 <xsl:attribute name="space-after">1em</xsl:attribute>
24382 <xsl:attribute name="keep-together.within-column">auto</xsl:attribute>
24383 </xsl:attribute-set>
24387 <refsection><info><title>Description</title></info>
24389 <para>This <literal>attribute set</literal> is used for common
24390 properties shared by the DocBook Publishers elements
24391 <tag>dialogue</tag>,
24392 <tag>drama</tag>, and <tag>poetry</tag>.
24393 It is imported into each of the individual
24394 attribute sets for those elements.
24400 <refentry version="5.0" id="dialogue.properties">
24402 <refentrytitle>dialogue.properties</refentrytitle>
24403 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
24406 <refname>dialogue.properties</refname>
24407 <refpurpose>Properties applied to the DocBook Publishers dialogue element</refpurpose>
24411 <programlisting id="dialogue.properties.frag">
24412 <xsl:attribute-set name="dialogue.properties" use-attribute-sets="publishers.properties"></xsl:attribute-set>
24416 <refsection><info><title>Description</title></info>
24418 <para>This <literal>attribute set</literal> is applied to the output
24419 block for the DocBook Publishers <tag>dialogue</tag> element.
24420 By default, it imports the attributes defined in the
24421 <tag>publishers.properties</tag> attribute-set.
24427 <refentry version="5.0" id="drama.properties">
24429 <refentrytitle>drama.properties</refentrytitle>
24430 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
24433 <refname>drama.properties</refname>
24434 <refpurpose>Properties applied to the DocBook Publishers drama element</refpurpose>
24438 <programlisting id="drama.properties.frag">
24439 <xsl:attribute-set name="drama.properties" use-attribute-sets="publishers.properties"></xsl:attribute-set>
24443 <refsection><info><title>Description</title></info>
24445 <para>This <literal>attribute set</literal> is applied to the output
24446 block for the DocBook Publishers <tag>drama</tag> element.
24447 By default, it imports the attributes defined in the
24448 <tag>publishers.properties</tag> attribute-set.
24454 <refentry version="5.0" id="poetry.properties">
24456 <refentrytitle>poetry.properties</refentrytitle>
24457 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
24460 <refname>poetry.properties</refname>
24461 <refpurpose>Properties applied to the DocBook Publishers drama element</refpurpose>
24465 <programlisting id="poetry.properties.frag">
24466 <xsl:attribute-set name="poetry.properties" use-attribute-sets="publishers.properties"></xsl:attribute-set>
24470 <refsection><info><title>Description</title></info>
24472 <para>This <literal>attribute set</literal> is applied to the output
24473 block for the DocBook Publishers <tag>poetry</tag> element.
24474 By default, it imports the attributes defined in the
24475 <tag>publishers.properties</tag> attribute-set.
24481 <refentry version="5.0" id="line.properties">
24483 <refentrytitle>line.properties</refentrytitle>
24484 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
24487 <refname>line.properties</refname>
24488 <refpurpose>Properties applied to the DocBook Publishers
24489 line element. </refpurpose>
24493 <programlisting id="line.properties.frag">
24494 <xsl:attribute-set name="line.properties"></xsl:attribute-set>
24498 <refsection><info><title>Description</title></info>
24500 <para>This <literal>attribute set</literal> is applied
24501 to the <tag>block</tag> that contains the output of a
24502 <tag>line</tag> element from DocBook Publishers.
24508 <refentry version="5.0" id="linegroup.properties">
24510 <refentrytitle>linegroup.properties</refentrytitle>
24511 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
24514 <refname>linegroup.properties</refname>
24515 <refpurpose>Properties applied to the DocBook Publishers
24516 linegroup element</refpurpose>
24520 <programlisting id="linegroup.properties.frag">
24521 <xsl:attribute-set name="linegroup.properties">
24522 <xsl:attribute name="provisional-distance-between-starts">20%</xsl:attribute>
24523 <xsl:attribute name="provisional-label-separation">.3em</xsl:attribute>
24524 <xsl:attribute name="space-before">.5em</xsl:attribute>
24525 </xsl:attribute-set>
24529 <refsection><info><title>Description</title></info>
24531 <para>This <literal>attribute set</literal> is applied
24532 to the <tag>list-block</tag> that contains the output of a
24533 <tag>linegroup</tag> element from DocBook Publishers.
24539 <refentry version="5.0" id="speaker.properties">
24541 <refentrytitle>speaker.properties</refentrytitle>
24542 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
24545 <refname>speaker.properties</refname>
24546 <refpurpose>Properties applied to the DocBook Publishers
24547 speaker element</refpurpose>
24551 <programlisting id="speaker.properties.frag">
24552 <xsl:attribute-set name="speaker.properties"></xsl:attribute-set>
24556 <refsection><info><title>Description</title></info>
24558 <para>This <literal>attribute set</literal> is applied
24559 to the <tag>block</tag> that contains the output of a
24560 <tag>speaker</tag> element from DocBook Publishers.
24566 <refentry version="5.0" id="stagedir.properties">
24568 <refentrytitle>stagedir.properties</refentrytitle>
24569 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
24572 <refname>stagedir.properties</refname>
24573 <refpurpose>To add properties to the outer block of stage direction.</refpurpose>
24577 <programlisting id="stagedir.properties.frag">
24578 <xsl:attribute-set name="stagedir.properties">
24579 <xsl:attribute name="font-weight">bold</xsl:attribute>
24580 <xsl:attribute name="font-style">italic</xsl:attribute>
24581 <xsl:attribute name="space-before">1em</xsl:attribute>
24582 <xsl:attribute name="space-after">1em</xsl:attribute>
24583 </xsl:attribute-set>
24587 <refsection><info><title>Description</title></info>
24589 <para>These properties are added to the outer block containing the
24591 Use this attribute-set to set the space above and below,
24592 and any indent for the whole stagedir.</para>
24597 <refentry version="5.0" id="inlinestagedir.properties">
24599 <refentrytitle>inlinestagedir.properties</refentrytitle>
24600 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
24603 <refname>inlinestagedir.properties</refname>
24604 <refpurpose>Properties applied to the DocBook Publishers
24605 inlinestagedir element. </refpurpose>
24609 <programlisting id="inlinestagedir.properties.frag">
24610 <xsl:attribute-set name="inlinestagedir.properties">
24611 <xsl:attribute name="font-weight">bold</xsl:attribute>
24612 <xsl:attribute name="font-style">italic</xsl:attribute>
24613 </xsl:attribute-set>
24617 <refsection><info><title>Description</title></info>
24619 <para>This <literal>attribute set</literal> is applied
24620 to the <tag>fo:inline</tag> that contains the output of a
24621 <tag>inlinestagedir</tag> element from DocBook Publishers.
24624 <para>The XSL template that matches on <tag>inlinestagedir</tag>
24625 also adds square brackets around the text.</para>
24633 <part id="manpages">
24634 <?dbhtml dir="manpages"?>
24635 <?dbhtml filename="index.html"?>
24636 <title xml:base="../manpages/param.xml">Manpages Parameter Reference</title>
24637 <partintro id="manintro">
24639 <para xml:base="../manpages/param.xml">This is reference documentation for all user-configurable
24640 parameters in the DocBook XSL "manpages" stylesheet (for
24641 generating groff/nroff output). Note that the manpages
24642 stylesheet is a customization layer of the DocBook XSL HTML
24643 stylesheet. Therefore, you can also use a number of <link xlink:href="../html/">HTML stylesheet parameters</link>
24644 to control manpages output (in addition to the
24645 manpages-specific parameters listed in this section).</para>
24648 <reference id="general" xml:base="../manpages/param.xml">
24649 <title>Hyphenation, justification, and breaking</title>
24650 <refentry version="5.0" id="man.hyphenate">
24652 <refentrytitle>man.hyphenate</refentrytitle>
24653 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
24656 <refname>man.hyphenate</refname>
24657 <refpurpose>Enable hyphenation?</refpurpose>
24661 <programlisting id="man.hyphenate.frag">
24662 <xsl:param name="man.hyphenate">0</xsl:param></programlisting>
24665 <refsection><info><title>Description</title></info>
24667 <para>If non-zero, hyphenation is enabled.</para>
24670 <para>The default value for this parameter is zero because groff is
24671 not particularly smart about how it does hyphenation; it can end up
24672 hyphenating a lot of things that you don't want hyphenated. To
24673 mitigate that, the default behavior of the stylesheets is to suppress
24674 hyphenation of computer inlines, filenames, and URLs. (You can
24675 override the default behavior by setting non-zero values for the
24676 <parameter>man.hyphenate.urls</parameter>,
24677 <parameter>man.hyphenate.filenames</parameter>, and
24678 <parameter>man.hyphenate.computer.inlines</parameter> parameters.) But
24679 the best way is still to just globally disable hyphenation, as the
24680 stylesheets do by default.</para>
24682 <para>The only good reason to enabled hyphenation is if you have also
24683 enabled justification (which is disabled by default). The reason is
24684 that justified text can look very bad unless you also hyphenate it; to
24685 quote the <quote>Hypenation</quote> node from the groff info page:
24688 <para><emphasis>Since the odds are not great for finding a set of
24689 words, for every output line, which fit nicely on a line without
24690 inserting excessive amounts of space between words, 'gtroff'
24691 hyphenates words so that it can justify lines without inserting too
24692 much space between words.</emphasis></para>
24695 So, if you set a non-zero value for the
24696 <parameter>man.justify</parameter> parameter (to enable
24697 justification), then you should probably also set a non-zero value for
24698 <parameter>man.hyphenate</parameter> (to enable hyphenation).</para>
24705 <refentry version="5.0" id="man.hyphenate.urls">
24707 <refentrytitle>man.hyphenate.urls</refentrytitle>
24708 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
24711 <refname>man.hyphenate.urls</refname>
24712 <refpurpose>Hyphenate URLs?</refpurpose>
24716 <programlisting id="man.hyphenate.urls.frag">
24717 <xsl:param name="man.hyphenate.urls">0</xsl:param></programlisting>
24720 <refsection><info><title>Description</title></info>
24722 <para>If zero (the default), hyphenation is suppressed for output of
24723 the <tag>ulink</tag> <tag class="attribute">url</tag> attribute.</para>
24726 <para>If hyphenation is already turned off globally (that is, if
24727 <parameter>man.hyphenate</parameter> is zero, setting
24728 <parameter>man.hyphenate.urls</parameter> is not necessary.</para>
24731 <para>If <parameter>man.hyphenate.urls</parameter> is non-zero, URLs
24732 will not be treated specially and are subject to hyphenation just like
24733 other words.</para>
24736 <para>If you are thinking about setting a non-zero value for
24737 <parameter>man.hyphenate.urls</parameter> in order to make long
24738 URLs break across lines, you'd probably be better off
24739 experimenting with setting the
24740 <parameter>man.break.after.slash</parameter> parameter first. That
24741 will cause long URLs to be broken after slashes.</para>
24747 <refentry version="5.0" id="man.hyphenate.filenames">
24749 <refentrytitle>man.hyphenate.filenames</refentrytitle>
24750 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
24753 <refname>man.hyphenate.filenames</refname>
24754 <refpurpose>Hyphenate filenames?</refpurpose>
24758 <programlisting id="man.hyphenate.filenames.frag">
24759 <xsl:param name="man.hyphenate.filenames">0</xsl:param></programlisting>
24762 <refsection><info><title>Description</title></info>
24764 <para>If zero (the default), hyphenation is suppressed for
24765 <tag>filename</tag> output.</para>
24768 <para>If hyphenation is already turned off globally (that is, if
24769 <parameter>man.hyphenate</parameter> is zero, setting
24770 <parameter>man.hyphenate.filenames</parameter> is not
24774 <para>If <parameter>man.hyphenate.filenames</parameter> is non-zero,
24775 filenames will not be treated specially and are subject to hyphenation
24776 just like other words.</para>
24779 <para>If you are thinking about setting a non-zero value for
24780 <parameter>man.hyphenate.filenames</parameter> in order to make long
24781 filenames/pathnames break across lines, you'd probably be better off
24782 experimenting with setting the
24783 <parameter>man.break.after.slash</parameter> parameter first. That
24784 will cause long pathnames to be broken after slashes.</para>
24790 <refentry version="5.0" id="man.hyphenate.computer.inlines">
24792 <refentrytitle>man.hyphenate.computer.inlines</refentrytitle>
24793 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
24796 <refname>man.hyphenate.computer.inlines</refname>
24797 <refpurpose>Hyphenate computer inlines?</refpurpose>
24801 <programlisting id="man.hyphenate.computer.inlines.frag">
24802 <xsl:param name="man.hyphenate.computer.inlines">0</xsl:param></programlisting>
24805 <refsection><info><title>Description</title></info>
24807 <para>If zero (the default), hyphenation is suppressed for
24808 <quote>computer inlines</quote> such as environment variables,
24809 constants, etc. This parameter current affects output of the following
24811 <simplelist type="inline">
24813 <member><tag>classname</tag></member>
24814 <member><tag>constant</tag></member>
24815 <member><tag>envar</tag></member>
24816 <member><tag>errorcode</tag></member>
24817 <member><tag>option</tag></member>
24818 <member><tag>replaceable</tag></member>
24819 <member><tag>userinput</tag></member>
24820 <member><tag>type</tag></member>
24821 <member><tag>varname</tag></member>
24826 <para>If hyphenation is already turned off globally (that is, if
24827 <parameter>man.hyphenate</parameter> is zero, setting the
24828 <parameter>man.hyphenate.computer.inlines</parameter> is not
24832 <para>If <parameter>man.hyphenate.computer.inlines</parameter> is
24833 non-zero, computer inlines will not be treated specially and will be
24834 hyphenated like other words when needed.</para>
24839 <refentry version="5.0" id="man.justify">
24841 <refentrytitle>man.justify</refentrytitle>
24842 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
24845 <refname>man.justify</refname>
24846 <refpurpose>Justify text to both right and left margins?</refpurpose>
24850 <programlisting id="man.justify.frag">
24851 <xsl:param name="man.justify">0</xsl:param></programlisting>
24854 <refsection><info><title>Description</title></info>
24856 <para>If non-zero, text is justified to both the right and left
24857 margins (or, in roff terminology, "adjusted and filled" to both the
24858 right and left margins). If zero (the default), text is adjusted to
24859 the left margin only -- producing what is traditionally called
24860 "ragged-right" text.</para>
24863 <para>The default value for this parameter is zero because justified
24864 text looks good only when it is also hyphenated. Without hyphenation,
24865 excessive amounts of space often end up getting between words, in
24866 order to "pad" lines out to align on the right margin.</para>
24868 <para>The problem is that groff is not particularly smart about how it
24869 does hyphenation; it can end up hyphenating a lot of things that you
24870 don't want hyphenated. So, disabling both justification and
24871 hyphenation ensures that hyphens won't get inserted where you don't
24872 want to them, and you don't end up with lines containing excessive
24873 amounts of space between words.</para>
24875 <para>However, if do you decide to set a non-zero value for the
24876 <parameter>man.justify</parameter> parameter (to enable
24877 justification), then you should probably also set a non-zero value for
24878 <parameter>man.hyphenate</parameter> (to enable hyphenation).</para>
24880 <para>Yes, these default settings run counter to how most existing man
24881 pages are formatted. But there are some notable exceptions, such as
24882 the <literal>perl</literal> man pages.</para>
24887 <refentry version="5.0" id="man.break.after.slash">
24889 <refentrytitle>man.break.after.slash</refentrytitle>
24890 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
24893 <refname>man.break.after.slash</refname>
24894 <refpurpose>Enable line-breaking after slashes?</refpurpose>
24898 <programlisting id="man.break.after.slash.frag">
24899 <xsl:param name="man.break.after.slash">0</xsl:param></programlisting>
24902 <refsection><info><title>Description</title></info>
24904 <para>If non-zero, line-breaking after slashes is enabled. This is
24905 mainly useful for causing long URLs or pathnames/filenames to be
24906 broken up or "wrapped" across lines (though it also has the side
24907 effect of sometimes causing relatively short URLs and pathnames to be
24908 broken up across lines too).</para>
24910 <para>If zero (the default), line-breaking after slashes is
24911 disabled. In that case, strings containing slashes (for example, URLs
24912 or filenames) are not broken across lines, even if they exceed the
24913 maximum column widith.</para>
24916 <para>If you set a non-zero value for this parameter, check your
24917 man-page output carefuly afterwards, in order to make sure that the
24918 setting has not introduced an excessive amount of breaking-up of URLs
24919 or pathnames. If your content contains mostly short URLs or
24920 pathnames, setting a non-zero value for
24921 <parameter>man.break.after.slash</parameter> will probably result in
24922 in a significant number of relatively short URLs and pathnames being
24923 broken across lines, which is probably not what you want.</para>
24929 </reference><reference id="indent" xml:base="../manpages/param.xml">
24930 <title>Indentation</title>
24931 <refentry version="5.0" id="man.indent.width">
24933 <refentrytitle>man.indent.width</refentrytitle>
24934 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
24937 <refname>man.indent.width</refname>
24938 <refpurpose>Specifies width used for adjusted indents</refpurpose>
24942 <programlisting id="man.indent.width.frag">
24943 <xsl:param name="man.indent.width">4</xsl:param>
24947 <refsection><info><title>Description</title></info>
24948 <para>The <parameter>man.indent.width</parameter> parameter specifies
24949 the width used for adjusted indents. The value of
24950 <parameter>man.indent.width</parameter> is used for indenting of
24951 lists, verbatims, headings, and elsewhere, depending on whether the
24952 values of certain <literal>man.indent.*</literal> boolean parameters
24953 are non-zero.</para>
24955 <para>The value of <parameter>man.indent.width</parameter> should
24956 include a valid roff measurement unit (for example,
24957 <literal>n</literal> or <literal>u</literal>). The default value of
24958 <literal>4n</literal> specifies a 4-en width; when viewed on a
24959 console, that amounts to the width of four characters. For details
24960 about roff measurment units, see the <literal>Measurements</literal>
24961 node in the groff info page.</para>
24966 <refentry version="5.0" id="man.indent.refsect">
24968 <refentrytitle>man.indent.refsect</refentrytitle>
24969 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
24972 <refname>man.indent.refsect</refname>
24973 <refpurpose>Adjust indentation of refsect* and refsection?</refpurpose>
24977 <programlisting id="man.indent.refsect.frag">
24978 <xsl:param name="man.indent.refsect" select="0"></xsl:param></programlisting>
24981 <refsection><info><title>Description</title></info>
24983 <para>If the value of <parameter>man.indent.refsect</parameter> is
24984 non-zero, the width of the left margin for
24985 <tag>refsect1</tag>, <tag>refsect2</tag> and
24986 <tag>refsect3</tag> contents and titles (and first-level,
24987 second-level, and third-level nested
24988 <tag>refsection</tag>instances) is adjusted by the value of
24989 the <parameter>man.indent.width</parameter> parameter. With
24990 <parameter>man.indent.width</parameter> set to its default value of
24991 <literal>3n</literal>, the main results are that:
24995 <para>contents of <tag>refsect1</tag> are output with a
24996 left margin of three characters instead the roff default of seven
24997 or eight characters</para>
25000 <para>contents of <tag>refsect2</tag> are displayed in
25001 console output with a left margin of six characters instead the of
25002 the roff default of seven characters</para>
25005 <para> the contents of <tag>refsect3</tag> and nested
25006 <tag>refsection</tag> instances are adjusted
25007 accordingly.</para>
25011 If instead the value of <parameter>man.indent.refsect</parameter> is
25012 zero, no margin adjustment is done for <literal>refsect*</literal>
25016 <para>If your content is primarly comprised of
25017 <tag>refsect1</tag> and <tag>refsect2</tag> content
25018 (or the <tag>refsection</tag> equivalent) – with few or
25019 no <tag>refsect3</tag> or lower nested sections , you may be
25020 able to “conserve” space in your output by setting
25021 <parameter>man.indent.refsect</parameter> to a non-zero value. Doing
25022 so will “squeeze” the left margin in such as way as to provide an
25023 additional four characters of “room” per line in
25024 <tag>refsect1</tag> output. That extra room may be useful
25025 if, for example, you have many verbatim sections with long lines in
25032 <refentry version="5.0" id="man.indent.blurbs">
25034 <refentrytitle>man.indent.blurbs</refentrytitle>
25035 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
25038 <refname>man.indent.blurbs</refname>
25039 <refpurpose>Adjust indentation of blurbs?</refpurpose>
25043 <programlisting id="man.indent.blurbs.frag">
25044 <xsl:param name="man.indent.blurbs" select="1"></xsl:param></programlisting>
25047 <refsection><info><title>Description</title></info>
25049 <para>If the value of <parameter>man.indent.blurbs</parameter> is
25050 non-zero, the width of the left margin for
25051 <tag>authorblurb</tag>, <tag>personblurb</tag>, and
25052 <tag>contrib</tag> output is set to the value of the
25053 <parameter>man.indent.width</parameter> parameter
25054 (<literal>3n</literal> by default). If instead the value of
25055 <parameter>man.indent.blurbs</parameter> is zero, the built-in roff
25056 default width (<literal>7.2n</literal>) is used.</para>
25061 <refentry version="5.0" id="man.indent.lists">
25063 <refentrytitle>man.indent.lists</refentrytitle>
25064 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
25067 <refname>man.indent.lists</refname>
25068 <refpurpose>Adjust indentation of lists?</refpurpose>
25072 <programlisting id="man.indent.lists.frag">
25073 <xsl:param name="man.indent.lists" select="1"></xsl:param></programlisting>
25076 <refsection><info><title>Description</title></info>
25078 <para>If the value of <parameter>man.indent.lists</parameter> is
25079 non-zero, the width of the left margin for list items in
25080 <tag>itemizedlist</tag>,
25081 <tag>orderedlist</tag>,
25082 <tag>variablelist</tag> output (and output of some other
25083 lists) is set to the value of the
25084 <parameter>man.indent.width</parameter> parameter
25085 (<literal>4n</literal> by default). If instead the value of
25086 <parameter>man.indent.lists</parameter> is zero, the built-in roff
25087 default width (<literal>7.2n</literal>) is used.</para>
25092 <refentry version="5.0" id="man.indent.verbatims">
25094 <refentrytitle>man.indent.verbatims</refentrytitle>
25095 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
25098 <refname>man.indent.verbatims</refname>
25099 <refpurpose>Adjust indentation of verbatims?</refpurpose>
25103 <programlisting id="man.indent.verbatims.frag">
25104 <xsl:param name="man.indent.verbatims" select="1"></xsl:param></programlisting>
25107 <refsection><info><title>Description</title></info>
25109 <para>If the value of <parameter>man.indent.verbatims</parameter> is
25110 non-zero, the width of the left margin for output of verbatim
25111 environments (<tag>programlisting</tag>,
25112 <tag>screen</tag>, and so on) is set to the value of the
25113 <parameter>man.indent.width</parameter> parameter
25114 (<literal>3n</literal> by default). If instead the value of
25115 <parameter>man.indent.verbatims</parameter> is zero, the built-in roff
25116 default width (<literal>7.2n</literal>) is used.</para>
25121 </reference><reference id="fonts" xml:base="../manpages/param.xml">
25122 <title>Fonts</title>
25123 <refentry version="5.0" id="man.font.funcprototype">
25125 <refentrytitle>man.font.funcprototype</refentrytitle>
25126 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
25129 <refname>man.font.funcprototype</refname>
25130 <refpurpose>Specifies font for funcprototype output</refpurpose>
25134 <programlisting id="man.font.funcprototype.frag">
25135 <xsl:param name="man.font.funcprototype">BI</xsl:param>
25139 <refsection><info><title>Description</title></info>
25141 <para>The <parameter>man.font.funcprototype</parameter> parameter
25142 specifies the font for <tag>funcprototype</tag> output. It
25143 should be a valid roff font name, such as <literal>BI</literal> or
25144 <literal>B</literal>.</para>
25149 <refentry version="5.0" id="man.font.funcsynopsisinfo">
25151 <refentrytitle>man.font.funcsynopsisinfo</refentrytitle>
25152 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
25155 <refname>man.font.funcsynopsisinfo</refname>
25156 <refpurpose>Specifies font for funcsynopsisinfo output</refpurpose>
25160 <programlisting id="man.font.funcsynopsisinfo.frag">
25161 <xsl:param name="man.font.funcsynopsisinfo">B</xsl:param>
25165 <refsection><info><title>Description</title></info>
25167 <para>The <parameter>man.font.funcsynopsisinfo</parameter> parameter
25168 specifies the font for <tag>funcsynopsisinfo</tag> output. It
25169 should be a valid roff font name, such as <literal>B</literal> or
25170 <literal>I</literal>.</para>
25175 <refentry version="5.0" id="man.font.links">
25177 <refentrytitle>man.font.links</refentrytitle>
25178 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
25181 <refname>man.font.links</refname>
25182 <refpurpose>Specifies font for links</refpurpose>
25186 <programlisting id="man.font.links.frag">
25187 <xsl:param name="man.font.links">B</xsl:param>
25191 <refsection><info><title>Description</title></info>
25193 <para>The <parameter>man.font.links</parameter> parameter
25194 specifies the font for output of links (<tag>ulink</tag> instances
25195 and any instances of any element with an <tag class="attribute">xlink:href</tag> attribute).</para>
25197 <para>The value of <parameter>man.font.links</parameter> must be
25198 either <literal>B</literal> or <literal>I</literal>, or empty. If
25199 the value is empty, no font formatting is applied to links.</para>
25201 <para>If you set <parameter>man.endnotes.are.numbered</parameter> and/or
25202 <parameter>man.endnotes.list.enabled</parameter> to zero (disabled), then
25203 you should probably also set an empty value for
25204 <parameter>man.font.links</parameter>. But if
25205 <parameter>man.endnotes.are.numbered</parameter> is non-zero (enabled),
25206 you should probably keep
25207 <parameter>man.font.links</parameter> set to
25208 <literal>B</literal> or <literal>I</literal><footnote><para>The
25209 main purpose of applying a font format to links in most output
25210 formats it to indicate that the formatted text is
25211 “clickable”; given that links rendered in man pages are
25212 not “real” hyperlinks that users can click on, it might
25213 seem like there is never a good reason to have font formatting for
25214 link contents in man output.</para>
25215 <para>In fact, if you suppress the
25216 display of inline link references (by setting
25217 <parameter>man.endnotes.are.numbered</parameter> to zero), there is no
25218 good reason to apply font formatting to links. However, if
25219 <parameter>man.endnotes.are.numbered</parameter> is non-zero, having
25220 font formatting for links (arguably) serves a purpose: It provides
25221 “context” information about exactly what part of the text
25222 is being “annotated” by the link. Depending on how you
25223 mark up your content, that context information may or may not
25224 have value.</para></footnote>.</para>
25227 <refsection><info><title>Related Parameters</title></info>
25228 <para><parameter>man.endnotes.list.enabled</parameter>,
25229 <parameter>man.endnotes.are.numbered</parameter></para>
25234 <refentry version="5.0" id="man.font.table.headings">
25236 <refentrytitle>man.font.table.headings</refentrytitle>
25237 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
25240 <refname>man.font.table.headings</refname>
25241 <refpurpose>Specifies font for table headings</refpurpose>
25245 <programlisting id="man.font.table.headings.frag">
25246 <xsl:param name="man.font.table.headings">B</xsl:param>
25250 <refsection><info><title>Description</title></info>
25252 <para>The <parameter>man.font.table.headings</parameter> parameter
25253 specifies the font for <tag>table</tag> headings. It should be
25254 a valid roff font, such as <literal>B</literal> or
25255 <literal>I</literal>.</para>
25260 <refentry version="5.0" id="man.font.table.title">
25262 <refentrytitle>man.font.table.title</refentrytitle>
25263 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
25266 <refname>man.font.table.title</refname>
25267 <refpurpose>Specifies font for table headings</refpurpose>
25271 <programlisting id="man.font.table.title.frag">
25272 <xsl:param name="man.font.table.title">B</xsl:param>
25276 <refsection><info><title>Description</title></info>
25278 <para>The <parameter>man.font.table.title</parameter> parameter
25279 specifies the font for <tag>table</tag> titles. It should be
25280 a valid roff font, such as <literal>B</literal> or
25281 <literal>I</literal>.</para>
25286 </reference><reference id="synopsis" xml:base="../manpages/param.xml">
25287 <title>SYNOPSIS section</title>
25288 <refentry version="5.0" id="man.funcsynopsis.style">
25290 <refentrytitle>man.funcsynopsis.style</refentrytitle>
25291 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
25292 <refmiscinfo class="other" otherclass="value">ansi</refmiscinfo>
25293 <refmiscinfo class="other" otherclass="value">kr</refmiscinfo>
25296 <refname>man.funcsynopsis.style</refname>
25297 <refpurpose>What style of <tag>funcsynopsis</tag> should be generated?</refpurpose>
25300 <programlisting id="man.funcsynopsis.style.frag"><xsl:param name="man.funcsynopsis.style">ansi</xsl:param></programlisting>
25302 <refsection><info><title>Description</title></info>
25303 <para>If <parameter>man.funcsynopsis.style</parameter> is
25304 <literal>ansi</literal>, ANSI-style function synopses are
25305 generated for a <tag>funcsynopsis</tag>, otherwise K&R-style
25306 function synopses are generated.</para>
25310 </reference><reference id="authors" xml:base="../manpages/param.xml">
25311 <title>AUTHORS and COPYRIGHT sections</title>
25312 <refentry version="5.0" id="man.authors.section.enabled">
25314 <refentrytitle>man.authors.section.enabled</refentrytitle>
25315 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
25318 <refname>man.authors.section.enabled</refname>
25319 <refpurpose>Display auto-generated AUTHORS section?</refpurpose>
25322 <programlisting id="man.authors.section.enabled.frag">
25323 <xsl:param name="man.authors.section.enabled">1</xsl:param>
25326 <refsection><info><title>Description</title></info>
25328 <para>If the value of
25329 <parameter>man.authors.section.enabled</parameter> is non-zero
25330 (the default), then an <literal>AUTHORS</literal> section is
25331 generated near the end of each man page. The output of the
25332 <literal>AUTHORS</literal> section is assembled from any
25333 <tag>author</tag>, <tag>editor</tag>, and <tag>othercredit</tag>
25334 metadata found in the contents of the child <tag>info</tag> or
25335 <tag>refentryinfo</tag> (if any) of the <tag>refentry</tag>
25336 itself, or from any <tag>author</tag>, <tag>editor</tag>, and
25337 <tag>othercredit</tag> metadata that may appear in <tag>info</tag>
25338 contents of any ancestors of the <tag>refentry</tag>.</para>
25340 <para>If the value of
25341 <parameter>man.authors.section.enabled</parameter> is zero, the
25342 the auto-generated <literal>AUTHORS</literal> section is
25345 <para>Set the value of
25346 <parameter>man.authors.section.enabled</parameter> to zero if
25347 you want to have a manually created <literal>AUTHORS</literal>
25348 section in your source, and you want it to appear in output
25349 instead of the auto-generated <literal>AUTHORS</literal>
25354 <refentry version="5.0" id="man.copyright.section.enabled">
25356 <refentrytitle>man.copyright.section.enabled</refentrytitle>
25357 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
25360 <refname>man.copyright.section.enabled</refname>
25361 <refpurpose>Display auto-generated COPYRIGHT section?</refpurpose>
25364 <programlisting id="man.copyright.section.enabled.frag">
25365 <xsl:param name="man.copyright.section.enabled">1</xsl:param>
25368 <refsection><info><title>Description</title></info>
25370 <para>If the value of
25371 <parameter>man.copyright.section.enabled</parameter> is non-zero
25372 (the default), then a <literal>COPYRIGHT</literal> section is
25373 generated near the end of each man page. The output of the
25374 <literal>COPYRIGHT</literal> section is assembled from any
25375 <tag>copyright</tag> and <tag>legalnotice</tag> metadata found in
25376 the contents of the child <tag>info</tag> or
25377 <tag>refentryinfo</tag> (if any) of the <tag>refentry</tag>
25378 itself, or from any <tag>copyright</tag> and
25379 <tag>legalnotice</tag> metadata that may appear in <tag>info</tag>
25380 contents of any ancestors of the <tag>refentry</tag>.</para>
25382 <para>If the value of
25383 <parameter>man.copyright.section.enabled</parameter> is zero, the
25384 the auto-generated <literal>COPYRIGHT</literal> section is
25387 <para>Set the value of
25388 <parameter>man.copyright.section.enabled</parameter> to zero if
25389 you want to have a manually created <literal>COPYRIGHT</literal>
25390 section in your source, and you want it to appear in output
25391 instead of the auto-generated <literal>COPYRIGHT</literal>
25396 </reference><reference id="endnotes" xml:base="../manpages/param.xml">
25397 <title>Endnotes and link handling</title>
25398 <refentry version="5.0" id="man.endnotes.list.enabled">
25400 <refentrytitle>man.endnotes.list.enabled</refentrytitle>
25401 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
25404 <refname>man.endnotes.list.enabled</refname>
25405 <refpurpose>Display endnotes list at end of man page?</refpurpose>
25409 <programlisting id="man.endnotes.list.enabled.frag">
25410 <xsl:param name="man.endnotes.list.enabled">1</xsl:param>
25414 <refsection><info><title>Description</title></info>
25416 <para>If the value of <parameter>man.endnotes.list.enabled</parameter> is
25417 non-zero (the default), then an endnotes list is added to the end of
25418 the output man page.</para>
25420 <para>If the value of <parameter>man.endnotes.list.enabled</parameter> is
25421 zero, the list is suppressed — unless link numbering is enabled (that
25422 is, if <parameter>man.endnotes.are.numbered</parameter> is non-zero), in
25423 which case, that setting overrides the
25424 <parameter>man.endnotes.list.enabled</parameter> setting, and the
25425 endnotes list is still displayed. The reason is that inline
25426 numbering of notesources associated with endnotes only makes sense
25427 if a (numbered) list of endnotes is also generated.</para>
25431 <parameter>man.endnotes.list.enabled</parameter> at its default
25432 (non-zero) value ensures that no “out of line” information (such
25433 as the URLs for hyperlinks and images) gets lost in your
25434 man-page output. It just gets “rearranged”.</para>
25435 <para>So if you’re thinking about disabling endnotes listing by
25436 setting the value of
25437 <parameter>man.endnotes.list.enabled</parameter> to zero:
25438 Before you do so, first take some time to carefully consider
25439 the information needs and experiences of your users. The “out
25440 of line” information has value even if the presentation of it
25441 in text output is not as interactive as it may be in other
25442 output formats.</para>
25443 <para>As far as the specific case of URLs: Even though the URLs
25444 displayed in text output may not be “real” (clickable)
25445 hyperlinks, many X terminals have convenience features for
25446 recognizing URLs and can, for example, present users with
25447 an options to open a URL in a browser with the user clicks on
25448 the URL is a terminal window. And short of those, users with X
25449 terminals can always manually cut and paste the URLs into a web
25451 <para>Also, note that various “man to html” tools, such as the
25452 widely used <command><link xlink:href="http://users.actrix.gen.nz/michael/vhman2html.html">man2html</link></command> (<literal>VH-Man2html</literal>)
25453 application, automatically mark up URLs with <literal>a@href</literal> markup
25454 during conversion — resulting in “real” hyperlinks in HTML
25455 output from those tools.</para>
25458 <para>To “turn off” numbering of endnotes in the
25459 endnotes list, set <parameter>man.endnotes.are.numbered</parameter>
25460 to zero. The endnotes list will
25461 still be displayed; it will just be displayed without the
25462 numbers<footnote><para>It can still make sense to have
25463 the list of endnotes displayed even if you have endnotes numbering turned
25464 off. In that case, your endnotes list basically becomes a “list
25465 of references” without any association with specific text in
25466 your document. This is probably the best option if you find the inline
25467 endnotes numbering obtrusive. Your users will still have access to all the “out of line”
25468 such as URLs for hyperlinks.</para></footnote>
25471 <para>The default heading for the endnotes list is
25472 <literal>NOTES</literal>. To change that, set a non-empty
25473 value for the <parameter>man.endnotes.list.heading</parameter>
25476 <para>In the case of notesources that are links: Along with the
25477 URL for each link, the endnotes list includes the contents of the
25478 link. The list thus includes only non-empty<footnote>
25480 <para>A “non-empty” link is one that looks like
25481 this:<literallayout class="monospaced"> <ulink url="http://snapshots.docbook.org/xsl/doc/manpages/">manpages</ulink></literallayout>
25482 an “empty link” is on that looks like this:<literallayout class="monospaced"> <ulink url="http://snapshots.docbook.org/xsl/doc/manpages/"/></literallayout>
25483 </para></footnote> links.
25485 Empty links are never included, and never numbered. They are simply
25486 displayed inline, without any numbering.</para>
25488 <para>In addition, if there are multiple instances of links in a
25489 <tag>refentry</tag> that have the same URL, the URL is listed only
25490 once. The contents listed for that link in the endnotes list are
25491 the contents of the first link which has that URL.</para>
25493 <para>If you disable endnotes listing, you should probably also set
25494 <parameter>man.links.are.underlined</parameter> to zero (to disable
25495 link underlining).</para>
25499 <refentry version="5.0" id="man.endnotes.list.heading">
25501 <refentrytitle>man.endnotes.list.heading</refentrytitle>
25502 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
25505 <refname>man.endnotes.list.heading</refname>
25506 <refpurpose>Specifies an alternate name for endnotes list</refpurpose>
25510 <programlisting id="man.endnotes.list.heading.frag">
25511 <xsl:param name="man.endnotes.list.heading"></xsl:param>
25515 <refsection><info><title>Description</title></info>
25517 <para>If the value of the
25518 <parameter>man.endnotes.are.numbered</parameter> parameter
25519 and/or the <parameter>man.endnotes.list.enabled</parameter>
25520 parameter is non-zero (the defaults for both are non-zero), a
25521 numbered list of endnotes is generated near the end of each man
25522 page. The default heading for the list of endnotes is the
25523 equivalent of the English word <literal>NOTES</literal> in
25524 the current locale. To cause an alternate heading to be displayed,
25525 set a non-empty value for the
25526 <parameter>man.endnotes.list.heading</parameter> parameter —
25527 for example, <literal>REFERENCES</literal>.</para>
25531 <refentry version="5.0" id="man.endnotes.are.numbered">
25533 <refentrytitle>man.endnotes.are.numbered</refentrytitle>
25534 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
25537 <refname>man.endnotes.are.numbered</refname>
25538 <refpurpose>Number endnotes?</refpurpose>
25542 <programlisting id="man.endnotes.are.numbered.frag">
25543 <xsl:param name="man.endnotes.are.numbered">1</xsl:param>
25547 <refsection><info><title>Description</title></info>
25549 <para>If the value of <parameter>man.endnotes.are.numbered</parameter> is
25550 non-zero (the default), then for each non-empty<footnote>
25551 <para>A “non-empty” notesource is one that looks like
25552 this:<literallayout class="monospaced"> <ulink url="http://snapshots.docbook.org/xsl/doc/manpages/">manpages</ulink></literallayout>
25553 an “empty” notesource is on that looks like this:<literallayout class="monospaced"> <ulink url="http://snapshots.docbook.org/xsl/doc/manpages/"/></literallayout>
25554 </para></footnote> “notesource”:
25558 <para>a number (in square brackets) is displayed inline after the
25559 rendered inline contents (if any) of the notesource</para>
25562 <para>the contents of the notesource are included in a
25563 numbered list of endnotes that is generated at the end of
25564 each man page; the number for each endnote corresponds to
25565 the inline number for the notesource with which it is
25569 The default heading for the list of endnotes is
25570 <literal>NOTES</literal>. To output a different heading, set a value
25571 for the <parameter>man.endnotes.section.heading</parameter>
25575 <para>The endnotes list is also displayed (but without
25576 numbers) if the value of
25577 <parameter>man.endnotes.list.enabled</parameter> is
25582 <para>If the value of <parameter>man.endnotes.are.numbered</parameter> is
25583 zero, numbering of endnotess is suppressed; only inline
25584 contents (if any) of the notesource are displayed inline.
25586 <para>If you are thinking about disabling endnote numbering by setting
25587 the value of <parameter>man.endnotes.are.numbered</parameter> to zero,
25588 before you do so, first take some time to carefully
25589 consider the information needs and experiences of your users. The
25590 square-bracketed numbers displayed inline after notesources may seem
25591 obstrusive and aesthetically unpleasing<footnote><para>As far as notesources that are links, ytou might
25592 think it would be better to just display URLs for non-empty
25593 links inline, after their content, rather than displaying
25594 square-bracketed numbers all over the place. But it's not better. In
25595 fact, it's not even practical, because many (most) URLs for links
25596 are too long to be displayed inline. They end up overflowing the
25597 right margin. You can set a non-zero value for
25598 <parameter>man.break.after.slash</parameter> parameter to deal with
25599 that, but it could be argued that what you end up with is at least
25600 as ugly, and definitely more obstrusive, then having short
25601 square-bracketed numbers displayed inline.</para></footnote>,
25603 but in a text-only output format, the
25604 numbered-notesources/endnotes-listing mechanism is the only
25605 practical way to handle this kind of content.</para>
25607 <para>Also, users of “text based” browsers such as
25608 <command>lynx</command> will already be accustomed to seeing inline
25609 numbers for links. And various "man to html" applications, such as
25610 the widely used <command><link xlink:href="http://users.actrix.gen.nz/michael/vhman2html.html">man2html</link></command> (<literal>VH-Man2html</literal>)
25611 application, can automatically turn URLs into "real" HTML hyperlinks
25612 in output. So leaving <parameter>man.endnotes.are.numbered</parameter>
25613 at its default (non-zero) value ensures that no information is
25614 lost in your man-page output. It just gets
25615 “rearranged”.</para>
25618 <para>The handling of empty links is not affected by this
25619 parameter. Empty links are handled simply by displaying their URLs
25620 inline. Empty links are never auto-numbered.</para>
25622 <para>If you disable endnotes numbering, you should probably also set
25623 <parameter>man.font.links</parameter> to an empty value (to
25624 disable font formatting for links.</para>
25627 <refsection><info><title>Related Parameters</title></info>
25628 <para><parameter>man.endnotes.list.enabled</parameter>,
25629 <parameter>man.font.links</parameter></para>
25633 <refentry version="5.0" id="man.base.url.for.relative.links">
25635 <refentrytitle>man.base.url.for.relative.links</refentrytitle>
25636 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
25639 <refname>man.base.url.for.relative.links</refname>
25640 <refpurpose>Specifies a base URL for relative links</refpurpose>
25644 <programlisting id="man.base.url.for.relative.links.frag"><xsl:param name="man.base.url.for.relative.links">[set $man.base.url.for.relative.links]/</xsl:param></programlisting>
25647 <refsection><info><title>Description</title></info>
25649 <para>For any “notesource” listed in the auto-generated
25650 “NOTES” section of output man pages (which is generated when
25652 <parameter>man.endnotes.list.enabled</parameter> parameter
25653 is non-zero), if the notesource is a link source with a
25654 relative URI, the URI is displayed in output with the value
25656 <parameter>man.base.url.for.relative.links</parameter>
25657 parameter prepended to the value of the link URI.</para>
25660 <para>A link source is an notesource that references an
25664 <para>a <tag>ulink</tag> element with a <tag class="attribute">url</tag> attribute</para>
25667 <para>any element with an <tag class="attribute">xlink:href</tag> attribute</para>
25670 <para>an <tag>imagedata</tag>, <tag>audiodata</tag>, or
25671 <tag>videodata</tag> element</para>
25677 <para>If you use relative URIs in link sources in your DocBook
25678 <tag>refentry</tag> source, and you leave
25679 <parameter>man.base.url.for.relative.links</parameter>
25680 unset, the relative links will appear “as is” in the “Notes”
25681 section of any man-page output generated from your source.
25682 That’s probably not what you want, because such relative
25683 links are only usable in the context of HTML output. So, to
25684 make the links meaningful and usable in the context of
25685 man-page output, set a value for
25686 <parameter>man.base.url.for.relative.links</parameter> that
25687 points to the online version of HTML output generated from
25688 your DocBook <tag>refentry</tag> source. For
25690 <programlisting><xsl:param name="man.base.url.for.relative.links"
25691 >http://www.kernel.org/pub/software/scm/git/docs/</xsl:param></programlisting>
25696 <refsection><info><title>Related Parameters</title></info>
25697 <para><parameter>man.endnotes.list.enabled</parameter></para>
25702 </reference><reference id="lists" xml:base="../manpages/param.xml">
25703 <title>Lists</title>
25704 <refentry version="5.0" id="man.segtitle.suppress">
25706 <refentrytitle>man.segtitle.suppress</refentrytitle>
25707 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
25710 <refname>man.segtitle.suppress</refname>
25711 <refpurpose>Suppress display of segtitle contents?</refpurpose>
25715 <programlisting id="man.segtitle.suppress.frag">
25716 <xsl:param name="man.segtitle.suppress" select="0"></xsl:param></programlisting>
25719 <refsection><info><title>Description</title></info>
25721 <para>If the value of <parameter>man.segtitle.suppress</parameter> is
25722 non-zero, then display of <tag>segtitle</tag> contents is
25723 suppressed in output.</para>
25728 </reference><reference id="charmap" xml:base="../manpages/param.xml">
25729 <title>Character/string substitution</title>
25730 <refentry version="5.0" id="man.charmap.enabled">
25732 <refentrytitle>man.charmap.enabled</refentrytitle>
25733 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
25736 <refname>man.charmap.enabled</refname>
25737 <refpurpose>Apply character map before final output?</refpurpose>
25741 <programlisting id="man.charmap.enabled.frag">
25742 <xsl:param name="man.charmap.enabled" select="1"></xsl:param>
25746 <refsection><info><title>Description</title></info>
25748 <para>If the value of the <parameter>man.charmap.enabled</parameter>
25749 parameter is non-zero, a "character map" is used to substitute certain
25750 Unicode symbols and special characters with appropriate roff/groff
25751 equivalents, just before writing each man-page file to the
25752 filesystem. If instead the value of
25753 <parameter>man.charmap.enabled</parameter> is zero, Unicode characters
25754 are passed through "as is".</para>
25756 <refsection><info><title>Details</title></info>
25758 <para>For converting certain Unicode symbols and special characters in
25759 UTF-8 or UTF-16 encoded XML source to appropriate groff/roff
25760 equivalents in man-page output, the DocBook XSL Stylesheets
25761 distribution includes a <link xlink:href="http://snapshots.docbook.org/xsl/manpages/charmap.groff.xsl">roff character map</link> that is compliant with the <link xlink:href="http://www.w3.org/TR/xslt20/#character-maps">XSLT character
25762 map</link> format as detailed in the XSLT 2.0 specification. The map
25763 contains more than 800 character mappings and can be considered the
25764 standard roff character map for the distribution.</para>
25766 <para>You can use the <parameter>man.charmap.uri</parameter>
25767 parameter to specify a URI for the location for an alternate roff
25768 character map to use in place of the standard roff character map
25769 provided in the distribution.</para>
25771 <para>You can also use a subset of a character map. For details,
25772 see the <parameter>man.charmap.use.subset</parameter>,
25773 <parameter>man.charmap.subset.profile</parameter>, and
25774 <parameter>man.charmap.subset.profile.english</parameter>
25781 <refentry version="5.0" id="man.charmap.uri">
25783 <refentrytitle>man.charmap.uri</refentrytitle>
25784 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
25787 <refname>man.charmap.uri</refname>
25788 <refpurpose>URI for custom roff character map</refpurpose>
25792 <programlisting id="man.charmap.uri.frag">
25793 <xsl:param name="man.charmap.uri"></xsl:param>
25797 <refsection><info><title>Description</title></info>
25799 <para>For converting certain Unicode symbols and special characters in
25800 UTF-8 or UTF-16 encoded XML source to appropriate groff/roff
25801 equivalents in man-page output, the DocBook XSL Stylesheets
25802 distribution includes an <link xlink:href="http://www.w3.org/TR/xslt20/#character-maps">XSLT character
25803 map</link>. That character map can be considered the standard roff
25804 character map for the distribution.</para>
25806 <para>If the value of the <parameter>man.charmap.uri</parameter>
25807 parameter is non-empty, that value is used as the URI for the location
25808 for an alternate roff character map to use in place of the standard
25809 roff character map provided in the distribution.</para>
25812 <para>Do not set a value for <parameter>man.charmap.uri</parameter>
25813 unless you have a custom roff character map that differs from the
25814 standard one provided in the distribution.</para>
25819 <refentry version="5.0" id="man.charmap.use.subset">
25821 <refentrytitle>man.charmap.use.subset</refentrytitle>
25822 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
25825 <refname>man.charmap.use.subset</refname>
25826 <refpurpose>Use subset of character map instead of full map?</refpurpose>
25830 <programlisting id="man.charmap.use.subset.frag">
25831 <xsl:param name="man.charmap.use.subset" select="1"></xsl:param>
25835 <refsection><info><title>Description</title></info>
25837 <para>If the value of the
25838 <parameter>man.charmap.use.subset</parameter> parameter is non-zero,
25839 a subset of the roff character map is used instead of the full roff
25840 character map. The profile of the subset used is determined either
25841 by the value of the
25842 <parameter>man.charmap.subset.profile</parameter>
25843 parameter (if the source is not in English) or the
25844 <parameter>man.charmap.subset.profile.english</parameter>
25845 parameter (if the source is in English).</para>
25848 <para>You may want to experiment with setting a non-zero value of
25849 <parameter>man.charmap.use.subset</parameter>, so that the full
25850 character map is used. Depending on which XSLT engine you run,
25851 setting a non-zero value for
25852 <parameter>man.charmap.use.subset</parameter> may significantly
25853 increase the time needed to process your documents. Or it may
25854 not. For example, if you set it and run it with xsltproc, it seems
25855 to dramatically increase processing time; on the other hand, if you
25856 set it and run it with Saxon, it does not seem to increase
25857 processing time nearly as much.</para>
25859 <para>If processing time is not a important concern and/or you can
25860 tolerate the increase in processing time imposed by using the full
25861 character map, set <parameter>man.charmap.use.subset</parameter> to
25865 <refsection><info><title>Details</title></info>
25867 <para>For converting certain Unicode symbols and special characters in
25868 UTF-8 or UTF-16 encoded XML source to appropriate groff/roff
25869 equivalents in man-page output, the DocBook XSL Stylesheets
25870 distribution includes a <link xlink:href="http://snapshots.docbook.org/xsl/manpages/charmap.groff.xsl">roff character map</link> that is compliant with the <link xlink:href="http://www.w3.org/TR/xslt20/#character-maps">XSLT character
25871 map</link> format as detailed in the XSLT 2.0 specification. The map
25872 contains more than 800 character mappings and can be considered the
25873 standard roff character map for the distribution.</para>
25876 <para>You can use the <parameter>man.charmap.uri</parameter>
25877 parameter to specify a URI for the location for an alternate roff
25878 character map to use in place of the standard roff character map
25879 provided in the distribution.</para>
25882 <para>Because it is not terrifically efficient to use the standard
25883 800-character character map in full -- and for most (or all) users,
25884 never necessary to use it in full -- the DocBook XSL Stylesheets
25885 support a mechanism for using, within any given character map, a
25886 subset of character mappings instead of the full set. You can use the
25887 <parameter>man.charmap.subset.profile</parameter> or
25888 <parameter>man.charmap.subset.profile.english</parameter>
25889 parameter to tune the profile of that subset to use.</para>
25895 <refentry version="5.0" id="man.charmap.subset.profile">
25897 <refentrytitle>man.charmap.subset.profile</refentrytitle>
25898 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
25901 <refname>man.charmap.subset.profile</refname>
25902 <refpurpose>Profile of character map subset</refpurpose>
25906 <programlisting id="man.charmap.subset.profile.frag">
25907 <xsl:param name="man.charmap.subset.profile">
25908 @*[local-name() = 'block'] = 'Miscellaneous Technical' or
25909 (@*[local-name() = 'block'] = 'C1 Controls And Latin-1 Supplement (Latin-1 Supplement)' and
25910 (@*[local-name() = 'class'] = 'symbols' or
25911 @*[local-name() = 'class'] = 'letters')
25913 @*[local-name() = 'block'] = 'Latin Extended-A'
25915 (@*[local-name() = 'block'] = 'General Punctuation' and
25916 (@*[local-name() = 'class'] = 'spaces' or
25917 @*[local-name() = 'class'] = 'dashes' or
25918 @*[local-name() = 'class'] = 'quotes' or
25919 @*[local-name() = 'class'] = 'bullets'
25922 @*[local-name() = 'name'] = 'HORIZONTAL ELLIPSIS' or
25923 @*[local-name() = 'name'] = 'WORD JOINER' or
25924 @*[local-name() = 'name'] = 'SERVICE MARK' or
25925 @*[local-name() = 'name'] = 'TRADE MARK SIGN' or
25926 @*[local-name() = 'name'] = 'ZERO WIDTH NO-BREAK SPACE'
25931 <refsection><info><title>Description</title></info>
25933 <para>If the value of the
25934 <parameter>man.charmap.use.subset</parameter> parameter is non-zero,
25935 and your DocBook source is not written in English (that
25936 is, if the <tag class="attribute">lang</tag> or <tag class="attribute">xml:lang</tag> attribute on the root element
25937 in your DocBook source or on the first <tag>refentry</tag>
25938 element in your source has a value other than
25939 <literal>en</literal>), then the character-map subset specified
25940 by the <parameter>man.charmap.subset.profile</parameter>
25941 parameter is used instead of the full roff character map.</para>
25943 <para>Otherwise, if the <tag class="attribute">lang</tag> or <tag class="attribute">xml:lang</tag> attribute on the root
25944 element in your DocBook
25945 source or on the first <tag>refentry</tag> element in your source
25946 has the value <literal>en</literal> or if it has no <tag class="attribute">lang</tag> or <tag class="attribute">xml:lang</tag> attribute, then the character-map
25947 subset specified by the
25948 <parameter>man.charmap.subset.profile.english</parameter>
25949 parameter is used instead of
25950 <parameter>man.charmap.subset.profile</parameter>.</para>
25952 <para>The difference between the two subsets is that
25953 <parameter>man.charmap.subset.profile</parameter> provides
25954 mappings for characters in Western European languages that are
25955 not part of the Roman (English) alphabet (ASCII character set).</para>
25957 <para>The value of <parameter>man.charmap.subset.profile</parameter>
25958 is a string representing an XPath expression that matches attribute
25959 names and values for <tag namespace="http://docbook.sf.net/xmlns/unichar/1.0">output-character</tag>
25960 elements in the character map.</para>
25962 <para>The attributes supported in the <link xlink:href="http://snapshots.docbook.org/xsl/manpages/charmap.groff.xsl">standard roff character map included in the distribution</link> are:
25965 <term>character</term>
25967 <simpara>a raw Unicode character or numeric Unicode
25968 character-entity value (either in decimal or hex); all
25969 characters have this attribute</simpara>
25975 <simpara>a standard full/long ISO/Unicode character name (e.g.,
25976 "OHM SIGN"); all characters have this attribute</simpara>
25982 <simpara>a standard Unicode "block" name (e.g., "General
25983 Punctuation"); all characters have this attribute. For the full
25984 list of Unicode block names supported in the standard roff
25985 character map, see <xref linkend="BlocksAndClasses"/>.</simpara>
25991 <simpara>a class of characters (e.g., "spaces"). Not all
25992 characters have this attribute; currently, it is used only with
25993 certain characters within the "C1 Controls And Latin-1
25994 Supplement" and "General Punctuation" blocks. For details, see
25995 <xref linkend="BlocksAndClasses"/>.</simpara>
25999 <term>entity</term>
26001 <simpara>an ISO entity name (e.g., "ohm"); not all characters
26002 have this attribute, because not all characters have ISO entity
26003 names; for example, of the 800 or so characters in the standard
26004 roff character map included in the distribution, only around 300
26005 have ISO entity names.
26010 <term>string</term>
26012 <simpara>a string representing an roff/groff escape-code (with
26013 "@esc@" used in place of the backslash), or a simple ASCII
26014 string; all characters in the roff character map have this
26015 attribute</simpara>
26020 <para>The value of <parameter>man.charmap.subset.profile</parameter>
26021 is evaluated as an XPath expression at run-time to select a portion of
26022 the roff character map to use. You can tune the subset used by adding
26023 or removing parts. For example, if you need to use a wide range of
26024 mathematical operators in a document, and you want to have them
26025 converted into roff markup properly, you might add the following:
26027 <literallayout class="monospaced"> @*[local-name() = 'block'] ='MathematicalOperators' </literallayout>
26029 That will cause a additional set of around 67 additional "math"
26030 characters to be converted into roff markup. </para>
26033 <para>Depending on which XSLT engine you use, either the EXSLT
26034 <function>dyn:evaluate</function> extension function (for xsltproc or
26035 Xalan) or <function>saxon:evaluate</function> extension function (for
26036 Saxon) are used to dynamically evaluate the value of
26037 <parameter>man.charmap.subset.profile</parameter> at run-time. If you
26038 don't use xsltproc, Saxon, Xalan -- or some other XSLT engine that
26039 supports <function>dyn:evaluate</function> -- you must either set the
26040 value of the <parameter>man.charmap.use.subset</parameter> parameter
26041 to zero and process your documents using the full character map
26042 instead, or set the value of the
26043 <parameter>man.charmap.enabled</parameter> parameter to zero instead
26044 (so that character-map processing is disabled completely.</para>
26047 <para>An alternative to using
26048 <parameter>man.charmap.subset.profile</parameter> is to create your
26049 own custom character map, and set the value of
26050 <parameter>man.charmap.uri</parameter> to the URI/filename for
26051 that. If you use a custom character map, you will probably want to
26052 include in it just the characters you want to use, and so you will
26053 most likely also want to set the value of
26054 <parameter>man.charmap.use.subset</parameter> to zero.</para>
26055 <para>You can create a
26056 custom character map by making a copy of the <link xlink:href="http://snapshots.docbook.org/xsl/manpages/charmap.groff.xsl">standard roff character map</link> provided in the distribution, and
26057 then adding to, changing, and/or deleting from that.</para>
26060 <para>If you author your DocBook XML source in UTF-8 or UTF-16
26061 encoding and aren't sure what OSes or environments your man-page
26062 output might end up being viewed on, and not sure what version of
26063 nroff/groff those environments might have, you should be careful about
26064 what Unicode symbols and special characters you use in your source and
26065 what parts you add to the value of
26066 <parameter>man.charmap.subset.profile</parameter>.</para>
26067 <para>Many of the escape codes used are specific to groff and using
26068 them may not provide the expected output on an OS or environment that
26069 uses nroff instead of groff.</para>
26070 <para>On the other hand, if you intend for your man-page output to be
26071 viewed only on modern systems (for example, GNU/Linux systems, FreeBSD
26072 systems, or Cygwin environments) that have a good, up-to-date groff,
26073 then you can safely include a wide range of Unicode symbols and
26074 special characters in your UTF-8 or UTF-16 encoded DocBook XML source
26075 and add any of the supported Unicode block names to the value of
26076 <parameter>man.charmap.subset.profile</parameter>.</para>
26080 <para>For other details, see the documentation for the
26081 <parameter>man.charmap.use.subset</parameter> parameter.</para>
26083 <refsection id="BlocksAndClasses"><info><title>Supported Unicode block names and "class" values</title></info>
26086 <para>Below is the full list of Unicode block names and "class"
26087 values supported in the standard roff stylesheet provided in the
26088 distribution, along with a description of which codepoints from the
26089 Unicode range corresponding to that block name or block/class
26090 combination are supported.</para>
26094 <para><link xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&id=C1%20Controls%20and%20Latin-1%20Supplement%20(Latin-1%20Supplement)">C1 Controls And Latin-1 Supplement (Latin-1 Supplement)</link> (x00a0 to x00ff)
26095 <itemizedlist><info><title>class values</title></info>
26098 <para>symbols</para>
26101 <para>letters</para>
26103 </itemizedlist></para>
26106 <para><link xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&id=Latin%20Extended-A">Latin Extended-A</link> (x0100 to x017f, partial)</para>
26109 <para><link xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&id=Spacing%20Modifier%20Letters">Spacing Modifier Letters</link> (x02b0 to x02ee, partial)</para>
26112 <para><link xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&id=Greek%20and%20Coptic">Greek and Coptic</link> (x0370 to x03ff, partial)</para>
26115 <para><link xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&id=General%20Punctuation">General Punctuation</link> (x2000 to x206f, partial)
26116 <itemizedlist><info><title>class values</title></info>
26119 <para><link xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&start=8192&end=8203">spaces</link></para>
26122 <para><link xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&start=8208&end=8213">dashes</link></para>
26125 <para>quotes</para>
26128 <para>daggers</para>
26131 <para>bullets</para>
26134 <para>leaders</para>
26137 <para>primes</para>
26143 <para><link xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&id=Superscripts%20and%20Subscripts">Superscripts and Subscripts</link> (x2070 to x209f)</para>
26146 <para><link xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&id=Currency%20Symbols">Currency Symbols</link> (x20a0 to x20b1)</para>
26149 <para><link xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&id=Letterlike%20Symbols">Letterlike Symbols</link> (x2100 to x214b)</para>
26152 <para><link xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&id=Number%20Forms">Number Forms</link> (x2150 to x218f)</para>
26155 <para><link xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&id=Arrows">Arrows</link> (x2190 to x21ff, partial)</para>
26158 <para><link xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&id=Mathematical%20Operators">Mathematical Operators</link> (x2200 to x22ff, partial)</para>
26161 <para><link xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&id=Control%20Pictures">Control Pictures</link> (x2400 to x243f)</para>
26164 <para><link xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&id=Enclosed%20Alphanumerics">Enclosed Alphanumerics</link> (x2460 to x24ff)</para>
26167 <para><link xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&id=Geometric%20Shapes">Geometric Shapes</link> (x25a0 to x25f7, partial)</para>
26170 <para><link xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&id=Miscellaneous%20Symbols">Miscellaneous Symbols</link> (x2600 to x26ff, partial)</para>
26173 <para><link xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&id=Dingbats">Dingbats</link> (x2700 to x27be, partial)</para>
26176 <para><link xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&id=Alphabetic%20Presentation%20Forms">Alphabetic Presentation Forms</link> (xfb00 to xfb04 only)</para>
26183 <refentry version="5.0" id="man.charmap.subset.profile.english">
26185 <refentrytitle>man.charmap.subset.profile.english</refentrytitle>
26186 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
26189 <refname>man.charmap.subset.profile.english</refname>
26190 <refpurpose>Profile of character map subset</refpurpose>
26194 <programlisting id="man.charmap.subset.profile.english.frag">
26195 <xsl:param name="man.charmap.subset.profile.english">
26196 @*[local-name() = 'block'] = 'Miscellaneous Technical' or
26197 (@*[local-name() = 'block'] = 'C1 Controls And Latin-1 Supplement (Latin-1 Supplement)' and
26198 @*[local-name() = 'class'] = 'symbols')
26200 (@*[local-name() = 'block'] = 'General Punctuation' and
26201 (@*[local-name() = 'class'] = 'spaces' or
26202 @*[local-name() = 'class'] = 'dashes' or
26203 @*[local-name() = 'class'] = 'quotes' or
26204 @*[local-name() = 'class'] = 'bullets'
26207 @*[local-name() = 'name'] = 'HORIZONTAL ELLIPSIS' or
26208 @*[local-name() = 'name'] = 'WORD JOINER' or
26209 @*[local-name() = 'name'] = 'SERVICE MARK' or
26210 @*[local-name() = 'name'] = 'TRADE MARK SIGN' or
26211 @*[local-name() = 'name'] = 'ZERO WIDTH NO-BREAK SPACE'
26216 <refsection><info><title>Description</title></info>
26218 <para>If the value of the
26219 <parameter>man.charmap.use.subset</parameter> parameter is
26220 non-zero, and your DocBook source is written in English (that
26221 is, if its <tag class="attribute">lang</tag> or <tag class="attribute">xml:lang</tag> attribute on the root element
26222 in your DocBook source or on the first <tag>refentry</tag>
26223 element in your source has the value <literal>en</literal> or if
26224 it has no <tag class="attribute">lang</tag> or <tag class="attribute">xml:lang</tag> attribute), then the
26225 character-map subset specified by the
26226 <parameter>man.charmap.subset.profile.english</parameter>
26227 parameter is used instead of the full roff character map.</para>
26229 <para>Otherwise, if the <tag class="attribute">lang</tag> or <tag class="attribute">xml:lang</tag> attribute
26230 on the root element in your DocBook source or on the first
26231 <tag>refentry</tag> element in your source has a value other
26232 than <literal>en</literal>, then the character-map subset
26234 <parameter>man.charmap.subset.profile</parameter> parameter is
26236 <parameter>man.charmap.subset.profile.english</parameter>.</para>
26238 <para>The difference between the two subsets is that
26239 <parameter>man.charmap.subset.profile</parameter> provides
26240 mappings for characters in Western European languages that are
26241 not part of the Roman (English) alphabet (ASCII character set).</para>
26243 <para>The value of <parameter>man.charmap.subset.profile.english</parameter>
26244 is a string representing an XPath expression that matches attribute
26245 names and values for <tag namespace="http://docbook.sf.net/xmlns/unichar/1.0">output-character</tag> elements in the character map.</para>
26247 <para>For other details, see the documentation for the
26248 <parameter>man.charmap.subset.profile.english</parameter> and
26249 <parameter>man.charmap.use.subset</parameter> parameters.</para>
26254 <refentry version="5.0" id="man.string.subst.map.local.pre">
26256 <refentrytitle>man.string.subst.map.local.pre</refentrytitle>
26257 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
26260 <refname>man.string.subst.map.local.pre</refname>
26261 <refpurpose>Specifies “local” string substitutions</refpurpose>
26265 <programlisting id="man.string.subst.map.local.pre.frag">
26266 <xsl:param name="man.string.subst.map.local.pre"></xsl:param>
26270 <refsection><info><title>Description</title></info>
26272 <para>Use the <parameter>man.string.subst.map.local.pre</parameter>
26273 parameter to specify any “local” string substitutions to perform over
26274 the entire roff source for each man page <emphasis>before</emphasis>
26275 performing the string substitutions specified by the <parameter>man.string.subst.map</parameter> parameter.</para>
26277 <para>For details about the format of this parameter, see the
26278 documentation for the <parameter>man.string.subst.map</parameter>
26284 <refentry version="5.0" id="man.string.subst.map">
26286 <refentrytitle>man.string.subst.map</refentrytitle>
26287 <refmiscinfo class="other" otherclass="datatype">rtf</refmiscinfo>
26290 <refname>man.string.subst.map</refname>
26291 <refpurpose>Specifies a set of string substitutions</refpurpose>
26295 <programlisting id="man.string.subst.map.frag">
26296 <xsl:param name="man.string.subst.map">
26298 <!-- * remove no-break marker at beginning of line (stylesheet artifact) -->
26299 <ss:substitution oldstring="▒▀" newstring="▒"></ss:substitution>
26300 <!-- * replace U+2580 no-break marker (stylesheet-added) w/ no-break space -->
26301 <ss:substitution oldstring="▀" newstring="\ "></ss:substitution>
26303 <!-- ==================================================================== -->
26305 <!-- * squeeze multiple newlines before a roff request -->
26306 <ss:substitution oldstring="
26309 ."></ss:substitution>
26310 <!-- * remove any .sp instances that directly precede a .PP -->
26311 <ss:substitution oldstring=".sp
26312 .PP" newstring=".PP"></ss:substitution>
26313 <!-- * remove any .sp instances that directly follow a .PP -->
26314 <ss:substitution oldstring=".sp
26315 .sp" newstring=".sp"></ss:substitution>
26316 <!-- * squeeze multiple .sp instances into a single .sp-->
26317 <ss:substitution oldstring=".PP
26318 .sp" newstring=".PP"></ss:substitution>
26319 <!-- * squeeze multiple newlines after start of no-fill (verbatim) env. -->
26320 <ss:substitution oldstring=".nf
26323 "></ss:substitution>
26324 <!-- * squeeze multiple newlines after REstoring margin -->
26325 <ss:substitution oldstring=".RE
26328 "></ss:substitution>
26329 <!-- * U+2591 is a marker we add before and after every Parameter in -->
26330 <!-- * Funcprototype output -->
26331 <ss:substitution oldstring="░" newstring=" "></ss:substitution>
26332 <!-- * U+2592 is a marker we add for the newline before output of <sbr>; -->
26333 <ss:substitution oldstring="▒" newstring="
26334 "></ss:substitution>
26336 <!-- * Now deal with some other characters that are added by the -->
26337 <!-- * stylesheets during processing. -->
26339 <!-- * bullet -->
26340 <ss:substitution oldstring="•" newstring="\(bu"></ss:substitution>
26341 <!-- * left double quote -->
26342 <ss:substitution oldstring="“" newstring="\(lq"></ss:substitution>
26343 <!-- * right double quote -->
26344 <ss:substitution oldstring="”" newstring="\(rq"></ss:substitution>
26345 <!-- * left single quote -->
26346 <ss:substitution oldstring="‘" newstring="\(oq"></ss:substitution>
26347 <!-- * right single quote -->
26348 <ss:substitution oldstring="’" newstring="\(cq"></ss:substitution>
26349 <!-- * copyright sign -->
26350 <ss:substitution oldstring="©" newstring="\(co"></ss:substitution>
26351 <!-- * registered sign -->
26352 <ss:substitution oldstring="®" newstring="\(rg"></ss:substitution>
26353 <!-- * ...servicemark... -->
26354 <!-- * There is no groff equivalent for it. -->
26355 <ss:substitution oldstring="℠" newstring="(SM)"></ss:substitution>
26356 <!-- * ...trademark... -->
26357 <!-- * We don't do "\(tm" because for console output, -->
26358 <!-- * groff just renders that as "tm"; that is: -->
26360 <!-- * Product&#x2122; -> Producttm -->
26362 <!-- * So we just make it to "(TM)" instead; thus: -->
26364 <!-- * Product&#x2122; -> Product(TM) -->
26365 <ss:substitution oldstring="™" newstring="(TM)"></ss:substitution>
26371 <refsection><info><title>Description</title></info>
26373 <para>The <parameter>man.string.subst.map</parameter> parameter
26374 contains <link linkend="map">a map</link> that specifies a set of
26375 string substitutions to perform over the entire roff source for each
26376 man page, either just before generating final man-page output (that
26377 is, before writing man-page files to disk) or, if the value of the
26378 <parameter>man.charmap.enabled</parameter> parameter is non-zero,
26379 before applying the roff character map.</para>
26381 <para>You can use <parameter>man.string.subst.map</parameter> as a
26382 “lightweight” character map to perform “essential” substitutions --
26383 that is, substitutions that are <emphasis>always</emphasis> performed,
26384 even if the value of the <parameter>man.charmap.enabled</parameter>
26385 parameter is zero. For example, you can use it to replace quotation
26386 marks or other special characters that are generated by the DocBook
26387 XSL stylesheets for a particular locale setting (as opposed to those
26388 characters that are actually in source XML documents), or to replace
26389 any special characters that may be automatically generated by a
26390 particular customization of the DocBook XSL stylesheets.</para>
26393 <para>Do you not change value of the
26394 <parameter>man.string.subst.map</parameter> parameter unless you are
26395 sure what you are doing. First consider adding your
26396 string-substitution mappings to either or both of the following
26400 <term><parameter>man.string.subst.map.local.pre</parameter></term>
26401 <listitem><para>applied before
26402 <parameter>man.string.subst.map</parameter></para></listitem>
26405 <term><parameter>man.string.subst.map.local.post</parameter></term>
26406 <listitem><para>applied after
26407 <parameter>man.string.subst.map</parameter></para></listitem>
26410 By default, both of those parameters contain no
26411 string substitutions. They are intended as a means for you to
26412 specify your own local string-substitution mappings.</para>
26414 <para>If you remove any of default mappings from the value of the
26415 <parameter>man.string.subst.map</parameter> parameter, you are
26416 likely to end up with broken output. And be very careful about adding
26417 anything to it; it’s used for doing string substitution over the
26418 entire roff source of each man page – it causes target strings to be
26419 replaced in roff requests and escapes, not just in the visible
26420 contents of the page.</para>
26424 <refsection id="map">
26426 <title>Contents of the substitution map</title>
26428 <para>The string-substitution map contains one or more
26429 <tag>ss:substitution</tag> elements, each of which has two
26433 <term>oldstring</term>
26435 <simpara>string to replace</simpara>
26439 <term>newstring</term>
26441 <simpara>string with which to replace <tag class="attribute">oldstring</tag></simpara>
26445 It may also include XML comments (that is, delimited with
26446 "<literal><!--</literal>" and "<literal>--></literal>").
26453 <refentry version="5.0" id="man.string.subst.map.local.post">
26455 <refentrytitle>man.string.subst.map.local.post</refentrytitle>
26456 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
26459 <refname>man.string.subst.map.local.post</refname>
26460 <refpurpose>Specifies “local” string substitutions</refpurpose>
26464 <programlisting id="man.string.subst.map.local.post.frag">
26465 <xsl:param name="man.string.subst.map.local.post"></xsl:param>
26469 <refsection><info><title>Description</title></info>
26471 <para>Use the <parameter>man.string.subst.map.local.post</parameter>
26472 parameter to specify any “local” string substitutions to perform over
26473 the entire roff source for each man page <emphasis>after</emphasis>
26474 performing the string substitutions specified by the <parameter>man.string.subst.map</parameter> parameter.</para>
26476 <para>For details about the format of this parameter, see the
26477 documentation for the <parameter>man.string.subst.map</parameter>
26483 </reference><reference id="refmeta" xml:base="../manpages/param.xml">
26484 <title>Refentry metadata gathering</title>
26485 <refentry version="5.0" id="refentry.meta.get.quietly">
26487 <refentrytitle>refentry.meta.get.quietly</refentrytitle>
26488 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
26491 <refname>refentry.meta.get.quietly</refname>
26492 <refpurpose>Suppress notes and warnings when gathering refentry metadata?</refpurpose>
26496 <programlisting id="refentry.meta.get.quietly.frag">
26497 <xsl:param name="refentry.meta.get.quietly" select="0"></xsl:param>
26501 <refsection><info><title>Description</title></info>
26503 <para>If zero (the default), notes and warnings about “missing” markup
26504 are generated during gathering of refentry metadata. If non-zero, the
26505 metadata is gathered “quietly” -- that is, the notes and warnings are
26509 <para>If you are processing a large amount of <tag>refentry</tag>
26510 content, you may be able to speed up processing significantly by
26511 setting a non-zero value for
26512 <parameter>refentry.meta.get.quietly</parameter>.</para>
26518 <refentry version="5.0" id="refentry.date.profile">
26520 <refentrytitle>refentry.date.profile</refentrytitle>
26521 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
26524 <refname>refentry.date.profile</refname>
26525 <refpurpose>Specifies profile for refentry "date" data</refpurpose>
26529 <programlisting id="refentry.date.profile.frag">
26530 <xsl:param name="refentry.date.profile">
26531 (($info[//date])[last()]/date)[1]|
26532 (($info[//pubdate])[last()]/pubdate)[1]
26537 <refsection><info><title>Description</title></info>
26539 <para>The value of <parameter>refentry.date.profile</parameter> is a
26540 string representing an XPath expression. It is evaluated at run-time
26541 and used only if <parameter>refentry.date.profile.enabled</parameter>
26542 is non-zero. Otherwise, the <tag>refentry</tag> metadata-gathering
26543 logic "hard coded" into the stylesheets is used.</para>
26545 <para> The <literal>man(7)</literal> man page describes this content
26546 as "the date of the last revision". In man pages, it is the content
26547 that is usually displayed in the center footer.</para>
26552 <refentry version="5.0" id="refentry.date.profile.enabled">
26554 <refentrytitle>refentry.date.profile.enabled</refentrytitle>
26555 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
26558 <refname>refentry.date.profile.enabled</refname>
26559 <refpurpose>Enable refentry "date" profiling?</refpurpose>
26563 <programlisting id="refentry.date.profile.enabled.frag">
26564 <xsl:param name="refentry.date.profile.enabled">0</xsl:param></programlisting>
26567 <refsection><info><title>Description</title></info>
26569 <para>If the value of
26570 <parameter>refentry.date.profile.enabled</parameter> is non-zero, then
26571 during <tag>refentry</tag> metadata gathering, the info profile
26572 specified by the customizable
26573 <parameter>refentry.date.profile</parameter> parameter is used.</para>
26575 <para>If instead the value of
26576 <parameter>refentry.date.profile.enabled</parameter> is zero (the
26577 default), then "hard coded" logic within the DocBook XSL stylesheets
26578 is used for gathering <tag>refentry</tag> "date" data.</para>
26580 <para>If you find that the default <tag>refentry</tag>
26581 metadata-gathering behavior is causing incorrect "date" data to show
26582 up in your output, then consider setting a non-zero value for
26583 <parameter>refentry.date.profile.enabled</parameter> and adjusting the
26584 value of <parameter>refentry.date.profile</parameter> to cause correct
26585 data to be gathered. </para>
26587 <para>Note that the terms "source" and "date" have special meanings in
26588 this context. For details, see the documentation for the
26589 <parameter>refentry.date.profile</parameter> parameter.</para>
26594 <refentry version="5.0" id="refentry.manual.profile">
26596 <refentrytitle>refentry.manual.profile</refentrytitle>
26597 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
26600 <refname>refentry.manual.profile</refname>
26601 <refpurpose>Specifies profile for refentry "manual" data</refpurpose>
26605 <programlisting id="refentry.manual.profile.frag">
26606 <xsl:param name="refentry.manual.profile">
26607 (($info[//title])[last()]/title)[1]|
26613 <refsection><info><title>Description</title></info>
26615 <para>The value of <parameter>refentry.manual.profile</parameter> is
26616 a string representing an XPath expression. It is evaluated at
26617 run-time and used only if
26618 <parameter>refentry.manual.profile.enabled</parameter> is
26619 non-zero. Otherwise, the <tag>refentry</tag> metadata-gathering logic
26620 "hard coded" into the stylesheets is used.</para>
26622 <para>In man pages, this content is usually displayed in the middle of
26623 the header of the page. The <literal>man(7)</literal> man page
26624 describes this as "the title of the manual (e.g., <citetitle>Linux
26625 Programmer's Manual</citetitle>)". Here are some examples from
26626 existing man pages:
26629 <para><citetitle>dpkg utilities</citetitle>
26630 (<command>dpkg-name</command>)</para>
26633 <para><citetitle>User Contributed Perl Documentation</citetitle>
26634 (<command>GET</command>)</para>
26637 <para><citetitle>GNU Development Tools</citetitle>
26638 (<command>ld</command>)</para>
26641 <para><citetitle>Emperor Norton Utilities</citetitle>
26642 (<command>ddate</command>)</para>
26645 <para><citetitle>Debian GNU/Linux manual</citetitle>
26646 (<command>faked</command>)</para>
26649 <para><citetitle>GIMP Manual Pages</citetitle>
26650 (<command>gimp</command>)</para>
26653 <para><citetitle>KDOC Documentation System</citetitle>
26654 (<command>qt2kdoc</command>)</para>
26662 <refentry version="5.0" id="refentry.manual.profile.enabled">
26664 <refentrytitle>refentry.manual.profile.enabled</refentrytitle>
26665 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
26668 <refname>refentry.manual.profile.enabled</refname>
26669 <refpurpose>Enable refentry "manual" profiling?</refpurpose>
26673 <programlisting id="refentry.manual.profile.enabled.frag">
26674 <xsl:param name="refentry.manual.profile.enabled">0</xsl:param></programlisting>
26677 <refsection><info><title>Description</title></info>
26679 <para>If the value of
26680 <parameter>refentry.manual.profile.enabled</parameter> is
26681 non-zero, then during <tag>refentry</tag> metadata gathering, the info
26682 profile specified by the customizable
26683 <parameter>refentry.manual.profile</parameter> parameter is
26686 <para>If instead the value of
26687 <parameter>refentry.manual.profile.enabled</parameter> is zero (the
26688 default), then "hard coded" logic within the DocBook XSL stylesheets
26689 is used for gathering <tag>refentry</tag> "manual" data.</para>
26691 <para>If you find that the default <tag>refentry</tag>
26692 metadata-gathering behavior is causing incorrect "manual" data to show
26693 up in your output, then consider setting a non-zero value for
26694 <parameter>refentry.manual.profile.enabled</parameter> and adjusting
26695 the value of <parameter>refentry.manual.profile</parameter> to cause
26696 correct data to be gathered. </para>
26698 <para>Note that the term "manual" has a special meanings in this
26699 context. For details, see the documentation for the
26700 <parameter>refentry.manual.profile</parameter> parameter.</para>
26705 <refentry version="5.0" id="refentry.source.name.suppress">
26707 <refentrytitle>refentry.source.name.suppress</refentrytitle>
26708 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
26711 <refname>refentry.source.name.suppress</refname>
26712 <refpurpose>Suppress "name" part of refentry "source" contents?</refpurpose>
26716 <programlisting id="refentry.source.name.suppress.frag">
26717 <xsl:param name="refentry.source.name.suppress">0</xsl:param></programlisting>
26720 <refsection><info><title>Description</title></info>
26722 <para>If the value of
26723 <parameter>refentry.source.name.suppress</parameter> is non-zero, then
26724 during <tag>refentry</tag> metadata gathering, no "source name" data
26725 is added to the <tag>refentry</tag> "source" contents. Instead (unless
26726 <parameter>refentry.version.suppress</parameter> is also non-zero),
26727 only "version" data is added to the "source" contents.</para>
26729 <para>If you find that the <tag>refentry</tag> metadata gathering
26730 mechanism is causing unwanted "source name" data to show up in your
26731 output -- for example, in the footer (or possibly header) of a man
26732 page -- then you might consider setting a non-zero value for
26733 <parameter>refentry.source.name.suppress</parameter>.</para>
26735 <para>Note that the terms "source", "source name", and "version" have
26736 special meanings in this context. For details, see the documentation
26737 for the <parameter>refentry.source.name.profile</parameter>
26743 <refentry version="5.0" id="refentry.source.name.profile">
26745 <refentrytitle>refentry.source.name.profile</refentrytitle>
26746 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
26749 <refname>refentry.source.name.profile</refname>
26750 <refpurpose>Specifies profile for refentry "source name" data</refpurpose>
26754 <programlisting id="refentry.source.name.profile.frag">
26755 <xsl:param name="refentry.source.name.profile">
26756 (($info[//productname])[last()]/productname)[1]|
26757 (($info[//corpname])[last()]/corpname)[1]|
26758 (($info[//corpcredit])[last()]/corpcredit)[1]|
26759 (($info[//corpauthor])[last()]/corpauthor)[1]|
26760 (($info[//orgname])[last()]/orgname)[1]|
26761 (($info[//publishername])[last()]/publishername)[1]
26766 <refsection><info><title>Description</title></info>
26768 <para>The value of <parameter>refentry.source.name.profile</parameter>
26769 is a string representing an XPath expression. It is evaluated at
26770 run-time and used only if
26771 <parameter>refentry.source.name.profile.enabled</parameter> is
26772 non-zero. Otherwise, the <tag>refentry</tag> metadata-gathering logic
26773 "hard coded" into the stylesheets is used.</para>
26775 <para>A "source name" is one part of a (potentially) two-part
26776 <replaceable>Name</replaceable> <replaceable>Version</replaceable>
26777 "source" field. In man pages, it is usually displayed in the left
26778 footer of the page. It typically indicates the software system or
26779 product that the item documented in the man page belongs to. The
26780 <literal>man(7)</literal> man page describes it as "the source of
26781 the command", and provides the following examples:
26784 <para>For binaries, use something like: GNU, NET-2, SLS
26785 Distribution, MCC Distribution.</para>
26788 <para>For system calls, use the version of the kernel that you
26789 are currently looking at: Linux 0.99.11.</para>
26792 <para>For library calls, use the source of the function: GNU, BSD
26793 4.3, Linux DLL 4.4.1.</para>
26798 <para>In practice, there are many pages that simply have a Version
26799 number in the "source" field. So, it looks like what we have is a
26801 <replaceable>Name</replaceable> <replaceable>Version</replaceable>,
26807 <para>product name (e.g., BSD) or org. name (e.g., GNU)</para>
26811 <term>Version</term>
26813 <para>version number</para>
26817 Each part is optional. If the <replaceable>Name</replaceable> is a
26818 product name, then the <replaceable>Version</replaceable> is probably
26819 the version of the product. Or there may be no
26820 <replaceable>Name</replaceable>, in which case, if there is a
26821 <replaceable>Version</replaceable>, it is probably the version
26822 of the item itself, not the product it is part of. Or, if the
26823 <replaceable>Name</replaceable> is an organization name, then there
26824 probably will be no <replaceable>Version</replaceable>.</para>
26828 <refentry version="5.0" id="refentry.source.name.profile.enabled">
26830 <refentrytitle>refentry.source.name.profile.enabled</refentrytitle>
26831 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
26834 <refname>refentry.source.name.profile.enabled</refname>
26835 <refpurpose>Enable refentry "source name" profiling?</refpurpose>
26839 <programlisting id="refentry.source.name.profile.enabled.frag">
26840 <xsl:param name="refentry.source.name.profile.enabled">0</xsl:param></programlisting>
26843 <refsection><info><title>Description</title></info>
26845 <para>If the value of
26846 <parameter>refentry.source.name.profile.enabled</parameter> is
26847 non-zero, then during <tag>refentry</tag> metadata gathering, the info
26848 profile specified by the customizable
26849 <parameter>refentry.source.name.profile</parameter> parameter is
26852 <para>If instead the value of
26853 <parameter>refentry.source.name.profile.enabled</parameter> is zero (the
26854 default), then "hard coded" logic within the DocBook XSL stylesheets
26855 is used for gathering <tag>refentry</tag> "source name" data.</para>
26857 <para>If you find that the default <tag>refentry</tag>
26858 metadata-gathering behavior is causing incorrect "source name" data to
26859 show up in your output, then consider setting a non-zero value for
26860 <parameter>refentry.source.name.profile.enabled</parameter> and
26861 adjusting the value of
26862 <parameter>refentry.source.name.profile</parameter> to cause correct
26863 data to be gathered. </para>
26865 <para>Note that the terms "source" and "source name" have special
26866 meanings in this context. For details, see the documentation for the
26867 <parameter>refentry.source.name.profile</parameter> parameter.</para>
26872 <refentry version="5.0" id="refentry.version.suppress">
26874 <refentrytitle>refentry.version.suppress</refentrytitle>
26875 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
26878 <refname>refentry.version.suppress</refname>
26879 <refpurpose>Suppress "version" part of refentry "source" contents?</refpurpose>
26883 <programlisting id="refentry.version.suppress.frag">
26884 <xsl:param name="refentry.version.suppress">0</xsl:param></programlisting>
26887 <refsection><info><title>Description</title></info>
26889 <para>If the value of <parameter>refentry.version.suppress</parameter>
26890 is non-zero, then during <tag>refentry</tag> metadata gathering, no
26891 "version" data is added to the <tag>refentry</tag> "source"
26892 contents. Instead (unless
26893 <parameter>refentry.source.name.suppress</parameter> is also
26894 non-zero), only "source name" data is added to the "source"
26897 <para>If you find that the <tag>refentry</tag> metadata gathering
26898 mechanism is causing unwanted "version" data to show up in your output
26899 -- for example, in the footer (or possibly header) of a man page --
26900 then you might consider setting a non-zero value for
26901 <parameter>refentry.version.suppress</parameter>.</para>
26903 <para>Note that the terms "source", "source name", and "version" have
26904 special meanings in this context. For details, see the documentation
26905 for the <parameter>refentry.source.name.profile</parameter>
26911 <refentry version="5.0" id="refentry.version.profile">
26913 <refentrytitle>refentry.version.profile</refentrytitle>
26914 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
26917 <refname>refentry.version.profile</refname>
26918 <refpurpose>Specifies profile for refentry "version" data</refpurpose>
26922 <programlisting id="refentry.version.profile.frag">
26923 <xsl:param name="refentry.version.profile">
26924 (($info[//productnumber])[last()]/productnumber)[1]|
26925 (($info[//edition])[last()]/edition)[1]|
26926 (($info[//releaseinfo])[last()]/releaseinfo)[1]
26931 <refsection><info><title>Description</title></info>
26933 <para>The value of <parameter>refentry.version.profile</parameter> is
26934 a string representing an XPath expression. It is evaluated at
26935 run-time and used only if
26936 <parameter>refentry.version.profile.enabled</parameter> is
26937 non-zero. Otherwise, the <tag>refentry</tag> metadata-gathering logic
26938 "hard coded" into the stylesheets is used.</para>
26940 <para>A "source.name" is one part of a (potentially) two-part
26941 <replaceable>Name</replaceable> <replaceable>Version</replaceable>
26942 "source" field. For more details, see the documentation for the
26943 <parameter>refentry.source.name.profile</parameter> parameter.</para>
26948 <refentry version="5.0" id="refentry.version.profile.enabled">
26950 <refentrytitle>refentry.version.profile.enabled</refentrytitle>
26951 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
26954 <refname>refentry.version.profile.enabled</refname>
26955 <refpurpose>Enable refentry "version" profiling?</refpurpose>
26959 <programlisting id="refentry.version.profile.enabled.frag">
26960 <xsl:param name="refentry.version.profile.enabled">0</xsl:param></programlisting>
26963 <refsection><info><title>Description</title></info>
26965 <para>If the value of
26966 <parameter>refentry.version.profile.enabled</parameter> is
26967 non-zero, then during <tag>refentry</tag> metadata gathering, the info
26968 profile specified by the customizable
26969 <parameter>refentry.version.profile</parameter> parameter is
26972 <para>If instead the value of
26973 <parameter>refentry.version.profile.enabled</parameter> is zero (the
26974 default), then "hard coded" logic within the DocBook XSL stylesheets
26975 is used for gathering <tag>refentry</tag> "version" data.</para>
26977 <para>If you find that the default <tag>refentry</tag>
26978 metadata-gathering behavior is causing incorrect "version" data to show
26979 up in your output, then consider setting a non-zero value for
26980 <parameter>refentry.version.profile.enabled</parameter> and adjusting
26981 the value of <parameter>refentry.version.profile</parameter> to cause
26982 correct data to be gathered. </para>
26984 <para>Note that the terms "source" and "version" have special
26985 meanings in this context. For details, see the documentation for the
26986 <parameter>refentry.version.profile</parameter> parameter.</para>
26991 <refentry version="5.0" id="refentry.manual.fallback.profile">
26993 <refentrytitle>refentry.manual.fallback.profile</refentrytitle>
26994 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
26997 <refname>refentry.manual.fallback.profile</refname>
26998 <refpurpose>Specifies profile of "fallback" for refentry "manual" data</refpurpose>
27002 <programlisting id="refentry.manual.fallback.profile.frag">
27003 <xsl:param name="refentry.manual.fallback.profile">
27004 refmeta/refmiscinfo[not(@class = 'date')][1]/node()</xsl:param>
27008 <refsection><info><title>Description</title></info>
27011 <parameter>refentry.manual.fallback.profile</parameter> is a string
27012 representing an XPath expression. It is evaluated at run-time and
27013 used only if no "manual" data can be found by other means (that is,
27014 either using the <tag>refentry</tag> metadata-gathering logic "hard
27015 coded" in the stylesheets, or the value of
27016 <parameter>refentry.manual.profile</parameter>, if it is
27020 <para>Depending on which XSLT engine you run, either the EXSLT
27021 <function>dyn:evaluate</function> extension function (for xsltproc or
27022 Xalan) or <function>saxon:evaluate</function> extension function (for
27023 Saxon) are used to dynamically evaluate the value of
27024 <parameter>refentry.manual.fallback.profile</parameter> at
27025 run-time. If you don't use xsltproc, Saxon, Xalan -- or some other
27026 XSLT engine that supports <function>dyn:evaluate</function> -- you
27027 must manually disable fallback processing by setting an empty value
27028 for the <parameter>refentry.manual.fallback.profile</parameter>
27035 <refentry version="5.0" id="refentry.source.fallback.profile">
27037 <refentrytitle>refentry.source.fallback.profile</refentrytitle>
27038 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
27041 <refname>refentry.source.fallback.profile</refname>
27042 <refpurpose>Specifies profile of "fallback" for refentry "source" data</refpurpose>
27046 <programlisting id="refentry.source.fallback.profile.frag">
27047 <xsl:param name="refentry.source.fallback.profile">
27048 refmeta/refmiscinfo[not(@class = 'date')][1]/node()</xsl:param>
27052 <refsection><info><title>Description</title></info>
27055 <parameter>refentry.source.fallback.profile</parameter> is a string
27056 representing an XPath expression. It is evaluated at run-time and used
27057 only if no "source" data can be found by other means (that is, either
27058 using the <tag>refentry</tag> metadata-gathering logic "hard coded" in
27059 the stylesheets, or the value of the
27060 <parameter>refentry.source.name.profile</parameter> and
27061 <parameter>refentry.version.profile</parameter> parameters, if those
27062 are enabled).</para>
27065 <para>Depending on which XSLT engine you run, either the EXSLT
27066 <function>dyn:evaluate</function> extension function (for xsltproc or
27067 Xalan) or <function>saxon:evaluate</function> extension function (for
27068 Saxon) are used to dynamically evaluate the value of
27069 <parameter>refentry.source.fallback.profile</parameter> at
27070 run-time. If you don't use xsltproc, Saxon, Xalan -- or some other
27071 XSLT engine that supports <function>dyn:evaluate</function> -- you
27072 must manually disable fallback processing by setting an empty value
27073 for the <parameter>refentry.source.fallback.profile</parameter>
27080 </reference><reference id="th" xml:base="../manpages/param.xml">
27081 <title>Page header/footer</title>
27082 <refentry version="5.0" id="man.th.extra1.suppress">
27084 <refentrytitle>man.th.extra1.suppress</refentrytitle>
27085 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
27088 <refname>man.th.extra1.suppress</refname>
27089 <refpurpose>Suppress extra1 part of header/footer?</refpurpose>
27093 <programlisting id="man.th.extra1.suppress.frag">
27094 <xsl:param name="man.th.extra1.suppress">0</xsl:param></programlisting>
27097 <refsection><info><title>Description</title></info>
27099 <para>If the value of <parameter>man.th.extra1.suppress</parameter> is
27100 non-zero, then the <literal>extra1</literal> part of the
27101 <literal>.TH</literal> title line header/footer is suppressed.</para>
27103 <para>The content of the <literal>extra1</literal> field is almost
27104 always displayed in the center footer of the page and is, universally,
27110 <refentry version="5.0" id="man.th.extra2.suppress">
27112 <refentrytitle>man.th.extra2.suppress</refentrytitle>
27113 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
27116 <refname>man.th.extra2.suppress</refname>
27117 <refpurpose>Suppress extra2 part of header/footer?</refpurpose>
27121 <programlisting id="man.th.extra2.suppress.frag">
27122 <xsl:param name="man.th.extra2.suppress">0</xsl:param></programlisting>
27125 <refsection><info><title>Description</title></info>
27127 <para>If the value of <parameter>man.th.extra2.suppress</parameter> is
27128 non-zero, then the <literal>extra2</literal> part of the
27129 <literal>.TH</literal> title line header/footer is suppressed.</para>
27131 <para>The content of the <literal>extra2</literal> field is usually
27132 displayed in the left footer of the page and is typically "source"
27133 data, often in the form
27134 <replaceable>Name</replaceable> <replaceable>Version</replaceable>;
27135 for example, "GTK+ 1.2" (from the <literal>gtk-options(7)</literal>
27139 <para>You can use the
27140 <parameter>refentry.source.name.suppress</parameter> and
27141 <parameter>refentry.version.suppress</parameter> parameters to
27142 independently suppress the <replaceable>Name</replaceable> and
27143 <replaceable>Version</replaceable> parts of the
27144 <literal>extra2</literal> field.</para>
27150 <refentry version="5.0" id="man.th.extra3.suppress">
27152 <refentrytitle>man.th.extra3.suppress</refentrytitle>
27153 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
27156 <refname>man.th.extra3.suppress</refname>
27157 <refpurpose>Suppress extra3 part of header/footer?</refpurpose>
27161 <programlisting id="man.th.extra3.suppress.frag">
27162 <xsl:param name="man.th.extra3.suppress">0</xsl:param></programlisting>
27165 <refsection><info><title>Description</title></info>
27167 <para>If the value of <parameter>man.th.extra3.suppress</parameter> is
27168 non-zero, then the <literal>extra3</literal> part of the
27169 <literal>.TH</literal> title line header/footer is
27172 <para>The content of the <literal>extra3</literal> field is usually
27173 displayed in the middle header of the page and is typically a "manual
27174 name"; for example, "GTK+ User's Manual" (from the
27175 <literal>gtk-options(7)</literal> man page).</para>
27180 <refentry version="5.0" id="man.th.title.max.length">
27182 <refentrytitle>man.th.title.max.length</refentrytitle>
27183 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
27186 <refname>man.th.title.max.length</refname>
27187 <refpurpose>Maximum length of title in header/footer</refpurpose>
27191 <programlisting id="man.th.title.max.length.frag">
27192 <xsl:param name="man.th.title.max.length">20</xsl:param>
27196 <refsection><info><title>Description</title></info>
27198 <para>Specifies the maximum permitted length of the title part of the
27199 man-page <literal>.TH</literal> title line header/footer. If the title
27200 exceeds the maxiumum specified, it is truncated down to the maximum
27201 permitted length.</para>
27203 <refsection><info><title>Details</title></info>
27206 <para>Every man page generated using the DocBook stylesheets has a
27207 title line, specified using the <literal>TH</literal> roff
27208 macro. Within that title line, there is always, at a minimum, a title,
27209 followed by a section value (representing a man "section" -- usually
27210 just a number).</para>
27212 <para>The title and section are displayed, together, in the visible
27213 header of each page. Where in the header they are displayed depends on
27214 OS the man page is viewed on, and on what version of nroff/groff/man
27215 is used for viewing the page. But, at a minimum and across all
27216 systems, the title and section are displayed on the right-hand column
27217 of the header. On many systems -- those with a modern groff, including
27218 Linux systems -- they are displayed twice: both in the left and right
27219 columns of the header.</para>
27221 <para>So if the length of the title exceeds a certain percentage of
27222 the column width in which the page is viewed, the left and right
27223 titles can end up overlapping, making them unreadable, or breaking to
27224 another line, which doesn't look particularly good.</para>
27226 <para>So the stylesheets provide the
27227 <parameter>man.th.title.max.length</parameter> parameter as a means
27228 for truncating titles that exceed the maximum length that can be
27229 viewing properly in a page header.</para>
27231 <para>The default value is reasonable but somewhat arbitrary. If you
27232 have pages with long titles, you may want to experiment with changing
27233 the value in order to achieve the correct aesthetic results.</para>
27239 <refentry version="5.0" id="man.th.extra2.max.length">
27241 <refentrytitle>man.th.extra2.max.length</refentrytitle>
27242 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
27245 <refname>man.th.extra2.max.length</refname>
27246 <refpurpose>Maximum length of extra2 in header/footer</refpurpose>
27250 <programlisting id="man.th.extra2.max.length.frag">
27251 <xsl:param name="man.th.extra2.max.length">30</xsl:param>
27255 <refsection><info><title>Description</title></info>
27257 <para>Specifies the maximum permitted length of the
27258 <literal>extra2</literal> part of the man-page part of the
27259 <literal>.TH</literal> title line header/footer. If the
27260 <literal>extra2</literal> content exceeds the maxiumum specified, it
27261 is truncated down to the maximum permitted length.</para>
27263 <para>The content of the <literal>extra2</literal> field is usually
27264 displayed in the left footer of the page and is typically "source"
27265 data indicating the software system or product that the item
27266 documented in the man page belongs to, often in the form
27267 <replaceable>Name</replaceable> <replaceable>Version</replaceable>;
27268 for example, "GTK+ 1.2" (from the <literal>gtk-options(7)</literal>
27271 <para>The default value for this parameter is reasonable but somewhat
27272 arbitrary. If you are processing pages with long "source" information,
27273 you may want to experiment with changing the value in order to achieve
27274 the correct aesthetic results.</para>
27278 <refentry version="5.0" id="man.th.extra3.max.length">
27280 <refentrytitle>man.th.extra3.max.length</refentrytitle>
27281 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
27284 <refname>man.th.extra3.max.length</refname>
27285 <refpurpose>Maximum length of extra3 in header/footer</refpurpose>
27289 <programlisting id="man.th.extra3.max.length.frag">
27290 <xsl:param name="man.th.extra3.max.length">30</xsl:param>
27294 <refsection><info><title>Description</title></info>
27296 <para>Specifies the maximum permitted length of the
27297 <literal>extra3</literal> part of the man-page <literal>.TH</literal>
27298 title line header/footer. If the <literal>extra3</literal> content
27299 exceeds the maxiumum specified, it is truncated down to the maximum
27300 permitted length.</para>
27302 <para>The content of the <literal>extra3</literal> field is usually
27303 displayed in the middle header of the page and is typically a "manual
27304 name"; for example, "GTK+ User's Manual" (from the
27305 <literal>gtk-options(7)</literal> man page).</para>
27307 <para>The default value for this parameter is reasonable but somewhat
27308 arbitrary. If you are processing pages with long "manual names" -- or
27309 especially if you are processing pages that have both long "title"
27310 parts (command/function, etc. names) <emphasis>and</emphasis> long
27311 manual names -- you may want to experiment with changing the value in
27312 order to achieve the correct aesthetic results.</para>
27316 </reference><reference id="output" xml:base="../manpages/param.xml">
27317 <title>Output</title>
27318 <refentry version="5.0" id="man.output.manifest.enabled">
27320 <refentrytitle>man.output.manifest.enabled</refentrytitle>
27321 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
27324 <refname>man.output.manifest.enabled</refname>
27325 <refpurpose>Generate a manifest file?</refpurpose>
27329 <programlisting id="man.output.manifest.enabled.frag"><xsl:param name="man.output.manifest.enabled" select="0"></xsl:param></programlisting>
27332 <refsection><info><title>Description</title></info>
27334 <para>If non-zero, a list of filenames for man pages generated by
27335 the stylesheet transformation is written to the file named by the
27336 <parameter>man.output.manifest.filename</parameter> parameter.</para>
27341 <refentry version="5.0" id="man.output.manifest.filename">
27343 <refentrytitle>man.output.manifest.filename</refentrytitle>
27344 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
27347 <refname>man.output.manifest.filename</refname>
27348 <refpurpose>Name of manifest file</refpurpose>
27352 <programlisting id="man.output.manifest.filename.frag"><xsl:param name="man.output.manifest.filename">MAN.MANIFEST</xsl:param></programlisting>
27355 <refsection><info><title>Description</title></info>
27357 <para>The <parameter>man.output.manifest.filename</parameter> parameter
27358 specifies the name of the file to which the manpages manifest file
27359 is written (if the value of the
27360 <parameter>man.output.manifest.enabled</parameter> parameter is
27366 <refentry version="5.0" id="man.output.in.separate.dir">
27368 <refentrytitle>man.output.in.separate.dir</refentrytitle>
27369 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
27372 <refname>man.output.in.separate.dir</refname>
27373 <refpurpose>Output man-page files in separate output directory?</refpurpose>
27377 <programlisting id="man.output.in.separate.dir.frag">
27378 <xsl:param name="man.output.in.separate.dir" select="0"></xsl:param>
27382 <refsection><info><title>Description</title></info>
27384 <para>If the value of <literal>man.output.in.separate.dir</literal>
27385 parameter is non-zero, man-page files are output in a separate
27386 directory, specified by the <parameter>man.output.base.dir</parameter>
27387 parameter; otherwise, if the value of
27388 <literal>man.output.in.separate.dir</literal> is zero, man-page files
27389 are not output in a separate directory.</para>
27394 <refentry version="5.0" id="man.output.lang.in.name.enabled">
27396 <refentrytitle>man.output.lang.in.name.enabled</refentrytitle>
27397 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
27400 <refname>man.output.lang.in.name.enabled</refname>
27401 <refpurpose>Include $LANG value in man-page filename/pathname?</refpurpose>
27405 <programlisting id="man.output.lang.in.name.enabled.frag">
27406 <xsl:param name="man.output.lang.in.name.enabled" select="0"></xsl:param>
27410 <refsection><info><title>Description</title></info>
27412 <para>The <parameter>man.output.lang.in.name.enabled</parameter>
27413 parameter specifies whether a <literal>$lang</literal> value is
27414 included in man-page filenames and pathnames.</para>
27416 <para>If the value of
27417 <parameter>man.output.lang.in.name.enabled</parameter> is non-zero,
27418 man-page files are output with the <literal>$lang</literal> value
27419 included in their filenames or pathnames as follows;
27423 <para>if <parameter>man.output.subdirs.enabled</parameter> is
27424 non-zero, each file is output to, e.g., a
27425 <filename>man/<replaceable>$lang</replaceable>/man8/foo.8</filename>
27429 <para>if <parameter>man.output.subdirs.enabled</parameter> is
27430 zero, each file is output with a
27431 <literal>foo.<replaceable>$lang</replaceable>.8</literal>
27440 <refentry version="5.0" id="man.output.base.dir">
27442 <refentrytitle>man.output.base.dir</refentrytitle>
27443 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
27446 <refname>man.output.base.dir</refname>
27447 <refpurpose>Specifies separate output directory</refpurpose>
27451 <programlisting id="man.output.base.dir.frag"><xsl:param name="man.output.base.dir">man/</xsl:param></programlisting>
27454 <refsection><info><title>Description</title></info>
27456 <para>The <parameter>man.output.base.dir</parameter> parameter
27457 specifies the base directory into which man-page files are output. The
27458 <parameter>man.output.subdirs.enabled</parameter> parameter controls
27459 whether the files are output in subdirectories within the base
27463 <para>The values of the <parameter>man.output.base.dir</parameter>
27464 and <parameter>man.output.subdirs.enabled</parameter> parameters are
27465 used only if the value of
27466 <parameter>man.output.in.separate.dir</parameter> parameter is
27467 non-zero. If the value of the
27468 <parameter>man.output.in.separate.dir</parameter> is zero, man-page
27469 files are not output in a separate directory.</para>
27475 <refentry version="5.0" id="man.output.subdirs.enabled">
27477 <refentrytitle>man.output.subdirs.enabled</refentrytitle>
27478 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
27481 <refname>man.output.subdirs.enabled</refname>
27482 <refpurpose>Output man-page files in subdirectories within base output directory?</refpurpose>
27486 <programlisting id="man.output.subdirs.enabled.frag">
27487 <xsl:param name="man.output.subdirs.enabled" select="1"></xsl:param>
27491 <refsection><info><title>Description</title></info>
27493 <para>The <parameter>man.output.subdirs.enabled</parameter> parameter
27494 controls whether man-pages files are output in subdirectories within
27495 the base directory specified by the directory specified by the
27496 <parameter>man.output.base.dir</parameter> parameter.</para>
27499 <para>The values of the <parameter>man.output.base.dir</parameter>
27500 and <parameter>man.output.subdirs.enabled</parameter> parameters are
27501 used only if the value of
27502 <parameter>man.output.in.separate.dir</parameter> parameter is
27503 non-zero. If the value of the
27504 <parameter>man.output.in.separate.dir</parameter> is zero, man-page
27505 files are not output in a separate directory.</para>
27511 <refentry version="5.0" id="man.output.quietly">
27513 <refentrytitle>man.output.quietly</refentrytitle>
27514 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
27517 <refname>man.output.quietly</refname>
27518 <refpurpose>Suppress filename messages emitted when generating output?</refpurpose>
27522 <programlisting id="man.output.quietly.frag">
27523 <xsl:param name="man.output.quietly" select="0"></xsl:param>
27527 <refsection><info><title>Description</title></info>
27529 <para>If zero (the default), for each man-page file created, a message
27530 with the name of the file is emitted. If non-zero, the files are
27531 output "quietly" -- that is, the filename messages are
27535 <para>If you are processing a large amount of <tag>refentry</tag>
27536 content, you may be able to speed up processing significantly by
27537 setting a non-zero value for
27538 <parameter>man.output.quietly</parameter>.</para>
27544 <refentry version="5.0" id="man.output.encoding">
27546 <refentrytitle>man.output.encoding</refentrytitle>
27547 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
27550 <refname>man.output.encoding</refname>
27551 <refpurpose>Encoding used for man-page output</refpurpose>
27555 <programlisting id="man.output.encoding.frag">
27556 <xsl:param name="man.output.encoding">UTF-8</xsl:param>
27560 <refsection><info><title>Description</title></info>
27562 <para>This parameter specifies the encoding to use for files generated
27563 by the manpages stylesheet. Not all processors support specification
27564 of this parameter.</para>
27567 <para>If the value of the <parameter>man.charmap.enabled</parameter>
27568 parameter is non-zero (the default), keeping the
27569 <parameter>man.output.encoding</parameter> parameter at its default
27570 value (<literal>UTF-8</literal>) or setting it to
27571 <literal>UTF-16</literal> <emphasis role="bold">does not cause your
27572 man pages to be output in raw UTF-8 or UTF-16</emphasis> -- because
27573 any Unicode characters for which matches are found in the enabled
27574 character map will be replaced with roff escape sequences before the
27575 final man-page files are generated.</para>
27577 <para>So if you want to generate "real" UTF-8 man pages, without any
27578 character substitution being performed on your content, you need to
27579 set <parameter>man.charmap.enabled</parameter> to zero (which will
27580 completely disable character-map processing). </para>
27582 <para>You may also need to set
27583 <parameter>man.charmap.enabled</parameter> to zero if you want to
27584 output man pages in an encoding other than <literal>UTF-8</literal>
27585 or <literal>UTF-16</literal>. Character-map processing is based on
27586 Unicode character values and may not work with other output
27593 <refentry version="5.0" id="man.output.better.ps.enabled">
27595 <refentrytitle>man.output.better.ps.enabled</refentrytitle>
27596 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
27599 <refname>man.output.better.ps.enabled</refname>
27600 <refpurpose>Enable enhanced print/PostScript output?</refpurpose>
27603 <programlisting id="man.output.better.ps.enabled.frag">
27604 <xsl:param name="man.output.better.ps.enabled">0</xsl:param>
27607 <refsection><info><title>Description</title></info>
27609 <para>If the value of the
27610 <parameter>man.output.better.ps.enabled</parameter> parameter is
27611 non-zero, certain markup is embedded in each generated man page
27612 such that PostScript output from the <command>man -Tps</command>
27613 command for that page will include a number of enhancements
27614 designed to improve the quality of that output.</para>
27616 <para>If <parameter>man.output.better.ps.enabled</parameter> is
27617 zero (the default), no such markup is embedded in generated man
27618 pages, and no enhancements are included in the PostScript
27619 output generated from those man pages by the <command>man
27620 -Tps</command> command.</para>
27623 <para>The enhancements provided by this parameter rely on
27624 features that are specific to groff (GNU troff) and that are
27625 not part of “classic” AT&T troff or any of its
27626 derivatives. Therefore, any man pages you generate with this
27627 parameter enabled will be readable only on systems on which
27628 the groff (GNU troff) program is installed, such as GNU/Linux
27629 systems. The pages <emphasis role="bold">will not not be
27630 readable on systems on with the classic troff (AT&T
27631 troff) command is installed</emphasis>.</para>
27634 <para>The value of this parameter only affects PostScript output
27635 generated from the <command>man</command> command. It has no
27636 effect on output generated using the FO backend.</para>
27639 <para>You can generate PostScript output for any man page by
27640 running the following command:</para>
27641 <programlisting> man <replaceable>FOO</replaceable> -Tps > <replaceable>FOO</replaceable>.ps</programlisting>
27642 <para>You can then generate PDF output by running the following
27644 <programlisting> ps2pdf <replaceable>FOO</replaceable>.ps</programlisting>
27650 </reference><reference id="other" xml:base="../manpages/param.xml">
27651 <title>Other</title>
27652 <refentry version="5.0" id="man.table.footnotes.divider">
27654 <refentrytitle>man.table.footnotes.divider</refentrytitle>
27655 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
27658 <refname>man.table.footnotes.divider</refname>
27659 <refpurpose>Specifies divider string that appears before table footnotes</refpurpose>
27663 <programlisting id="man.table.footnotes.divider.frag">
27664 <xsl:param name="man.table.footnotes.divider">----</xsl:param>
27668 <refsection><info><title>Description</title></info>
27670 <para>In each table that contains footenotes, the string specified by
27671 the <parameter>man.table.footnotes.divider</parameter> parameter is
27672 output before the list of footnotes for the table.</para>
27677 <refentry version="5.0" id="man.subheading.divider.enabled">
27679 <refentrytitle>man.subheading.divider.enabled</refentrytitle>
27680 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
27683 <refname>man.subheading.divider.enabled</refname>
27684 <refpurpose>Add divider comment to roff source before/after subheadings?</refpurpose>
27688 <programlisting id="man.subheading.divider.enabled.frag">
27689 <xsl:param name="man.subheading.divider.enabled">0</xsl:param>
27693 <refsection><info><title>Description</title></info>
27695 <para>If the value of the
27696 <parameter>man.subheading.divider.enabled</parameter> parameter is
27697 non-zero, the contents of the
27698 <parameter>man.subheading.divider</parameter> parameter are used to
27699 add a "divider" before and after subheadings in the roff
27700 output. <emphasis role="bold">The divider is not visisble in the
27701 rendered man page</emphasis>; it is added as a comment, in the source,
27702 simply for the purpose of increasing reability of the source.</para>
27704 <para>If <parameter>man.subheading.divider.enabled</parameter> is zero
27705 (the default), the subheading divider is suppressed.</para>
27710 <refentry version="5.0" id="man.subheading.divider">
27712 <refentrytitle>man.subheading.divider</refentrytitle>
27713 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
27716 <refname>man.subheading.divider</refname>
27717 <refpurpose>Specifies string to use as divider comment before/after subheadings</refpurpose>
27721 <programlisting id="man.subheading.divider.frag">
27722 <xsl:param name="man.subheading.divider">========================================================================</xsl:param>
27726 <refsection><info><title>Description</title></info>
27728 <para>If the value of the
27729 <parameter>man.subheading.divider.enabled</parameter> parameter is
27730 non-zero, the contents of the
27731 <parameter>man.subheading.divider</parameter> parameter are used to
27732 add a "divider" before and after subheadings in the roff
27733 output. <emphasis role="bold">The divider is not visisble in the
27734 rendered man page</emphasis>; it is added as a comment, in the source,
27735 simply for the purpose of increasing reability of the source.</para>
27737 <para>If <parameter>man.subheading.divider.enabled</parameter> is zero
27738 (the default), the subheading divider is suppressed.</para>
27745 <part id="roundtrip">
27746 <?dbhtml dir="roundtrip"?>
27747 <?dbhtml filename="index.html"?>
27748 <title xml:base="../roundtrip/param.xml">Roundtrip Parameter Reference</title>
27749 <partintro id="roundtripintro">
27751 <para xml:base="../roundtrip/param.xml">This is reference documentation for all user-configurable
27752 parameters in the DocBook “Roundtrip” Stylesheets (for
27753 transforming DocBook to WordML, OpenDocument, and Apple Pages,
27754 and for converting from those formats back to DocBook).</para>
27759 <refentry version="5.0" id="wordml.template" xml:base="../roundtrip/param.xml">
27761 <refentrytitle>wordml.template</refentrytitle>
27762 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
27765 <refname>wordml.template</refname>
27766 <refpurpose>Specify the template WordML document</refpurpose>
27770 <programlisting id="wordml.template.frag">
27771 <xsl:param name="wordml.template"></xsl:param>
27775 <refsection><info><title>Description</title></info>
27777 <para>The <parameter>wordml.template</parameter> parameter specifies a WordML document to use as a template for the generated document. The template document is used to define the (extensive) headers for the generated document, in particular the paragraph and character styles that are used to format the various elements. Any content in the template document is ignored.</para>
27779 <para>A template document is used in order to allow maintenance of the paragraph and character styles to be done using Word itself, rather than these XSL stylesheets.</para>
27784 <refentry version="5.0" id="pages.template" xml:base="../roundtrip/param.xml">
27786 <refentrytitle>pages.template</refentrytitle>
27787 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
27790 <refname>pages.template</refname>
27791 <refpurpose>Specify the template Pages document</refpurpose>
27795 <programlisting id="pages.template.frag">
27796 <xsl:param name="pages.template"></xsl:param>
27800 <refsection><info><title>Description</title></info>
27802 <para>The <parameter>pages.template</parameter> parameter specifies a Pages (the Apple word processing application) document to use as a template for the generated document. The template document is used to define the (extensive) headers for the generated document, in particular the paragraph and character styles that are used to format the various elements. Any content in the template document is ignored.</para>
27804 <para>A template document is used in order to allow maintenance of the paragraph and character styles to be done using Pages itself, rather than these XSL stylesheets.</para>
27811 <part id="slides"><title>Slides Parameter Reference</title>
27812 <?dbhtml dir="slides"?>
27813 <?dbhtml filename="index.html"?>
27814 <partintro id="slidesintro">
27815 <para>This is reference documentation for all
27816 user-configurable parameters in the DocBook XSL Slides
27817 stylesheets (for generating HTML and PDF slide
27818 presentations).</para>
27820 <para>The Slides stylesheet for HTML output is a
27821 customization layer of the DocBook XSL HTML
27822 stylesheet; the Slides stylesheet for FO output is a
27823 customization layer of the DocBook XSL FO stylesheet.
27824 Therefore, in addition to the slides-specific
27825 parameters listed in this section, you can also use a
27826 number of <link xlink:href="../html">HTML stylesheet
27827 parameters</link> and <link xlink:href="../fo">FO
27828 stylesheet parameters</link> to control Slides
27832 <reference id="xhtml" xml:base="../slides/xhtml/param.xml">
27833 <title>XHTML: General Params</title>
27835 <refentry version="5.0" id="disable.collapsible">
27837 <refentrytitle>disable.collapsible</refentrytitle>
27838 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
27841 <refname>disable.collapsible</refname>
27842 <refpurpose>Specifies whether collapsible rendering is enabled</refpurpose>
27846 <programlisting id="disable.collapsible.frag">
27847 <xsl:param name="disable.collapsible">0</xsl:param>
27851 <refsection><info><title>Description</title></info>
27853 <para>This parameter specifies whether elements marked as
27854 collapsible are generated as such in the output document.</para>
27859 <refentry version="5.0" id="disable.incremental">
27861 <refentrytitle>disable.incremental</refentrytitle>
27862 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
27865 <refname>disable.incremental</refname>
27866 <refpurpose>Specifies whether incremental rendering is enabled</refpurpose>
27870 <programlisting id="disable.incremental.frag">
27871 <xsl:param name="disable.incremental">0</xsl:param>
27875 <refsection><info><title>Description</title></info>
27877 <para>This parameter specifies whether elements marked as
27878 incremental are generated as such in the output document.</para>
27883 <refentry version="5.0" id="generate.copyright">
27885 <refentrytitle>generate.copyright</refentrytitle>
27886 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
27889 <refname>generate.copyright</refname>
27890 <refpurpose>Specifies whether copyright is generated</refpurpose>
27894 <programlisting id="generate.copyright.frag">
27895 <xsl:param name="generate.copyright">1</xsl:param>
27899 <refsection><info><title>Description</title></info>
27901 <para>This parameter specifies whether the copyright info is generated
27902 in the footer area.</para>
27907 <refentry version="5.0" id="generate.foilgroup.numbered.toc">
27909 <refentrytitle>generate.foilgroup.numbered.toc</refentrytitle>
27910 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
27913 <refname>generate.foilgroup.numbered.toc</refname>
27914 <refpurpose>Specifies whether foilgroups have a numbered TOC</refpurpose>
27918 <programlisting id="generate.foilgroup.numbered.toc.frag">
27919 <xsl:param name="generate.foilgroup.numbered.toc">1</xsl:param>
27923 <refsection><info><title>Description</title></info>
27925 <para>If TOC generation is turned on, this parameter specifies
27926 whether foilgroups have a numbered TOC. If disabled, TOC items
27927 will be bulleted, not numbered.</para>
27932 <refentry version="5.0" id="generate.foilgroup.toc">
27934 <refentrytitle>generate.foilgroup.toc</refentrytitle>
27935 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
27938 <refname>generate.foilgroup.toc</refname>
27939 <refpurpose>Specifies whether foilgroups have a TOC</refpurpose>
27943 <programlisting id="generate.foilgroup.toc.frag">
27944 <xsl:param name="generate.foilgroup.toc">1</xsl:param>
27948 <refsection><info><title>Description</title></info>
27950 <para>This parameter specifies whether foilgroups will
27951 contain a table of contents of the included foils.</para>
27956 <refentry version="5.0" id="generate.handoutnotes">
27958 <refentrytitle>generate.handoutnotes</refentrytitle>
27959 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
27962 <refname>generate.handoutnotes</refname>
27963 <refpurpose>Specifies whether handoutnotes are generated</refpurpose>
27967 <programlisting id="generate.handoutnotes.frag">
27968 <xsl:param name="generate.handoutnotes">0</xsl:param>
27972 <refsection><info><title>Description</title></info>
27974 <para>This parameter specifies whether handoutnotes shall
27975 be generated to the output.</para>
27980 <refentry version="5.0" id="generate.pubdate">
27982 <refentrytitle>generate.pubdate</refentrytitle>
27983 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
27986 <refname>generate.pubdate</refname>
27987 <refpurpose>Specifies whether the pubdate is generated</refpurpose>
27991 <programlisting id="generate.pubdate.frag">
27992 <xsl:param name="generate.pubdate">1</xsl:param>
27996 <refsection><info><title>Description</title></info>
27998 <para>This parameter specifies whether the publication date is generated
27999 in the footer area.</para>
28004 <refentry version="5.0" id="generate.speakernotes">
28006 <refentrytitle>generate.speakernotes</refentrytitle>
28007 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
28010 <refname>generate.speakernotes</refname>
28011 <refpurpose>Specifies whether speakernotes are generated</refpurpose>
28015 <programlisting id="generate.speakernotes.frag">
28016 <xsl:param name="generate.speakernotes">0</xsl:param>
28020 <refsection><info><title>Description</title></info>
28022 <para>This parameter specifies whether speakernotes shall
28023 be generated to the output.</para>
28028 <refentry version="5.0" id="generate.titlepage">
28030 <refentrytitle>generate.titlepage</refentrytitle>
28031 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
28034 <refname>generate.titlepage</refname>
28035 <refpurpose>Specifies whether titlepage is generated</refpurpose>
28039 <programlisting id="generate.titlepage.frag">
28040 <xsl:param name="generate.titlepage">1</xsl:param>
28044 <refsection><info><title>Description</title></info>
28046 <para>This parameter specifies whether titlepage is generated
28047 for the presentation.</para>
28052 <refentry version="5.0" id="mml.embedding.mode">
28054 <refentrytitle>mml.embedding.mode</refentrytitle>
28055 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
28056 <refmiscinfo class="other" otherclass="value">inline</refmiscinfo>
28057 <refmiscinfo class="other" otherclass="value">object</refmiscinfo>
28058 <refmiscinfo class="other" otherclass="value">image</refmiscinfo>
28059 <refmiscinfo class="other" otherclass="value">link</refmiscinfo>
28060 <refmiscinfo class="other" otherclass="value">iframe</refmiscinfo>
28061 <refmiscinfo class="other" otherclass="value">embed</refmiscinfo>
28064 <refname>mml.embedding.mode</refname>
28065 <refpurpose>Specifies how inline MathML is processed</refpurpose>
28069 <programlisting id="mml.embedding.mode.frag">
28070 <xsl:param name="mml.embedding.mode">inline</xsl:param>
28074 <refsection><info><title>Description</title></info>
28076 <para>This parameter specifies how inline MathML formulas
28077 are embedded into the output document.</para>
28081 <term>inline</term>
28083 <para>Content is copied over inline with its namespace.</para>
28087 <term>object</term>
28089 <para>Content is extracted into an externel file and referenced
28090 by an <markup>object</markup> element.</para>
28096 <para>Content is extracted into an externel file and referenced
28097 by an <markup>img</markup> element.</para>
28103 <para>Content is extracted into an externel file and referenced
28104 by an <markup>a</markup> element.</para>
28108 <term>iframe</term>
28110 <para>Content is extracted into an externel file and referenced
28111 by an <markup>iframe</markup> element.</para>
28117 <para>Content is extracted into an externel file and referenced
28118 by an <markup>embed</markup> element.</para>
28126 <refentry version="5.0" id="svg.embedding.mode">
28128 <refentrytitle>svg.embedding.mode</refentrytitle>
28129 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
28130 <refmiscinfo class="other" otherclass="value">inline</refmiscinfo>
28131 <refmiscinfo class="other" otherclass="value">object</refmiscinfo>
28132 <refmiscinfo class="other" otherclass="value">image</refmiscinfo>
28133 <refmiscinfo class="other" otherclass="value">link</refmiscinfo>
28134 <refmiscinfo class="other" otherclass="value">iframe</refmiscinfo>
28135 <refmiscinfo class="other" otherclass="value">embed</refmiscinfo>
28138 <refname>svg.embedding.mode</refname>
28139 <refpurpose>Specifies how inline SVG is processed</refpurpose>
28143 <programlisting id="svg.embedding.mode.frag">
28144 <xsl:param name="svg.embedding.mode">object</xsl:param>
28148 <refsection><info><title>Description</title></info>
28150 <para>This parameter specifies how inline SVG graphics
28151 are embedded into the output document.</para>
28155 <term>inline</term>
28157 <para>Content is copied over inline with its namespace.</para>
28161 <term>object</term>
28163 <para>Content is extracted into an externel file and referenced
28164 by an <markup>object</markup> element.</para>
28170 <para>Content is extracted into an externel file and referenced
28171 by an <markup>img</markup> element.</para>
28177 <para>Content is extracted into an externel file and referenced
28178 by an <markup>a</markup> element.</para>
28182 <term>iframe</term>
28184 <para>Content is extracted into an externel file and referenced
28185 by an <markup>iframe</markup> element.</para>
28191 <para>Content is extracted into an externel file and referenced
28192 by an <markup>embed</markup> element.</para>
28200 <refentry version="5.0" id="user.css">
28202 <refentrytitle>user.css</refentrytitle>
28203 <refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo>
28206 <refname>user.css</refname>
28207 <refpurpose>Specifies the path to user-supplied CSS</refpurpose>
28211 <programlisting id="user.css.frag">
28212 <xsl:param name="user.css">user.css</xsl:param>
28216 <refsection><info><title>Description</title></info>
28218 <para>This parameter specifies the path from where the
28219 CSS styling is read. This file can be used to
28220 add additional styling to the slides.</para>
28225 <refentry version="5.0" id="wrap.slidecontent">
28227 <refentrytitle>wrap.slidecontent</refentrytitle>
28228 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
28231 <refname>wrap.slidecontent</refname>
28232 <refpurpose>Specifies whether the foil content is wrapped into a div</refpurpose>
28236 <programlisting id="wrap.slidecontent.frag">
28237 <xsl:param name="wrap.slidecontent">0</xsl:param>
28241 <refsection><info><title>Description</title></info>
28243 <para>This parameter specifies whether the foil content is wrapped into
28244 a div so that additional styling can be applied.</para>
28249 </reference><reference id="s5" xml:base="../slides/xhtml/param.xml">
28250 <title>XHTML: S5 Params</title>
28252 <refentry version="5.0" id="s5.controls">
28254 <refentrytitle>s5.controls</refentrytitle>
28255 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
28258 <refname>s5.controls</refname>
28259 <refpurpose>Specifies whether S5 controls are visible</refpurpose>
28263 <programlisting id="s5.controls.frag">
28264 <xsl:param name="s5.controls">0</xsl:param>
28268 <refsection><info><title>Description</title></info>
28270 <para>This parameter specifies whether S5 navigation controls are
28271 visible by default.</para>
28276 <refentry version="5.0" id="s5.defaultview">
28278 <refentrytitle>s5.defaultview</refentrytitle>
28279 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
28280 <refmiscinfo class="other" otherclass="value">slideshow</refmiscinfo>
28281 <refmiscinfo class="other" otherclass="value">outline</refmiscinfo>
28284 <refname>s5.defaultview</refname>
28285 <refpurpose>Specifies the default S5 view</refpurpose>
28289 <programlisting id="s5.defaultview.frag">
28290 <xsl:param name="s5.defaultview">slideshow</xsl:param>
28294 <refsection><info><title>Description</title></info>
28296 <para>This parameter specifies, which is the default view
28297 in the generated S5 presentation.</para>
28302 <refentry version="5.0" id="s5.opera.css">
28304 <refentrytitle>s5.opera.css</refentrytitle>
28305 <refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo>
28308 <refname>s5.opera.css</refname>
28309 <refpurpose>Specifies the name of the S5 Opera-specific CSS file</refpurpose>
28313 <programlisting id="s5.opera.css.frag">
28314 <xsl:param name="s5.opera.css">opera.css</xsl:param>
28318 <refsection><info><title>Description</title></info>
28320 <para>This parameter specifies the name of the S5 Opera-specific
28326 <refentry version="5.0" id="s5.outline.css">
28328 <refentrytitle>s5.outline.css</refentrytitle>
28329 <refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo>
28332 <refname>s5.outline.css</refname>
28333 <refpurpose>Specifies the name of the S5 outline CSS file</refpurpose>
28337 <programlisting id="s5.outline.css.frag">
28338 <xsl:param name="s5.outline.css">outline.css</xsl:param>
28342 <refsection><info><title>Description</title></info>
28344 <para>This parameter specifies the name of the S5 outline CSS file.</para>
28349 <refentry version="5.0" id="s5.path.prefix">
28351 <refentrytitle>s5.path.prefix</refentrytitle>
28352 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
28355 <refname>s5.path.prefix</refname>
28356 <refpurpose>Specifies the path to S5 files</refpurpose>
28360 <programlisting id="s5.path.prefix.frag">
28361 <xsl:param name="s5.path.prefix">files/s5/ui/default/</xsl:param>
28365 <refsection><info><title>Description</title></info>
28367 <para>This parameter specifies the path where S5 CSS and
28368 JavaScript files reside. All the CSS and JavaScript paths
28369 will be generated relative to this directory.</para>
28374 <refentry version="5.0" id="s5.print.css">
28376 <refentrytitle>s5.print.css</refentrytitle>
28377 <refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo>
28380 <refname>s5.print.css</refname>
28381 <refpurpose>Specifies the name of the S5 print CSS file</refpurpose>
28385 <programlisting id="s5.print.css.frag">
28386 <xsl:param name="s5.print.css">print.css</xsl:param>
28390 <refsection><info><title>Description</title></info>
28392 <para>This parameter specifies the name of the S5 print CSS file.</para>
28397 <refentry version="5.0" id="s5.slides.css">
28399 <refentrytitle>s5.slides.css</refentrytitle>
28400 <refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo>
28403 <refname>s5.slides.css</refname>
28404 <refpurpose>Specifies the name of the S5 slides CSS file</refpurpose>
28408 <programlisting id="s5.slides.css.frag">
28409 <xsl:param name="s5.slides.css">slides.css</xsl:param>
28413 <refsection><info><title>Description</title></info>
28415 <para>This parameter specifies the name of the S5 slides CSS file.</para>
28420 <refentry version="5.0" id="s5.slides.js">
28422 <refentrytitle>s5.slides.js</refentrytitle>
28423 <refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo>
28426 <refname>s5.slides.js</refname>
28427 <refpurpose>Specifies the name of the S5 slides JavaScript file</refpurpose>
28431 <programlisting id="s5.slides.js.frag">
28432 <xsl:param name="s5.slides.js">slides.js</xsl:param>
28436 <refsection><info><title>Description</title></info>
28438 <para>This parameter specifies the name of the S5 slides JavaScript
28444 </reference><reference id="slidy" xml:base="../slides/xhtml/param.xml">
28445 <title>XHTML: Slidy Params</title>
28447 <refentry version="5.0" id="slidy.duration">
28449 <refentrytitle>slidy.duration</refentrytitle>
28450 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
28453 <refname>slidy.duration</refname>
28454 <refpurpose>Specifies the duration of the presentation</refpurpose>
28458 <programlisting id="slidy.duration.frag">
28459 <xsl:param name="slidy.duration">0</xsl:param>
28463 <refsection><info><title>Description</title></info>
28465 <para>This parameter specifies the duration of the presentation
28466 in minutes. A JavaScript clock will count down to help the
28467 speaker in not running out of time. Can be disabled if set to 0.</para>
28472 <refentry version="5.0" id="slidy.path.prefix">
28474 <refentrytitle>slidy.path.prefix</refentrytitle>
28475 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
28478 <refname>slidy.path.prefix</refname>
28479 <refpurpose>Specifies the path to Slidy files</refpurpose>
28483 <programlisting id="slidy.path.prefix.frag">
28484 <xsl:param name="slidy.path.prefix">files/slidy/</xsl:param>
28488 <refsection><info><title>Description</title></info>
28490 <para>This parameter specifies the path where Slidy CSS and
28491 JavaScript files reside. All the CSS and JavaScript paths
28492 will be generated relative to this directory.</para>
28497 <refentry version="5.0" id="slidy.slidy.css">
28499 <refentrytitle>slidy.slidy.css</refentrytitle>
28500 <refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo>
28503 <refname>slidy.slidy.css</refname>
28504 <refpurpose>Specifies the name of the main Slidy CSS file</refpurpose>
28508 <programlisting id="slidy.slidy.css.frag">
28509 <xsl:param name="slidy.slidy.css">styles/slidy.css</xsl:param>
28513 <refsection><info><title>Description</title></info>
28515 <para>This parameter specifies the name of the main Slidy CSS file.</para>
28520 <refentry version="5.0" id="slidy.slidy.js">
28522 <refentrytitle>slidy.slidy.js</refentrytitle>
28523 <refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo>
28526 <refname>slidy.slidy.js</refname>
28527 <refpurpose>Specifies the name of the Slidy JavaScript file</refpurpose>
28531 <programlisting id="slidy.slidy.js.frag">
28532 <xsl:param name="slidy.slidy.js">scripts/slidy.js</xsl:param>
28536 <refsection><info><title>Description</title></info>
28538 <para>This parameter specifies the name of the Slidy JavaScript file.</para>
28543 <refentry version="5.0" id="slidy.user.css">
28545 <refentrytitle>slidy.user.css</refentrytitle>
28546 <refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo>
28549 <refname>slidy.user.css</refname>
28550 <refpurpose>Specifies the name of the Slidy user CSS file</refpurpose>
28554 <programlisting id="slidy.user.css.frag">
28555 <xsl:param name="slidy.user.css">styles/w3c-blue.css</xsl:param>
28559 <refsection><info><title>Description</title></info>
28561 <para>This parameter specifies the name of the Slidy user CSS file.</para>
28567 <reference id="fo" xml:base="../slides/fo/param.xml">
28568 <title>FO: General Params</title>
28570 <refentry version="5.0" id="foil.title.master">
28572 <refentrytitle>foil.title.master</refentrytitle>
28573 <refmiscinfo class="other" otherclass="datatype">number</refmiscinfo>
28576 <refname>foil.title.master</refname>
28577 <refpurpose>Specifies unitless font size to use for foil titles</refpurpose>
28581 <programlisting id="foil.title.master.frag">
28582 <xsl:param name="foil.title.master">36</xsl:param>
28583 <!-- Inconsistant use of point size? -->
28587 <refsection><info><title>Description</title></info>
28589 <para>Specifies a unitless font size to use for foil titles; used in
28590 combination with the <parameter>foil.title.size</parameter>
28595 <refentry version="5.0" id="foil.title.size">
28597 <refentrytitle>foil.title.size</refentrytitle>
28598 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
28601 <refname>foil.title.size</refname>
28602 <refpurpose>Specifies font size to use for foil titles, including units</refpurpose>
28606 <programlisting id="foil.title.size.frag">
28607 <xsl:param name="foil.title.size">
28608 <xsl:value-of select="$foil.title.master"></xsl:value-of><xsl:text>pt</xsl:text>
28613 <refsection><info><title>Description</title></info>
28615 <para>This parameter combines the value of the
28616 <parameter>foil.title.master</parameter> parameter with a unit
28617 specification. The default unit is <literal>pt</literal>
28623 <refentry version="5.0" id="generate.copyright">
28625 <refentrytitle>generate.copyright</refentrytitle>
28626 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
28629 <refname>generate.copyright</refname>
28630 <refpurpose>Specifies whether copyright is generated</refpurpose>
28634 <programlisting id="generate.copyright.frag">
28635 <xsl:param name="generate.copyright">1</xsl:param>
28639 <refsection><info><title>Description</title></info>
28641 <para>This parameter specifies whether the copyright info is generated
28642 in the footer area.</para>
28647 <refentry version="5.0" id="generate.foilgroup.numbered.toc">
28649 <refentrytitle>generate.foilgroup.numbered.toc</refentrytitle>
28650 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
28653 <refname>generate.foilgroup.numbered.toc</refname>
28654 <refpurpose>Specifies whether foilgroups have a numbered TOC</refpurpose>
28658 <programlisting id="generate.foilgroup.numbered.toc.frag">
28659 <xsl:param name="generate.foilgroup.numbered.toc">1</xsl:param>
28663 <refsection><info><title>Description</title></info>
28665 <para>If TOC generation is turned on, this parameter specifies
28666 whether foilgroups have a numbered TOC. If disabled, TOC items
28667 will be bulleted, not numbered.</para>
28672 <refentry version="5.0" id="generate.foilgroup.toc">
28674 <refentrytitle>generate.foilgroup.toc</refentrytitle>
28675 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
28678 <refname>generate.foilgroup.toc</refname>
28679 <refpurpose>Specifies whether foilgroups have a TOC</refpurpose>
28683 <programlisting id="generate.foilgroup.toc.frag">
28684 <xsl:param name="generate.foilgroup.toc">1</xsl:param>
28688 <refsection><info><title>Description</title></info>
28690 <para>This parameter specifies whether foilgroups will
28691 contain a table of contents of the included foils.</para>
28696 <refentry version="5.0" id="generate.handoutnotes">
28698 <refentrytitle>generate.handoutnotes</refentrytitle>
28699 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
28702 <refname>generate.handoutnotes</refname>
28703 <refpurpose>Specifies whether handoutnotes are generated</refpurpose>
28707 <programlisting id="generate.handoutnotes.frag">
28708 <xsl:param name="generate.handoutnotes">0</xsl:param>
28712 <refsection><info><title>Description</title></info>
28714 <para>This parameter specifies whether handoutnotes shall
28715 be generated to the output.</para>
28720 <refentry version="5.0" id="generate.page.number">
28722 <refentrytitle>generate.page.number</refentrytitle>
28723 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
28724 <refmiscinfo class="other" otherclass="value">full<alt>1/2</alt></refmiscinfo>
28725 <refmiscinfo class="other" otherclass="value">compact<alt>1</alt></refmiscinfo>
28726 <refmiscinfo class="other" otherclass="value">no</refmiscinfo>
28729 <refname>generate.page.number</refname>
28730 <refpurpose>Specifies whether page numbers are generated</refpurpose>
28734 <programlisting id="generate.page.number.frag">
28735 <xsl:param name="generate.page.number">compact</xsl:param>
28739 <refsection><info><title>Description</title></info>
28741 <para>This parameter specifies how page numbers are generated in
28742 the footer area.</para>
28748 <para>No page numbers generated at all.</para>
28754 <para>Current page number, a slash and the total number of pages</para>
28758 <term>compact</term>
28760 <para>Current page number only</para>
28766 <para>No page numbers generated at all.</para>
28774 <refentry version="5.0" id="generate.pubdate">
28776 <refentrytitle>generate.pubdate</refentrytitle>
28777 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
28780 <refname>generate.pubdate</refname>
28781 <refpurpose>Specifies whether the pubdate is generated</refpurpose>
28785 <programlisting id="generate.pubdate.frag">
28786 <xsl:param name="generate.pubdate">1</xsl:param>
28790 <refsection><info><title>Description</title></info>
28792 <para>This parameter specifies whether the publication date is generated
28793 in the footer area.</para>
28798 <refentry version="5.0" id="generate.speakernotes">
28800 <refentrytitle>generate.speakernotes</refentrytitle>
28801 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
28804 <refname>generate.speakernotes</refname>
28805 <refpurpose>Specifies whether speakernotes are generated</refpurpose>
28809 <programlisting id="generate.speakernotes.frag">
28810 <xsl:param name="generate.speakernotes">0</xsl:param>
28814 <refsection><info><title>Description</title></info>
28816 <para>This parameter specifies whether speakernotes shall
28817 be generated to the output.</para>
28822 <refentry version="5.0" id="generate.titlepage">
28824 <refentrytitle>generate.titlepage</refentrytitle>
28825 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
28828 <refname>generate.titlepage</refname>
28829 <refpurpose>Specifies whether titlepage is generated</refpurpose>
28833 <programlisting id="generate.titlepage.frag">
28834 <xsl:param name="generate.titlepage">1</xsl:param>
28838 <refsection><info><title>Description</title></info>
28840 <para>This parameter specifies whether titlepage is generated
28841 for the presentation.</para>
28846 <refentry version="5.0" id="mml.embedding.mode">
28848 <refentrytitle>mml.embedding.mode</refentrytitle>
28849 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
28850 <refmiscinfo class="other" otherclass="value">inline</refmiscinfo>
28851 <refmiscinfo class="other" otherclass="value">external-graphic</refmiscinfo>
28852 <refmiscinfo class="other" otherclass="value">instream-foreign-object</refmiscinfo>
28855 <refname>mml.embedding.mode</refname>
28856 <refpurpose>Specifies how inline MathML is processed</refpurpose>
28860 <programlisting id="mml.embedding.mode.fo.frag">
28861 <xsl:param name="mml.embedding.mode">external-graphic</xsl:param>
28865 <refsection><info><title>Description</title></info>
28867 <para>This parameter specifies how inline MathML formulas
28868 are embedded into the output document.</para>
28872 <term>inline</term>
28874 <para>Content is copied over inline with its namespace.</para>
28878 <term>external-graphic</term>
28880 <para>Content is extracted into an externel file and referenced
28881 by an <markup>external-graphic</markup> element.</para>
28885 <term>instream-foreign-object</term>
28887 <para>Content is copied over with its namespace inside an
28888 <markup>instream-foreign-object</markup> element.</para>
28896 <refentry version="5.0" id="slide.font.family">
28898 <refentrytitle>slide.font.family</refentrytitle>
28899 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
28900 <refmiscinfo class="other" otherclass="list-type">open</refmiscinfo>
28901 <refmiscinfo class="other" otherclass="value">serif</refmiscinfo>
28902 <refmiscinfo class="other" otherclass="value">sans-serif</refmiscinfo>
28903 <refmiscinfo class="other" otherclass="value">monospace</refmiscinfo>
28906 <refname>slide.font.family</refname>
28907 <refpurpose>Specifies font family to use for slide bodies</refpurpose>
28911 <programlisting id="slide.font.family.frag">
28912 <xsl:param name="slide.font.family">Helvetica</xsl:param>
28916 <refsection><info><title>Description</title></info>
28918 <para>Specifies the font family to use for slides bodies.</para>
28923 <refentry version="5.0" id="slide.title.font.family">
28925 <refentrytitle>slide.title.font.family</refentrytitle>
28926 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
28927 <refmiscinfo class="other" otherclass="list-type">open</refmiscinfo>
28928 <refmiscinfo class="other" otherclass="value">serif</refmiscinfo>
28929 <refmiscinfo class="other" otherclass="value">sans-serif</refmiscinfo>
28930 <refmiscinfo class="other" otherclass="value">monospace</refmiscinfo>
28933 <refname>slide.title.font.family</refname>
28934 <refpurpose>Specifies font family to use for slide titles</refpurpose>
28938 <programlisting id="slide.title.font.family.frag">
28939 <xsl:param name="slide.title.font.family">Helvetica</xsl:param>
28943 <refsection><info><title>Description</title></info>
28945 <para>Specifies the font family to use for slides titles.</para>
28950 <refentry version="5.0" id="svg.embedding.mode">
28952 <refentrytitle>svg.embedding.mode</refentrytitle>
28953 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
28954 <refmiscinfo class="other" otherclass="value">external-graphic</refmiscinfo>
28955 <refmiscinfo class="other" otherclass="value">instream-foreign-object</refmiscinfo>
28958 <refname>svg.embedding.mode</refname>
28959 <refpurpose>Specifies how inline SVG is processed</refpurpose>
28963 <programlisting id="svg.embedding.mode.fo.frag">
28964 <xsl:param name="svg.embedding.mode">instream-foreign-object</xsl:param>
28968 <refsection><info><title>Description</title></info>
28970 <para>This parameter specifies how inline SVG graphics
28971 are embedded into the output document.</para>
28975 <term>inline</term>
28977 <para>Content is copied over inline with its namespace.</para>
28981 <term>external-graphic</term>
28983 <para>Content is extracted into an externel file and referenced
28984 by an <markup>external-graphic</markup> element.</para>
28988 <term>instream-foreign-object</term>
28990 <para>Content is copied over with its namespace inside an
28991 <markup>instream-foreign-object</markup> element.</para>
28999 </reference><reference id="propsets" xml:base="../slides/fo/param.xml">
29000 <title>FO: Property Sets</title>
29001 <refentry version="5.0" id="foil.header.properties">
29003 <refentrytitle>foil.header.properties</refentrytitle>
29004 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
29007 <refname>foil.header.properties</refname>
29008 <refpurpose>Specifies properties for foil header area</refpurpose>
29012 <programlisting id="foil.header.properties.frag">
29013 <xsl:attribute-set name="foil.header.properties">
29014 <xsl:attribute name="background-color">white</xsl:attribute>
29015 <xsl:attribute name="color">black</xsl:attribute>
29016 <xsl:attribute name="font-weight">bold</xsl:attribute>
29017 <xsl:attribute name="text-align">center</xsl:attribute>
29018 <xsl:attribute name="font-family">
29019 <xsl:value-of select="$slide.title.font.family"></xsl:value-of>
29020 </xsl:attribute>
29021 <xsl:attribute name="space-after">12pt</xsl:attribute>
29022 </xsl:attribute-set>
29026 <refsection><info><title>Description</title></info>
29028 <para>This parameter specifies properties for the foil header area.</para>
29033 <refentry version="5.0" id="foil.master.properties">
29035 <refentrytitle>foil.master.properties</refentrytitle>
29036 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
29039 <refname>foil.master.properties</refname>
29040 <refpurpose>Specifies properties for foil master</refpurpose>
29044 <programlisting id="foil.master.properties.frag">
29045 <xsl:attribute-set name="foil.master.properties">
29046 <xsl:attribute name="page-width">
29047 <xsl:value-of select="$page.width"></xsl:value-of>
29048 </xsl:attribute>
29049 <xsl:attribute name="page-height">
29050 <xsl:value-of select="$page.height"></xsl:value-of>
29051 </xsl:attribute>
29052 <xsl:attribute name="margin-top">
29053 <xsl:value-of select="$page.margin.top"></xsl:value-of>
29054 </xsl:attribute>
29055 <xsl:attribute name="margin-bottom">
29056 <xsl:value-of select="$page.margin.bottom"></xsl:value-of>
29057 </xsl:attribute>
29058 <xsl:attribute name="margin-left">
29059 <xsl:value-of select="$page.margin.inner"></xsl:value-of>
29060 </xsl:attribute>
29061 <xsl:attribute name="margin-right">
29062 <xsl:value-of select="$page.margin.outer"></xsl:value-of>
29063 </xsl:attribute>
29064 </xsl:attribute-set>
29068 <refsection><info><title>Description</title></info>
29070 <para>This parameter specifies properties for the foil master.</para>
29075 <refentry version="5.0" id="foil.page-sequence.properties">
29077 <refentrytitle>foil.page-sequence.properties</refentrytitle>
29078 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
29081 <refname>foil.page-sequence.properties</refname>
29082 <refpurpose>Specifies properties for foil page-sequence</refpurpose>
29086 <programlisting id="foil.page-sequence.properties.frag">
29087 <xsl:attribute-set name="foil.page-sequence.properties">
29088 <xsl:attribute name="hyphenate">
29089 <xsl:value-of select="$hyphenate"></xsl:value-of>
29090 </xsl:attribute>
29091 </xsl:attribute-set>
29095 <refsection><info><title>Description</title></info>
29097 <para>This parameter specifies properties for foil page-sequence.</para>
29102 <refentry version="5.0" id="foil.properties">
29104 <refentrytitle>foil.properties</refentrytitle>
29105 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
29108 <refname>foil.properties</refname>
29109 <refpurpose>Specifies properties for all foils</refpurpose>
29113 <programlisting id="foil.properties.frag">
29114 <xsl:attribute-set name="foil.properties">
29115 <xsl:attribute name="font-family">
29116 <xsl:value-of select="$slide.font.family"></xsl:value-of>
29117 </xsl:attribute>
29118 <xsl:attribute name="margin-{$direction.align.start}">1in</xsl:attribute>
29119 <xsl:attribute name="margin-{$direction.align.end}">1in</xsl:attribute>
29120 <xsl:attribute name="font-size">
29121 <xsl:value-of select="$body.font.size"></xsl:value-of>
29122 </xsl:attribute>
29123 </xsl:attribute-set>
29127 <refsection><info><title>Description</title></info>
29129 <para>This parameter specifies properties that are applied to all foils.</para>
29134 <refentry version="5.0" id="foil.region-after.properties">
29136 <refentrytitle>foil.region-after.properties</refentrytitle>
29137 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
29140 <refname>foil.region-after.properties</refname>
29141 <refpurpose>Specifies properties for foil region-after</refpurpose>
29145 <programlisting id="foil.region-after.properties.frag">
29146 <xsl:attribute-set name="foil.region-after.properties">
29147 <xsl:attribute name="extent">
29148 <xsl:value-of select="$region.after.extent"></xsl:value-of>
29149 </xsl:attribute>
29150 <xsl:attribute name="display-align">after</xsl:attribute>
29151 </xsl:attribute-set>
29155 <refsection><info><title>Description</title></info>
29157 <para>This parameter specifies properties for the foil region-after.</para>
29162 <refentry version="5.0" id="foil.region-before.properties">
29164 <refentrytitle>foil.region-before.properties</refentrytitle>
29165 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
29168 <refname>foil.region-before.properties</refname>
29169 <refpurpose>Specifies properties for foil region-before</refpurpose>
29173 <programlisting id="foil.region-before.properties.frag">
29174 <xsl:attribute-set name="foil.region-before.properties">
29175 <xsl:attribute name="extent">
29176 <xsl:value-of select="$region.before.extent"></xsl:value-of>
29177 </xsl:attribute>
29178 <xsl:attribute name="display-align">
29179 <xsl:value-of select="'before'"></xsl:value-of>
29180 </xsl:attribute>
29181 </xsl:attribute-set>
29185 <refsection><info><title>Description</title></info>
29187 <para>This parameter specifies properties for the foil region-before.</para>
29192 <refentry version="5.0" id="foil.region-body.properties">
29194 <refentrytitle>foil.region-body.properties</refentrytitle>
29195 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
29198 <refname>foil.region-body.properties</refname>
29199 <refpurpose>Specifies properties for foil region-body</refpurpose>
29203 <programlisting id="foil.region-body.properties.frag">
29204 <xsl:attribute-set name="foil.region-body.properties">
29205 <xsl:attribute name="margin-bottom">
29206 <xsl:value-of select="$body.margin.bottom"></xsl:value-of>
29207 </xsl:attribute>
29208 <xsl:attribute name="margin-top">
29209 <xsl:value-of select="$body.margin.top"></xsl:value-of>
29210 </xsl:attribute>
29211 <xsl:attribute name="column-count">
29212 <xsl:value-of select="$column.count.body"></xsl:value-of>
29213 </xsl:attribute>
29214 </xsl:attribute-set>
29218 <refsection><info><title>Description</title></info>
29220 <para>This parameter specifies properties for the foil region-body.</para>
29225 <refentry version="5.0" id="foil.subtitle.properties">
29227 <refentrytitle>foil.subtitle.properties</refentrytitle>
29228 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
29231 <refname>foil.subtitle.properties</refname>
29232 <refpurpose>Specifies properties for all foil subtitles</refpurpose>
29236 <programlisting id="foil.subtitle.properties.frag">
29237 <xsl:attribute-set name="foil.subtitle.properties">
29238 <xsl:attribute name="font-family">
29239 <xsl:value-of select="$slide.title.font.family"></xsl:value-of>
29240 </xsl:attribute>
29241 <xsl:attribute name="text-align">center</xsl:attribute>
29242 <xsl:attribute name="font-size">
29243 <xsl:value-of select="$foil.title.master * 0.8"></xsl:value-of><xsl:text>pt</xsl:text>
29244 </xsl:attribute>
29245 <xsl:attribute name="space-after">12pt</xsl:attribute>
29246 </xsl:attribute-set>
29250 <refsection><info><title>Description</title></info>
29252 <para>This parameter specifies properties that are applied to all foil subtitles.</para>
29257 <refentry version="5.0" id="foil.title.properties">
29259 <refentrytitle>foil.title.properties</refentrytitle>
29260 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
29263 <refname>foil.title.properties</refname>
29264 <refpurpose>Specifies properties for foil title</refpurpose>
29268 <programlisting id="foil.title.properties.frag">
29269 <xsl:attribute-set name="foil.title.properties">
29270 <xsl:attribute name="font-size">
29271 <xsl:value-of select="$foil.title.size"></xsl:value-of>
29272 </xsl:attribute>
29273 </xsl:attribute-set>
29277 <refsection><info><title>Description</title></info>
29279 <para>This parameter specifies properties for the foil title.</para>
29284 <refentry version="5.0" id="foil.footer.properties">
29286 <refentrytitle>foil.footer.properties</refentrytitle>
29287 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
29290 <refname>foil.footer.properties</refname>
29291 <refpurpose>Specifies properties for slides footer</refpurpose>
29295 <programlisting id="foil.footer.properties.frag">
29296 <xsl:attribute-set name="foil.footer.properties"></xsl:attribute-set>
29300 <refsection><info><title>Description</title></info>
29302 <para>This parameter specifies properties for the foil footer.</para>
29307 <refentry version="5.0" id="handoutnotes.properties">
29309 <refentrytitle>handoutnotes.properties</refentrytitle>
29310 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
29313 <refname>footnote.properties</refname>
29314 <refpurpose>Properties applied to handoutnotes
29319 <programlisting id="handoutnotes.properties.frag">
29320 <xsl:attribute-set name="handoutnotes.properties"></xsl:attribute-set>
29324 <refsection><info><title>Description</title></info>
29326 <para>This attribute set is applied to handoutnotes.</para>
29331 <refentry version="5.0" id="slides.properties">
29333 <refentrytitle>slides.properties</refentrytitle>
29334 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
29337 <refname>slides.properties</refname>
29338 <refpurpose>Specifies properties for all slides</refpurpose>
29342 <programlisting id="slides.properties.frag">
29343 <xsl:attribute-set name="slides.properties">
29344 <xsl:attribute name="font-family">
29345 <xsl:value-of select="$slide.font.family"></xsl:value-of>
29346 </xsl:attribute>
29347 </xsl:attribute-set>
29351 <refsection><info><title>Description</title></info>
29353 <para>This parameter specifies properties that are applied to all slides.</para>
29358 <refentry version="5.0" id="slides.titlepage.master.properties">
29360 <refentrytitle>slides.titlepage.master.properties</refentrytitle>
29361 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
29364 <refname>slides.titlepage.master.properties</refname>
29365 <refpurpose>Specifies properties for slides titlepage master</refpurpose>
29369 <programlisting id="slides.titlepage.master.properties.frag">
29370 <xsl:attribute-set name="slides.titlepage.master.properties">
29371 <xsl:attribute name="page-width">
29372 <xsl:value-of select="$page.width"></xsl:value-of>
29373 </xsl:attribute>
29374 <xsl:attribute name="page-height">
29375 <xsl:value-of select="$page.height"></xsl:value-of>
29376 </xsl:attribute>
29377 <xsl:attribute name="margin-top">
29378 <xsl:value-of select="$page.margin.top"></xsl:value-of>
29379 </xsl:attribute>
29380 <xsl:attribute name="margin-bottom">
29381 <xsl:value-of select="$page.margin.bottom"></xsl:value-of>
29382 </xsl:attribute>
29383 <xsl:attribute name="margin-left">
29384 <xsl:value-of select="$page.margin.inner"></xsl:value-of>
29385 </xsl:attribute>
29386 <xsl:attribute name="margin-right">
29387 <xsl:value-of select="$page.margin.outer"></xsl:value-of>
29388 </xsl:attribute>
29389 </xsl:attribute-set>
29393 <refsection><info><title>Description</title></info>
29395 <para>This parameter specifies properties for the slides titlepage master.</para>
29400 <refentry version="5.0" id="slides.titlepage.region-body.properties">
29402 <refentrytitle>slides.titlepage.region-body.properties</refentrytitle>
29403 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
29406 <refname>slides.titlepage.region-body.properties</refname>
29407 <refpurpose>Specifies properties for slides titlepage region-body</refpurpose>
29411 <programlisting id="slides.titlepage.region-body.properties.frag">
29412 <xsl:attribute-set name="slides.titlepage.region-body.properties">
29413 <xsl:attribute name="margin-bottom">0pt</xsl:attribute>
29414 <xsl:attribute name="margin-top">0pt</xsl:attribute>
29415 <xsl:attribute name="column-count">
29416 <xsl:value-of select="$column.count.body"></xsl:value-of>
29417 </xsl:attribute>
29418 </xsl:attribute-set>
29422 <refsection><info><title>Description</title></info>
29424 <para>This parameter specifies properties for the slides titlepage region-body.</para>
29429 <refentry version="5.0" id="slides.titlepage.corpauthor.properties">
29431 <refentrytitle>slides.titlepage.corpauthor.properties</refentrytitle>
29432 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
29435 <refname>slides.titlepage.corpauthor.properties</refname>
29436 <refpurpose>Specifies properties for slides titlepage title</refpurpose>
29440 <programlisting id="slides.titlepage.corpauthor.properties.frag">
29441 <xsl:attribute-set name="slides.titlepage.corpauthor.properties">
29442 <xsl:attribute name="text-align">center</xsl:attribute>
29443 <xsl:attribute name="space-after">1em</xsl:attribute>
29444 <xsl:attribute name="font-size">20.736pt</xsl:attribute>
29445 </xsl:attribute-set>
29449 <refsection><info><title>Description</title></info>
29451 <para>This parameter specifies properties for the corpauthor on the default
29457 <refentry version="5.0" id="slides.titlepage.title.properties">
29459 <refentrytitle>slides.titlepage.title.properties</refentrytitle>
29460 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
29463 <refname>slides.titlepage.title.properties</refname>
29464 <refpurpose>Specifies properties for slides titlepage title</refpurpose>
29468 <programlisting id="slides.titlepage.title.properties.frag">
29469 <xsl:attribute-set name="slides.titlepage.title.properties">
29470 <xsl:attribute name="text-align">center</xsl:attribute>
29471 <xsl:attribute name="space-after">1em</xsl:attribute>
29472 <xsl:attribute name="padding-top">1.5in</xsl:attribute>
29473 <xsl:attribute name="keep-with-next">always</xsl:attribute>
29474 <xsl:attribute name="font-size">
29475 <xsl:value-of select="$foil.title.size"></xsl:value-of>
29476 </xsl:attribute>
29477 <xsl:attribute name="font-weight">bold</xsl:attribute>
29478 <xsl:attribute name="font-family">
29479 <xsl:value-of select="$slide.title.font.family"></xsl:value-of>
29480 </xsl:attribute>
29481 </xsl:attribute-set>
29485 <refsection><info><title>Description</title></info>
29487 <para>This parameter specifies properties for the title on the default
29493 <refentry version="5.0" id="slides.titlepage.subtitle.properties">
29495 <refentrytitle>slides.titlepage.subtitle.properties</refentrytitle>
29496 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
29499 <refname>slides.titlepage.subtitle.properties</refname>
29500 <refpurpose>Specifies properties for slides titlepage title</refpurpose>
29504 <programlisting id="slides.titlepage.subtitle.properties.frag">
29505 <xsl:attribute-set name="slides.titlepage.subtitle.properties">
29506 <xsl:attribute name="text-align">center</xsl:attribute>
29507 <xsl:attribute name="space-after">1em</xsl:attribute>
29508 <xsl:attribute name="font-family">
29509 <xsl:value-of select="$slide.title.font.family"></xsl:value-of>
29510 </xsl:attribute>
29511 </xsl:attribute-set>
29515 <refsection><info><title>Description</title></info>
29517 <para>This parameter specifies properties for the subtitle on the default
29523 <refentry version="5.0" id="slides.titlepage.author.properties">
29525 <refentrytitle>slides.titlepage.author.properties</refentrytitle>
29526 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
29529 <refname>slides.titlepage.author.properties</refname>
29530 <refpurpose>Specifies properties for slides titlepage title</refpurpose>
29534 <programlisting id="slides.titlepage.author.properties.frag">
29535 <xsl:attribute-set name="slides.titlepage.author.properties">
29536 <xsl:attribute name="text-align">center</xsl:attribute>
29537 <xsl:attribute name="space-after">1em</xsl:attribute>
29538 <xsl:attribute name="font-size">20.736pt</xsl:attribute>
29539 </xsl:attribute-set>
29543 <refsection><info><title>Description</title></info>
29545 <para>This parameter specifies properties for the author on the default
29551 <refentry version="5.0" id="slides.titlepage.pubdate.properties">
29553 <refentrytitle>slides.titlepage.pubdate.properties</refentrytitle>
29554 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
29557 <refname>slides.titlepage.pubdate.properties</refname>
29558 <refpurpose>Specifies properties for slides titlepage title</refpurpose>
29562 <programlisting id="slides.titlepage.pubdate.properties.frag">
29563 <xsl:attribute-set name="slides.titlepage.pubdate.properties">
29564 <xsl:attribute name="text-align">center</xsl:attribute>
29565 <xsl:attribute name="space-after">1em</xsl:attribute>
29566 <xsl:attribute name="font-size">17.28pt</xsl:attribute>
29567 </xsl:attribute-set>
29571 <refsection><info><title>Description</title></info>
29573 <para>This parameter specifies properties for the pubdate on the default
29579 <refentry version="5.0" id="slides.titlepage.authorgroup.properties">
29581 <refentrytitle>slides.titlepage.authorgroup.properties</refentrytitle>
29582 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
29585 <refname>slides.titlepage.authorgroup.properties</refname>
29586 <refpurpose>Specifies properties for slides titlepage title</refpurpose>
29590 <programlisting id="slides.titlepage.authorgroup.properties.frag">
29591 <xsl:attribute-set name="slides.titlepage.authorgroup.properties"></xsl:attribute-set>
29595 <refsection><info><title>Description</title></info>
29597 <para>This parameter specifies properties for the authorgroup on the default
29603 <refentry version="5.0" id="speakernotes.properties">
29605 <refentrytitle>speakernotes.properties</refentrytitle>
29606 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
29609 <refname>footnote.properties</refname>
29610 <refpurpose>Properties applied to speakernotes
29615 <programlisting id="speakernotes.properties.frag">
29616 <xsl:attribute-set name="speakernotes.properties"></xsl:attribute-set>
29620 <refsection><info><title>Description</title></info>
29622 <para>This attribute set is applied to speakernotes.</para>
29629 <part id="website">
29630 <?dbhtml dir="website"?>
29631 <?dbhtml filename="index.html"?>
29632 <title xml:base="../website/param.xml">Website Parameter Reference</title>
29633 <partintro id="websiteintro">
29635 <para xml:base="../website/param.xml">This is reference documentation for all user-configurable
29636 parameters in the DocBook XSL Website stylesheet (for
29637 generating websites from DocBook XML sources). Note that the
29638 Website stylesheet is a customization layer of the DocBook XSL
29639 HTML stylesheet. Therefore, in addition to the
29640 Website-specific parameters listed in this section, you can
29641 also use a number of <link xlink:href="../html/">HTML
29642 stylesheet parameters</link> to control Website output.</para>
29645 <reference id="general" xml:base="../website/param.xml">
29646 <title>General Parameters</title>
29647 <refentry version="5.0" id="autolayout-file">
29649 <refentrytitle>autolayout-file</refentrytitle>
29650 <refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo>
29653 <refname>autolayout-file</refname>
29654 <refpurpose>Identifies the autolayout.xml file</refpurpose>
29658 <programlisting id="autolayout-file.frag">
29659 <xsl:param name="autolayout-file">autolayout.xml</xsl:param>
29663 <refsection><info><title>Description</title></info>
29664 <para>When the source pages are spread over several directories, this
29665 parameter can be set (for example, from the command line of a batch-mode
29666 XSLT processor) to indicate the location of the autolayout.xml file.</para>
29667 <para>FIXME: for browser-based use, there needs to be a PI for this...
29672 <refentry version="5.0" id="body.attributes">
29674 <refentrytitle>body.attributes</refentrytitle>
29675 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
29678 <refname>body.attributes</refname>
29679 <refpurpose>DEPRECATED</refpurpose>
29683 <programlisting id="body.attributes.frag">
29684 <xsl:attribute-set name="body.attributes">
29685 <xsl:attribute name="bgcolor">white</xsl:attribute>
29686 <xsl:attribute name="text">black</xsl:attribute>
29687 <xsl:attribute name="link">#0000FF</xsl:attribute>
29688 <xsl:attribute name="vlink">#840084</xsl:attribute>
29689 <xsl:attribute name="alink">#0000FF</xsl:attribute>
29690 </xsl:attribute-set>
29694 <refsection><info><title>Description</title></info>
29695 <para>DEPRECATED</para>
29699 <refentry version="5.0" id="currentpage.marker">
29701 <refentrytitle>currentpage.marker</refentrytitle>
29702 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
29705 <refname>currentpage.marker</refname>
29706 <refpurpose>The text symbol used to mark the current page</refpurpose>
29710 <programlisting id="currentpage.marker.frag">
29711 <xsl:param name="currentpage.marker">@</xsl:param>
29715 <refsection><info><title>Description</title></info>
29716 <para>Character to use as identifying the current page in </para>
29720 <refentry version="5.0" id="dry-run">
29722 <refentrytitle>dry-run</refentrytitle>
29723 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
29726 <refname>dry-run</refname>
29727 <refpurpose>Indicates that no files should be produced</refpurpose>
29730 <programlisting id="dry-run.frag">
29731 <xsl:param name="dry-run" select="0"></xsl:param>
29734 <refsection><info><title>Description</title></info>
29735 <para>When using the XSLT processor to manage dependencies and construct
29736 the website, this parameter can be used to suppress the generation of
29737 new and updated files. Effectively, this allows you to see what the
29738 stylesheet would do, without actually making any changes.</para>
29739 <para>Only applies when XSLT-based chunking is being used.</para>
29743 <refentry version="5.0" id="feedback.href">
29745 <refentrytitle>feedback.href</refentrytitle>
29746 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
29749 <refname>feedback.href</refname>
29750 <refpurpose>HREF (URI) for feedback link</refpurpose>
29754 <programlisting id="feedback.href.frag">
29755 <xsl:param name="feedback.href"></xsl:param>
29759 <refsection><info><title>Description</title></info>
29760 <para>The <varname>feedback.href</varname> value is used as the value
29761 for the <tag class="attribute">href</tag> attribute on the feedback
29762 link. If <varname>feedback.href</varname>
29763 is empty, no feedback link is generated.</para>
29767 <refentry version="5.0" id="feedback.link.text">
29769 <refentrytitle>feedback.link.text</refentrytitle>
29770 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
29773 <refname>feedback.link.text</refname>
29774 <refpurpose>The text of the feedback link</refpurpose>
29778 <programlisting id="feedback.link.text.frag">
29779 <xsl:param name="feedback.link.text">Feedback</xsl:param>
29783 <refsection><info><title>Description</title></info>
29784 <para>The contents of this variable is used as the text of the feedback
29785 link if <varname>feedback.href</varname> is not empty. If
29786 <varname>feedback.href</varname> is empty, no feedback link is
29791 <refentry version="5.0" id="feedback.with.ids">
29793 <refentrytitle>feedback.with.ids</refentrytitle>
29794 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
29797 <refname>feedback.with.ids</refname>
29798 <refpurpose>Toggle use of IDs in feedback</refpurpose>
29802 <programlisting id="feedback.with.ids.frag">
29803 <xsl:param name="feedback.with.ids" select="0"></xsl:param>
29807 <refsection><info><title>Description</title></info>
29808 <para>If <varname>feedback.with.ids</varname> is non-zero, the ID of the
29809 current page will be added to the feedback link. This can be used, for
29810 example, if the <varname>feedback.href</varname> is a CGI script.</para>
29814 <refentry version="5.0" id="filename-prefix">
29816 <refentrytitle>filename-prefix</refentrytitle>
29817 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
29820 <refname>filename-prefix</refname>
29821 <refpurpose>Prefix added to all filenames</refpurpose>
29825 <programlisting id="filename-prefix.frag">
29826 <xsl:param name="filename-prefix"></xsl:param>
29830 <refsection><info><title>Description</title></info>
29831 <para>To produce the <quote>text-only</quote> (that is, non-tabular) layout
29832 of a website simultaneously with the tabular layout, the filenames have to
29833 be distinguished. That's accomplished by adding the
29834 <varname>filename-prefix</varname> to the front of each filename.</para>
29838 <refentry version="5.0" id="footer.hr">
29840 <refentrytitle>footer.hr</refentrytitle>
29841 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
29844 <refname>footer.hr</refname>
29845 <refpurpose>Toggle <HR> before footer</refpurpose>
29849 <programlisting id="footer.hr.frag">
29850 <xsl:param name="footer.hr" select="1"></xsl:param>
29854 <refsection><info><title>Description</title></info>
29855 <para>If non-zero, an <HR> is generated at the bottom of each web page,
29856 before the footer.</para>
29860 <refentry version="5.0" id="header.hr">
29862 <refentrytitle>header.hr</refentrytitle>
29863 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
29866 <refname>header.hr</refname>
29867 <refpurpose>Toggle <HR> after header</refpurpose>
29871 <programlisting id="header.hr.frag">
29872 <xsl:param name="header.hr" select="1"></xsl:param>
29876 <refsection><info><title>Description</title></info>
29877 <para>If non-zero, an <HR> is generated at the bottom of each web page,
29878 before the footer.</para>
29882 <refentry version="5.0" id="output-root">
29884 <refentrytitle>output-root</refentrytitle>
29885 <refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo>
29888 <refname>output-root</refname>
29889 <refpurpose>Specifies the root directory of the website</refpurpose>
29893 <programlisting id="output-root.frag">
29894 <xsl:param name="output-root">.</xsl:param>
29898 <refsection><info><title>Description</title></info>
29899 <para>When using the XSLT processor to manage dependencies and construct
29900 the website, this parameter can be used to indicate the root directory
29901 where the resulting pages are placed.</para>
29902 <para>Only applies when XSLT-based chunking is being used.</para>
29906 <refentry version="5.0" id="rebuild-all">
29908 <refentrytitle>rebuild-all</refentrytitle>
29909 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
29912 <refname>rebuild-all</refname>
29913 <refpurpose>Indicates that all files should be produced</refpurpose>
29917 <programlisting id="rebuild-all.frag">
29918 <xsl:param name="rebuild-all" select="0"></xsl:param>
29922 <refsection><info><title>Description</title></info>
29923 <para>When using the XSLT processor to manage dependencies and construct
29924 the website, this parameter can be used to regenerate the whole website,
29925 updating even pages that don't appear to need to be updated.</para>
29926 <para>The dependency extension only looks at the source documents. So
29927 if you change something in the stylesheet, for example, that has a global
29928 effect, you can use this parameter to force the stylesheet to rebuild the
29931 <para>Only applies when XSLT-based chunking is being used.</para>
29935 <refentry version="5.0" id="sequential.links">
29937 <refentrytitle>sequential.links</refentrytitle>
29938 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
29941 <refname>sequential.links</refname>
29942 <refpurpose>Make sequentional links?</refpurpose>
29946 <programlisting id="sequential.links.frag">
29947 <xsl:param name="sequential.links" select="0"></xsl:param>
29951 <refsection><info><title>Description</title></info>
29956 <refentry version="5.0" id="suppress.homepage.title">
29958 <refentrytitle>suppress.homepage.title</refentrytitle>
29959 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
29962 <refname>suppress.homepage.title</refname>
29963 <refpurpose>Suppress title on homepage?</refpurpose>
29967 <programlisting id="suppress.homepage.title.frag">
29968 <xsl:param name="suppress.homepage.title" select="1"></xsl:param>
29972 <refsection><info><title>Description</title></info>
29973 <para>FIXME:If non-zero, the title on the homepage is suppressed?</para>
29977 <refentry version="5.0" id="table.spacer.image">
29979 <refentrytitle>table.spacer.image</refentrytitle>
29980 <refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo>
29983 <refname>table.spacer.image</refname>
29984 <refpurpose>Invisible pixel for tabular accessibility</refpurpose>
29988 <programlisting id="table.spacer.image.frag">
29989 <xsl:param name="table.spacer.image">graphics/spacer.gif</xsl:param>
29993 <refsection><info><title>Description</title></info>
29994 <para>This is the 1x1 pixel, transparent pixel used for <link xlink:href="http://diveintoaccessibility.org/day_10_presenting_your_main_content_first.html">the table trick</link> to increase the accessibility of the tabular
29995 website presentation.</para>
29999 </reference><reference id="nav" xml:base="../website/param.xml">
30000 <title>Navigation Parameters</title>
30001 <refentry version="5.0" id="banner.before.navigation">
30003 <refentrytitle>banner.before.navigation</refentrytitle>
30004 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
30007 <refname>banner.before.navigation</refname>
30008 <refpurpose>Put banner before navigation?</refpurpose>
30012 <programlisting id="banner.before.navigation.frag">
30013 <xsl:param name="banner.before.navigation" select="1"></xsl:param>
30017 <refsection><info><title>Description</title></info>
30022 <refentry version="5.0" id="navbgcolor">
30024 <refentrytitle>navbgcolor</refentrytitle>
30025 <refmiscinfo class="other" otherclass="datatype">color</refmiscinfo>
30028 <refname>navbgcolor</refname>
30029 <refpurpose>The background color of the navigation TOC</refpurpose>
30033 <programlisting id="navbgcolor.frag">
30034 <xsl:param name="navbgcolor">#4080FF</xsl:param>
30038 <refsection><info><title>Description</title></info>
30039 <para>The background color of the navigation TOC.</para>
30040 <para>Only applies with the tabular presentation is being used.</para>
30044 <refentry version="5.0" id="navbodywidth">
30046 <refentrytitle>navbodywidth</refentrytitle>
30047 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
30050 <refname>navbodywidth</refname>
30051 <refpurpose>Specifies the width of the navigation table body</refpurpose>
30055 <programlisting id="navbodywidth.frag">
30056 <xsl:param name="navbodywidth"></xsl:param>
30060 <refsection><info><title>Description</title></info>
30061 <para>The width of the body column.</para>
30062 <para>Only applies with the tabular presentation is being used.</para>
30066 <refentry version="5.0" id="nav.table.summary">
30068 <refentrytitle>nav.table.summary</refentrytitle>
30069 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
30072 <refname>nav.table.summary</refname>
30073 <refpurpose>HTML Table summary attribute value for navigation tables</refpurpose>
30077 <programlisting id="nav.table.summary.frag">
30078 <xsl:param name="nav.table.summary">Navigation</xsl:param>
30082 <refsection><info><title>Description</title></info>
30083 <para>The value of this parameter is used as the value of the table
30084 summary attribute for the navigation table.</para>
30085 <para>Only applies with the tabular presentation is being used.</para>
30089 <refentry version="5.0" id="navtocwidth">
30091 <refentrytitle>navtocwidth</refentrytitle>
30092 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
30095 <refname>navtocwidth</refname>
30096 <refpurpose>Specifies the width of the navigation table TOC</refpurpose>
30100 <programlisting id="navtocwidth.frag">
30101 <xsl:param name="navtocwidth">220</xsl:param>
30105 <refsection><info><title>Description</title></info>
30106 <para>The width, in pixels, of the navigation column.</para>
30107 <para>Only applies with the tabular presentation is being used.</para>
30111 <refentry version="5.0" id="textbgcolor">
30113 <refentrytitle>textbgcolor</refentrytitle>
30114 <refmiscinfo class="other" otherclass="datatype">color</refmiscinfo>
30117 <refname>textbgcolor</refname>
30118 <refpurpose>The background color of the table body</refpurpose>
30122 <programlisting id="textbgcolor.frag">
30123 <xsl:param name="textbgcolor">white</xsl:param>
30127 <refsection><info><title>Description</title></info>
30128 <para>The background color of the table body.</para>
30129 <para>Only applies with the tabular presentation is being used.</para>
30133 </reference><reference id="toc" xml:base="../website/param.xml">
30134 <title>ToC Parameters</title>
30135 <refentry version="5.0" id="toc.blank.graphic">
30137 <refentrytitle>toc.blank.graphic</refentrytitle>
30138 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
30141 <refname>toc.blank.graphic</refname>
30142 <refpurpose>Use graphic for "blanks" in TOC?</refpurpose>
30146 <programlisting id="toc.blank.graphic.frag">
30147 <xsl:param name="toc.blank.graphic" select="1"></xsl:param>
30151 <refsection><info><title>Description</title></info>
30152 <para>If non-zero, "blanks" in the the TOC will be accomplished
30153 with the graphic identified by <varname>toc.spacer.image</varname>.
30155 <para>Only applies with the tabular presentation is being used.</para>
30159 <refentry version="5.0" id="toc.blank.image">
30161 <refentrytitle>toc.blank.image</refentrytitle>
30162 <refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo>
30165 <refname>toc.blank.image</refname>
30166 <refpurpose>The image for "blanks" in the TOC</refpurpose>
30170 <programlisting id="toc.blank.image.frag">
30171 <xsl:param name="toc.blank.image">graphics/blank.gif</xsl:param>
30175 <refsection><info><title>Description</title></info>
30176 <para>If <varname>toc.blank.graphic</varname> is non-zero, this image
30177 will be used to for "blanks" in the TOC.</para>
30178 <para>Only applies with the tabular presentation is being used.</para>
30182 <refentry version="5.0" id="toc.blank.text">
30184 <refentrytitle>toc.blank.text</refentrytitle>
30185 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
30188 <refname>toc.blank.text</refname>
30189 <refpurpose>The text for "blanks" in the TOC</refpurpose>
30193 <programlisting id="toc.blank.text.frag">
30194 <xsl:param name="toc.blank.text">   </xsl:param>
30198 <refsection><info><title>Description</title></info>
30199 <para>If <varname>toc.blank.graphic</varname> is zero, this text string
30200 will be used for "blanks" in the TOC.</para>
30201 <para>Only applies with the tabular presentation is being used.</para>
30205 <refentry version="5.0" id="toc.pointer.graphic">
30207 <refentrytitle>toc.pointer.graphic</refentrytitle>
30208 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
30211 <refname>toc.pointer.graphic</refname>
30212 <refpurpose>Use graphic for TOC pointer?</refpurpose>
30216 <programlisting id="toc.pointer.graphic.frag">
30217 <xsl:param name="toc.pointer.graphic" select="1"></xsl:param>
30221 <refsection><info><title>Description</title></info>
30222 <para>If non-zero, the "pointer" in the TOC will be displayed
30223 with the graphic identified by <varname>toc.pointer.image</varname>.
30225 <para>Only applies with the tabular presentation is being used.</para>
30229 <refentry version="5.0" id="toc.pointer.image">
30231 <refentrytitle>toc.pointer.image</refentrytitle>
30232 <refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo>
30235 <refname>toc.pointer.image</refname>
30236 <refpurpose>The image for the "pointer" in the TOC</refpurpose>
30240 <programlisting id="toc.pointer.image.frag">
30241 <xsl:param name="toc.pointer.image">graphics/arrow.gif</xsl:param>
30245 <refsection><info><title>Description</title></info>
30246 <para>If <varname>toc.pointer.graphic</varname> is non-zero, this image
30247 will be used for the "pointer" in the TOC.</para>
30248 <para>Only applies with the tabular presentation is being used.</para>
30252 <refentry version="5.0" id="toc.pointer.text">
30254 <refentrytitle>toc.pointer.text</refentrytitle>
30255 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
30258 <refname>toc.pointer.text</refname>
30259 <refpurpose>The text for the "pointer" in the TOC</refpurpose>
30263 <programlisting id="toc.pointer.text.frag">
30264 <xsl:param name="toc.pointer.text"> > </xsl:param>
30268 <refsection><info><title>Description</title></info>
30269 <para>If <varname>toc.pointer.graphic</varname> is zero, this text string
30270 will be used to display the "pointer" in the TOC.</para>
30271 <para>Only applies with the tabular presentation is being used.</para>
30275 <refentry version="5.0" id="toc.spacer.graphic">
30277 <refentrytitle>toc.spacer.graphic</refentrytitle>
30278 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
30281 <refname>toc.spacer.graphic</refname>
30282 <refpurpose>Use graphic for TOC spacer?</refpurpose>
30286 <programlisting id="toc.spacer.graphic.frag">
30287 <xsl:param name="toc.spacer.graphic" select="1"></xsl:param>
30291 <refsection><info><title>Description</title></info>
30292 <para>If non-zero, the indentation in the TOC will be accomplished
30293 with the graphic identified by <varname>toc.spacer.image</varname>.
30295 <para>Only applies with the tabular presentation is being used.</para>
30299 <refentry version="5.0" id="toc.spacer.image">
30301 <refentrytitle>toc.spacer.image</refentrytitle>
30302 <refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo>
30305 <refname>toc.spacer.image</refname>
30306 <refpurpose>The image for spacing the TOC</refpurpose>
30310 <programlisting id="toc.spacer.image.frag">
30311 <xsl:param name="toc.spacer.image">graphics/blank.gif</xsl:param>
30315 <refsection><info><title>Description</title></info>
30316 <para>If <varname>toc.spacer.graphic</varname> is non-zero, this image
30317 will be used to indent the TOC.</para>
30318 <para>Only applies with the tabular presentation is being used.</para>
30322 <refentry version="5.0" id="toc.spacer.text">
30324 <refentrytitle>toc.spacer.text</refentrytitle>
30325 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
30328 <refname>toc.spacer.text</refname>
30329 <refpurpose>The text for spacing the TOC</refpurpose>
30333 <programlisting id="toc.spacer.text.frag">
30334 <xsl:param name="toc.spacer.text">   </xsl:param>
30338 <refsection><info><title>Description</title></info>
30339 <para>If <varname>toc.spacer.graphic</varname> is zero, this text string
30340 will be used to indent the TOC.</para>
30341 <para>Only applies with the tabular presentation is being used.</para>
30347 <!-- Prepare WebHelp output
30348 <part xml:id="webhelp">
30349 <?dbhtml dir="webhelp"?>
30350 <?dbhtml filename="index.html"?>
30351 <xi:include href="../webhelp/param.xml" xpointer="xpointer(/book/info/title)" />
30352 <partintro xml:id="webhelpintro">
30353 <xi:include href="../webhelp/param.xml" xpointer="xpointer(/book/info/abstract/node())" />
30355 <xi:include href="../webhelp/param.xml" xpointer="xpointer(/book/reference)" />
30360 <book id="pi"><title>DocBook XSL Stylesheets User Reference: PIs</title>
30361 <?dbhtml dir="pi"?>
30362 <?dbhtml filename="index.html"?>
30365 <para>This is generated reference documentation for all
30366 user-specifiable processing instructions in the DocBook
30369 <para>You add these PIs at particular points in a document to
30370 cause specific “exceptions” to formatting/output behavior. To
30371 make global changes in formatting/output behavior across an
30372 entire document, it’s better to do it by setting an
30373 appropriate stylesheet parameter (if there is one).</para>
30378 <part id="pi-html">
30379 <info xml:base="../html/pi.xml"><title>HTML Processing Instruction Reference</title>
30380 <releaseinfo role="meta">
30383 <partintro id="partintro" xml:base="../html/pi.xml">
30384 <title>Introduction</title>
30386 <para>This is generated reference documentation for all
30387 user-specifiable processing instructions (PIs) in the DocBook
30388 XSL stylesheets for HTML output.
30391 <para>You add these PIs at particular points in a document to
30392 cause specific “exceptions” to formatting/output behavior. To
30393 make global changes in formatting/output behavior across an
30394 entire document, it’s better to do it by setting an
30395 appropriate stylesheet parameter (if there is one).</para>
30402 <refentry id="dbhtml_background-color" xml:base="../html/pi.xml">
30404 <refname>dbhtml_background-color</refname>
30405 <refpurpose>Sets background color for an image</refpurpose>
30409 <synopsis><tag class="xmlpi">dbhtml background-color="<replaceable>color</replaceable>"</tag></synopsis>
30412 <refsect1><title>Description</title>
30414 <para>Use the <tag class="xmlpi">dbhtml background-color</tag> PI before or
30415 after an image (<tag>graphic</tag>, <tag>inlinegraphic</tag>,
30416 <tag>imagedata</tag>, or <tag>videodata</tag> element) as a
30417 sibling to the element, to set a background color for the
30420 </refsect1><refsect1><title>Parameters</title>
30423 <varlistentry><term>background-color="<replaceable>color</replaceable>"</term>
30426 <para>An HTML color value</para>
30432 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
30434 <para><link role="tcg" xlink:href="BGcolor.html">Background color</link></para>
30436 </refsect1></refentry>
30438 <refentry id="dbhtml_bgcolor" xml:base="../html/pi.xml">
30440 <refname>dbhtml_bgcolor</refname>
30441 <refpurpose>Sets background color on a CALS table row or table cell</refpurpose>
30445 <synopsis><tag class="xmlpi">dbhtml bgcolor="<replaceable>color</replaceable>"</tag></synopsis>
30448 <refsect1><title>Description</title>
30450 <para>Use the <tag class="xmlpi">dbhtml bgcolor</tag> PI as child of a CALS table row
30451 or cell to set a background color for that table row or cell.</para>
30453 </refsect1><refsect1><title>Parameters</title>
30456 <varlistentry><term>bgcolor="<replaceable>color</replaceable>"</term>
30459 <para>An HTML color value</para>
30465 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
30467 <para><link role="tcg" xlink:href="BGtableColor.html#CellBGColor">Cell background color</link></para>
30469 </refsect1></refentry>
30471 <refentry id="dbhtml_cellpadding" xml:base="../html/pi.xml">
30473 <refname>dbhtml_cellpadding</refname>
30474 <refpurpose>Specifies cellpadding in CALS table or qandaset output</refpurpose>
30478 <synopsis><tag class="xmlpi">dbhtml cellpadding="<replaceable>number</replaceable>"</tag></synopsis>
30481 <refsect1><title>Description</title>
30483 <para>Use the <tag class="xmlpi">dbhtml cellpadding</tag> PI as a child of a
30484 CALS <tag>table</tag> or <tag>qandaset</tag> to specify the value
30485 for the HTML <literal>cellpadding</literal> attribute in the
30486 output HTML table.</para>
30488 </refsect1><refsect1><title>Parameters</title>
30491 <varlistentry><term>cellpadding="<replaceable>number</replaceable>"</term>
30494 <para>Specifies the cellpadding</para>
30500 </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
30502 <para><parameter>html.cellpadding</parameter></para>
30504 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
30506 <para><link role="tcg" xlink:href="CellSpacing.html">Cell spacing and cell padding</link>,
30507 <link role="tcg" xlink:href="QandAformat.html">Q and A formatting</link></para>
30509 </refsect1></refentry>
30511 <refentry id="dbhtml_cellspacing" xml:base="../html/pi.xml">
30513 <refname>dbhtml_cellspacing</refname>
30514 <refpurpose>Specifies cellspacing in CALS table or qandaset output</refpurpose>
30518 <synopsis><tag class="xmlpi">dbhtml cellspacing="<replaceable>number</replaceable>"</tag></synopsis>
30521 <refsect1><title>Description</title>
30523 <para>Use the <tag class="xmlpi">dbhtml cellspacing</tag> PI as a child of a
30524 CALS <tag>table</tag> or <tag>qandaset</tag> to specify the value
30525 for the HTML <literal>cellspacing</literal> attribute in the
30526 output HTML table.</para>
30528 </refsect1><refsect1><title>Parameters</title>
30531 <varlistentry><term>cellspacing="<replaceable>number</replaceable>"</term>
30534 <para>Specifies the cellspacing</para>
30540 </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
30542 <para><parameter>html.cellspacing</parameter></para>
30544 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
30546 <para><link role="tcg" xlink:href="CellSpacing.html">Cell spacing and cell padding</link>,
30547 <link role="tcg" xlink:href="QandAformat.html">Q and A formatting</link></para>
30549 </refsect1></refentry>
30551 <refentry id="dbhtml_class" xml:base="../html/pi.xml">
30553 <refname>dbhtml_class</refname>
30554 <refpurpose>Set value of the class attribute for a CALS table row</refpurpose>
30558 <synopsis><tag class="xmlpi">dbhtml class="<replaceable>name</replaceable>"</tag></synopsis>
30561 <refsect1><title>Description</title>
30563 <para>Use the <tag class="xmlpi">dbhtml class</tag> PI as a child of a
30564 <tag>row</tag> to specify a <literal>class</literal>
30565 attribute and value in the HTML output for that row.</para>
30567 </refsect1><refsect1><title>Parameters</title>
30570 <varlistentry><term>class="<replaceable>name</replaceable>"</term>
30573 <para>Specifies the class name</para>
30579 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
30581 <para><link role="tcg" xlink:href="CSSTableCells.html">Table styles in HTML output</link></para>
30583 </refsect1></refentry>
30585 <refentry id="dbhtml_dir" xml:base="../html/pi.xml">
30587 <refname>dbhtml_dir</refname>
30588 <refpurpose>Specifies a directory name in which to write files</refpurpose>
30592 <synopsis><tag class="xmlpi">dbhtml dir="<replaceable>path</replaceable>"</tag></synopsis>
30595 <refsect1><title>Description</title>
30597 <para>When chunking output, use the <tag class="xmlpi">dbhtml dir</tag> PI
30598 as a child of a chunk source to cause the output of that
30599 chunk to be written to the specified directory; also, use it
30600 as a child of a <tag>mediaobject</tag> to specify a
30601 directory into which any long-description files for that
30602 <tag>mediaobject</tag> will be written.</para>
30606 <para>The output directory specification is inherited by all
30607 chunks of the descendants of the element. If descendants need
30608 to go to a different directory, then add another
30609 <tag class="xmlpi">dbhtml dir</tag> processing
30610 instruction as a child of the source element
30611 for that chunk, and specify the path relative to the
30612 ancestor path.</para>
30616 <para>For example, to put most chunk files into
30617 <filename class="directory">shared</filename>
30618 but one chapter into
30619 <filename class="directory">exception</filename>
30620 at the same level, use:</para>
30623 <programlisting><book>
30624 <?dbhtml dir="shared"?>
30627 <?dbhtml dir="../exception"?>
30633 </refsect1><refsect1><title>Parameters</title>
30636 <varlistentry><term>dir="<replaceable>path</replaceable>"</term>
30639 <para>Specifies the pathname for the directory</para>
30645 </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
30647 <para><parameter>base.dir</parameter></para>
30649 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
30651 <para><link role="tcg" xlink:href="Chunking.html#dbhtmlDirPI">dbhtml dir processing instruction</link></para>
30653 </refsect1></refentry>
30655 <refentry id="dbhtml_filename" xml:base="../html/pi.xml">
30657 <refname>dbhtml_filename</refname>
30658 <refpurpose>Specifies a filename for a chunk</refpurpose>
30662 <synopsis><tag class="xmlpi">dbhtml filename="<replaceable>filename</replaceable>"</tag></synopsis>
30665 <refsect1><title>Description</title>
30667 <para>When chunking output, use the <tag class="xmlpi">dbhtml filename</tag>
30668 PI as a child of a chunk source to specify a filename for
30669 the output file for that chunk. Include the filename suffix.</para>
30673 <para>You cannot include a directory path in the filename value,
30674 or your links may not work. Add a
30675 <tag class="xmlpi">dbhtml dir</tag> processing instruction
30676 to specify the output directory. You can also combine the two
30677 specifications in one processing instruction:
30678 <tag class="xmlpi">dbhtml dir="mydir" filename="myfile.html"</tag>.</para>
30681 </refsect1><refsect1><title>Parameters</title>
30684 <varlistentry><term>filename="<replaceable>path</replaceable>"</term>
30687 <para>Specifies the filename for the file</para>
30693 </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
30695 <para><parameter>use.id.as.filename</parameter></para>
30697 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
30699 <para><link role="tcg" xlink:href="Chunking.html#DbhtmlFilenames">dbhtml filenames</link></para>
30701 </refsect1></refentry>
30703 <refentry id="dbhtml_funcsynopsis-style" xml:base="../html/pi.xml">
30705 <refname>dbhtml_funcsynopsis-style</refname>
30706 <refpurpose>Specifies presentation style for a funcsynopsis</refpurpose>
30710 <synopsis><tag class="xmlpi">dbhtml funcsynopsis-style="kr"|"ansi"</tag></synopsis>
30713 <refsect1><title>Description</title>
30715 <para>Use the <tag class="xmlpi">dbhtml funcsynopsis-style</tag> PI as a child of
30716 a <tag>funcsynopsis</tag> or anywhere within a funcsynopsis
30717 to control the presentation style for output of all
30718 <tag>funcprototype</tag> instances within that funcsynopsis.</para>
30720 </refsect1><refsect1><title>Parameters</title>
30723 <varlistentry><term>funcsynopsis-style="kr"</term>
30726 <para>Displays <tag>funcprototype</tag> output in K&R style</para>
30730 <varlistentry><term>funcsynopsis-style="ansi"</term>
30733 <para>Displays <tag>funcprototype</tag> output in ANSI style</para>
30739 </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
30741 <para><parameter>funcsynopsis.style</parameter></para>
30743 </refsect1></refentry>
30745 <refentry id="dbhtml_img.src.path" xml:base="../html/pi.xml">
30747 <refname>dbhtml_img.src.path</refname>
30748 <refpurpose>Specifies a path to the location of an image file</refpurpose>
30752 <synopsis><tag class="xmlpi">dbhtml img.src.path="<replaceable>path</replaceable>"</tag></synopsis>
30755 <refsect1><title>Description</title>
30757 <para>Use the <tag class="xmlpi">dbhtml img.src.path</tag> PI before or
30758 after an image (<tag>graphic</tag>,
30759 <tag>inlinegraphic</tag>, <tag>imagedata</tag>, or
30760 <tag>videodata</tag> element) as a sibling to the element,
30761 to specify a path to the location of the image; in HTML
30762 output, the value specified for the
30763 <code>img.src.path</code> attribute is prepended to the
30766 </refsect1><refsect1><title>Parameters</title>
30769 <varlistentry><term>img.src.path="<replaceable>path</replaceable>"</term>
30772 <para>Specifies the pathname to prepend to the name of the image file</para>
30778 </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
30780 <para><parameter>img.src.path</parameter></para>
30782 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
30784 <para><link role="tcg" xlink:href="GraphicsLocations.html#UsingFileref">Using fileref</link></para>
30786 </refsect1></refentry>
30788 <refentry id="dbhtml_label-width" xml:base="../html/pi.xml">
30790 <refname>dbhtml_label-width</refname>
30791 <refpurpose>Specifies the label width for a qandaset</refpurpose>
30795 <synopsis><tag class="xmlpi">dbhtml label-width="<replaceable>width</replaceable>"</tag></synopsis>
30798 <refsect1><title>Description</title>
30800 <para>Use the <tag class="xmlpi">dbhtml label-width</tag> PI as a child of a
30801 <tag>qandaset</tag> to specify the width of labels.</para>
30803 </refsect1><refsect1><title>Parameters</title>
30806 <varlistentry><term>label-width="<replaceable>width</replaceable>"</term>
30809 <para>Specifies the label width (including units)</para>
30815 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
30817 <para><link role="tcg" xlink:href="QandAformat.html">Q and A formatting</link></para>
30819 </refsect1></refentry>
30821 <refentry id="dbhtml_linenumbering.everyNth" xml:base="../html/pi.xml">
30823 <refname>dbhtml_linenumbering.everyNth</refname>
30824 <refpurpose>Specifies interval for line numbers in verbatims</refpurpose>
30828 <synopsis><tag class="xmlpi">dbhtml linenumbering.everyNth="<replaceable>N</replaceable>"</tag></synopsis>
30831 <refsect1><title>Description</title>
30833 <para>Use the <tag class="xmlpi">dbhtml linenumbering.everyNth</tag> PI as a child
30834 of a “verbatim” element – <tag>programlisting</tag>,
30835 <tag>screen</tag>, <tag>synopsis</tag> — to specify
30836 the interval at which lines are numbered.</para>
30838 </refsect1><refsect1><title>Parameters</title>
30841 <varlistentry><term>linenumbering.everyNth="<replaceable>N</replaceable>"</term>
30844 <para>Specifies numbering interval; a number is output
30845 before every <replaceable>N</replaceable>th line</para>
30851 </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
30853 <para><parameter>linenumbering.everyNth</parameter></para>
30855 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
30857 <para><link role="tcg" xlink:href="AnnotateListing.html#LineNumbering">Line numbering</link></para>
30859 </refsect1></refentry>
30861 <refentry id="dbhtml_linenumbering.separator" xml:base="../html/pi.xml">
30863 <refname>dbhtml_linenumbering.separator</refname>
30864 <refpurpose>Specifies separator text for line numbers in verbatims</refpurpose>
30868 <synopsis><tag class="xmlpi">dbhtml linenumbering.separator="<replaceable>text</replaceable>"</tag></synopsis>
30871 <refsect1><title>Description</title>
30873 <para>Use the <tag class="xmlpi">dbhtml linenumbering.separator</tag> PI as a child
30874 of a “verbatim” element – <tag>programlisting</tag>,
30875 <tag>screen</tag>, <tag>synopsis</tag> — to specify
30876 the separator text output between the line numbers and content.</para>
30878 </refsect1><refsect1><title>Parameters</title>
30881 <varlistentry><term>linenumbering.separator="<replaceable>text</replaceable>"</term>
30884 <para>Specifies the text (zero or more characters)</para>
30890 </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
30892 <para><parameter>linenumbering.separator</parameter></para>
30894 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
30896 <para><link role="tcg" xlink:href="AnnotateListing.html#LineNumbering">Line numbering</link></para>
30898 </refsect1></refentry>
30900 <refentry id="dbhtml_linenumbering.width" xml:base="../html/pi.xml">
30902 <refname>dbhtml_linenumbering.width</refname>
30903 <refpurpose>Specifies width for line numbers in verbatims</refpurpose>
30907 <synopsis><tag class="xmlpi">dbhtml linenumbering.width="<replaceable>width</replaceable>"</tag></synopsis>
30910 <refsect1><title>Description</title>
30912 <para>Use the <tag class="xmlpi">dbhtml linenumbering.width</tag> PI as a child
30913 of a “verbatim” element – <tag>programlisting</tag>,
30914 <tag>screen</tag>, <tag>synopsis</tag> — to specify
30915 the width set aside for line numbers.</para>
30917 </refsect1><refsect1><title>Parameters</title>
30920 <varlistentry><term>linenumbering.width="<replaceable>width</replaceable>"</term>
30923 <para>Specifies the width (inluding units)</para>
30929 </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
30931 <para><parameter>linenumbering.width</parameter></para>
30933 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
30935 <para><link role="tcg" xlink:href="AnnotateListing.html#LineNumbering">Line numbering</link></para>
30937 </refsect1></refentry>
30939 <refentry id="dbhtml_list-presentation" xml:base="../html/pi.xml">
30941 <refname>dbhtml_list-presentation</refname>
30942 <refpurpose>Specifies presentation style for a variablelist or
30943 segmentedlist</refpurpose>
30947 <synopsis><tag class="xmlpi">dbhtml list-presentation="list"|"table"</tag></synopsis>
30950 <refsect1><title>Description</title>
30952 <para>Use the <tag class="xmlpi">dbhtml list-presentation</tag> PI as a child of
30953 a <tag>variablelist</tag> or <tag>segmentedlist</tag> to
30954 control the presentation style for the list (to cause it, for
30955 example, to be displayed as a table).</para>
30957 </refsect1><refsect1><title>Parameters</title>
30960 <varlistentry><term>list-presentation="list"</term>
30963 <para>Displays the list as a list</para>
30967 <varlistentry><term>list-presentation="table"</term>
30970 <para>Displays the list as a table</para>
30976 </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
30981 <para><parameter>variablelist.as.table</parameter></para>
30986 <para><parameter>segmentedlist.as.table</parameter></para>
30991 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
30993 <para><link role="tcg" xlink:href="Variablelists.html#VarListFormatting">Variable list formatting in HTML</link></para>
30995 </refsect1></refentry>
30997 <refentry id="dbhtml_list-width" xml:base="../html/pi.xml">
30999 <refname>dbhtml_list-width</refname>
31000 <refpurpose>Specifies the width of a variablelist or simplelist</refpurpose>
31004 <synopsis><tag class="xmlpi">dbhtml list-width="<replaceable>width</replaceable>"</tag></synopsis>
31007 <refsect1><title>Description</title>
31009 <para>Use the <tag class="xmlpi">dbhtml list-width</tag> PI as a child of a
31010 <tag>variablelist</tag> or a <tag>simplelist</tag> presented
31011 as a table, to specify the output width.</para>
31013 </refsect1><refsect1><title>Parameters</title>
31016 <varlistentry><term>list-width="<replaceable>width</replaceable>"</term>
31019 <para>Specifies the output width (including units)</para>
31025 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
31027 <para><link role="tcg" xlink:href="Variablelists.html#VarListFormatting">Variable list formatting in HTML</link></para>
31029 </refsect1></refentry>
31031 <refentry id="dbhtml_row-height" xml:base="../html/pi.xml">
31033 <refname>dbhtml_row-height</refname>
31034 <refpurpose>Specifies the height for a CALS table row</refpurpose>
31038 <synopsis><tag class="xmlpi">dbhtml row-height="<replaceable>height</replaceable>"</tag></synopsis>
31041 <refsect1><title>Description</title>
31043 <para>Use the <tag class="xmlpi">dbhtml row-height</tag> PI as a child of a
31044 <tag>row</tag> to specify the height of the row.</para>
31046 </refsect1><refsect1><title>Parameters</title>
31049 <varlistentry><term>row-height="<replaceable>height</replaceable>"</term>
31052 <para>Specifies the row height (including units)</para>
31058 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
31060 <para><link role="tcg" xlink:href="RowHeight.html">Row height</link></para>
31062 </refsect1></refentry>
31064 <refentry id="dbhtml_start" xml:base="../html/pi.xml">
31066 <refname>dbhtml_start</refname>
31067 <refpurpose>(obsolete) Sets the starting number on an ordered list</refpurpose>
31071 <synopsis><tag class="xmlpi">dbhtml start="<replaceable>character</replaceable>"</tag></synopsis>
31074 <refsect1><title>Description</title>
31076 <para><emphasis>This PI is obsolete</emphasis>. The intent of
31077 this PI was to provide a means for setting a specific starting
31078 number for an ordered list. Instead of this PI, set a value
31079 for the <literal>override</literal> attribute on the first
31080 <tag>listitem</tag> in the list; that will have the same
31081 effect as what this PI was intended for.</para>
31083 </refsect1><refsect1><title>Parameters</title>
31086 <varlistentry><term>start="<replaceable>character</replaceable>"</term>
31089 <para>Specifies the character to use as the starting
31090 number; use 0-9, a-z, A-Z, or lowercase or uppercase
31091 Roman numerals</para>
31097 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
31099 <para><link role="tcg" xlink:href="Orderedlists.html#ListStartNum">List starting number</link></para>
31101 </refsect1></refentry>
31103 <refentry id="dbhtml_stop-chunking" xml:base="../html/pi.xml">
31105 <refname>dbhtml_stop-chunking</refname>
31106 <refpurpose>Do not chunk any descendants of this element.</refpurpose>
31110 <synopsis><tag class="xmlpi">dbhtml stop-chunking</tag></synopsis>
31113 <refsect1><title>Description</title>
31115 <para>When generating chunked HTML output, adding this PI as the child of an element that contains elements that would normally be generated on separate pages if generating chunked output causes chunking to stop at this point. No descendants of the current element will be split into new HTML pages:
31116 <programlisting><section>
31117 <title>Configuring pencil</title>
31118 <?dbhtml stop-chunking?>
31122 </section></programlisting>
31125 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
31127 <para><link role="tcg" xlink:href="Chunking.html">Chunking into multiple HTML files</link></para>
31129 </refsect1></refentry>
31131 <refentry id="dbhtml_table-summary" xml:base="../html/pi.xml">
31133 <refname>dbhtml_table-summary</refname>
31134 <refpurpose>Specifies summary for CALS table, variablelist, segmentedlist, or qandaset output</refpurpose>
31138 <synopsis><tag class="xmlpi">dbhtml table-summary="<replaceable>text</replaceable>"</tag></synopsis>
31141 <refsect1><title>Description</title>
31143 <para>Use the <tag class="xmlpi">dbhtml table-summary</tag> PI as a child of
31144 a CALS <tag>table</tag>, <tag>variablelist</tag>,
31145 <tag>segmentedlist</tag>, or <tag>qandaset</tag> to specify
31146 the text for the HTML <literal>summary</literal> attribute
31147 in the output HTML table.</para>
31149 </refsect1><refsect1><title>Parameters</title>
31152 <varlistentry><term>table-summary="<replaceable>text</replaceable>"</term>
31155 <para>Specifies the summary text (zero or more characters)</para>
31161 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
31163 <para><link role="tcg" xlink:href="Variablelists.html#VarListFormatting">Variable list formatting in HTML</link>,
31164 <link role="tcg" xlink:href="TableSummary.html">Table summary text</link></para>
31166 </refsect1></refentry>
31168 <refentry id="dbhtml_table-width" xml:base="../html/pi.xml">
31170 <refname>dbhtml_table-width</refname>
31171 <refpurpose>Specifies the width for a CALS table</refpurpose>
31175 <synopsis><tag class="xmlpi">dbhtml table-width="<replaceable>width</replaceable>"</tag></synopsis>
31178 <refsect1><title>Description</title>
31180 <para>Use the <tag class="xmlpi">dbhtml table-width</tag> PI as a child of a
31181 CALS <tag>table</tag> to specify the width of the table in
31184 </refsect1><refsect1><title>Parameters</title>
31187 <varlistentry><term>table-width="<replaceable>width</replaceable>"</term>
31190 <para>Specifies the table width (including units or as a percentage)</para>
31196 </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
31198 <para><parameter>default.table.width</parameter></para>
31200 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
31202 <para><link role="tcg" xlink:href="Tables.html#TableWidth">Table width</link></para>
31204 </refsect1></refentry>
31206 <refentry id="dbhtml_term-presentation" xml:base="../html/pi.xml">
31208 <refname>dbhtml_term-presentation</refname>
31209 <refpurpose>Sets character formatting for terms in a variablelist</refpurpose>
31213 <synopsis><tag class="xmlpi">dbhtml term-presentation="bold"|"italic"|"bold-italic"</tag></synopsis>
31216 <refsect1><title>Description</title>
31218 <para>Use the <tag class="xmlpi">dbhtml term-presentation</tag> PI as a child
31219 of a <tag>variablelist</tag> to set character formatting for
31220 the <tag>term</tag> output of the list.</para>
31222 </refsect1><refsect1><title>Parameters</title>
31225 <varlistentry><term>term-presentation="<replaceable>bold</replaceable>"</term>
31228 <para>Specifies that terms are displayed in bold</para>
31232 <varlistentry><term>term-presentation="<replaceable>italic</replaceable>"</term>
31235 <para>Specifies that terms are displayed in italic</para>
31239 <varlistentry><term>term-presentation="<replaceable>bold-italic</replaceable>"</term>
31242 <para>Specifies that terms are displayed in bold-italic</para>
31248 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
31250 <para><link role="tcg" xlink:href="Variablelists.html#VarListFormatting">Variable list formatting in HTML</link></para>
31252 </refsect1></refentry>
31254 <refentry id="dbhtml_term-separator" xml:base="../html/pi.xml">
31256 <refname>dbhtml_term-separator</refname>
31257 <refpurpose>Specifies separator text among terms in a varlistentry</refpurpose>
31261 <synopsis><tag class="xmlpi">dbhtml term-separator="<replaceable>text</replaceable>"</tag></synopsis>
31264 <refsect1><title>Description</title>
31266 <para>Use the <tag class="xmlpi">dbhtml term-separator</tag> PI as a child
31267 of a <tag>variablelist</tag> to specify the separator text
31268 among <tag>term</tag> instances.</para>
31270 </refsect1><refsect1><title>Parameters</title>
31273 <varlistentry><term>term-separator="<replaceable>text</replaceable>"</term>
31276 <para>Specifies the text (zero or more characters)</para>
31282 </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
31284 <para><parameter>variablelist.term.separator</parameter></para>
31286 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
31288 <para><link role="tcg" xlink:href="Variablelists.html#VarListFormatting">Variable list formatting in HTML</link></para>
31290 </refsect1></refentry>
31292 <refentry id="dbhtml_term-width" xml:base="../html/pi.xml">
31294 <refname>dbhtml_term-width</refname>
31295 <refpurpose>Specifies the term width for a variablelist</refpurpose>
31299 <synopsis><tag class="xmlpi">dbhtml term-width="<replaceable>width</replaceable>"</tag></synopsis>
31302 <refsect1><title>Description</title>
31304 <para>Use the <tag class="xmlpi">dbhtml term-width</tag> PI as a child of a
31305 <tag>variablelist</tag> to specify the width for
31306 <tag>term</tag> output.</para>
31308 </refsect1><refsect1><title>Parameters</title>
31311 <varlistentry><term>term-width="<replaceable>width</replaceable>"</term>
31314 <para>Specifies the term width (including units)</para>
31320 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
31322 <para><link role="tcg" xlink:href="Variablelists.html#VarListFormatting">Variable list formatting in HTML</link></para>
31324 </refsect1></refentry>
31326 <refentry id="dbhtml_toc" xml:base="../html/pi.xml">
31328 <refname>dbhtml_toc</refname>
31329 <refpurpose>Specifies whether a TOC should be generated for a qandaset</refpurpose>
31333 <synopsis><tag class="xmlpi">dbhtml toc="0"|"1"</tag></synopsis>
31336 <refsect1><title>Description</title>
31338 <para>Use the <tag class="xmlpi">dbhtml toc</tag> PI as a child of a
31339 <tag>qandaset</tag> to specify whether a table of contents
31340 (TOC) is generated for the <tag>qandaset</tag>.</para>
31342 </refsect1><refsect1><title>Parameters</title>
31345 <varlistentry><term>toc="0"</term>
31348 <para>If zero, no TOC is generated</para>
31352 <varlistentry><term>toc="1"</term>
31355 <para>If <code>1</code> (or any non-zero value),
31356 a TOC is generated</para>
31362 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
31364 <para><link role="tcg" xlink:href="QandAtoc.html">Q and A list of questions</link>,
31365 <link role="tcg" xlink:href="QandAformat.html">Q and A formatting</link></para>
31367 </refsect1></refentry>
31369 <refentry id="dbcmdlist" xml:base="../html/pi.xml">
31371 <refname>dbcmdlist</refname>
31372 <refpurpose>Generates a hyperlinked list of commands</refpurpose>
31376 <synopsis><tag class="xmlpi">dbcmdlist</tag></synopsis>
31379 <refsect1><title>Description</title>
31381 <para>Use the <tag class="xmlpi">dbcmdlist</tag> PI as the child of any
31382 element (for example, <tag>refsynopsisdiv</tag>) containing multiple
31383 <tag>cmdsynopsis</tag> instances; a hyperlinked navigational
31384 “command list” will be generated at the top of output for that
31385 element, enabling users to quickly jump
31386 to each command synopsis.</para>
31388 </refsect1><refsect1><title>Parameters</title>
31390 <para>[No parameters]</para>
31392 </refsect1></refentry>
31394 <refentry id="dbfunclist" xml:base="../html/pi.xml">
31396 <refname>dbfunclist</refname>
31397 <refpurpose>Generates a hyperlinked list of functions</refpurpose>
31401 <synopsis><tag class="xmlpi">dbfunclist</tag></synopsis>
31404 <refsect1><title>Description</title>
31406 <para>Use the <tag class="xmlpi">dbfunclist</tag> PI as the child of any
31407 element (for example, <tag>refsynopsisdiv</tag>) containing multiple
31408 <tag>funcsynopsis</tag> instances; a hyperlinked
31409 navigational “function list” will be generated at the top of
31410 output for that element, enabling users to quickly
31411 jump to to each function synopsis.</para>
31413 </refsect1><refsect1><title>Parameters</title>
31415 <para>[No parameters]</para>
31417 </refsect1></refentry>
31419 <refentry id="dbhtml-include_href" xml:base="../html/pi.xml">
31421 <refname>dbhtml-include_href</refname>
31422 <refpurpose>Copies an external well-formed HTML/XML file into current doc</refpurpose>
31426 <synopsis><tag class="xmlpi">dbhtml-include href="<replaceable>URI</replaceable>"</tag></synopsis>
31429 <refsect1><title>Description</title>
31431 <para>Use the <tag class="xmlpi">dbhtml-include href</tag> PI anywhere in a
31432 document to cause the contents of the file referenced by the
31433 <code>href</code> pseudo-attribute to be copied/inserted “as
31434 is” into your HTML output at the point in document order
31435 where the PI occurs in the source.</para>
31439 <para>The referenced file may contain plain text (as long as
31440 it is “wrapped” in an <tag>html</tag> element — see the
31441 note below) or markup in any arbitrary vocabulary,
31442 including HTML — but it must conform to XML
31443 well-formedness constraints (because the feature in XSLT
31444 1.0 for opening external files, the
31445 <function>document()</function> function, can only handle
31446 files that meet XML well-formedness constraints).</para>
31449 <para>Among other things, XML well-formedness constraints
31450 require a document to have <emphasis>a single root
31451 element</emphasis>. So if the content you want to
31452 include is plain text or is markup that does
31453 <emphasis>not</emphasis> have a single root element,
31454 <emphasis role="strong">wrap the content in an
31455 <tag>html</tag> element</emphasis>. The stylesheets will
31456 strip out that surrounding <tag>html</tag> “wrapper” when
31457 they find it, leaving just the content you want to
31461 </refsect1><refsect1><title>Parameters</title>
31464 <varlistentry><term>href="<replaceable>URI</replaceable>"</term>
31467 <para>Specifies the URI for the file to include; the URI
31468 can be, for example, a remote <literal>http:</literal>
31469 URI, or a local filesystem <literal>file:</literal>
31476 </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
31478 <para><parameter>textinsert.extension</parameter></para>
31480 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
31482 <para><link role="tcg" xlink:href="InsertExtHtml.html">Inserting external HTML code</link>,
31483 <link role="tcg" xlink:href="ExternalCode.html">External code files</link></para>
31485 </refsect1></refentry>
31487 <refentry id="dbhh" xml:base="../html/pi.xml">
31489 <refname>dbhh</refname>
31490 <refpurpose>Sets topic name and topic id for context-sensitive HTML Help</refpurpose>
31494 <synopsis><tag class="xmlpi">dbhh topicname="<replaceable>name</replaceable>" topicid="<replaceable>id</replaceable>"</tag></synopsis>
31497 <refsect1><title>Description</title>
31499 <para>Use the <tag class="xmlpi">dbhh</tag> PI as a child of components
31500 that should be used as targets for context-sensitive help requests.</para>
31502 </refsect1><refsect1><title>Parameters</title>
31505 <varlistentry><term>topicname="<replaceable>name</replaceable>"</term>
31508 <para>Specifies a unique string constant that identifies a help topic</para>
31512 <varlistentry><term>topicid="<replaceable>id</replaceable>"</term>
31515 <para>Specifies a unique integer value for the <literal>topicname</literal> string</para>
31521 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
31523 <para><link role="tcg" xlink:href="HtmlHelp.html#HHContextHelp">Context-sensitive help</link></para>
31525 </refsect1></refentry>
31529 <info xml:base="../fo/pi.xml"><title>FO Processing Instruction Reference</title>
31530 <releaseinfo role="meta">
31534 <partintro id="partintro" xml:base="../fo/pi.xml">
31535 <title>Introduction</title>
31538 <para>This is generated reference documentation for all
31539 user-specifiable processing instructions (PIs) in the DocBook
31540 XSL stylesheets for FO output.
31543 <para>You add these PIs at particular points in a document to
31544 cause specific “exceptions” to formatting/output behavior. To
31545 make global changes in formatting/output behavior across an
31546 entire document, it’s better to do it by setting an
31547 appropriate stylesheet parameter (if there is one).</para>
31554 <refentry id="dbfo_background-color" xml:base="../fo/pi.xml">
31556 <refname>dbfo_background-color</refname>
31557 <refpurpose>Sets background color for an image</refpurpose>
31561 <synopsis><tag class="xmlpi">dbfo background-color="<replaceable>color</replaceable>"</tag></synopsis>
31564 <refsect1><title>Description</title>
31566 <para>Use the <tag class="xmlpi">dbfo background-color</tag> PI before or
31567 after an image (<tag>graphic</tag>, <tag>inlinegraphic</tag>,
31568 <tag>imagedata</tag>, or <tag>videodata</tag> element) as a
31569 sibling to the element, to set a background color for the
31572 </refsect1><refsect1><title>Parameters</title>
31575 <varlistentry><term>background-color="<replaceable>color</replaceable>"</term>
31578 <para>An HTML color value</para>
31584 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
31586 <para><link role="tcg" xlink:href="BGcolor.html">Background color</link></para>
31588 </refsect1></refentry>
31590 <refentry id="dbfo_bgcolor" xml:base="../fo/pi.xml">
31592 <refname>dbfo_bgcolor</refname>
31593 <refpurpose>Sets background color on a table row or table cell</refpurpose>
31597 <synopsis><tag class="xmlpi">dbfo bgcolor="<replaceable>color</replaceable>"</tag></synopsis>
31600 <refsect1><title>Description</title>
31602 <para>Use the <tag class="xmlpi">dbfo bgcolor</tag> PI as child of a table row
31603 or cell to set a background color for that table row or cell.</para>
31606 <para>This PI works for both CALS and HTML tables.</para>
31608 </refsect1><refsect1><title>Parameters</title>
31611 <varlistentry><term>bgcolor="<replaceable>color</replaceable>"</term>
31614 <para>An HTML color value</para>
31620 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
31622 <para><link role="tcg" xlink:href="BGtableColor.html#CellBGColor">Cell background color</link></para>
31624 </refsect1></refentry>
31626 <refentry id="dbfo_float-type" xml:base="../fo/pi.xml">
31628 <refname>dbfo_float-type</refname>
31629 <refpurpose>Specifies float behavior for a sidebar</refpurpose>
31633 <synopsis><tag class="xmlpi">dbfo float-type="margin.note"</tag></synopsis>
31636 <refsect1><title>Description</title>
31638 <para>Use the <tag class="xmlpi">dbfo float-type</tag> PI to specify the float
31639 behavior for a <tag>sidebar</tag> (to cause the sidebar to be
31640 displayed as a marginal note).</para>
31642 </refsect1><refsect1><title>Parameters</title>
31645 <varlistentry><term>float-type="margin.note"</term>
31648 <para>Specifies that the <tag>sidebar</tag> should be
31649 displayed as a marginal note.</para>
31655 </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
31657 <para><parameter>sidebar.float.type</parameter> (parameter),
31658 <parameter>sidebar.float.width</parameter> (parameter),
31659 <parameter>sidebar.properties</parameter> (attribute-set),
31660 <parameter>sidebar.title.properties</parameter> (attribute-set)
31663 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
31665 <para><link role="tcg" xlink:href="SideFloats.html#SidebarFloats">A sidebar as
31666 side float</link></para>
31668 </refsect1></refentry>
31670 <refentry id="dbfo_font-size" xml:base="../fo/pi.xml">
31672 <refname>dbfo_font-size</refname>
31673 <refpurpose>Specifies “font-size” for block verbatim elements</refpurpose>
31677 <synopsis><tag class="xmlpi">dbfo font-size="SIZE"</tag></synopsis>
31680 <refsect1><title>Description</title>
31682 <para>Use the <tag class="xmlpi">dbfo font-size</tag> PI as a child of a
31683 verbatim element (<tag>screen</tag>, <tag>programlisting</tag>, or
31684 <tag>synopsis</tag>) to specify the “font-size”.</para>
31686 </refsect1><refsect1><title>Parameters</title>
31689 <varlistentry><term>font-size="SIZE"</term>
31692 <para>Specifies the font size (usually in points)</para>
31698 </refsect1></refentry>
31700 <refentry id="dbfo_funcsynopsis-style" xml:base="../fo/pi.xml">
31702 <refname>dbfo_funcsynopsis-style</refname>
31703 <refpurpose>Specifies presentation style for a funcsynopsis</refpurpose>
31707 <synopsis><tag class="xmlpi">dbfo funcsynopsis-style="kr"|"ansi"</tag></synopsis>
31710 <refsect1><title>Description</title>
31712 <para>Use the <tag class="xmlpi">dbfo funcsynopsis-style</tag> PI as a child of
31713 a <tag>funcsynopsis</tag> or anywhere within a funcsynopsis
31714 to control the presentation style for output of all
31715 <tag>funcprototype</tag> instances within that funcsynopsis.</para>
31717 </refsect1><refsect1><title>Parameters</title>
31720 <varlistentry><term>funcsynopsis-style="kr"</term>
31723 <para>Displays <tag>funcprototype</tag> output in K&R style</para>
31727 <varlistentry><term>funcsynopsis-style="ansi"</term>
31730 <para>Displays <tag>funcprototype</tag> output in ANSI style</para>
31736 </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
31738 <para><parameter>funcsynopsis.style</parameter></para>
31740 </refsect1></refentry>
31742 <refentry id="dbfo_glossary-presentation" xml:base="../fo/pi.xml">
31744 <refname>dbfo_glossary-presentation</refname>
31745 <refpurpose>Specifies presentation style for a glossary</refpurpose>
31749 <synopsis><tag class="xmlpi">dbfo glossary-presentation="list"|"blocks"</tag></synopsis>
31752 <refsect1><title>Description</title>
31754 <para>Use the <tag class="xmlpi">dbfo glossary-presentation</tag> PI as a child of
31755 a <tag>glossary</tag> to control its presentation style.</para>
31757 </refsect1><refsect1><title>Parameters</title>
31760 <varlistentry><term>glossary-presentation="list"</term>
31763 <para>Displays the glossary as a list</para>
31767 <varlistentry><term>glossary-presentation="blocks"</term>
31770 <para>Displays the glossary as blocks</para>
31776 </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
31778 <para><parameter>glossary.as.blocks</parameter></para>
31780 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
31782 <para><link role="tcg" xlink:href="Glossaries.html#GlossaryFormatPrint">Glossary
31783 formatting in print</link></para>
31785 </refsect1></refentry>
31787 <refentry id="dbfo_glosslist-presentation" xml:base="../fo/pi.xml">
31789 <refname>dbfo_glosslist-presentation</refname>
31790 <refpurpose>Specifies presentation style for a glosslist</refpurpose>
31794 <synopsis><tag class="xmlpi">dbfo glosslist-presentation="list"|"blocks"</tag></synopsis>
31797 <refsect1><title>Description</title>
31799 <para>Use the <tag class="xmlpi">dbfo glosslist-presentation</tag> PI as a child of
31800 a <tag>glosslist</tag> to control its presentation style.</para>
31802 </refsect1><refsect1><title>Parameters</title>
31805 <varlistentry><term>glosslist-presentation="list"</term>
31808 <para>Displays the glosslist as a list</para>
31812 <varlistentry><term>glosslist-presentation="blocks"</term>
31815 <para>Displays the glosslist as blocks</para>
31821 </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
31823 <para><parameter>glosslist.as.blocks</parameter> </para>
31825 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
31827 <para><link role="tcg" xlink:href="Glossaries.html#GlossaryFormatPrint">Glossary
31828 formatting in print</link></para>
31830 </refsect1></refentry>
31832 <refentry id="dbfo_glossterm-width" xml:base="../fo/pi.xml">
31834 <refname>dbfo_glossterm-width</refname>
31835 <refpurpose>Specifies the glossterm width for a glossary or
31836 glosslist</refpurpose>
31840 <synopsis><tag class="xmlpi">dbfo glossterm-width="<replaceable>width</replaceable>"</tag></synopsis>
31843 <refsect1><title>Description</title>
31845 <para>Use the <tag class="xmlpi">dbfo glossterm-width</tag> PI as a child of a
31846 <tag>glossary</tag> or <tag>glosslist</tag> to specify the
31847 width for output of <tag>glossterm</tag> instances in the
31850 </refsect1><refsect1><title>Parameters</title>
31853 <varlistentry><term>glossterm-width="<replaceable>width</replaceable>"</term>
31856 <para>Specifies the glossterm width (including units)</para>
31862 </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
31864 <para><parameter>glossterm.width</parameter>,
31865 <parameter>glossterm.separation</parameter>
31868 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
31870 <para><link role="tcg" xlink:href="Glossaries.html#GlossaryFormatPrint">Glossary
31871 formatting in print</link></para>
31873 </refsect1></refentry>
31875 <refentry id="dbfo_keep-together" xml:base="../fo/pi.xml">
31877 <refname>dbfo_keep-together</refname>
31878 <refpurpose>Specifies “keep” behavior for a table, example,
31879 figure, equation, procedure, or task</refpurpose>
31883 <synopsis><tag class="xmlpi">dbfo keep-together="auto"|"always"</tag></synopsis>
31886 <refsect1><title>Description</title>
31888 <para>Use the <tag class="xmlpi">dbfo keep-together</tag> PI as a child of a
31889 formal object (<tag>table</tag>, <tag>example</tag>,
31890 <tag>figure</tag>, <tag>equation</tag>, <tag>procedure</tag>, or
31891 <tag>task</tag>) to specify “keep” behavior (to allow the object to
31892 “break” across a page).</para>
31895 <para>The PI also works with <tag>informaltable</tag>, <tag>informalexample</tag>,
31896 <tag>informalfigure</tag> and <tag>informalequation</tag>.
31900 </refsect1><refsect1><title>Parameters</title>
31903 <varlistentry><term>keep-together="auto"</term>
31906 <para>Enables the object to break across a page</para>
31910 <varlistentry><term>keep-together="always"</term>
31913 <para>Prevents the object from breaking across a page (the
31914 default stylesheet behavior)</para>
31920 </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
31922 <para>formal.object.properties</para>
31924 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
31926 <para><link role="tcg" xlink:href="PageBreaking.html#KeepTogetherPI">Keep-together processing instruction</link></para>
31928 </refsect1></refentry>
31930 <refentry id="dbfo_label-width" xml:base="../fo/pi.xml">
31932 <refname>dbfo_label-width</refname>
31933 <refpurpose>Specifies the label width for a qandaset, itemizedlist, orderedlist
31934 or calloutlist</refpurpose>
31938 <synopsis><tag class="xmlpi">dbfo label-width="<replaceable>width</replaceable>"</tag></synopsis>
31941 <refsect1><title>Description</title>
31943 <para>Use the <tag class="xmlpi">dbfo label-width</tag> PI as a child of a
31944 <tag>qandaset</tag>, <tag>itemizedlist</tag>, <tag>orderedlist</tag>,
31945 or <tag>calloutlist</tag> to specify the width of labels.</para>
31947 </refsect1><refsect1><title>Parameters</title>
31950 <varlistentry><term>label-width="<replaceable>width</replaceable>"</term>
31953 <para>Specifies the label width (including units)</para>
31959 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
31961 <para><link role="tcg" xlink:href="QandAformat.html">Q and A formatting</link></para>
31963 </refsect1></refentry>
31965 <refentry id="dbfo_linenumbering.everyNth" xml:base="../fo/pi.xml">
31967 <refname>dbfo_linenumbering.everyNth</refname>
31968 <refpurpose>Specifies interval for line numbers in verbatims</refpurpose>
31972 <synopsis><tag class="xmlpi">dbfo linenumbering.everyNth="<replaceable>N</replaceable>"</tag></synopsis>
31975 <refsect1><title>Description</title>
31977 <para>Use the <tag class="xmlpi">dbfo linenumbering.everyNth</tag> PI as a child
31978 of a “verbatim” element – <tag>programlisting</tag>,
31979 <tag>screen</tag>, <tag>synopsis</tag> — to specify
31980 the interval at which lines are numbered.</para>
31982 </refsect1><refsect1><title>Parameters</title>
31985 <varlistentry><term>linenumbering.everyNth="<replaceable>N</replaceable>"</term>
31988 <para>Specifies numbering interval; a number is output
31989 before every <replaceable>N</replaceable>th line</para>
31995 </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
31997 <para><parameter>linenumbering.everyNth</parameter></para>
31999 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
32001 <para><link role="tcg" xlink:href="AnnotateListing.html#LineNumbering">Line numbering</link></para>
32003 </refsect1></refentry>
32005 <refentry id="dbfo_linenumbering.separator" xml:base="../fo/pi.xml">
32007 <refname>dbfo_linenumbering.separator</refname>
32008 <refpurpose>Specifies separator text for line numbers in verbatims</refpurpose>
32012 <synopsis><tag class="xmlpi">dbfo linenumbering.separator="<replaceable>text</replaceable>"</tag></synopsis>
32015 <refsect1><title>Description</title>
32017 <para>Use the <tag class="xmlpi">dbfo linenumbering.separator</tag> PI as a child
32018 of a “verbatim” element – <tag>programlisting</tag>,
32019 <tag>screen</tag>, <tag>synopsis</tag> — to specify
32020 the separator text output between the line numbers and content.</para>
32022 </refsect1><refsect1><title>Parameters</title>
32025 <varlistentry><term>linenumbering.separator="<replaceable>text</replaceable>"</term>
32028 <para>Specifies the text (zero or more characters)</para>
32034 </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
32036 <para><parameter>linenumbering.separator</parameter></para>
32038 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
32040 <para><link role="tcg" xlink:href="AnnotateListing.html#LineNumbering">Line numbering</link></para>
32042 </refsect1></refentry>
32044 <refentry id="dbfo_linenumbering.width" xml:base="../fo/pi.xml">
32046 <refname>dbfo_linenumbering.width</refname>
32047 <refpurpose>Specifies width for line numbers in verbatims</refpurpose>
32051 <synopsis><tag class="xmlpi">dbfo linenumbering.width="<replaceable>width</replaceable>"</tag></synopsis>
32054 <refsect1><title>Description</title>
32056 <para>Use the <tag class="xmlpi">dbfo linenumbering.width</tag> PI as a child
32057 of a “verbatim” element – <tag>programlisting</tag>,
32058 <tag>screen</tag>, <tag>synopsis</tag> — to specify
32059 the width set aside for line numbers.</para>
32061 </refsect1><refsect1><title>Parameters</title>
32064 <varlistentry><term>linenumbering.width="<replaceable>width</replaceable>"</term>
32067 <para>Specifies the width (inluding units)</para>
32073 </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
32075 <para><parameter>linenumbering.width</parameter></para>
32077 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
32079 <para><link role="tcg" xlink:href="AnnotateListing.html#LineNumbering">Line numbering</link></para>
32081 </refsect1></refentry>
32083 <refentry id="dbfo_list-presentation" xml:base="../fo/pi.xml">
32085 <refname>dbfo_list-presentation</refname>
32086 <refpurpose>Specifies presentation style for a variablelist or
32087 segmentedlist</refpurpose>
32091 <synopsis><tag class="xmlpi">dbfo list-presentation="list"|"blocks"|"table"</tag></synopsis>
32094 <refsect1><title>Description</title>
32096 <para>Use the <tag class="xmlpi">dbfo list-presentation</tag> PI as a child of
32097 a <tag>variablelist</tag> or <tag>segmentedlist</tag> to
32098 control the presentation style for the list (to cause it, for
32099 example, to be displayed as a table).</para>
32101 </refsect1><refsect1><title>Parameters</title>
32104 <varlistentry><term>list-presentation="list"</term>
32107 <para>Displays the list as a list</para>
32111 <varlistentry><term>list-presentation="blocks"</term>
32114 <para>(<tag>variablelist</tag> only) Displays the list as blocks</para>
32118 <varlistentry><term>list-presentation="table"</term>
32121 <para>(<tag>segmentedlist</tag> only) Displays the list as a table</para>
32127 </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
32132 <para><parameter>variablelist.as.blocks</parameter></para>
32137 <para><parameter>variablelist.as.table</parameter></para>
32142 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
32144 <para><link role="tcg" xlink:href="Variablelists.html#ListIndents">Variable list formatting in print</link></para>
32146 </refsect1></refentry>
32148 <refentry id="dbfo_list-width" xml:base="../fo/pi.xml">
32150 <refname>dbfo_list-width</refname>
32151 <refpurpose>Specifies the width of a horizontal simplelist</refpurpose>
32155 <synopsis><tag class="xmlpi">dbfo list-width="<replaceable>width</replaceable>"</tag></synopsis>
32158 <refsect1><title>Description</title>
32160 <para>Use the <tag class="xmlpi">dbfo list-width</tag> PI as a child of a
32161 <tag>simplelist</tag> whose <tag class="attribute">class</tag>
32162 value is <literal>horizontal</literal>, to specify the width
32163 of the <tag>simplelist</tag>.</para>
32165 </refsect1><refsect1><title>Parameters</title>
32168 <varlistentry><term>list-width="<replaceable>width</replaceable>"</term>
32171 <para>Specifies the <tag>simplelist</tag> width (including units)</para>
32177 </refsect1></refentry>
32179 <refentry id="dbfo_orientation" xml:base="../fo/pi.xml">
32181 <refname>dbfo_orientation</refname>
32182 <refpurpose>Specifies the orientation for a CALS table row or cell</refpurpose>
32186 <synopsis><tag class="xmlpi">dbfo orientation="0"|"90"|"180"|"270"|"-90"|"-180"|"-270"</tag></synopsis>
32189 <refsect1><title>Description</title>
32191 <para>Use the <tag class="xmlpi">dbfo orientation</tag> PI as a child of a CALS
32192 <tag>table</tag> row or cell to specify the orientation
32193 (rotation) for the row or cell.</para>
32195 </refsect1><refsect1><title>Parameters</title>
32198 <varlistentry><term>orientation="0"|"90"|"180"|"270"|"-90"|"-180"|"-270"</term>
32201 <para>Specifies the number of degrees by which the cell or
32202 row is rotated</para>
32208 </refsect1></refentry>
32210 <refentry id="dbfo_pgwide" xml:base="../fo/pi.xml">
32212 <refname>dbfo_pgwide</refname>
32213 <refpurpose>Specifies if an <tag>equation</tag> or <tag>example</tag> goes across full page width</refpurpose>
32217 <synopsis><tag class="xmlpi">dbfo pgwide="0"|"1"</tag></synopsis>
32220 <refsect1><title>Description</title>
32222 <para>Use the <tag class="xmlpi">dbfo pgwide</tag> PI as a child of an
32223 <tag>equation</tag> or <tag>example</tag> to specify that the
32224 content should rendered across the full width of the page.</para>
32226 </refsect1><refsect1><title>Parameters</title>
32229 <varlistentry><term>pgwide="0"</term>
32232 <para>If zero, the content is rendered across the current
32237 <varlistentry><term>pgwide="1"</term>
32240 <para>If <code>1</code> (or any non-zero value), the
32241 content is rendered across the full width of the page</para>
32247 </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
32249 <para><parameter>pgwide.properties</parameter></para>
32251 </refsect1></refentry>
32253 <refentry id="dbfo_rotated-width" xml:base="../fo/pi.xml">
32255 <refname>dbfo_rotated-width</refname>
32256 <refpurpose>Specifies the width for a CALS table <tag>entry</tag> or
32257 <tag>row</tag></refpurpose>
32261 <synopsis><tag class="xmlpi">dbfo rotated-width="<replaceable>width</replaceable>"</tag></synopsis>
32264 <refsect1><title>Description</title>
32266 <para>Use the <tag class="xmlpi">dbfo rotated-width</tag> PI as a child of
32267 <tag>entry</tag> or <tag>row</tag> instance in a CALS table to specify the
32268 width of that the <tag>entry</tag> or <tag>row</tag>; or
32269 use it higher up in table to cause the width to be inherited
32270 recursively down.</para>
32272 </refsect1><refsect1><title>Parameters</title>
32275 <varlistentry><term>rotated-width="<replaceable>width</replaceable>"</term>
32278 <para>Specifies the width of a row or cell (including units)</para>
32284 </refsect1></refentry>
32286 <refentry id="dbfo_sidebar-width" xml:base="../fo/pi.xml">
32288 <refname>dbfo_sidebar-width</refname>
32289 <refpurpose>Specifies the width of a sidebar</refpurpose>
32293 <synopsis><tag class="xmlpi">dbfo sidebar-width="<replaceable>width</replaceable>"</tag></synopsis>
32296 <refsect1><title>Description</title>
32298 <para>Use the <tag class="xmlpi">dbfo sidebar-width</tag> PI as a child of a
32299 <tag>sidebar</tag> to specify the width of the sidebar.</para>
32301 </refsect1><refsect1><title>Parameters</title>
32304 <varlistentry><term>sidebar-width="<replaceable>width</replaceable>"</term>
32307 <para>Specifies the <tag>sidebar</tag> width (including units)</para>
32313 </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
32315 <para><parameter>sidebar.float.type parameter</parameter>,
32316 <parameter>sidebar.float.width parameter</parameter>,
32317 <parameter>sidebar.properties attribute-set</parameter>,
32318 <parameter>sidebar.title.properties</parameter>
32321 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
32323 <para><link role="tcg" xlink:href="SideFloats.html#SidebarFloats">A sidebar as
32324 side float</link></para>
32326 </refsect1></refentry>
32328 <refentry id="dbfo_start" xml:base="../fo/pi.xml">
32330 <refname>dbfo_start</refname>
32331 <refpurpose>(obsolete) Sets the starting number on an ordered list</refpurpose>
32335 <synopsis><tag class="xmlpi">dbfo start="<replaceable>character</replaceable>"</tag></synopsis>
32338 <refsect1><title>Description</title>
32340 <para><emphasis>This PI is obsolete</emphasis>. The intent of
32341 it was to provide a means for setting a specific starting
32342 number for an ordered list. Instead of this PI, set a value
32343 for the <literal>override</literal> attribute on the first
32344 <tag>listitem</tag> in the list; that will have the same
32345 effect as what this PI was intended for.</para>
32347 </refsect1><refsect1><title>Parameters</title>
32350 <varlistentry><term>start="<replaceable>character</replaceable>"</term>
32353 <para>Specifies the character to use as the starting
32354 number; use 0-9, a-z, A-Z, or lowercase or uppercase
32355 Roman numerals</para>
32361 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
32363 <para><link role="tcg" xlink:href="Orderedlists.html#ListStartNum">List starting number</link></para>
32365 </refsect1></refentry>
32367 <refentry id="dbfo_table-width" xml:base="../fo/pi.xml">
32369 <refname>dbfo_table-width</refname>
32370 <refpurpose>Specifies the width for a CALS table or for revhistory
32371 output</refpurpose>
32375 <synopsis><tag class="xmlpi">dbfo table-width="<replaceable>width</replaceable>"</tag></synopsis>
32378 <refsect1><title>Description</title>
32380 <para>Use the <tag class="xmlpi">dbfo table-width</tag> PI as a child or
32381 sibling of a CALS <tag>table</tag>, or as a child of an
32382 <tag>informaltable</tag>, <tag>entrytbl</tag>, or
32383 <tag>revhistory</tag> instance (which is rendered as a table
32384 in output) to specify the width of the table in output.</para>
32386 </refsect1><refsect1><title>Parameters</title>
32389 <varlistentry><term>table-width="<replaceable>width</replaceable>"</term>
32392 <para>Specifies the table width (including units or as a percentage)</para>
32398 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
32400 <para><link role="tcg" xlink:href="Tables.html#TableWidth">Table width</link></para>
32402 </refsect1></refentry>
32404 <refentry id="dbfo_term-width" xml:base="../fo/pi.xml">
32406 <refname>dbfo_term-width</refname>
32407 <refpurpose>Specifies the term width for a variablelist</refpurpose>
32411 <synopsis><tag class="xmlpi">dbfo term-width="<replaceable>width</replaceable>"</tag></synopsis>
32414 <refsect1><title>Description</title>
32416 <para>Use the <tag class="xmlpi">dbfo term-width</tag> PI as a child of a
32417 <tag>variablelist</tag> to specify the width for
32418 <tag>term</tag> output.</para>
32420 </refsect1><refsect1><title>Parameters</title>
32423 <varlistentry><term>term-width="<replaceable>width</replaceable>"</term>
32426 <para>Specifies the term width (including units)</para>
32432 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
32434 <para><link role="tcg" xlink:href="Variablelists.html#ListIndents">Variable list formatting in print</link></para>
32436 </refsect1></refentry>
32438 <refentry id="dbfo_toc" xml:base="../fo/pi.xml">
32440 <refname>dbfo_toc</refname>
32441 <refpurpose>Specifies whether a TOC should be generated for a qandaset</refpurpose>
32445 <synopsis><tag class="xmlpi">dbfo toc="0"|"1"</tag></synopsis>
32448 <refsect1><title>Description</title>
32450 <para>Use the <tag class="xmlpi">dbfo toc</tag> PI as a child of a
32451 <tag>qandaset</tag> to specify whether a table of contents
32452 (TOC) is generated for the <tag>qandaset</tag>.</para>
32454 </refsect1><refsect1><title>Parameters</title>
32457 <varlistentry><term>toc="0"</term>
32460 <para>If zero, no TOC is generated</para>
32464 <varlistentry><term>toc="1"</term>
32467 <para>If <code>1</code> (or any non-zero value),
32468 a TOC is generated</para>
32474 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
32476 <para><link role="tcg" xlink:href="QandAtoc.html">Q and A list of questions</link>,
32477 <link role="tcg" xlink:href="QandAformat.html">Q and A formatting</link></para>
32479 </refsect1></refentry>
32481 <refentry id="dbfo-need" xml:base="../fo/pi.xml">
32483 <refname>dbfo-need</refname>
32484 <refpurpose>Specify a need for space (a kind of soft page break)</refpurpose>
32488 <synopsis><tag class="xmlpi">dbfo-need height="<replaceable>n</replaceable>" [space-before="<replaceable>n</replaceable>"]</tag></synopsis>
32491 <refsect1><title>Description</title>
32493 <para>A “need” is a request for space on a page. If the
32494 requested space is not available, the page breaks and the
32495 content that follows the need request appears on the next
32496 page. If the requested space is available, then no page break
32497 is inserted.</para>
32499 </refsect1><refsect1><title>Parameters</title>
32502 <varlistentry><term>height="<replaceable>n</replaceable>"</term>
32505 <para>The amount of height needed (including units)</para>
32509 <varlistentry><term>space-before="<replaceable>n</replaceable>"</term>
32512 <para>The amount of extra vertical space to add (including units)</para>
32518 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
32520 <para><link role="tcg" xlink:href="PageBreaking.html#SoftPageBreaks">Soft page breaks</link></para>
32522 </refsect1></refentry>
32524 <refentry id="dbfo_row-height" xml:base="../fo/pi.xml">
32526 <refname>dbfo_row-height</refname>
32527 <refpurpose>Specifies the height for a CALS table row</refpurpose>
32531 <synopsis><tag class="xmlpi">dbfo row-height="<replaceable>height</replaceable>"</tag></synopsis>
32534 <refsect1><title>Description</title>
32536 <para>Use the <tag class="xmlpi">dbfo row-height</tag> PI as a child of a
32537 <tag>row</tag> to specify the height of the row.</para>
32539 </refsect1><refsect1><title>Parameters</title>
32542 <varlistentry><term>row-height="<replaceable>height</replaceable>"</term>
32545 <para>Specifies the row height (including units)</para>
32551 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
32553 <para><link role="tcg" xlink:href="RowHeight.html">Row height</link></para>
32555 </refsect1></refentry>
32559 <info xml:base="../manpages/pi.xml"><title>manpages Processing Instruction Reference</title>
32560 <releaseinfo role="meta">
32563 <partintro id="partintro" xml:base="../manpages/pi.xml">
32564 <title>Introduction</title>
32566 <para>This is generated reference documentation for all
32567 user-specifiable processing instructions (PIs) in the DocBook
32568 XSL stylesheets for manpages output.
32571 <para>You add these PIs at particular points in a document to
32572 cause specific “exceptions” to formatting/output behavior. To
32573 make global changes in formatting/output behavior across an
32574 entire document, it’s better to do it by setting an
32575 appropriate stylesheet parameter (if there is one).</para>
32582 <refentry id="dbman_funcsynopsis-style" xml:base="../manpages/pi.xml">
32584 <refname>dbman_funcsynopsis-style</refname>
32585 <refpurpose>Specifies presentation style for a funcsynopsis.</refpurpose>
32589 <synopsis><tag class="xmlpi">dbman funcsynopsis-style="kr"|"ansi"</tag></synopsis>
32592 <refsect1><title>Description</title>
32594 <para>Use the <tag class="xmlpi">dbman
32595 funcsynopsis-style</tag> PI as a child of a
32596 <tag>funcsynopsis</tag> or anywhere within a funcsynopsis
32597 to control the presentation style for output of all
32598 <tag>funcprototype</tag> instances within that funcsynopsis.</para>
32600 </refsect1><refsect1><title>Parameters</title>
32603 <varlistentry><term>funcsynopsis-style="kr"</term>
32606 <para>Displays the <tag>funcprototype</tag> in K&R style</para>
32610 <varlistentry><term>funcsynopsis-style="ansi"</term>
32613 <para>Displays the <tag>funcprototype</tag> in ANSI style</para>
32619 </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
32621 <para><parameter>man.funcsynopsis.style</parameter></para>
32623 </refsect1></refentry>
32626 <part id="pi-common">
32627 <info xml:base="../common/pi.xml"><title>Common Processing Instruction Reference</title>
32628 <releaseinfo role="meta">
32631 <partintro id="partintro" xml:base="../common/pi.xml">
32632 <title>Introduction</title>
32634 <para>This is generated reference documentation for all
32635 user-specifiable processing instructions (PIs) in the
32636 “common” part of the DocBook XSL stylesheets.
32639 <para>You add these PIs at particular points in a document to
32640 cause specific “exceptions” to formatting/output behavior. To
32641 make global changes in formatting/output behavior across an
32642 entire document, it’s better to do it by setting an
32643 appropriate stylesheet parameter (if there is one).</para>
32650 <refentry id="dbchoice_choice" xml:base="../common/pi.xml">
32652 <refname>dbchoice_choice</refname>
32653 <refpurpose>Generates a localized choice separator</refpurpose>
32657 <synopsis><tag class="xmlpi">dbchoice choice="and"|"or"|<replaceable>string</replaceable>"</tag></synopsis>
32660 <refsect1><title>Description</title>
32662 <para>Use the <tag class="xmlpi">dbchoice choice</tag> PI to
32663 generate an appropriate localized “choice” separator (for
32664 example, <literal>and</literal> or <literal>or</literal>)
32665 before the final item in an inline <tag>simplelist</tag></para>
32669 <para>This PI is a less-than-ideal hack; support for it may
32670 disappear in the future (particularly if and when a more
32671 appropriate means for marking up "choice" lists becomes
32672 available in DocBook).</para>
32675 </refsect1><refsect1><title>Parameters</title>
32678 <varlistentry><term>choice="and"</term>
32681 <para>generates a localized <literal>and</literal> separator</para>
32685 <varlistentry><term>choice="or"</term>
32688 <para>generates a localized <literal>or</literal> separator</para>
32692 <varlistentry><term>choice="<replaceable>string</replaceable>"</term>
32695 <para>generates a literal <replaceable>string</replaceable> separator</para>
32701 </refsect1></refentry>
32703 <refentry id="dbtimestamp" xml:base="../common/pi.xml">
32705 <refname>dbtimestamp</refname>
32706 <refpurpose>Inserts a date timestamp</refpurpose>
32710 <synopsis><tag class="xmlpi">dbtimestamp format="<replaceable>formatstring</replaceable>" [padding="0"|"1"]</tag></synopsis>
32713 <refsect1><title>Description</title>
32715 <para>Use the <tag class="xmlpi">dbtimestamp</tag> PI at any point in a
32716 source document to cause a date timestamp (a formatted
32717 string representing the current date and time) to be
32718 inserted in output of the document.</para>
32720 </refsect1><refsect1><title>Parameters</title>
32723 <varlistentry><term>format="<replaceable>formatstring</replaceable>"</term>
32726 <para>Specifies format in which the date and time are
32731 <para>For details of the content of the format string,
32732 see <link role="tcg" xlink:href="Datetime.html">Date and time</link>.</para>
32737 <varlistentry><term>padding="0"|"1"</term>
32740 <para>Specifies padding behavior; if non-zero, padding is is added</para>
32746 </refsect1></refentry>
32748 <refentry id="dbtex_delims" xml:base="../common/pi.xml">
32750 <refname>dbtex_delims</refname>
32751 <refpurpose>Generates delimiters around embedded TeX equations
32752 in output</refpurpose>
32756 <synopsis><tag class="xmlpi">dbtex delims="no"|"yes"</tag></synopsis>
32759 <refsect1><title>Description</title>
32761 <para>Use the <tag class="xmlpi">dbtex delims</tag> PI as a
32762 child of a <tag>textobject</tag> containing embedded TeX
32763 markup, to cause that markup to be surrounded by
32764 <literal>$</literal> delimiter characters in output.</para>
32768 <para>This feature is useful for print/PDF output only if you
32769 use the obsolete and now unsupported PassiveTeX XSL-FO
32773 </refsect1><refsect1><title>Parameters</title>
32776 <varlistentry><term>dbtex delims="no"|"yes"</term>
32779 <para>Specifies whether delimiters are output</para>
32785 </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
32787 <para><parameter>tex.math.delims</parameter></para>
32789 </refsect1></refentry>
32793 <book id="developer"><title>DocBook XSL Stylesheets Developer Reference</title>
32796 <para>This is technical reference documentation for
32797 developers using the DocBook XSL Stylesheets. It is not
32798 intended to be user documentation, but is instead
32799 provided for developers writing customization layers for
32800 the stylesheets.</para>
32804 <?dbhtml dir="lib"?>
32805 <?dbhtml filename="index.html"?>
32806 <title xml:base="../lib/lib.xml">XSL Library Template Reference</title>
32807 <partintro id="libintro">
32808 <title xml:base="../lib/lib.xml">Introduction</title>
32809 <para xml:base="../lib/lib.xml">This is technical reference documentation for the
32810 vocabulary-independent “library” templates in the DocBook XSL
32811 Stylesheets.</para>
32812 <para xml:base="../lib/lib.xml">This is not intended to be user documentation. It is
32813 provided for developers writing customization layers for the
32814 stylesheets.</para>
32817 <reference id="generallibrary" xml:base="../lib/lib.xml">
32818 <title>General Library Templates</title>
32820 <refentry id="dot.count">
32822 <refname>dot.count</refname>
32823 <refpurpose>Returns the number of <quote>.</quote> characters in a string</refpurpose>
32826 <refsect1><title>Description</title>
32828 <para>Given a string, the <function>dot.count</function>
32829 template returns the number of dot/period characters in the
32830 string. This template is useful, for example, when testing the
32831 nesting level of nested inline markup (for nested emphasis,
32832 quotations, etc.).</para>
32834 <programlisting id="dot.count.frag">
32835 <xsl:template name="dot.count">
32836 <!-- Returns the number of "." characters in a string -->
32837 <xsl:param name="string"></xsl:param>
32838 <xsl:param name="count" select="0"></xsl:param>
32840 <xsl:when test="contains($string, '.')">
32841 <xsl:call-template name="dot.count">
32842 <xsl:with-param name="string" select="substring-after($string, '.')"></xsl:with-param>
32843 <xsl:with-param name="count" select="$count+1"></xsl:with-param>
32844 </xsl:call-template>
32846 <xsl:otherwise>
32847 <xsl:value-of select="$count"></xsl:value-of>
32848 </xsl:otherwise>
32849 </xsl:choose>
32850 </xsl:template>
32858 <refentry id="copy-string">
32860 <refname>copy-string</refname>
32861 <refpurpose>Returns <quote>count</quote> copies of a string</refpurpose>
32864 <refsect1><title>Description</title>
32866 <para>Given a string, the <function>copy-string</function>
32867 template creates <replaceable>n</replaceable> copies of the
32868 string, when the value of <replaceable>n</replaceable> is
32869 given by the <parameter>count</parameter> parameter.</para>
32871 <programlisting id="copy-string.frag">
32872 <xsl:template name="copy-string">
32873 <!-- returns 'count' copies of 'string' -->
32874 <xsl:param name="string"></xsl:param>
32875 <xsl:param name="count" select="0"></xsl:param>
32876 <xsl:param name="result"></xsl:param>
32879 <xsl:when test="$count>0">
32880 <xsl:call-template name="copy-string">
32881 <xsl:with-param name="string" select="$string"></xsl:with-param>
32882 <xsl:with-param name="count" select="$count - 1"></xsl:with-param>
32883 <xsl:with-param name="result">
32884 <xsl:value-of select="$result"></xsl:value-of>
32885 <xsl:value-of select="$string"></xsl:value-of>
32886 </xsl:with-param>
32887 </xsl:call-template>
32889 <xsl:otherwise>
32890 <xsl:value-of select="$result"></xsl:value-of>
32891 </xsl:otherwise>
32892 </xsl:choose>
32893 </xsl:template>
32901 <refentry id="string.subst">
32903 <refname>string.subst</refname>
32904 <refpurpose>Substitute one text string for another in a string</refpurpose>
32907 <refsect1><title>Description</title>
32909 <para>The <function>string.subst</function> template replaces all
32910 occurances of <parameter>target</parameter> in <parameter>string</parameter>
32911 with <parameter>replacement</parameter> and returns the result.
32914 <programlisting id="string.subst.frag">
32915 <xsl:template name="string.subst">
32916 <xsl:param name="string"></xsl:param>
32917 <xsl:param name="target"></xsl:param>
32918 <xsl:param name="replacement"></xsl:param>
32921 <xsl:when test="contains($string, $target)">
32922 <xsl:variable name="rest">
32923 <xsl:call-template name="string.subst">
32924 <xsl:with-param name="string" select="substring-after($string, $target)"></xsl:with-param>
32925 <xsl:with-param name="target" select="$target"></xsl:with-param>
32926 <xsl:with-param name="replacement" select="$replacement"></xsl:with-param>
32927 </xsl:call-template>
32928 </xsl:variable>
32929 <xsl:value-of select="concat(substring-before($string, $target), $replacement, $rest)"></xsl:value-of>
32931 <xsl:otherwise>
32932 <xsl:value-of select="$string"></xsl:value-of>
32933 </xsl:otherwise>
32934 </xsl:choose>
32935 </xsl:template>
32943 <refentry id="xpointer.idref">
32945 <refname>xpointer.idref</refname>
32946 <refpurpose>Extract IDREF from an XPointer</refpurpose>
32949 <refsect1><title>Description</title>
32951 <para>The <function>xpointer.idref</function> template returns the
32952 ID portion of an XPointer which is a pointer to an ID within the current
32953 document, or the empty string if it is not.</para>
32954 <para>In other words, <function>xpointer.idref</function> returns
32955 <quote>foo</quote> when passed either <literal>#foo</literal>
32956 or <literal>#xpointer(id('foo'))</literal>, otherwise it returns
32957 the empty string.</para>
32959 <programlisting id="xpointer.idref.frag">
32960 <xsl:template name="xpointer.idref">
32961 <xsl:param name="xpointer">http://...</xsl:param>
32963 <xsl:when test="starts-with($xpointer, '#xpointer(id(')">
32964 <xsl:variable name="rest" select="substring-after($xpointer, '#xpointer(id(')"></xsl:variable>
32965 <xsl:variable name="quote" select="substring($rest, 1, 1)"></xsl:variable>
32966 <xsl:value-of select="substring-before(substring-after($xpointer, $quote), $quote)"></xsl:value-of>
32968 <xsl:when test="starts-with($xpointer, '#')">
32969 <xsl:value-of select="substring-after($xpointer, '#')"></xsl:value-of>
32971 <!-- otherwise it's a pointer to some other document -->
32972 </xsl:choose>
32973 </xsl:template>
32981 <refentry id="idref">
32983 <refname>idref</refname>
32984 <refpurpose>Extract IDREF from a linking element</refpurpose>
32987 <refsect1><title>Description</title>
32989 <para>The <function>idref</function> template accepts
32990 any <tag>xref</tag> or universally linking element as a parameter
32991 and returns the local
32992 ID that it points to.
32993 If it has a <tag class="attribute">linkend</tag> attribute,
32994 it returns that value.
32995 If it has a <tag class="attribute">xlink:href</tag>, it
32996 returns that value, parsed as needed to extract just
32997 the id reference. Otherwise it returns an empty string.</para>
32999 <programlisting id="idref.frag">
33000 <xsl:template name="idref">
33001 <xsl:param name="xref" select="."></xsl:param>
33002 <xsl:param name="linkend" select="$xref/@linkend"></xsl:param>
33003 <xsl:param name="xpointer">
33004 <xsl:call-template name="xpointer.idref">
33005 <xsl:with-param name="xpointer" select="$xref/@xlink:href"></xsl:with-param>
33006 </xsl:call-template>
33010 <xsl:when test="string-length($linkend) != 0">
33011 <xsl:value-of select="$linkend"></xsl:value-of>
33013 <xsl:when test="string-length($xpointer) != 0">
33014 <xsl:value-of select="$xpointer"></xsl:value-of>
33016 <!-- otherwise it's a pointer to some other document -->
33017 </xsl:choose>
33018 </xsl:template>
33027 <refentry id="length-magnitude">
33029 <refname>length-magnitude</refname>
33030 <refpurpose>Return the unqualified dimension from a length specification</refpurpose>
33033 <refsect1><title>Description</title>
33035 <para>The <function>length-magnitude</function> template returns the
33036 unqualified length ("20" for "20pt") from a dimension.
33039 <programlisting id="length-magnitude.frag">
33040 <xsl:template name="length-magnitude">
33041 <xsl:param name="length" select="'0pt'"></xsl:param>
33044 <xsl:when test="string-length($length) = 0"></xsl:when>
33045 <xsl:when test="substring($length,1,1) = '0' or substring($length,1,1) = '1' or substring($length,1,1) = '2' or substring($length,1,1) = '3' or substring($length,1,1) = '4' or substring($length,1,1) = '5' or substring($length,1,1) = '6' or substring($length,1,1) = '7' or substring($length,1,1) = '8' or substring($length,1,1) = '9' or substring($length,1,1) = '.'">
33046 <xsl:value-of select="substring($length,1,1)"></xsl:value-of>
33047 <xsl:call-template name="length-magnitude">
33048 <xsl:with-param name="length" select="substring($length,2)"></xsl:with-param>
33049 </xsl:call-template>
33051 </xsl:choose>
33052 </xsl:template>
33060 <refentry id="length-units">
33062 <refname>length-units</refname>
33063 <refpurpose>Return the units from a length specification</refpurpose>
33066 <refsect1><title>Description</title>
33068 <para>The <function>length-units</function> template returns the
33069 units ("pt" for "20pt") from a length. If no units are supplied on the
33070 length, the <parameter>defauilt.units</parameter> are returned.</para>
33072 <programlisting id="length-units.frag">
33073 <xsl:template name="length-units">
33074 <xsl:param name="length" select="'0pt'"></xsl:param>
33075 <xsl:param name="default.units" select="'px'"></xsl:param>
33076 <xsl:variable name="magnitude">
33077 <xsl:call-template name="length-magnitude">
33078 <xsl:with-param name="length" select="$length"></xsl:with-param>
33079 </xsl:call-template>
33080 </xsl:variable>
33082 <xsl:variable name="units">
33083 <xsl:value-of select="substring($length, string-length($magnitude)+1)"></xsl:value-of>
33084 </xsl:variable>
33087 <xsl:when test="$units = ''">
33088 <xsl:value-of select="$default.units"></xsl:value-of>
33090 <xsl:otherwise>
33091 <xsl:value-of select="$units"></xsl:value-of>
33092 </xsl:otherwise>
33093 </xsl:choose>
33094 </xsl:template>
33102 <refentry id="length-spec">
33104 <refname>length-spec</refname>
33105 <refpurpose>Return a fully qualified length specification</refpurpose>
33108 <refsect1><title>Description</title>
33110 <para>The <function>length-spec</function> template returns the
33111 qualified length from a dimension. If an unqualified length is given,
33112 the <parameter>default.units</parameter> will be added to it.
33115 <programlisting id="length-spec.frag">
33116 <xsl:template name="length-spec">
33117 <xsl:param name="length" select="'0pt'"></xsl:param>
33118 <xsl:param name="default.units" select="'px'"></xsl:param>
33120 <xsl:variable name="magnitude">
33121 <xsl:call-template name="length-magnitude">
33122 <xsl:with-param name="length" select="$length"></xsl:with-param>
33123 </xsl:call-template>
33124 </xsl:variable>
33126 <xsl:variable name="units">
33127 <xsl:value-of select="substring($length, string-length($magnitude)+1)"></xsl:value-of>
33128 </xsl:variable>
33130 <xsl:value-of select="$magnitude"></xsl:value-of>
33132 <xsl:when test="$units='cm' or $units='mm' or $units='in' or $units='pt' or $units='pc' or $units='px' or $units='em'">
33133 <xsl:value-of select="$units"></xsl:value-of>
33135 <xsl:when test="$units = ''">
33136 <xsl:value-of select="$default.units"></xsl:value-of>
33138 <xsl:otherwise>
33139 <xsl:message>
33140 <xsl:text>Unrecognized unit of measure: </xsl:text>
33141 <xsl:value-of select="$units"></xsl:value-of>
33142 <xsl:text>.</xsl:text>
33143 </xsl:message>
33144 </xsl:otherwise>
33145 </xsl:choose>
33146 </xsl:template>
33154 <refentry id="length-in-points">
33156 <refname>length-in-points</refname>
33157 <refpurpose>Returns the size, in points, of a specified length</refpurpose>
33160 <refsect1><title>Description</title>
33162 <para>The <function>length-in-points</function> template converts a length
33163 specification to points and returns that value as an unqualified
33168 <para>There is no way for the template to infer the size of an
33169 <literal>em</literal>. It relies on the default <parameter>em.size</parameter>
33170 which is initially <literal>10</literal> (for 10pt).</para>
33172 <para>Similarly, converting pixels to points relies on the
33173 <parameter>pixels.per.inch</parameter> parameter which is initially
33174 <literal>90</literal>.
33178 <programlisting id="length-in-points.frag">
33179 <xsl:template name="length-in-points">
33180 <xsl:param name="length" select="'0pt'"></xsl:param>
33181 <xsl:param name="em.size" select="10"></xsl:param>
33182 <xsl:param name="pixels.per.inch" select="90"></xsl:param>
33184 <xsl:variable name="magnitude">
33185 <xsl:call-template name="length-magnitude">
33186 <xsl:with-param name="length" select="$length"></xsl:with-param>
33187 </xsl:call-template>
33188 </xsl:variable>
33190 <xsl:variable name="units">
33191 <xsl:value-of select="substring($length, string-length($magnitude)+1)"></xsl:value-of>
33192 </xsl:variable>
33195 <xsl:when test="$units = 'pt'">
33196 <xsl:value-of select="$magnitude"></xsl:value-of>
33198 <xsl:when test="$units = 'cm'">
33199 <xsl:value-of select="$magnitude div 2.54 * 72.0"></xsl:value-of>
33201 <xsl:when test="$units = 'mm'">
33202 <xsl:value-of select="$magnitude div 25.4 * 72.0"></xsl:value-of>
33204 <xsl:when test="$units = 'in'">
33205 <xsl:value-of select="$magnitude * 72.0"></xsl:value-of>
33207 <xsl:when test="$units = 'pc'">
33208 <xsl:value-of select="$magnitude * 12.0"></xsl:value-of>
33210 <xsl:when test="$units = 'px'">
33211 <xsl:value-of select="$magnitude div $pixels.per.inch * 72.0"></xsl:value-of>
33213 <xsl:when test="$units = 'em'">
33214 <xsl:value-of select="$magnitude * $em.size"></xsl:value-of>
33216 <xsl:otherwise>
33217 <xsl:message>
33218 <xsl:text>Unrecognized unit of measure: </xsl:text>
33219 <xsl:value-of select="$units"></xsl:value-of>
33220 <xsl:text>.</xsl:text>
33221 </xsl:message>
33222 </xsl:otherwise>
33223 </xsl:choose>
33224 </xsl:template>
33232 <refentry id="pi-attribute">
33234 <refname>pi-attribute</refname>
33235 <refpurpose>Extract a pseudo-attribute from a PI</refpurpose>
33238 <refsect1><title>Description</title>
33240 <para>The <function>pi-attribute</function> template extracts a pseudo-attribute
33241 from a processing instruction. For example, given the PI
33242 <quote><literal><?foo bar="1" baz='red'?></literal></quote>,</para>
33243 <programlisting><xsl:call-template name="pi-attribute">
33244 <xsl:with-param name="pis" select="processing-instruction('foo')"/>
33245 <xsl:with-param name="attribute" select="'baz'"/>
33246 </xsl:call-template></programlisting>
33247 <para>will return <quote>red</quote>. This template returns the first matching
33248 attribute that it finds. Presented with processing instructions that
33249 contain badly formed pseudo-attributes (missing or unbalanced quotes,
33250 for example), the template may silently return erroneous results.</para>
33252 <programlisting id="pi-attribute.frag">
33253 <xsl:template name="pi-attribute">
33254 <xsl:param name="pis" select="processing-instruction('BOGUS_PI')"></xsl:param>
33255 <xsl:param name="attribute">filename</xsl:param>
33256 <xsl:param name="count">1</xsl:param>
33259 <xsl:when test="$count>count($pis)">
33260 <!-- not found -->
33262 <xsl:otherwise>
33263 <xsl:variable name="pi">
33264 <xsl:value-of select="$pis[$count]"></xsl:value-of>
33265 </xsl:variable>
33266 <xsl:variable name="pivalue">
33267 <xsl:value-of select="concat(' ', normalize-space($pi))"></xsl:value-of>
33268 </xsl:variable>
33270 <xsl:when test="contains($pivalue,concat(' ', $attribute, '='))">
33271 <xsl:variable name="rest" select="substring-after($pivalue,concat(' ', $attribute,'='))"></xsl:variable>
33272 <xsl:variable name="quote" select="substring($rest,1,1)"></xsl:variable>
33273 <xsl:value-of select="substring-before(substring($rest,2),$quote)"></xsl:value-of>
33275 <xsl:otherwise>
33276 <xsl:call-template name="pi-attribute">
33277 <xsl:with-param name="pis" select="$pis"></xsl:with-param>
33278 <xsl:with-param name="attribute" select="$attribute"></xsl:with-param>
33279 <xsl:with-param name="count" select="$count + 1"></xsl:with-param>
33280 </xsl:call-template>
33281 </xsl:otherwise>
33282 </xsl:choose>
33283 </xsl:otherwise>
33284 </xsl:choose>
33285 </xsl:template>
33293 <refentry id="lookup.key">
33295 <refname>lookup.key</refname>
33296 <refpurpose>Retrieve the value associated with a particular key in a table</refpurpose>
33299 <refsect1><title>Description</title>
33301 <para>Given a table of space-delimited key/value pairs,
33302 the <function>lookup.key</function> template extracts the value associated
33303 with a particular key.</para>
33305 <programlisting id="lookup.key.frag">
33306 <xsl:template name="lookup.key">
33307 <xsl:param name="key" select="''"></xsl:param>
33308 <xsl:param name="table" select="''"></xsl:param>
33310 <xsl:if test="contains($table, ' ')">
33312 <xsl:when test="substring-before($table, ' ') = $key">
33313 <xsl:variable name="rest" select="substring-after($table, ' ')"></xsl:variable>
33315 <xsl:when test="contains($rest, ' ')">
33316 <xsl:value-of select="substring-before($rest, ' ')"></xsl:value-of>
33318 <xsl:otherwise>
33319 <xsl:value-of select="$rest"></xsl:value-of>
33320 </xsl:otherwise>
33321 </xsl:choose>
33323 <xsl:otherwise>
33324 <xsl:call-template name="lookup.key">
33325 <xsl:with-param name="key" select="$key"></xsl:with-param>
33326 <xsl:with-param name="table" select="substring-after(substring-after($table,' '), ' ')"></xsl:with-param>
33327 </xsl:call-template>
33328 </xsl:otherwise>
33329 </xsl:choose>
33331 </xsl:template>
33339 <refentry id="xpath.location">
33341 <refname>xpath.location</refname>
33342 <refpurpose>Calculate the XPath child-sequence to the current node</refpurpose>
33345 <refsect1><title>Description</title>
33347 <para>The <function>xpath.location</function> template calculates the
33348 absolute path from the root of the tree to the current element node.
33351 <programlisting id="xpath.location.frag">
33352 <xsl:template name="xpath.location">
33353 <xsl:param name="node" select="."></xsl:param>
33354 <xsl:param name="path" select="''"></xsl:param>
33356 <xsl:variable name="next.path">
33357 <xsl:value-of select="local-name($node)"></xsl:value-of>
33358 <xsl:if test="$path != ''">/</xsl:if>
33359 <xsl:value-of select="$path"></xsl:value-of>
33360 </xsl:variable>
33363 <xsl:when test="$node/parent::*">
33364 <xsl:call-template name="xpath.location">
33365 <xsl:with-param name="node" select="$node/parent::*"></xsl:with-param>
33366 <xsl:with-param name="path" select="$next.path"></xsl:with-param>
33367 </xsl:call-template>
33369 <xsl:otherwise>
33370 <xsl:text>/</xsl:text>
33371 <xsl:value-of select="$next.path"></xsl:value-of>
33372 </xsl:otherwise>
33373 </xsl:choose>
33374 </xsl:template>
33382 <refentry id="comment-escape-string">
33384 <refname>comment-escape-string</refname>
33385 <refpurpose>Prepare a string for inclusion in an XML comment</refpurpose>
33388 <refsect1><title>Description</title>
33390 <para>The <function>comment-escape-string</function> template returns a string
33391 that has been transformed so that it can safely be output as an XML comment.
33392 Internal occurrences of "--" will be replaced with "- -" and a leading and/or
33393 trailing space will be added to the string, if necessary.</para>
33395 <programlisting id="comment-escape-string.frag">
33396 <xsl:template name="comment-escape-string">
33397 <xsl:param name="string" select="''"></xsl:param>
33399 <xsl:if test="starts-with($string, '-')">
33400 <xsl:text> </xsl:text>
33403 <xsl:call-template name="comment-escape-string.recursive">
33404 <xsl:with-param name="string" select="$string"></xsl:with-param>
33405 </xsl:call-template>
33407 <xsl:if test="substring($string, string-length($string), 1) = '-'">
33408 <xsl:text> </xsl:text>
33410 </xsl:template>
33418 <refentry id="comment-escape-string.recursive">
33420 <refname>comment-escape-string.recursive</refname>
33421 <refpurpose>Internal function used by comment-escape-string</refpurpose>
33424 <refsect1><title>Description</title>
33426 <para>The <function>comment-escape-string.recursive</function> template is used
33427 by <function>comment-escape-string</function>.</para>
33429 <programlisting id="comment-escape-string.recursive.frag">
33430 <xsl:template name="comment-escape-string.recursive">
33431 <xsl:param name="string" select="''"></xsl:param>
33433 <xsl:when test="contains($string, '--')">
33434 <xsl:value-of select="substring-before($string, '--')"></xsl:value-of>
33435 <xsl:value-of select="'- -'"></xsl:value-of>
33436 <xsl:call-template name="comment-escape-string.recursive">
33437 <xsl:with-param name="string" select="substring-after($string, '--')"></xsl:with-param>
33438 </xsl:call-template>
33440 <xsl:otherwise>
33441 <xsl:value-of select="$string"></xsl:value-of>
33442 </xsl:otherwise>
33443 </xsl:choose>
33444 </xsl:template>
33451 <refentry id="trim.text">
33453 <refname>trim.text</refname>
33454 <refpurpose>Trim leading and trailing whitespace from a text node</refpurpose>
33457 <refsect1><title>Description</title>
33459 <para>Given a text node, this function trims leading and trailing
33460 whitespace from it and returns the trimmed contents.</para>
33462 <programlisting id="trim.text.frag">
33464 <xsl:template name="trim.text">
33465 <xsl:param name="contents" select="."></xsl:param>
33466 <xsl:variable name="contents-left-trimmed">
33467 <xsl:call-template name="trim-left">
33468 <xsl:with-param name="contents" select="$contents"></xsl:with-param>
33469 </xsl:call-template>
33470 </xsl:variable>
33471 <xsl:variable name="contents-trimmed">
33472 <xsl:call-template name="trim-right">
33473 <xsl:with-param name="contents" select="$contents-left-trimmed"></xsl:with-param>
33474 </xsl:call-template>
33475 </xsl:variable>
33476 <xsl:value-of select="$contents-trimmed"></xsl:value-of>
33477 </xsl:template>
33479 <xsl:template name="trim-left">
33480 <xsl:param name="contents"></xsl:param>
33482 <xsl:when test="starts-with($contents,'
33483 ') or starts-with($contents,'
') or starts-with($contents,' ') or starts-with($contents,' ')">
33484 <xsl:call-template name="trim-left">
33485 <xsl:with-param name="contents" select="substring($contents, 2)"></xsl:with-param>
33486 </xsl:call-template>
33488 <xsl:otherwise>
33489 <xsl:value-of select="$contents"></xsl:value-of>
33490 </xsl:otherwise>
33491 </xsl:choose>
33492 </xsl:template>
33494 <xsl:template name="trim-right">
33495 <xsl:param name="contents"></xsl:param>
33496 <xsl:variable name="last-char">
33497 <xsl:value-of select="substring($contents, string-length($contents), 1)"></xsl:value-of>
33498 </xsl:variable>
33500 <xsl:when test="($last-char = '
33501 ') or ($last-char = '
') or ($last-char = ' ') or ($last-char = ' ')">
33502 <xsl:call-template name="trim-right">
33503 <xsl:with-param name="contents" select="substring($contents, 1, string-length($contents) - 1)"></xsl:with-param>
33504 </xsl:call-template>
33506 <xsl:otherwise>
33507 <xsl:value-of select="$contents"></xsl:value-of>
33508 </xsl:otherwise>
33509 </xsl:choose>
33510 </xsl:template>
33518 <refentry id="str.tokenize.keep.delimiters">
33520 <refname>str.tokenize.keep.delimiters</refname>
33521 <refpurpose>Tokenize a string while preserving any delimiters</refpurpose>
33523 <refsect1><title>Description</title>
33524 <para>Based on the occurrence of one or more delimiter characters,
33525 this function breaks a string into a list of tokens and delimiters,
33526 marking up each of the tokens with a <tag>token</tag> element
33527 and preserving the delimiters as text nodes between the tokens.</para>
33529 <para>This function is a very slightly modified version of a
33530 function from the <link xlink:href="http://www.exslt.org/">EXSLT
33531 site</link>. The original is available at:
33533 <blockquote><para><link xlink:href="http://www.exslt.org/str/functions/tokenize/str.tokenize.template.xsl"/></para></blockquote>
33535 The <function>str.tokenize.keep.delimiters</function> function
33536 differs only in that it preserves the delimiters instead of
33537 discarding them.</para>
33539 <programlisting id="str.tokenize.keep.delimiters.frag">
33540 <xsl:template name="str.tokenize.keep.delimiters">
33541 <xsl:param name="string" select="''"></xsl:param>
33542 <xsl:param name="delimiters" select="' '"></xsl:param>
33544 <xsl:when test="not($string)"></xsl:when>
33545 <xsl:when test="not($delimiters)">
33546 <xsl:call-template name="str.tokenize.keep.delimiters-characters">
33547 <xsl:with-param name="string" select="$string"></xsl:with-param>
33548 </xsl:call-template>
33550 <xsl:otherwise>
33551 <xsl:call-template name="str.tokenize.keep.delimiters-delimiters">
33552 <xsl:with-param name="string" select="$string"></xsl:with-param>
33553 <xsl:with-param name="delimiters" select="$delimiters"></xsl:with-param>
33554 </xsl:call-template>
33555 </xsl:otherwise>
33556 </xsl:choose>
33557 </xsl:template>
33558 <xsl:template name="str.tokenize.keep.delimiters-characters">
33559 <xsl:param name="string"></xsl:param>
33560 <xsl:if test="$string">
33561 <ssb:token><xsl:value-of select="substring($string, 1, 1)"></xsl:value-of></ssb:token>
33562 <xsl:call-template name="str.tokenize.keep.delimiters-characters">
33563 <xsl:with-param name="string" select="substring($string, 2)"></xsl:with-param>
33564 </xsl:call-template>
33566 </xsl:template>
33567 <xsl:template name="str.tokenize.keep.delimiters-delimiters">
33568 <xsl:param name="string"></xsl:param>
33569 <xsl:param name="delimiters"></xsl:param>
33570 <xsl:variable name="delimiter" select="substring($delimiters, 1, 1)"></xsl:variable>
33572 <xsl:when test="not($delimiter)">
33573 <ssb:token><xsl:value-of select="$string"></xsl:value-of></ssb:token>
33575 <xsl:when test="contains($string, $delimiter)">
33576 <xsl:if test="not(starts-with($string, $delimiter))">
33577 <xsl:call-template name="str.tokenize.keep.delimiters-delimiters">
33578 <xsl:with-param name="string" select="substring-before($string, $delimiter)"></xsl:with-param>
33579 <xsl:with-param name="delimiters" select="substring($delimiters, 2)"></xsl:with-param>
33580 </xsl:call-template>
33582 <!-- output each delimiter -->
33583 <xsl:value-of select="$delimiter"></xsl:value-of>
33584 <xsl:call-template name="str.tokenize.keep.delimiters-delimiters">
33585 <xsl:with-param name="string" select="substring-after($string, $delimiter)"></xsl:with-param>
33586 <xsl:with-param name="delimiters" select="$delimiters"></xsl:with-param>
33587 </xsl:call-template>
33589 <xsl:otherwise>
33590 <xsl:call-template name="str.tokenize.keep.delimiters-delimiters">
33591 <xsl:with-param name="string" select="$string"></xsl:with-param>
33592 <xsl:with-param name="delimiters" select="substring($delimiters, 2)"></xsl:with-param>
33593 </xsl:call-template>
33594 </xsl:otherwise>
33595 </xsl:choose>
33596 </xsl:template>
33603 <refentry id="apply-string-subst-map">
33605 <refname>apply-string-subst-map</refname>
33606 <refpurpose>Apply a string-substitution map</refpurpose>
33608 <refsect1><title>Description</title>
33609 <para>This function applies a “string substitution” map. Use it when
33610 you want to do multiple string substitutions on the same target
33611 content. It reads in two things: <parameter>content</parameter>, the
33612 content on which to perform the substitution, and
33613 <parameter>map.contents</parameter>, a node set of
33614 elements (the names of the elements don't matter), with each element
33615 having the following attributes:
33618 <simpara><tag class="attribute">oldstring</tag>, a string to
33619 be replaced</simpara>
33622 <simpara><tag class="attribute">newstring</tag>, a string with
33623 which to replace <tag class="attribute">oldstring</tag></simpara>
33626 The function uses <parameter>map.contents</parameter> to
33627 do substitution on <parameter>content</parameter>, and then
33628 returns the modified contents.</para>
33630 <para>This function is a very slightly modified version of Jeni
33631 Tennison’s <function>replace_strings</function> function in the
33632 <link xlink:href="http://www.dpawson.co.uk/xsl/sect2/StringReplace.html#d9351e13">multiple string replacements</link> section of Dave Pawson’s
33633 <link xlink:href="http://www.dpawson.co.uk/xsl/index.html">XSLT
33635 <para>The <function>apply-string-subst-map</function> function is
33636 essentially the same function as the
33637 <function>apply-character-map</function> function; the only
33638 difference is that in the map that
33639 <function>apply-string-subst-map</function> expects, <tag class="attribute">oldstring</tag> and <tag class="attribute">newstring</tag> attributes are used instead of
33640 <tag class="attribute">character</tag> and <tag class="attribute">string</tag> attributes.</para>
33642 <programlisting id="apply-string-subst-map.frag">
33643 <xsl:template name="apply-string-subst-map">
33644 <xsl:param name="content"></xsl:param>
33645 <xsl:param name="map.contents"></xsl:param>
33646 <xsl:variable name="replaced_text">
33647 <xsl:call-template name="string.subst">
33648 <xsl:with-param name="string" select="$content"></xsl:with-param>
33649 <xsl:with-param name="target" select="$map.contents[1]/@oldstring"></xsl:with-param>
33650 <xsl:with-param name="replacement" select="$map.contents[1]/@newstring"></xsl:with-param>
33651 </xsl:call-template>
33652 </xsl:variable>
33654 <xsl:when test="$map.contents[2]">
33655 <xsl:call-template name="apply-string-subst-map">
33656 <xsl:with-param name="content" select="$replaced_text"></xsl:with-param>
33657 <xsl:with-param name="map.contents" select="$map.contents[position() > 1]"></xsl:with-param>
33658 </xsl:call-template>
33660 <xsl:otherwise>
33661 <xsl:value-of select="$replaced_text"></xsl:value-of>
33662 </xsl:otherwise>
33663 </xsl:choose>
33664 </xsl:template>
33668 </reference><reference id="relativeuri" xml:base="../lib/lib.xml">
33669 <title>Relative URI Functions</title>
33671 <partintro id="partintro"><title>Introduction</title>
33673 <para>These functions manipulate relative URI references.</para>
33675 <para>The following assumptions must hold true:</para>
33679 <para>All URIs are relative.</para>
33682 <para>No URI contains the <quote><literal>../</literal></quote> sequence
33683 which would effectively move <quote>up</quote> the hierarchy.</para>
33687 <para>If these assumptions do not hold, the results are unpredictable.</para>
33693 <refentry id="count.uri.path.depth">
33695 <refname>count.uri.path.depth</refname>
33696 <refpurpose>Count the number of path components in a relative URI</refpurpose>
33699 <refsect1><title>Description</title>
33701 <para>This function counts the number of path components in a relative URI.</para>
33703 <programlisting id="count.uri.path.depth.frag">
33704 <xsl:template name="count.uri.path.depth">
33705 <xsl:param name="filename" select="''"></xsl:param>
33706 <xsl:param name="count" select="0"></xsl:param>
33709 <xsl:when test="contains($filename, '/')">
33710 <xsl:call-template name="count.uri.path.depth">
33711 <xsl:with-param name="filename" select="substring-after($filename, '/')"></xsl:with-param>
33712 <xsl:with-param name="count" select="$count + 1"></xsl:with-param>
33713 </xsl:call-template>
33715 <xsl:otherwise>
33716 <xsl:value-of select="$count"></xsl:value-of>
33717 </xsl:otherwise>
33718 </xsl:choose>
33719 </xsl:template>
33727 <refentry id="trim.common.uri.paths">
33729 <refname>trim.common.uri.paths</refname>
33730 <refpurpose>Trim common leading path components from a relative URI</refpurpose>
33733 <refsect1><title>Description</title>
33735 <para>This function trims common leading path components from a relative URI.</para>
33737 <programlisting id="trim.common.uri.paths.frag">
33738 <xsl:template name="trim.common.uri.paths">
33739 <xsl:param name="uriA" select="''"></xsl:param>
33740 <xsl:param name="uriB" select="''"></xsl:param>
33741 <xsl:param name="return" select="'A'"></xsl:param>
33743 <!-- Resolve any ../ in the path -->
33744 <xsl:variable name="trimmed.uriA">
33745 <xsl:call-template name="resolve.path">
33746 <xsl:with-param name="filename" select="$uriA"></xsl:with-param>
33747 </xsl:call-template>
33748 </xsl:variable>
33750 <xsl:variable name="trimmed.uriB">
33751 <xsl:call-template name="resolve.path">
33752 <xsl:with-param name="filename" select="$uriB"></xsl:with-param>
33753 </xsl:call-template>
33754 </xsl:variable>
33757 <xsl:when test="contains($trimmed.uriA, '/') and contains($trimmed.uriB, '/') and substring-before($trimmed.uriA, '/') = substring-before($trimmed.uriB, '/')">
33758 <xsl:call-template name="trim.common.uri.paths">
33759 <xsl:with-param name="uriA" select="substring-after($trimmed.uriA, '/')"></xsl:with-param>
33760 <xsl:with-param name="uriB" select="substring-after($trimmed.uriB, '/')"></xsl:with-param>
33761 <xsl:with-param name="return" select="$return"></xsl:with-param>
33762 </xsl:call-template>
33764 <xsl:otherwise>
33766 <xsl:when test="$return = 'A'">
33767 <xsl:value-of select="$trimmed.uriA"></xsl:value-of>
33769 <xsl:otherwise>
33770 <xsl:value-of select="$trimmed.uriB"></xsl:value-of>
33771 </xsl:otherwise>
33772 </xsl:choose>
33773 </xsl:otherwise>
33774 </xsl:choose>
33775 </xsl:template>
33781 <refentry id="resolve.path">
33783 <refname>resolve.path</refname>
33784 <refpurpose>Resolve any ../ in path, except leading ../</refpurpose>
33787 <refsect1><title>Description</title>
33789 <para>This function resolves any relative ../ parts of a file path.</para>
33791 <programlisting id="resolve.path.frag">
33792 <xsl:template name="resolve.path">
33793 <xsl:param name="filename" select="''"></xsl:param>
33795 <!-- Leading .. are not eliminated -->
33796 <xsl:when test="starts-with($filename, '../')">
33797 <xsl:value-of select="'../'"></xsl:value-of>
33798 <xsl:call-template name="resolve.path">
33799 <xsl:with-param name="filename" select="substring-after($filename, '../')"></xsl:with-param>
33800 </xsl:call-template>
33802 <xsl:when test="contains($filename, '/../')">
33803 <xsl:call-template name="resolve.path">
33804 <xsl:with-param name="filename">
33805 <xsl:call-template name="dirname">
33806 <xsl:with-param name="filename" select="substring-before($filename, '/../')"></xsl:with-param>
33807 </xsl:call-template>
33808 <xsl:value-of select="substring-after($filename, '/../')"></xsl:value-of>
33809 </xsl:with-param>
33810 </xsl:call-template>
33812 <xsl:otherwise>
33813 <xsl:value-of select="$filename"></xsl:value-of>
33814 </xsl:otherwise>
33815 </xsl:choose>
33816 </xsl:template>
33822 <refentry id="dirname">
33824 <refname>dirname</refname>
33825 <refpurpose>Return directory part of a path</refpurpose>
33828 <refsect1><title>Description</title>
33830 <para>This function returns the directory part of a path.</para>
33832 <programlisting id="dirname.frag">
33834 <xsl:template name="dirname">
33835 <xsl:param name="filename" select="''"></xsl:param>
33836 <xsl:if test="contains($filename, '/')">
33837 <xsl:value-of select="substring-before($filename, '/')"></xsl:value-of>
33838 <xsl:text>/</xsl:text>
33839 <xsl:call-template name="dirname">
33840 <xsl:with-param name="filename" select="substring-after($filename, '/')"></xsl:with-param>
33841 </xsl:call-template>
33843 </xsl:template>
33852 <part id="common-part"><title>Common Template Reference</title>
33853 <?dbhtml dir="common"?>
33854 <?dbhtml filename="index.html"?>
33857 <para>This is technical reference documentation for the
33858 “base”, “refentry”, and “utility” sets of common
33859 templates in the DocBook XSL Stylesheets. These
33860 templates are “common” in that they are shared across
33861 output formats (that is, they’re not
33862 output-format-dependent)</para>
33863 <para>This documentation is not intended to be user
33864 documentation. It is provided for developers writing
33865 customization layers for the stylesheets.</para>
33868 <reference id="base" xml:base="../common/common.xml">
33870 <title>Common » Base Template Reference</title>
33871 <releaseinfo role="meta">
33875 <partintro id="partintro">
33876 <title>Introduction</title>
33878 <para>This is technical reference documentation for the “base”
33879 set of common templates in the DocBook XSL Stylesheets.</para>
33882 <para>This is not intended to be user documentation. It is
33883 provided for developers writing customization layers for the
33884 stylesheets.</para>
33888 <refentry id="template.is.component">
33890 <refname>is.component</refname>
33891 <refpurpose>Tests if a given node is a component-level element</refpurpose>
33894 <synopsis><xsl:template name="is.component">
33895 <xsl:param name="node" select="."/>
33897 </xsl:template></synopsis>
33899 <refsect1><title>Description</title>
33901 <para>This template returns '1' if the specified node is a component
33902 (Chapter, Appendix, etc.), and '0' otherwise.</para>
33904 </refsect1><refsect1><title>Parameters</title>
33907 <varlistentry><term>node</term>
33910 <para>The node which is to be tested.</para>
33916 </refsect1><refsect1><title>Returns</title>
33918 <para>This template returns '1' if the specified node is a component
33919 (Chapter, Appendix, etc.), and '0' otherwise.</para>
33921 </refsect1></refentry>
33923 <refentry id="template.is.section">
33925 <refname>is.section</refname>
33926 <refpurpose>Tests if a given node is a section-level element</refpurpose>
33929 <synopsis><xsl:template name="is.section">
33930 <xsl:param name="node" select="."/>
33932 </xsl:template></synopsis>
33934 <refsect1><title>Description</title>
33936 <para>This template returns '1' if the specified node is a section
33937 (Section, Sect1, Sect2, etc.), and '0' otherwise.</para>
33939 </refsect1><refsect1><title>Parameters</title>
33942 <varlistentry><term>node</term>
33945 <para>The node which is to be tested.</para>
33951 </refsect1><refsect1><title>Returns</title>
33953 <para>This template returns '1' if the specified node is a section
33954 (Section, Sect1, Sect2, etc.), and '0' otherwise.</para>
33956 </refsect1></refentry>
33958 <refentry id="template.section.level">
33960 <refname>section.level</refname>
33961 <refpurpose>Returns the hierarchical level of a section</refpurpose>
33964 <synopsis><xsl:template name="section.level">
33965 <xsl:param name="node" select="."/>
33967 </xsl:template></synopsis>
33969 <refsect1><title>Description</title>
33971 <para>This template calculates the hierarchical level of a section.
33972 The element <tag>sect1</tag> is at level 1, <tag>sect2</tag> is
33973 at level 2, etc.</para>
33977 <para>Recursive sections are calculated down to the fifth level.</para>
33979 </refsect1><refsect1><title>Parameters</title>
33982 <varlistentry><term>node</term>
33985 <para>The section node for which the level should be calculated.
33986 Defaults to the context node.</para>
33992 </refsect1><refsect1><title>Returns</title>
33994 <para>The section level, <quote>1</quote>, <quote>2</quote>, etc.
33997 </refsect1></refentry>
33999 <refentry id="template.qanda.section.level">
34001 <refname>qanda.section.level</refname>
34002 <refpurpose>Returns the hierarchical level of a QandASet</refpurpose>
34005 <synopsis><xsl:template name="qanda.section.level"/></synopsis>
34007 <refsect1><title>Description</title>
34009 <para>This template calculates the hierarchical level of a QandASet.
34012 </refsect1><refsect1><title>Returns</title>
34014 <para>The level, <quote>1</quote>, <quote>2</quote>, etc.
34017 </refsect1></refentry>
34019 <refentry id="template.select.mediaobject">
34021 <refname>select.mediaobject</refname>
34022 <refpurpose>Selects and processes an appropriate media object from a list</refpurpose>
34025 <synopsis><xsl:template name="select.mediaobject">
34026 <xsl:param name="olist" select="d:imageobject|d:imageobjectco |d:videoobject|d:audioobject|d:textobject"/>
34028 </xsl:template></synopsis>
34030 <refsect1><title>Description</title>
34032 <para>This template takes a list of media objects (usually the
34033 children of a mediaobject or inlinemediaobject) and processes
34034 the "right" object.</para>
34038 <para>This template relies on a template named
34039 "select.mediaobject.index" to determine which object
34040 in the list is appropriate.</para>
34044 <para>If no acceptable object is located, nothing happens.</para>
34046 </refsect1><refsect1><title>Parameters</title>
34049 <varlistentry><term>olist</term>
34052 <para>The node list of potential objects to examine.</para>
34058 </refsect1><refsect1><title>Returns</title>
34060 <para>Calls <xsl:apply-templates> on the selected object.</para>
34062 </refsect1></refentry>
34064 <refentry id="template.select.mediaobject.index">
34066 <refname>select.mediaobject.index</refname>
34067 <refpurpose>Selects the position of the appropriate media object from a list</refpurpose>
34070 <synopsis><xsl:template name="select.mediaobject.index">
34071 <xsl:param name="olist" select="d:imageobject|d:imageobjectco |d:videoobject|d:audioobject|d:textobject"/>
34072 <xsl:param name="count">1</xsl:param>
34074 </xsl:template></synopsis>
34076 <refsect1><title>Description</title>
34078 <para>This template takes a list of media objects (usually the
34079 children of a mediaobject or inlinemediaobject) and determines
34080 the "right" object. It returns the position of that object
34081 to be used by the calling template.</para>
34085 <para>If the parameter <parameter>use.role.for.mediaobject</parameter>
34086 is nonzero, then it first checks for an object with
34087 a role attribute of the appropriate value. It takes the first
34088 of those. Otherwise, it takes the first acceptable object
34089 through a recursive pass through the list.</para>
34093 <para>This template relies on a template named "is.acceptable.mediaobject"
34094 to determine if a given object is an acceptable graphic. The semantics
34095 of media objects is that the first acceptable graphic should be used.
34100 <para>If no acceptable object is located, no index is returned.</para>
34102 </refsect1><refsect1><title>Parameters</title>
34105 <varlistentry><term>olist</term>
34108 <para>The node list of potential objects to examine.</para>
34112 <varlistentry><term>count</term>
34115 <para>The position in the list currently being considered by the
34116 recursive process.</para>
34122 </refsect1><refsect1><title>Returns</title>
34124 <para>Returns the position in the original list of the selected object.</para>
34126 </refsect1></refentry>
34128 <refentry id="template.is.acceptable.mediaobject">
34130 <refname>is.acceptable.mediaobject</refname>
34131 <refpurpose>Returns '1' if the specified media object is recognized</refpurpose>
34134 <synopsis><xsl:template name="is.acceptable.mediaobject">
34135 <xsl:param name="object"/>
34137 </xsl:template></synopsis>
34139 <refsect1><title>Description</title>
34141 <para>This template examines a media object and returns '1' if the
34142 object is recognized as a graphic.</para>
34144 </refsect1><refsect1><title>Parameters</title>
34147 <varlistentry><term>object</term>
34150 <para>The media object to consider.</para>
34156 </refsect1><refsect1><title>Returns</title>
34158 <para>0 or 1</para>
34160 </refsect1></refentry>
34162 <refentry id="template.check.id.unique">
34164 <refname>check.id.unique</refname>
34165 <refpurpose>Warn users about references to non-unique IDs</refpurpose>
34168 <synopsis><xsl:template name="check.id.unique">
34169 <xsl:param name="linkend"/>
34171 </xsl:template></synopsis>
34173 <refsect1><title>Description</title>
34175 <para>If passed an ID in <varname>linkend</varname>,
34176 <function>check.id.unique</function> prints
34177 a warning message to the user if either the ID does not exist or
34178 the ID is not unique.</para>
34180 </refsect1></refentry>
34182 <refentry id="template.check.idref.targets">
34184 <refname>check.idref.targets</refname>
34185 <refpurpose>Warn users about incorrectly typed references</refpurpose>
34188 <synopsis><xsl:template name="check.idref.targets">
34189 <xsl:param name="linkend"/>
34190 <xsl:param name="element-list"/>
34192 </xsl:template></synopsis>
34194 <refsect1><title>Description</title>
34196 <para>If passed an ID in <varname>linkend</varname>,
34197 <function>check.idref.targets</function> makes sure that the element
34198 pointed to by the link is one of the elements listed in
34199 <varname>element-list</varname> and warns the user otherwise.</para>
34201 </refsect1></refentry>
34203 <refentry id="template.copyright.years">
34205 <refname>copyright.years</refname>
34206 <refpurpose>Print a set of years with collapsed ranges</refpurpose>
34209 <synopsis><xsl:template name="copyright.years">
34210 <xsl:param name="years"/>
34211 <xsl:param name="print.ranges" select="1"/>
34212 <xsl:param name="single.year.ranges" select="0"/>
34213 <xsl:param name="firstyear" select="0"/>
34214 <xsl:param name="nextyear" select="0"/>
34216 </xsl:template></synopsis>
34218 <refsect1><title>Description</title>
34220 <para>This template prints a list of year elements with consecutive
34221 years printed as a range. In other words:</para>
34224 <screen><year>1992</year>
34225 <year>1993</year>
34226 <year>1994</year></screen>
34229 <para>is printed <quote>1992-1994</quote>, whereas:</para>
34232 <screen><year>1992</year>
34233 <year>1994</year></screen>
34236 <para>is printed <quote>1992, 1994</quote>.</para>
34240 <para>This template assumes that all the year elements contain only
34241 decimal year numbers, that the elements are sorted in increasing
34242 numerical order, that there are no duplicates, and that all the years
34243 are expressed in full <quote>century+year</quote>
34244 (<quote>1999</quote> not <quote>99</quote>) notation.</para>
34246 </refsect1><refsect1><title>Parameters</title>
34249 <varlistentry><term>years</term>
34252 <para>The initial set of year elements.</para>
34256 <varlistentry><term>print.ranges</term>
34259 <para>If non-zero, multi-year ranges are collapsed. If zero, all years
34260 are printed discretely.</para>
34264 <varlistentry><term>single.year.ranges</term>
34267 <para>If non-zero, two consecutive years will be printed as a range,
34268 otherwise, they will be printed discretely. In other words, a single
34269 year range is <quote>1991-1992</quote> but discretely it's
34270 <quote>1991, 1992</quote>.</para>
34276 </refsect1><refsect1><title>Returns</title>
34278 <para>This template returns the formatted list of years.</para>
34280 </refsect1></refentry>
34282 <refentry id="template.find.path.params">
34284 <refname>find.path.params</refname>
34285 <refpurpose>Search in a table for the "best" match for the node</refpurpose>
34288 <synopsis><xsl:template name="find.path.params">
34289 <xsl:param name="node" select="."/>
34290 <xsl:param name="table" select="''"/>
34291 <xsl:param name="location">
34292 <xsl:call-template name="xpath.location">
34293 <xsl:with-param name="node" select="$node"/>
34294 </xsl:call-template>
34297 </xsl:template></synopsis>
34299 <refsect1><title>Description</title>
34301 <para>This template searches in a table for the value that most-closely
34302 (in the typical best-match sense of XSLT) matches the current (element)
34303 node location.</para>
34305 </refsect1></refentry>
34307 <refentry id="template.string.upper">
34309 <refname>string.upper</refname>
34310 <refpurpose>Converts a string to all uppercase letters</refpurpose>
34313 <synopsis><xsl:template name="string.upper">
34314 <xsl:param name="string" select="''"/>
34316 </xsl:template></synopsis>
34318 <refsect1><title>Description</title>
34320 <para>Given a string, this template does a language-aware conversion
34321 of that string to all uppercase letters, based on the values of the
34322 <literal>lowercase.alpha</literal> and
34323 <literal>uppercase.alpha</literal> gentext keys for the current
34324 locale. It affects only those characters found in the values of
34325 <literal>lowercase.alpha</literal> and
34326 <literal>uppercase.alpha</literal>. All other characters are left
34329 </refsect1><refsect1><title>Parameters</title>
34332 <varlistentry><term>string</term>
34335 <para>The string to convert to uppercase.</para>
34341 </refsect1></refentry>
34343 <refentry id="template.string.lower">
34345 <refname>string.lower</refname>
34346 <refpurpose>Converts a string to all lowercase letters</refpurpose>
34349 <synopsis><xsl:template name="string.lower">
34350 <xsl:param name="string" select="''"/>
34352 </xsl:template></synopsis>
34354 <refsect1><title>Description</title>
34356 <para>Given a string, this template does a language-aware conversion
34357 of that string to all lowercase letters, based on the values of the
34358 <literal>uppercase.alpha</literal> and
34359 <literal>lowercase.alpha</literal> gentext keys for the current
34360 locale. It affects only those characters found in the values of
34361 <literal>uppercase.alpha</literal> and
34362 <literal>lowercase.alpha</literal>. All other characters are left
34365 </refsect1><refsect1><title>Parameters</title>
34368 <varlistentry><term>string</term>
34371 <para>The string to convert to lowercase.</para>
34377 </refsect1></refentry>
34379 <refentry id="template.select.choice.separator">
34381 <refname>select.choice.separator</refname>
34382 <refpurpose>Returns localized choice separator</refpurpose>
34385 <synopsis><xsl:template name="select.choice.separator"/></synopsis>
34387 <refsect1><title>Description</title>
34389 <para>This template enables auto-generation of an appropriate
34390 localized "choice" separator (for example, "and" or "or") before
34391 the final item in an inline list (though it could also be useful
34392 for generating choice separators for non-inline lists).</para>
34395 <para>It currently works by evaluating a processing instruction
34396 (PI) of the form <?dbchoice choice="foo"?> :
34400 <simpara>if the value of the <tag>choice</tag>
34401 pseudo-attribute is "and" or "or", returns a localized "and"
34405 <simpara>otherwise returns the literal value of the
34406 <tag>choice</tag> pseudo-attribute</simpara>
34410 The latter is provided only as a temporary workaround because the
34411 locale files do not currently have translations for the word
34412 <wordasword>or</wordasword>. So if you want to generate a a
34413 logical "or" separator in French (for example), you currently need
34415 <literallayout><?dbchoice choice="ou"?></literallayout>
34420 <para>The <tag>dbchoice</tag> processing instruction is
34421 an unfortunate hack; support for it may disappear in the future
34422 (particularly if and when a more appropriate means for marking
34423 up "choice" lists becomes available in DocBook).</para>
34426 </refsect1></refentry>
34428 <refentry id="template.evaluate.info.profile">
34430 <refname>evaluate.info.profile</refname>
34431 <refpurpose>Evaluates an info profile</refpurpose>
34434 <synopsis><xsl:template name="evaluate.info.profile">
34435 <xsl:param name="profile"/>
34436 <xsl:param name="info"/>
34438 </xsl:template></synopsis>
34440 <refsect1><title>Description</title>
34442 <para>This template evaluates an "info profile" matching the XPath
34443 expression given by the <parameter>profile</parameter>
34444 parameter. It relies on the XSLT <function>evaluate()</function>
34445 extension function.</para>
34449 <para>The value of the <parameter>profile</parameter> parameter
34450 can include the literal string <literal>$info</literal>. If found
34451 in the value of the <parameter>profile</parameter> parameter, the
34452 literal string <literal>$info</literal> string is replaced with
34453 the value of the <parameter>info</parameter> parameter, which
34454 should be a set of <replaceable>*info</replaceable> nodes; the
34455 expression is then evaluated using the XSLT
34456 <function>evaluate()</function> extension function.</para>
34458 </refsect1><refsect1><title>Parameters</title>
34462 <term>profile</term>
34465 <para>A string representing an XPath expression </para>
34473 <para>A set of *info nodes</para>
34479 </refsect1><refsect1><title>Returns</title>
34481 <para>Returns a node (the result of evaluating the
34482 <parameter>profile</parameter> parameter)</para>
34484 </refsect1></refentry>
34486 <refentry id="template.graphic.format.content-type">
34488 <refname>graphic.format.content-type</refname>
34489 <refpurpose>Returns mimetype for media format</refpurpose>
34492 <synopsis><xsl:template name="graphic.format.content-type">
34493 <xsl:param name="format"/>
34495 </xsl:template></synopsis>
34497 <refsect1><title>Description</title>
34499 <para>This takes as input a 'format' param and returns
34500 a mimetype string. It uses an xsl:choose after first
34501 converting the input to all uppercase.</para>
34503 </refsect1></refentry>
34505 <reference id="refentry" xml:base="../common/refentry.xml">
34507 <title>Common » Refentry Metadata Template Reference</title>
34508 <releaseinfo role="meta">
34512 <partintro id="partintro">
34513 <title>Introduction</title>
34515 <para>This is technical reference documentation for the “refentry
34516 metadata” templates in the DocBook XSL Stylesheets.</para>
34519 <para>This is not intended to be user documentation. It is provided
34520 for developers writing customization layers for the stylesheets.</para>
34524 <para>Currently, only the manpages stylesheets make use of these
34525 templates. They are, however, potentially useful elsewhere.</para>
34530 <refentry id="template.get.refentry.metadata">
34532 <refname>get.refentry.metadata</refname>
34533 <refpurpose>Gathers metadata from a refentry and its ancestors</refpurpose>
34536 <synopsis><xsl:template name="get.refentry.metadata">
34537 <xsl:param name="refname"/>
34538 <xsl:param name="info"/>
34539 <xsl:param name="prefs"/>
34541 </xsl:template></synopsis>
34543 <refsect1><title>Description</title>
34545 <para>Reference documentation for particular commands, functions,
34546 etc., is sometimes viewed in isolation from its greater "context". For
34547 example, users view Unix man pages as, well, individual pages, not as
34548 part of a "book" of some kind. Therefore, it is sometimes necessary to
34549 embed "context" information in output for each <tag>refentry</tag>.</para>
34553 <para>However, one problem is that different users mark up that
34554 context information in different ways. Often (usually), the
34555 context information is not actually part of the content of the
34556 <tag>refentry</tag> itself, but instead part of the content of a
34557 parent or ancestor element to the <tag>refentry</tag>. And
34558 even then, DocBook provides a variety of elements that users might
34559 potentially use to mark up the same kind of information. One user
34560 might use the <tag>productnumber</tag> element to mark up version
34561 information about a particular product, while another might use
34562 the <tag>releaseinfo</tag> element.</para>
34566 <para>Taking all that in mind, the
34567 <function>get.refentry.metadata</function> template tries to gather
34568 metadata from a <tag>refentry</tag> element and its ancestor
34569 elements in an intelligent and user-configurable way. The basic
34570 mechanism used in the XPath expressions throughout this stylesheet
34571 is to select the relevant metadata from the *info element that is
34572 closest to the actual <tag>refentry</tag> – either on the
34573 <tag>refentry</tag> itself, or on its nearest ancestor.</para>
34578 <para>The <function>get.refentry.metadata</function>
34579 template is actually just sort of a "driver" template; it
34580 calls other templates that do the actual data collection,
34581 then returns the data as a set.</para>
34585 </refsect1><refsect1><title>Parameters</title>
34589 <term>refname</term>
34592 <para>The first <tag>refname</tag> in the refentry</para>
34600 <para>A set of info nodes (from a <tag>refentry</tag>
34601 element and its ancestors)</para>
34609 <para>A node containing user preferences (from global
34610 stylesheet parameters)</para>
34616 </refsect1><refsect1><title>Returns</title>
34618 <para>Returns a node set with the following elements. The
34619 descriptions are verbatim from the <literal>man(7)</literal> man
34627 <para>the title of the man page (e.g., <literal>MAN</literal>)</para>
34632 <term>section</term>
34635 <para>the section number the man page should be placed in (e.g.,
34636 <literal>7</literal>)</para>
34644 <para>the date of the last revision</para>
34649 <term>source</term>
34652 <para>the source of the command</para>
34657 <term>manual</term>
34660 <para>the title of the manual (e.g., <citetitle>Linux
34661 Programmer's Manual</citetitle>)</para>
34669 </refsect1></refentry>
34671 <refentry id="template.get.refentry.title">
34673 <refname>get.refentry.title</refname>
34674 <refpurpose>Gets title metadata for a refentry</refpurpose>
34677 <synopsis><xsl:template name="get.refentry.title">
34678 <xsl:param name="refname"/>
34680 </xsl:template></synopsis>
34682 <refsect1><title>Description</title>
34684 <para>The <literal>man(7)</literal> man page describes this as "the
34685 title of the man page (e.g., <literal>MAN</literal>). This differs
34686 from <tag>refname</tag> in that, if the <tag>refentry</tag> has a
34687 <tag>refentrytitle</tag>, we use that as the <tag>title</tag>;
34688 otherwise, we just use first <tag>refname</tag> in the first
34689 <tag>refnamediv</tag> in the source.</para>
34691 </refsect1><refsect1><title>Parameters</title>
34695 <term>refname</term>
34698 <para>The first <tag>refname</tag> in the refentry</para>
34704 </refsect1><refsect1><title>Returns</title>
34706 <para>Returns a <tag>title</tag> node.</para>
34707 </refsect1></refentry>
34709 <refentry id="template.get.refentry.section">
34711 <refname>get.refentry.section</refname>
34712 <refpurpose>Gets section metadata for a refentry</refpurpose>
34715 <synopsis><xsl:template name="get.refentry.section">
34716 <xsl:param name="refname"/>
34717 <xsl:param name="quiet" select="0"/>
34719 </xsl:template></synopsis>
34721 <refsect1><title>Description</title>
34723 <para>The <literal>man(7)</literal> man page describes this as "the
34724 section number the man page should be placed in (e.g.,
34725 <literal>7</literal>)". If we do not find a <tag>manvolnum</tag>
34726 specified in the source, and we find that the <tag>refentry</tag> is
34727 for a function, we use the section number <literal>3</literal>
34728 ["Library calls (functions within program libraries)"]; otherwise, we
34729 default to using <literal>1</literal> ["Executable programs or shell
34732 </refsect1><refsect1><title>Parameters</title>
34736 <term>refname</term>
34739 <para>The first <tag>refname</tag> in the refentry</para>
34747 <para>If non-zero, no "missing" message is emitted</para>
34753 </refsect1><refsect1><title>Returns</title>
34755 <para>Returns a string representing a section number.</para>
34756 </refsect1></refentry>
34758 <refentry id="template.get.refentry.date">
34760 <refname>get.refentry.date</refname>
34761 <refpurpose>Gets date metadata for a refentry</refpurpose>
34764 <synopsis><xsl:template name="get.refentry.date">
34765 <xsl:param name="refname"/>
34766 <xsl:param name="info"/>
34767 <xsl:param name="prefs"/>
34769 </xsl:template></synopsis>
34771 <refsect1><title>Description</title>
34773 <para>The <literal>man(7)</literal> man page describes this as "the
34774 date of the last revision". If we cannot find a date in the source, we
34775 generate one.</para>
34777 </refsect1><refsect1><title>Parameters</title>
34781 <term>refname</term>
34784 <para>The first <tag>refname</tag> in the refentry</para>
34792 <para>A set of info nodes (from a <tag>refentry</tag>
34793 element and its ancestors)</para>
34801 <para>A node containing users preferences (from global stylesheet parameters)</para>
34807 </refsect1><refsect1><title>Returns</title>
34809 <para>Returns a <tag>date</tag> node.</para>
34811 </refsect1></refentry>
34813 <refentry id="template.get.refentry.source">
34815 <refname>get.refentry.source</refname>
34816 <refpurpose>Gets source metadata for a refentry</refpurpose>
34819 <synopsis><xsl:template name="get.refentry.source">
34820 <xsl:param name="refname"/>
34821 <xsl:param name="info"/>
34822 <xsl:param name="prefs"/>
34824 </xsl:template></synopsis>
34826 <refsect1><title>Description</title>
34828 <para>The <literal>man(7)</literal> man page describes this as "the
34829 source of the command", and provides the following examples:
34834 <para>For binaries, use something like: GNU, NET-2, SLS
34835 Distribution, MCC Distribution.</para>
34840 <para>For system calls, use the version of the kernel that you are
34841 currently looking at: Linux 0.99.11.</para>
34846 <para>For library calls, use the source of the function: GNU, BSD
34847 4.3, Linux DLL 4.4.1.</para>
34856 <para>The <literal>solbook(5)</literal> man page describes
34857 something very much like what <literal>man(7)</literal> calls
34858 "source", except that <literal>solbook(5)</literal> names it
34859 "software" and describes it like this:
34862 <para>This is the name of the software product that the topic
34863 discussed on the reference page belongs to. For example UNIX
34864 commands are part of the <literal>SunOS x.x</literal>
34872 <para>In practice, there are many pages that simply have a version
34873 number in the "source" field. So, it looks like what we have is a
34875 <replaceable>Name</replaceable> <replaceable>Version</replaceable>,
34883 <para>product name (e.g., BSD) or org. name (e.g., GNU)</para>
34888 <term>Version</term>
34891 <para>version name</para>
34897 Each part is optional. If the <replaceable>Name</replaceable> is a
34898 product name, then the <replaceable>Version</replaceable> is probably
34899 the version of the product. Or there may be no
34900 <replaceable>Name</replaceable>, in which case, if there is a
34901 <replaceable>Version</replaceable>, it is probably the version of the
34902 item itself, not the product it is part of. Or, if the
34903 <replaceable>Name</replaceable> is an organization name, then there
34904 probably will be no <replaceable>Version</replaceable>.
34907 </refsect1><refsect1><title>Parameters</title>
34911 <term>refname</term>
34914 <para>The first <tag>refname</tag> in the refentry</para>
34922 <para>A set of info nodes (from a <tag>refentry</tag>
34923 element and its ancestors)</para>
34931 <para>A node containing users preferences (from global
34932 stylesheet parameters)</para>
34938 </refsect1><refsect1><title>Returns</title>
34940 <para>Returns a <tag>source</tag> node.</para>
34942 </refsect1></refentry>
34944 <refentry id="template.get.refentry.source.name">
34946 <refname>get.refentry.source.name</refname>
34947 <refpurpose>Gets source-name metadata for a refentry</refpurpose>
34950 <synopsis><xsl:template name="get.refentry.source.name">
34951 <xsl:param name="refname"/>
34952 <xsl:param name="info"/>
34953 <xsl:param name="prefs"/>
34955 </xsl:template></synopsis>
34957 <refsect1><title>Description</title>
34959 <para>A "source name" is one part of a (potentially) two-part
34960 <replaceable>Name</replaceable> <replaceable>Version</replaceable>
34961 source field. For more details, see the documentation for the
34962 <function>get.refentry.source</function> template.</para>
34964 </refsect1><refsect1><title>Parameters</title>
34968 <term>refname</term>
34971 <para>The first <tag>refname</tag> in the refentry</para>
34979 <para>A set of info nodes (from a <tag>refentry</tag>
34980 element and its ancestors)</para>
34988 <para>A node containing users preferences (from global
34989 stylesheet parameters)</para>
34995 </refsect1><refsect1><title>Returns</title>
34997 <para>Depending on what output method is used for the
34998 current stylesheet, either returns a text node or possibly an element
34999 node, containing "source name" data.</para>
35001 </refsect1></refentry>
35003 <refentry id="template.get.refentry.version">
35005 <refname>get.refentry.version</refname>
35006 <refpurpose>Gets version metadata for a refentry</refpurpose>
35009 <synopsis><xsl:template name="get.refentry.version">
35010 <xsl:param name="refname"/>
35011 <xsl:param name="info"/>
35012 <xsl:param name="prefs"/>
35014 </xsl:template></synopsis>
35016 <refsect1><title>Description</title>
35018 <para>A "version" is one part of a (potentially) two-part
35019 <replaceable>Name</replaceable> <replaceable>Version</replaceable>
35020 source field. For more details, see the documentation for the
35021 <function>get.refentry.source</function> template.</para>
35023 </refsect1><refsect1><title>Parameters</title>
35027 <term>refname</term>
35030 <para>The first <tag>refname</tag> in the refentry</para>
35038 <para>A set of info nodes (from a <tag>refentry</tag>
35039 element and its ancestors)</para>
35047 <para>A node containing users preferences (from global
35048 stylesheet parameters)</para>
35054 </refsect1><refsect1><title>Returns</title>
35056 <para>Depending on what output method is used for the
35057 current stylesheet, either returns a text node or possibly an element
35058 node, containing "version" data.</para>
35060 </refsect1></refentry>
35062 <refentry id="template.get.refentry.manual">
35064 <refname>get.refentry.manual</refname>
35065 <refpurpose>Gets source metadata for a refentry</refpurpose>
35068 <synopsis><xsl:template name="get.refentry.manual">
35069 <xsl:param name="refname"/>
35070 <xsl:param name="info"/>
35071 <xsl:param name="prefs"/>
35073 </xsl:template></synopsis>
35075 <refsect1><title>Description</title>
35077 <para>The <literal>man(7)</literal> man page describes this as "the
35078 title of the manual (e.g., <citetitle>Linux Programmer's
35079 Manual</citetitle>)". Here are some examples from existing man pages:
35084 <para><citetitle>dpkg utilities</citetitle>
35085 (<command>dpkg-name</command>)</para>
35090 <para><citetitle>User Contributed Perl Documentation</citetitle>
35091 (<command>GET</command>)</para>
35096 <para><citetitle>GNU Development Tools</citetitle>
35097 (<command>ld</command>)</para>
35102 <para><citetitle>Emperor Norton Utilities</citetitle>
35103 (<command>ddate</command>)</para>
35108 <para><citetitle>Debian GNU/Linux manual</citetitle>
35109 (<command>faked</command>)</para>
35114 <para><citetitle>GIMP Manual Pages</citetitle>
35115 (<command>gimp</command>)</para>
35120 <para><citetitle>KDOC Documentation System</citetitle>
35121 (<command>qt2kdoc</command>)</para>
35130 <para>The <literal>solbook(5)</literal> man page describes
35131 something very much like what <literal>man(7)</literal> calls
35132 "manual", except that <literal>solbook(5)</literal> names it
35133 "sectdesc" and describes it like this:
35136 <para>This is the section title of the reference page; for
35137 example <literal>User Commands</literal>.</para>
35143 </refsect1><refsect1><title>Parameters</title>
35147 <term>refname</term>
35150 <para>The first <tag>refname</tag> in the refentry</para>
35158 <para>A set of info nodes (from a <tag>refentry</tag>
35159 element and its ancestors)</para>
35167 <para>A node containing users preferences (from global
35168 stylesheet parameters)</para>
35174 </refsect1><refsect1><title>Returns</title>
35176 <para>Returns a <tag>manual</tag> node.</para>
35178 </refsect1></refentry>
35180 <refentry id="template.get.refentry.metadata.prefs">
35182 <refname>get.refentry.metadata.prefs</refname>
35183 <refpurpose>Gets user preferences for refentry metadata gathering</refpurpose>
35186 <synopsis><xsl:template name="get.refentry.metadata.prefs"/></synopsis>
35188 <refsect1><title>Description</title>
35190 <para>The DocBook XSL stylesheets include several user-configurable
35191 global stylesheet parameters for controlling <tag>refentry</tag>
35192 metadata gathering. Those parameters are not read directly by the
35193 other <tag>refentry</tag> metadata-gathering
35194 templates. Instead, they are read only by the
35195 <function>get.refentry.metadata.prefs</function> template,
35196 which assembles them into a structure that is then passed to
35197 the other <tag>refentry</tag> metadata-gathering
35202 <para>So the, <function>get.refentry.metadata.prefs</function>
35203 template is the only interface to collecting stylesheet parameters for
35204 controlling <tag>refentry</tag> metadata gathering.</para>
35206 </refsect1><refsect1><title>Parameters</title>
35208 <para>There are no local parameters for this template; however, it
35209 does rely on a number of global parameters.</para>
35211 </refsect1><refsect1><title>Returns</title>
35213 <para>Returns a <tag>manual</tag> node.</para>
35215 </refsect1></refentry>
35217 <refentry id="template.set.refentry.metadata">
35219 <refname>set.refentry.metadata</refname>
35220 <refpurpose>Sets content of a refentry metadata item</refpurpose>
35223 <synopsis><xsl:template name="set.refentry.metadata">
35224 <xsl:param name="refname"/>
35225 <xsl:param name="info"/>
35226 <xsl:param name="contents"/>
35227 <xsl:param name="context"/>
35228 <xsl:param name="preferred"/>
35230 </xsl:template></synopsis>
35232 <refsect1><title>Description</title>
35234 <para>The <function>set.refentry.metadata</function> template is
35235 called each time a suitable source element is found for a certain
35236 metadata field.</para>
35238 </refsect1><refsect1><title>Parameters</title>
35242 <term>refname</term>
35245 <para>The first <tag>refname</tag> in the refentry</para>
35253 <para>A single *info node that contains the selected source element.</para>
35258 <term>contents</term>
35261 <para>A node containing the selected source element.</para>
35266 <term>context</term>
35269 <para>A string describing the metadata context in which the
35270 <function>set.refentry.metadata</function> template was
35271 called: either "date", "source", "version", or "manual".</para>
35277 </refsect1><refsect1><title>Returns</title>
35279 <para>Returns formatted contents of a selected source element.</para>
35280 </refsect1></refentry>
35282 <reference id="utility" xml:base="../common/utility.xml">
35284 <title>Common » Utility Template Reference</title>
35285 <releaseinfo role="meta">
35289 <partintro id="partintro">
35290 <title>Introduction</title>
35292 <para>This is technical reference documentation for the
35293 miscellaneous utility templates in the DocBook XSL
35294 Stylesheets.</para>
35298 <para>These templates are defined in a separate file from the set
35299 of “common” templates because some of the common templates
35300 reference DocBook XSL stylesheet parameters, requiring the
35301 entire set of parameters to be imported/included in any
35302 stylesheet that imports/includes the common templates.</para>
35305 <para>The utility templates don’t import or include any DocBook
35306 XSL stylesheet parameters, so the utility templates can be used
35307 without importing the whole set of parameters.</para>
35311 <para>This is not intended to be user documentation. It is
35312 provided for developers writing customization layers for the
35313 stylesheets.</para>
35317 <refentry id="template.log.message">
35319 <refname>log.message</refname>
35320 <refpurpose>Logs/emits formatted notes and warnings</refpurpose>
35323 <synopsis><xsl:template name="log.message">
35324 <xsl:param name="level"/>
35325 <xsl:param name="source"/>
35326 <xsl:param name="context-desc"/>
35327 <xsl:param name="context-desc-field-length">12</xsl:param>
35328 <xsl:param name="context-desc-padded">
35329 <xsl:if test="not($context-desc = '')">
35330 <xsl:call-template name="pad-string">
35331 <xsl:with-param name="leftRight">right</xsl:with-param>
35332 <xsl:with-param name="padVar" select="substring($context-desc, 1, $context-desc-field-length)"/>
35333 <xsl:with-param name="length" select="$context-desc-field-length"/>
35334 </xsl:call-template>
35337 <xsl:param name="message"/>
35338 <xsl:param name="message-field-length" select="45"/>
35339 <xsl:param name="message-padded">
35340 <xsl:variable name="spaces-for-blank-level">
35341 <!-- * if the level field is blank, we'll need to pad out -->
35342 <!-- * the message field with spaces to compensate -->
35344 <xsl:when test="$level = ''">
35345 <xsl:value-of select="4 + 2"/>
35346 <!-- * 4 = hard-coded length of comment text ("Note" or "Warn") -->
35347 <!-- * + 2 = length of colon-plus-space separator ": " -->
35349 <xsl:otherwise>
35350 <xsl:value-of select="0"/>
35351 </xsl:otherwise>
35352 </xsl:choose>
35353 </xsl:variable>
35354 <xsl:variable name="spaces-for-blank-context-desc">
35355 <!-- * if the context-description field is blank, we'll need -->
35356 <!-- * to pad out the message field with spaces to compensate -->
35358 <xsl:when test="$context-desc = ''">
35359 <xsl:value-of select="$context-desc-field-length + 2"/>
35360 <!-- * + 2 = length of colon-plus-space separator ": " -->
35362 <xsl:otherwise>
35363 <xsl:value-of select="0"/>
35364 </xsl:otherwise>
35365 </xsl:choose>
35366 </xsl:variable>
35367 <xsl:variable name="extra-spaces" select="$spaces-for-blank-level + $spaces-for-blank-context-desc"/>
35368 <xsl:call-template name="pad-string">
35369 <xsl:with-param name="leftRight">right</xsl:with-param>
35370 <xsl:with-param name="padVar" select="substring($message, 1, ($message-field-length + $extra-spaces))"/>
35371 <xsl:with-param name="length" select="$message-field-length + $extra-spaces"/>
35372 </xsl:call-template>
35375 </xsl:template></synopsis>
35377 <refsect1><title>Description</title>
35379 <para>The <function>log.message</function> template is a utility
35380 template for logging/emitting formatted messages – that is,
35381 notes and warnings, along with a given log “level” and an
35382 identifier for the “source” that the message relates to.</para>
35384 </refsect1><refsect1><title>Parameters</title>
35387 <varlistentry><term>level</term>
35390 <para>Text to log/emit in the message-level field to
35391 indicate the message level
35392 (<literal>Note</literal> or
35393 <literal>Warning</literal>)</para>
35397 <varlistentry><term>source</term>
35400 <para>Text to log/emit in the source field to identify the
35401 “source” to which the notification/warning relates.
35402 This can be any arbitrary string, but because the
35403 message lacks line and column numbers to identify the
35404 exact part of the source document to which it
35405 relates, the intention is that the value you pass
35406 into the <literal>source</literal> parameter should
35407 give the user some way to identify the portion of
35408 their source document on which to take potentially
35409 take action in response to the log message (for
35410 example, to edit, change, or add content).</para>
35413 <para>So the <literal>source</literal> value should be,
35414 for example, an ID, book/chapter/article title, title
35415 of some formal object, or even a string giving an
35416 XPath expression.</para>
35420 <varlistentry><term>context-desc</term>
35423 <para>Text to log/emit in the context-description field to
35424 describe the context for the message.</para>
35428 <varlistentry><term>context-desc-field-length</term>
35431 <para>Specifies length of the context-description field
35432 (in characters); default is 12</para>
35435 <para>If the text specified by the
35436 <literal>context-desc</literal> parameter is longer
35437 than the number of characters specified in
35438 <literal>context-desc-field-length</literal>, it is
35439 truncated to <literal>context-desc-field-length</literal>
35440 (12 characters by default).</para>
35443 <para>If the specified text is shorter than
35444 <literal>context-desc-field-length</literal>,
35445 it is right-padded out to
35446 <literal>context-desc-field-length</literal> (12 by
35450 <para>If no value has been specified for the
35451 <literal>context-desc</literal> parameter, the field is
35452 left empty and the text of the log message begins with
35453 the value of the <literal>message</literal>
35458 <varlistentry><term>message</term>
35461 <para>Text to log/emit in the actual message field</para>
35465 <varlistentry><term>message-field-length</term>
35468 <para>Specifies length of the message
35469 field (in characters); default is 45</para>
35475 </refsect1><refsect1><title>Returns</title>
35477 <para>Outputs a message (generally, to standard error).</para>
35478 </refsect1></refentry>
35480 <refentry id="template.get.doc.title">
35482 <refname>get.doc.title</refname>
35483 <refpurpose>Gets a title from the current document</refpurpose>
35486 <synopsis><xsl:template name="get.doc.title"/></synopsis>
35488 <refsect1><title>Description</title>
35490 <para>The <function>get.doc.title</function> template is a
35491 utility template for returning the first title found in the
35492 current document.</para>
35494 </refsect1><refsect1><title>Returns</title>
35496 <para>Returns a string containing some identifying title for the
35497 current document .</para>
35498 </refsect1></refentry>
35500 <refentry id="template.pad-string">
35502 <refname>pad-string</refname>
35503 <refpurpose>Right-pads or left-pads a string out to a certain length</refpurpose>
35506 <synopsis><xsl:template name="pad-string">
35507 <xsl:param name="padChar" select="' '"/>
35508 <xsl:param name="leftRight">left</xsl:param>
35509 <xsl:param name="padVar"/>
35510 <xsl:param name="length"/>
35512 </xsl:template></synopsis>
35514 <refsect1><title>Description</title>
35516 <para>This function takes string <parameter>padVar</parameter> and
35517 pads it out in the direction <parameter>rightLeft</parameter> to
35518 the string-length <parameter>length</parameter>, using string
35519 <parameter>padChar</parameter> (a space character by default) as
35520 the padding string (note that <parameter>padChar</parameter> can
35521 be a string; it is not limited to just being a single
35526 <para>This function began as a copy of Nate Austin's
35527 <function>prepend-pad</function> function in the <link xlink:href="http://www.dpawson.co.uk/xsl/sect2/padding.html">Padding
35528 Content</link> section of Dave Pawson's <link xlink:href="http://www.dpawson.co.uk/xsl/index.html">XSLT
35532 </refsect1><refsect1><title>Returns</title>
35534 <para>Returns a (padded) string.</para>
35535 </refsect1></refentry>
35537 <reference id="charmap" xml:base="../common/charmap.xml">
35539 <title>Common » Character-Map Template Reference</title>
35540 <releaseinfo role="meta">
35544 <partintro id="partintro">
35545 <title>Introduction</title>
35547 <para>This is technical reference documentation for the
35548 character-map templates in the DocBook XSL Stylesheets.</para>
35552 <para>These templates are defined in a separate file from the set
35553 of “common” templates because some of the common templates
35554 reference DocBook XSL stylesheet parameters, requiring the
35555 entire set of parameters to be imported/included in any
35556 stylesheet that imports/includes the common templates.</para>
35559 <para>The character-map templates don’t import or include
35560 any DocBook XSL stylesheet parameters, so the
35561 character-map templates can be used without importing the
35562 whole set of parameters.</para>
35566 <para>This is not intended to be user documentation. It is
35567 provided for developers writing customization layers for the
35568 stylesheets.</para>
35572 <refentry id="template.apply-character-map">
35574 <refname>apply-character-map</refname>
35575 <refpurpose>Applies an XSLT character map</refpurpose>
35578 <synopsis><xsl:template name="apply-character-map">
35579 <xsl:param name="content"/>
35580 <xsl:param name="map.contents"/>
35582 </xsl:template></synopsis>
35584 <refsect1><title>Description</title>
35586 <para>This template applies an <link xlink:href="http://www.w3.org/TR/xslt20/#character-maps">XSLT character map</link>; that is, it causes certain
35587 individual characters to be substituted with strings of one
35588 or more characters. It is useful mainly for replacing
35589 multiple “special” characters or symbols in the same target
35590 content. It uses the value of
35591 <parameter>map.contents</parameter> to do substitution on
35592 <parameter>content</parameter>, and then returns the
35593 modified contents.</para>
35597 <para>This template is a very slightly modified version of
35598 Jeni Tennison’s <function>replace_strings</function>
35599 template in the <link xlink:href="http://www.dpawson.co.uk/xsl/sect2/StringReplace.html#d9351e13">multiple string replacements</link> section of Dave Pawson’s
35600 <link xlink:href="http://www.dpawson.co.uk/xsl/index.html">XSLT FAQ</link>.</para>
35603 <para>The <function>apply-string-subst-map</function>
35604 template is essentially the same template as the
35605 <function>apply-character-map</function> template; the
35606 only difference is that in the map that
35607 <function>apply-string-subst-map</function> expects, <tag class="attribute">oldstring</tag> and <tag class="attribute">newstring</tag> attributes are used
35608 instead of <tag class="attribute">character</tag> and <tag class="attribute">string</tag> attributes.</para>
35611 </refsect1><refsect1><title>Parameters</title>
35614 <varlistentry><term>content</term>
35617 <para>The content on which to perform the character-map
35618 substitution.</para>
35622 <varlistentry><term>map.contents</term>
35625 <para>A node set of elements, with each element having
35626 the following attributes:
35630 <simpara><tag class="attribute">character</tag>, a
35631 character to be replaced</simpara>
35634 <simpara><tag class="attribute">string</tag>, a
35635 string with which to replace <tag class="attribute">character</tag></simpara>
35645 </refsect1></refentry>
35647 <refentry id="template.read-character-map">
35649 <refname>read-character-map</refname>
35650 <refpurpose>Reads in all or part of an XSLT character map</refpurpose>
35653 <synopsis><xsl:template name="read-character-map">
35654 <xsl:param name="use.subset"/>
35655 <xsl:param name="subset.profile"/>
35656 <xsl:param name="uri"/>
35658 </xsl:template></synopsis>
35660 <refsect1><title>Description</title>
35662 <para>The XSLT 2.0 specification describes <link xlink:href="http://www.w3.org/TR/xslt20/#character-maps">character maps</link> and explains how they may be used
35663 to allow a specific character appearing in a text or
35664 attribute node in a final result tree to be substituted by
35665 a specified string of characters during serialization. The
35666 <function>read-character-map</function> template provides a
35667 means for reading and using character maps with XSLT
35668 1.0-based tools.</para>
35671 <para>This template reads the character-map contents from
35672 <parameter>uri</parameter> (in full or in part, depending on
35673 the value of the <parameter>use.subset</parameter>
35674 parameter), then passes those contents to the
35675 <function>apply-character-map</function> template, along with
35676 <parameter>content</parameter>, the data on which to perform
35677 the character substitution.</para>
35680 <para>Using the character map “in part” means that it uses only
35681 those <tag>output-character</tag> elements that match the
35682 XPath expression given in the value of the
35683 <parameter>subset.profile</parameter> parameter. The current
35684 implementation of that capability here relies on the
35685 <function>evaluate</function> extension XSLT function.</para>
35687 </refsect1><refsect1><title>Parameters</title>
35690 <varlistentry><term>use.subset</term>
35693 <para>Specifies whether to use a subset of the character
35694 map instead of the whole map; boolean
35695 <literal>0</literal> or <literal>1</literal></para>
35699 <varlistentry><term>subset.profile</term>
35702 <para>XPath expression that specifies what subset of the
35703 character map to use</para>
35707 <varlistentry><term>uri</term>
35710 <para>URI for a character map</para>
35716 </refsect1></refentry>
35719 <part id="table-templates">
35720 <?dbhtml dir="fo"?>
35722 <info xml:base="../fo/table.xml">
35723 <title>Formatting Object Table Reference</title>
35724 <releaseinfo role="meta">
35727 <partintro id="partintro" xml:base="../fo/table.xml">
35728 <title>Introduction</title>
35730 <para>This is technical reference documentation for the FO
35731 table-processing templates in the DocBook XSL Stylesheets.</para>
35734 <para>This is not intended to be user documentation. It is
35735 provided for developers writing customization layers for the
35736 stylesheets.</para>
35740 <refentry id="template.calc.column.width" xml:base="../fo/table.xml">
35742 <refname>calc.column.width</refname>
35743 <refpurpose>Calculate an XSL FO table column width specification from a
35744 CALS table column width specification.</refpurpose>
35747 <synopsis><xsl:template name="calc.column.width">
35748 <xsl:param name="colwidth">1*</xsl:param>
35750 </xsl:template></synopsis>
35752 <refsect1><title>Description</title>
35754 <para>CALS expresses table column widths in the following basic
35762 <para><emphasis>99.99units</emphasis>, a fixed length specifier.</para>
35767 <para><emphasis>99.99</emphasis>, a fixed length specifier without any units.</para>
35772 <para><emphasis>99.99*</emphasis>, a relative length specifier.</para>
35777 <para><emphasis>99.99*+99.99units</emphasis>, a combination of both.</para>
35784 <para>The CALS units are points (pt), picas (pi), centimeters (cm),
35785 millimeters (mm), and inches (in). These are the same units as XSL,
35786 except that XSL abbreviates picas "pc" instead of "pi". If a length
35787 specifier has no units, the CALS default unit (pt) is assumed.</para>
35791 <para>Relative length specifiers are represented in XSL with the
35792 proportional-column-width() function.</para>
35796 <para>Here are some examples:</para>
35803 <para>"36pt" becomes "36pt"</para>
35808 <para>"3pi" becomes "3pc"</para>
35813 <para>"36" becomes "36pt"</para>
35818 <para>"3*" becomes "proportional-column-width(3)"</para>
35823 <para>"3*+2pi" becomes "proportional-column-width(3)+2pc"</para>
35828 <para>"1*+2" becomes "proportional-column-width(1)+2pt"</para>
35833 </refsect1><refsect1><title>Parameters</title>
35836 <varlistentry><term>colwidth</term>
35839 <para>The CALS column width specification.</para>
35845 </refsect1><refsect1><title>Returns</title>
35847 <para>The XSL column width specification.</para>
35849 </refsect1></refentry>
35852 <part id="template">
35853 <?dbhtml dir="template"?><?dbhtml filename="index.html"?>
35856 <info xml:base="../template/titlepage.xml">
35857 <title>Titlepage Template Stylesheet Reference</title>
35858 <releaseinfo role="meta">
35861 <partintro id="intro_partintro" xml:base="../template/titlepage.xml">
35862 <title>Introduction</title>
35864 <para>This is technical reference documentation for the
35865 “titlepage” templates in the DocBook XSL Stylesheets.</para>
35868 <para>This is not intended to be user documentation. It is
35869 provided for developers writing customization layers for the
35870 stylesheets.</para>
35874 <refentry id="template.get.namespace.prefix" xml:base="../template/titlepage.xml">
35876 <refname>get.namespace.prefix</refname>
35877 <refpurpose>Obtain namespace prefix for an element identified by a string containing qualified name</refpurpose>
35880 <synopsis><xsl:template name="get.namespace.prefix">
35881 <xsl:param name="element.name"/>
35883 </xsl:template></synopsis>
35885 <refsect1><title>Description</title>
35887 <para>This template interprets a string containing a qualified name of an element
35888 and returns the namespace prefix, if any.</para>
35891 <para>Element name could be an XPath expression starting with the element name; this
35892 template will first determine if the occurrence of a colon is preceded by a valid
35893 NCName, assuming only ASCII characters.</para>
35895 </refsect1></refentry>
35897 <refentry id="template.get.namespace.uri" xml:base="../template/titlepage.xml">
35899 <refname>get.namespace.uri</refname>
35900 <refpurpose>Obtain URI for an element identified by a string containing qualified name</refpurpose>
35903 <synopsis><xsl:template name="get.namespace.uri">
35904 <xsl:param name="element.name"/>
35905 <xsl:param name="reference.node" select="."/>
35906 <xsl:param name="missing.namespace.warning" select="not(/t:templates/@t:missing-namespace-ok = 'yes')"/>
35908 </xsl:template></synopsis>
35910 <refsect1><title>Description</title>
35912 <para>This template interprets a string containing a qualified name of an element
35913 and returns the namespace URI for that element, looking for namespace prefixes
35914 starting from a reference node.</para>
35916 </refsect1></refentry>
35918 <refentry id="template.output.wrapper" xml:base="../template/titlepage.xml">
35920 <refname>output.wrapper</refname>
35921 <refpurpose>Output the wrapper element</refpurpose>
35924 <synopsis><xsl:template name="output.wrapper">
35925 <xsl:param name="wrapper" select="ancestor-or-self::t:titlepage[@t:wrapper]"/>
35926 <xsl:param name="attr.copy.from" select="."/>
35927 <xsl:param name="attr.sets" select="''"/>
35928 <xsl:param name="content"/>
35930 </xsl:template></synopsis>
35932 <refsect1><title>Description</title>
35934 <para>This template locates the namespace for the defined wrapper element
35935 and output it within that namespace. The content of the element is passed
35936 via the content argument.</para>
35939 <para>The attribute sets to use for the wrapper element and the element to
35940 copy non-template attributes from are also passed as arguments.</para>
35942 </refsect1></refentry>
35944 <refentry id="templates" xml:base="../template/titlepage.xml">
35946 <refname>t:templates</refname>
35947 <refpurpose>Construct a stylesheet for the templates provided</refpurpose>
35950 <synopsis><xsl:template match="t:templates"/></synopsis>
35952 <refsect1><title>Description</title>
35954 <para>The <literal>t:templates</literal> element is the root of a
35955 set of templates. This template creates an appropriate
35956 <literal>xsl:stylesheet</literal> for the templates.</para>
35960 <para>If the <literal>t:templates</literal> element has a
35961 <literal>base-stylesheet</literal> attribute, an
35962 <literal>xsl:import</literal> statement is constructed for it.</para>
35966 <para>If the <literal>t:templates</literal> element has a
35967 <literal>copy-namespaces</literal> attribute, it is interpreted as a
35968 space-separated list of namespace prefixes to be copied from the template
35969 to the resulting stylesheet. Default namespace is always copied.</para>
35971 </refsect1></refentry>
35973 <refentry id="star" xml:base="../template/titlepage.xml">
35975 <refname>xsl:*</refname>
35976 <refpurpose>Copy xsl: elements straight through</refpurpose>
35979 <synopsis><xsl:template match="xsl:*"/></synopsis>
35981 <refsect1><title>Description</title>
35983 <para>This template simply copies the xsl: elements
35984 straight through into the result tree.</para>
35986 </refsect1></refentry>
35988 <refentry id="titlepage" xml:base="../template/titlepage.xml">
35990 <refname>t:titlepage</refname>
35991 <refpurpose>Create the templates necessary to construct a title page</refpurpose>
35994 <synopsis><xsl:template match="t:titlepage"/></synopsis>
35996 <refsect1><title>Description</title>
35998 <para>The <literal>t:titlepage</literal> element creates a set of
35999 templates for processing the titlepage for an element. The
36000 <quote>root</quote> of this template set is the template named
36001 <quote><literal>wrapper.titlepage</literal></quote>. That is the
36002 template that should be called to generate the title page.
36007 <para>The <literal>t:titlepage</literal> element has three attributes:
36011 <varlistentry><term>element</term>
36013 <para>The name of the source document element for which
36014 these templates apply. In other words, to make a title page for the
36015 <tag>article</tag> element, set the
36016 <tag class="attribute">element</tag> attribute to
36017 <quote><literal>article</literal></quote>. This attribute is required.
36021 <varlistentry><term>wrapper</term>
36023 <para>The entire title page can be wrapped with an element.
36024 This attribute identifies that element.
36028 <varlistentry><term>class</term>
36030 <para>If the <tag class="attribute">class</tag> attribute
36031 is set, a <tag class="attribute">class</tag> attribute with this
36032 value will be added to the wrapper element that surrounds the entire
36043 <para>Any other attributes are copied through literally to the
36044 wrapper element.</para>
36048 <para>The content of a <literal>t:titlepage</literal> is one or
36049 more <literal>t:titlepage-content</literal>,
36050 <literal>t:titlepage-separator</literal>, and
36051 <literal>t:titlepage-before</literal> elements.</para>
36055 <para>Each of these elements may be provided for the <quote>recto</quote>
36056 and <quote>verso</quote> sides of the title page.</para>
36059 </refsect1></refentry>
36061 <refentry id="titlepage-content" xml:base="../template/titlepage.xml">
36063 <refname>t:titlepage-content</refname>
36064 <refpurpose>Create templates for the content of one side of a title page</refpurpose>
36067 <synopsis><xsl:template match="t:titlepage-content"/></synopsis>
36069 <refsect1><title>Description</title>
36071 <para>The title page content, that is, the elements from the source
36072 document that are rendered on the title page, can be controlled independently
36073 for the recto and verso sides of the title page.</para>
36077 <para>The <literal>t:titlepage-content</literal> element has two attributes:
36081 <varlistentry><term>side</term>
36083 <para>Identifies the side of the page to which this title
36084 page content applies. The
36085 <tag class="attribute">side</tag> attribute is required and
36086 must be set to either
36087 <quote><literal>recto</literal></quote> or
36088 <quote><literal>verso</literal></quote>. In addition, you must specify
36089 exactly one <literal>t:titlepage-content</literal> for each side
36090 within each <literal>t:titlepage</literal>.</para>
36094 <varlistentry><term>order</term>
36096 <para>Indicates how the order of the elements presented on
36097 the title page is determined. If the
36098 <tag class="attribute">order</tag> is
36099 <quote><literal>document</literal></quote>, the elements are presented
36100 in document order. Otherwise (if the
36101 <tag class="attribute">order</tag> is
36102 <quote><literal>stylesheet</literal></quote>), the elements are presented
36103 in the order that they appear in the template (and consequently in
36104 the stylesheet).</para>
36114 <para>The content of a <literal>t:titlepage-content</literal> element is
36115 a list of element names. These names should be unqualified. They identify
36116 the elements in the source document that should appear on the title page.
36121 <para>Each element may have a single attribute:
36122 <tag class="attribute">predicate</tag>. The value of this
36123 attribute is used as a predicate for the expression that matches
36124 the element on which it occurs.</para>
36128 <para>In other words, to put only the first three authors on the
36129 recto-side of a title
36130 page, you could specify:
36133 <t:titlepage-contents side="recto">
36134 <!-- other titlepage elements -->
36135 <author predicate="[count(previous-sibling::author)<2]"/>
36136 <!-- other titlepage elements -->
36137 </t:titlepage-contents>
36143 <para>Usually, the elements so named are empty. But it is possible to
36144 make one level of selection within them. Suppose that you want to
36145 process <literal>authorgroup</literal> elements on the title page, but
36146 you want to select only proper authors, editors, or corporate authors,
36147 not collaborators or other credited authors.</para>
36151 <para>In that case, you can put a <literal>t:or</literal> group inside
36152 the <literal>authorgroup</literal> element:
36155 <t:titlepage-contents side="recto">
36156 <!-- other titlepage elements -->
36157 <authorgroup>
36161 <corpauthor/>
36163 </authorgroup>
36164 <!-- other titlepage elements -->
36165 </t:titlepage-contents>
36171 <para>This will have the effect of automatically generating a template
36172 for processing <literal>authorgroup</literal>s in the title page mode,
36173 selecting only the specified children. If you need more complex processing,
36174 you'll have to construct the templates by hand.</para>
36177 </refsect1></refentry>
36179 <refentry id="titlepage-separator" xml:base="../template/titlepage.xml">
36181 <refname>t:titlepage-separator</refname>
36182 <refpurpose>Create templates for the separator</refpurpose>
36185 <synopsis><xsl:template match="t:titlepage-separator"/></synopsis>
36187 <refsect1><title>Description</title>
36189 <para>The title page is separated from the content which follows it by
36190 the markup specified in the <literal>t:titlepage-separator</literal>
36193 </refsect1></refentry>
36195 <refentry id="titlepage-before" xml:base="../template/titlepage.xml">
36197 <refname>t:titlepage-before</refname>
36198 <refpurpose>Create templates for what precedes a title page</refpurpose>
36201 <synopsis><xsl:template match="t:titlepage-before"/></synopsis>
36203 <refsect1><title>Description</title>
36205 <para>Each side of the title page is preceded by the markup specified
36206 in the <literal>t:titlepage-before</literal> element for that
36209 </refsect1></refentry>
36211 <refentry id="star_in_copy" xml:base="../template/titlepage.xml">
36213 <refname>* (in copy mode)</refname>
36214 <refpurpose>Copy elements</refpurpose>
36217 <synopsis><xsl:template match="*" mode="copy"/></synopsis>
36219 <refsect1><title>Description</title>
36221 <para>This template simply copies the elements that it applies to
36222 straight through into the result tree.</para>
36224 </refsect1></refentry>
36226 <refentry id="attr_star_in_copy" xml:base="../template/titlepage.xml">
36228 <refname>@* (in copy mode)</refname>
36229 <refpurpose>Copy attributes</refpurpose>
36232 <synopsis><xsl:template match="@*" mode="copy"/></synopsis>
36234 <refsect1><title>Description</title>
36236 <para>This template simply copies the attributes that it applies to
36237 straight through into the result tree.</para>
36239 </refsect1></refentry>
36241 <refentry id="attr_star_in_document.order" xml:base="../template/titlepage.xml">
36243 <refname>* (in document.order mode)</refname>
36244 <refpurpose>Create rules to process titlepage elements in document order</refpurpose>
36247 <synopsis><xsl:template match="*" mode="document.order"/></synopsis>
36249 <refsect1><title>Description</title>
36251 <para>This template is called to process all of the children of the
36252 <literal>t:titlepage-content</literal> element. It creates the hairy
36253 select expression necessary to process each of those elements in
36254 the title page.</para>
36258 <para>Note that this template automatically handles the case where
36259 some DocBook elements, like title and subtitle, can occur both inside
36260 the *info elements where metadata is usually stored and outside.
36265 <para>It also automatically calculates the name for the *info container
36266 and handles elements that have historically had containers with different
36270 </refsect1></refentry>
36272 <refentry id="star_in_document.order" xml:base="../template/titlepage.xml">
36274 <refname>* (in document.order mode)</refname>
36275 <refpurpose>Create rules to process titlepage elements in stylesheet order</refpurpose>
36278 <synopsis><xsl:template match="*" mode="document.order"/></synopsis>
36280 <refsect1><title>Description</title>
36282 <para>This template is called to process all of the children of the
36283 <literal>t:titlepage-content</literal> element. It creates the set
36284 of <literal>xsl:apply-templates</literal> elements necessary
36285 process each of those elements in the title page.</para>
36289 <para>Note that this template automatically handles the case where
36290 some DocBook elements, like title and subtitle, can occur both inside
36291 the *info elements where metadata is usually stored and outside.
36296 <para>It also automatically calculates the name for the *info container
36297 and handles elements that have historically had containers with different
36301 </refsect1></refentry>
36303 <refentry id="star_in_titlepage.specialrules" xml:base="../template/titlepage.xml">
36305 <refname>* (in titlepage.specialrules mode)</refname>
36306 <refpurpose>Create templates for special rules</refpurpose>
36309 <synopsis><xsl:template match="*" mode="titlepage.specialrules"/></synopsis>
36311 <refsect1><title>Description</title>
36313 <para>This template is called to process all of the descendants of the
36314 <literal>t:titlepage-content</literal> element that require special
36315 processing. At present, that's just <literal>t:or</literal> elements.
36318 </refsect1></refentry>
36320 <refentry id="star_in_titlepage.subrules" xml:base="../template/titlepage.xml">
36322 <refname>* (in titlepage.subrules mode)</refname>
36323 <refpurpose>Create template for individual special rules</refpurpose>
36326 <synopsis><xsl:template match="*" mode="titlepage.subrules"/></synopsis>
36328 <refsect1><title>Description</title>
36330 <para>This template is called to process the children of special
36334 </refsect1></refentry>
36336 <refentry id="or" xml:base="../template/titlepage.xml">
36338 <refname>t:or</refname>
36339 <refpurpose>Process the t:or special rule</refpurpose>
36342 <synopsis><xsl:template match="t:or"/><xsl:template match="t:or" mode="titlepage.subrules"/></synopsis>
36344 <refsect1><title>Description</title>
36346 <para>This template processes t:or.</para>
36348 </refsect1></refentry>
36350 <refentry id="or_in_titlepage.subrules" xml:base="../template/titlepage.xml">
36352 <refname>t:or (in titlepage.subrules mode)</refname>
36353 <refpurpose>Process the t:or special rule in
36354 titlepage.subrules mode</refpurpose>
36357 <synopsis><xsl:template match="t:or" mode="titlepage.subrules"/></synopsis>
36359 <refsect1><title>Description</title>
36361 <para>The titlepage.subrules mode doesn't apply to t:or, so just
36362 reprocess this node in the normal mode.</para>
36364 </refsect1></refentry>
36366 <refentry id="template.element-or-list" xml:base="../template/titlepage.xml">
36368 <refname>element-or-list</refname>
36369 <refpurpose>Construct the "or-list" used in the select attribute for
36370 special rules.</refpurpose>
36373 <synopsis><xsl:template name="element-or-list">
36374 <xsl:param name="elements" select="*"/>
36375 <xsl:param name="element.count" select="count($elements)"/>
36376 <xsl:param name="count" select="1"/>
36377 <xsl:param name="orlist"/>
36379 </xsl:template></synopsis>
36381 <refsect1><title>Description</title>
36383 <para>Walk through each of the children of t:or, producing the
36384 text of the select attribute.</para>
36386 </refsect1></refentry>
36390 </set><!-- * vim: set ft=docbk foldlevel=2: -->