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">$Id: reference.xml 8321 2009-03-12 18:20:36Z mzjn $ </releaseinfo>
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://docbook.sourceforge.net/release/xsl/current/doc/reference.html">HTML</link>,
75 <link xlink:href="http://docbook.sourceforge.net/release/xsl/current/doc/reference.pdf">PDF</link>,
76 <link xlink:href="http://docbook.sourceforge.net/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>
146 <refentry version="5.0" id="admon.graphics.path">
148 <refentrytitle>admon.graphics.path</refentrytitle>
149 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
152 <refname>admon.graphics.path</refname>
153 <refpurpose>Path to admonition graphics</refpurpose>
157 <programlisting id="admon.graphics.path.frag"><xsl:param name="admon.graphics.path">images/</xsl:param></programlisting>
160 <refsection><info><title>Description</title></info>
162 <para>Sets the path to the directory containing the admonition graphics
163 (caution.png, important.png etc). This location is normally relative
164 to the output html directory. See <parameter>base.dir</parameter></para>
169 <refentry version="5.0" id="admon.graphics">
171 <refentrytitle>admon.graphics</refentrytitle>
172 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
175 <refname>admon.graphics</refname>
176 <refpurpose>Use graphics in admonitions?</refpurpose>
180 <programlisting id="admon.graphics.frag">
181 <xsl:param name="admon.graphics" select="0"></xsl:param>
185 <refsection><info><title>Description</title></info>
187 <para>If true (non-zero), admonitions are presented in an alternate style that uses
188 a graphic. Default graphics are provided in the distribution.
194 <refentry version="5.0" id="admon.textlabel">
196 <refentrytitle>admon.textlabel</refentrytitle>
197 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
200 <refname>admon.textlabel</refname>
201 <refpurpose>Use text label in admonitions?</refpurpose>
205 <programlisting id="admon.textlabel.frag">
206 <xsl:param name="admon.textlabel" select="1"></xsl:param>
210 <refsection><info><title>Description</title></info>
212 <para>If true (non-zero), admonitions are presented with a generated
213 text label such as Note or Warning in the appropriate language.
214 If zero, such labels are turned off, but any title child
215 of the admonition element are still output.
216 The default value is 1.
222 <refentry version="5.0" id="admon.style">
224 <refentrytitle>admon.style</refentrytitle>
225 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
228 <refname>admon.style</refname>
229 <refpurpose>Specifies the CSS style attribute that should be added to
230 admonitions.</refpurpose>
234 <programlisting id="admon.style.frag"><xsl:param name="admon.style">
235 <xsl:value-of select="concat('margin-', $direction.align.start, ': 0.5in; margin-', $direction.align.end, ': 0.5in;')"></xsl:value-of>
236 </xsl:param></programlisting>
239 <refsection><info><title>Description</title></info>
241 <para>Specifies the value of the CSS <tag class="attribute">style</tag>
242 attribute that should be added to admonitions.
248 </reference><reference id="callouts" xml:base="../html/param.xml"><title>Callouts</title>
249 <refentry version="5.0" id="callout.defaultcolumn">
251 <refentrytitle>callout.defaultcolumn</refentrytitle>
252 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
255 <refname>callout.defaultcolumn</refname>
256 <refpurpose>Indicates what column callouts appear in by default</refpurpose>
260 <programlisting id="callout.defaultcolumn.frag">
261 <xsl:param name="callout.defaultcolumn">60</xsl:param>
265 <refsection><info><title>Description</title></info>
267 <para>If a callout does not identify a column (for example, if it uses
268 the <literal>linerange</literal> <tag class="attribute">unit</tag>),
269 it will appear in the default column.
275 <refentry version="5.0" id="callout.graphics.extension">
277 <refentrytitle>callout.graphics.extension</refentrytitle>
278 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
281 <refname>callout.graphics.extension</refname>
282 <refpurpose>Filename extension for callout graphics</refpurpose>
286 <programlisting id="callout.graphics.extension.frag">
287 <xsl:param name="callout.graphics.extension">.png</xsl:param>
292 <refsection><info><title>Description</title></info>
293 <para>Sets the filename extension to use on callout graphics. </para>
296 <para>The Docbook XSL distribution provides callout graphics in the following formats:</para>
297 <listitem><para>SVG (extension: <filename class="extension">.svg</filename>)</para></listitem>
298 <listitem><para>PNG (extension: <filename class="extension">.png</filename>)</para></listitem>
299 <listitem><para>GIF (extension: <filename class="extension">.gif</filename>)</para></listitem>
304 <refentry version="5.0" id="callout.graphics.number.limit">
306 <refentrytitle>callout.graphics.number.limit</refentrytitle>
307 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
310 <refname>callout.graphics.number.limit</refname>
311 <refpurpose>Number of the largest callout graphic</refpurpose>
315 <programlisting id="callout.graphics.number.limit.frag">
316 <xsl:param name="callout.graphics.number.limit">15</xsl:param>
321 <refsection><info><title>Description</title></info>
323 <para>If <parameter>callout.graphics</parameter> is non-zero, graphics
324 are used to represent callout numbers instead of plain text. The value
325 of <parameter>callout.graphics.number.limit</parameter> is the largest
326 number for which a graphic exists. If the callout number exceeds this
327 limit, the default presentation "(plain text instead of a graphic)"
334 <refentry version="5.0" id="callout.graphics.path">
336 <refentrytitle>callout.graphics.path</refentrytitle>
337 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
340 <refname>callout.graphics.path</refname>
341 <refpurpose>Path to callout graphics</refpurpose>
345 <programlisting id="callout.graphics.path.frag">
346 <xsl:param name="callout.graphics.path">images/callouts/</xsl:param>
350 <refsection><info><title>Description</title></info>
352 <para>Sets the path to the directory holding the callout graphics. his
353 location is normally relative to the output html directory. see
354 base.dir. Always terminate the directory with / since the graphic file
355 is appended to this string, hence needs the separator.
361 <refentry version="5.0" id="callout.graphics">
363 <refentrytitle>callout.graphics</refentrytitle>
364 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
367 <refname>callout.graphics</refname>
368 <refpurpose>Use graphics for callouts?</refpurpose>
372 <programlisting id="callout.graphics.frag">
373 <xsl:param name="callout.graphics" select="1"></xsl:param>
377 <refsection><info><title>Description</title></info>
379 <para>If non-zero, callouts are presented with graphics (e.g., reverse-video
380 circled numbers instead of "(1)", "(2)", etc.).
381 Default graphics are provided in the distribution.
387 <refentry version="5.0" id="callout.list.table">
389 <refentrytitle>callout.list.table</refentrytitle>
390 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
393 <refname>callout.list.table</refname>
394 <refpurpose>Present callout lists using a table?</refpurpose>
398 <programlisting id="callout.list.table.frag">
399 <xsl:param name="callout.list.table" select="1"></xsl:param>
403 <refsection><info><title>Description</title></info>
405 <para>The default presentation of <tag>calloutlist</tag>s uses
406 an HTML <tag>DL</tag> element. Some browsers don't align DLs very well
407 if <parameter>callout.graphics</parameter> is used. With this option
408 turned on, <tag>calloutlist</tag>s are presented in an HTML
409 <tag>TABLE</tag>, which usually results in better alignment
410 of the callout number with the callout description.</para>
415 <refentry version="5.0" id="callout.unicode.number.limit">
417 <refentrytitle>callout.unicode.number.limit</refentrytitle>
418 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
421 <refname>callout.unicode.number.limit</refname>
422 <refpurpose>Number of the largest unicode callout character</refpurpose>
426 <programlisting id="callout.unicode.number.limit.frag">
427 <xsl:param name="callout.unicode.number.limit">10</xsl:param>
431 <refsection><info><title>Description</title></info>
433 <para>If <parameter>callout.unicode</parameter>
434 is non-zero, unicode characters are used to represent
435 callout numbers. The value of
436 <parameter>callout.unicode.number.limit</parameter>
438 the largest number for which a unicode character exists. If the callout number
439 exceeds this limit, the default presentation "(nnn)" will always
446 <refentry version="5.0" id="callout.unicode.start.character">
448 <refentrytitle>callout.unicode.start.character</refentrytitle>
449 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
452 <refname>callout.unicode.start.character</refname>
453 <refpurpose>First Unicode character to use, decimal value.</refpurpose>
457 <programlisting id="callout.unicode.start.character.frag">
458 <xsl:param name="callout.unicode.start.character">10102</xsl:param>
462 <refsection><info><title>Description</title></info>
464 <para>If <parameter>callout.graphics</parameter> is zero and <parameter>callout.unicode</parameter>
465 is non-zero, unicode characters are used to represent
466 callout numbers. The value of
467 <parameter>callout.unicode.start.character</parameter>
468 is the decimal unicode value used for callout number one. Currently,
469 only 10102 is supported in the stylesheets for this parameter.
475 <refentry version="5.0" id="callout.unicode">
477 <refentrytitle>callout.unicode</refentrytitle>
478 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
481 <refname>callout.unicode</refname>
482 <refpurpose>Use Unicode characters rather than images for callouts.</refpurpose>
486 <programlisting id="callout.unicode.frag"><xsl:param name="callout.unicode" select="0"></xsl:param></programlisting>
489 <refsection><info><title>Description</title></info>
491 <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.
497 <refentry version="5.0" id="callouts.extension">
499 <refentrytitle>callouts.extension</refentrytitle>
500 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
503 <refname>callouts.extension</refname>
504 <refpurpose>Enable the callout extension</refpurpose>
508 <programlisting id="callouts.extension.frag">
509 <xsl:param name="callouts.extension" select="1"></xsl:param>
513 <refsection><info><title>Description</title></info>
515 <para>The callouts extension processes <tag>areaset</tag>
516 elements in <tag>programlistingco</tag> and other text-based
523 </reference><reference id="ebnf" xml:base="../html/param.xml"><title>EBNF</title>
524 <refentry version="5.0" id="ebnf.table.bgcolor">
526 <refentrytitle>ebnf.table.bgcolor</refentrytitle>
527 <refmiscinfo class="other" otherclass="datatype">color</refmiscinfo>
530 <refname>ebnf.table.bgcolor</refname>
531 <refpurpose>Background color for EBNF tables</refpurpose>
535 <programlisting id="ebnf.table.bgcolor.frag">
536 <xsl:param name="ebnf.table.bgcolor">#F5DCB3</xsl:param>
540 <refsection><info><title>Description</title></info>
542 <para>Sets the background color for EBNF tables (a pale brown). No
543 <tag>bgcolor</tag> attribute is output if
544 <parameter>ebnf.table.bgcolor</parameter> is set to the null string. </para>
550 <refentry version="5.0" id="ebnf.table.border">
552 <refentrytitle>ebnf.table.border</refentrytitle>
553 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
556 <refname>ebnf.table.border</refname>
557 <refpurpose>Selects border on EBNF tables</refpurpose>
561 <programlisting id="ebnf.table.border.frag"><xsl:param name="ebnf.table.border" select="1"></xsl:param></programlisting>
564 <refsection><info><title>Description</title></info>
566 <para>Selects the border on EBNF tables. If non-zero, the tables have
567 borders, otherwise they don't.</para>
572 <refentry version="5.0" id="ebnf.assignment">
574 <refentrytitle>ebnf.assignment</refentrytitle>
575 <refmiscinfo class="other" otherclass="datatype">rtf</refmiscinfo>
578 <refname>ebnf.assignment</refname>
579 <refpurpose>The EBNF production assignment operator</refpurpose>
583 <programlisting id="ebnf.assignment.frag">
584 <xsl:param name="ebnf.assignment">
585 <code>::=</code>
591 <refsection><info><title>Description</title></info>
593 <para>The <parameter>ebnf.assignment</parameter> parameter determines what
594 text is used to show <quote>assignment</quote> in <tag>production</tag>s
595 in <tag>productionset</tag>s.</para>
597 <para>While <quote><literal>::=</literal></quote> is common, so are several
598 other operators.</para>
603 <refentry version="5.0" id="ebnf.statement.terminator">
605 <refentrytitle>ebnf.statement.terminator</refentrytitle>
606 <refmiscinfo class="other" otherclass="datatype">rtf</refmiscinfo>
609 <refname>ebnf.statement.terminator</refname>
610 <refpurpose>Punctuation that ends an EBNF statement.</refpurpose>
614 <programlisting id="ebnf.statement.terminator.frag">
615 <xsl:param name="ebnf.statement.terminator"></xsl:param>
620 <refsection><info><title>Description</title></info>
622 <para>The <parameter>ebnf.statement.terminator</parameter> parameter determines what
623 text is used to terminate each <tag>production</tag>
624 in <tag>productionset</tag>.</para>
626 <para>Some notations end each statement with a period.</para>
631 </reference><reference id="toc_index" xml:base="../html/param.xml"><title>ToC/LoT/Index Generation</title>
632 <refentry version="5.0" id="annotate.toc">
634 <refentrytitle>annotate.toc</refentrytitle>
635 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
638 <refname>annotate.toc</refname>
639 <refpurpose>Annotate the Table of Contents?</refpurpose>
643 <programlisting id="annotate.toc.frag"><xsl:param name="annotate.toc" select="1"></xsl:param></programlisting>
646 <refsection><info><title>Description</title></info>
648 <para>If true, TOCs will be annotated. At present, this just means
649 that the <tag>refpurpose</tag> of <tag>refentry</tag>
650 TOC entries will be displayed.
656 <refentry version="5.0" id="autotoc.label.separator">
658 <refentrytitle>autotoc.label.separator</refentrytitle>
659 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
662 <refname>autotoc.label.separator</refname>
663 <refpurpose>Separator between labels and titles in the ToC</refpurpose>
667 <programlisting id="autotoc.label.separator.frag">
668 <xsl:param name="autotoc.label.separator">. </xsl:param>
672 <refsection><info><title>Description</title></info>
674 <para>String used to separate labels and titles in a table of contents.</para>
679 <refentry version="5.0" id="autotoc.label.in.hyperlink">
681 <refentrytitle>autotoc.label.in.hyperlink</refentrytitle>
682 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
685 <refname>autotoc.label.in.hyperlink</refname>
686 <refpurpose>Include label in hyperlinked titles in TOC?</refpurpose>
690 <programlisting id="autotoc.label.in.hyperlink.frag"><xsl:param name="autotoc.label.in.hyperlink" select="1"></xsl:param></programlisting>
693 <refsection><info><title>Description</title></info>
695 <para>If the value of
696 <parameter>autotoc.label.in.hyperlink</parameter> is non-zero, labels
697 are included in hyperlinked titles in the TOC. If it is instead zero,
698 labels are still displayed prior to the hyperlinked titles, but
699 are not hyperlinked along with the titles.</para>
704 <refentry version="5.0" id="process.source.toc">
706 <refentrytitle>process.source.toc</refentrytitle>
707 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
710 <refname>process.source.toc</refname>
711 <refpurpose>Process a non-empty <tag>toc</tag> element if it occurs in a source document?</refpurpose>
715 <programlisting id="process.source.toc.frag"><xsl:param name="process.source.toc" select="0"></xsl:param></programlisting>
718 <refsection><info><title>Description</title></info>
720 <para>Specifies that the contents of a non-empty "hard-coded"
721 <tag>toc</tag> element in a source document are processed to
722 generate a TOC in output.
724 <para>This parameter has no effect on automated generation of
725 TOCs. An automated TOC may still be generated along with the
726 "hard-coded" TOC. To suppress automated TOC generation, adjust the
727 value of the <parameter>generate.toc</parameter> paramameter.</para>
729 <para>The <tag>process.source.toc</tag> parameter also has
730 no effect if the <tag>toc</tag> element is empty; handling
731 for empty <tag>toc</tag> is controlled by the
732 <parameter>process.empty.source.toc</parameter> parameter.</para>
739 <refentry version="5.0" id="process.empty.source.toc">
741 <refentrytitle>process.empty.source.toc</refentrytitle>
742 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
745 <refname>process.empty.source.toc</refname>
746 <refpurpose>Generate automated TOC if <tag>toc</tag> element occurs in a source document?</refpurpose>
750 <programlisting id="process.empty.source.toc.frag"><xsl:param name="process.empty.source.toc" select="0"></xsl:param></programlisting>
753 <refsection><info><title>Description</title></info>
755 <para>Specifies that if an empty <tag>toc</tag> element is found in a
756 source document, an automated TOC is generated at this point in the
759 <para>Depending on what the value of the
760 <parameter>generate.toc</parameter> parameter is, setting this
761 parameter to <literal>1</literal> could result in generation of
762 duplicate automated TOCs. So the
763 <parameter>process.empty.source.toc</parameter> is primarily useful
764 as an "override": by placing an empty <tag>toc</tag> in your
765 document and setting this parameter to <literal>1</literal>, you can
766 force a TOC to be generated even if <tag>generate.toc</tag>
774 <refentry version="5.0" id="bridgehead.in.toc">
776 <refentrytitle>bridgehead.in.toc</refentrytitle>
777 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
780 <refname>bridgehead.in.toc</refname>
781 <refpurpose>Should bridgehead elements appear in the TOC?</refpurpose>
785 <programlisting id="bridgehead.in.toc.frag"><xsl:param name="bridgehead.in.toc" select="0"></xsl:param></programlisting>
788 <refsection><info><title>Description</title></info>
790 <para>If non-zero, <tag>bridgehead</tag>s appear in the TOC. Note that
791 this option is not fully supported and may be removed in a future
792 version of the stylesheets.
798 <refentry version="5.0" id="simplesect.in.toc">
800 <refentrytitle>simplesect.in.toc</refentrytitle>
801 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
804 <refname>simplesect.in.toc</refname>
805 <refpurpose>Should <tag>simplesect</tag> elements appear in the TOC?</refpurpose>
809 <programlisting id="simplesect.in.toc.frag"><xsl:param name="simplesect.in.toc" select="0"></xsl:param></programlisting>
812 <refsection><info><title>Description</title></info>
814 <para>If non-zero, <tag>simplesect</tag>s will be included in the TOC.
820 <refentry version="5.0" id="manual.toc">
822 <refentrytitle>manual.toc</refentrytitle>
823 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
826 <refname>manual.toc</refname>
827 <refpurpose>An explicit TOC to be used for the TOC</refpurpose>
831 <programlisting id="manual.toc.frag">
832 <xsl:param name="manual.toc"></xsl:param>
836 <refsection><info><title>Description</title></info>
838 <para>The <parameter>manual.toc</parameter> identifies an explicit TOC that
839 will be used for building the printed TOC.
845 <refentry version="5.0" id="toc.list.type">
847 <refentrytitle>toc.list.type</refentrytitle>
848 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
849 <refmiscinfo class="other" otherclass="value">dl</refmiscinfo>
850 <refmiscinfo class="other" otherclass="value">ul</refmiscinfo>
851 <refmiscinfo class="other" otherclass="value">ol</refmiscinfo>
854 <refname>toc.list.type</refname>
855 <refpurpose>Type of HTML list element to use for Tables of Contents</refpurpose>
859 <programlisting id="toc.list.type.frag"><xsl:param name="toc.list.type">dl</xsl:param></programlisting>
862 <refsection><info><title>Description</title></info>
864 <para>When an automatically generated Table of Contents (or List of Titles)
865 is produced, this HTML element will be used to make the list.
871 <refentry version="5.0" id="toc.section.depth">
873 <refentrytitle>toc.section.depth</refentrytitle>
874 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
877 <refname>toc.section.depth</refname>
878 <refpurpose>How deep should recursive <tag>section</tag>s appear
879 in the TOC?</refpurpose>
883 <programlisting id="toc.section.depth.frag"><xsl:param name="toc.section.depth">2</xsl:param></programlisting>
886 <refsection><info><title>Description</title></info>
888 <para>Specifies the depth to which recursive sections should appear in the
895 <refentry version="5.0" id="toc.max.depth">
897 <refentrytitle>toc.max.depth</refentrytitle>
898 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
901 <refname>toc.max.depth</refname>
902 <refpurpose>How many levels should be created for each TOC?</refpurpose>
906 <programlisting id="toc.max.depth.frag"><xsl:param name="toc.max.depth">8</xsl:param></programlisting>
909 <refsection><info><title>Description</title></info>
911 <para>Specifies the maximal depth of TOC on all levels.</para>
916 <refentry version="5.0" id="generate.toc">
918 <refentrytitle>generate.toc</refentrytitle>
919 <refmiscinfo class="other" otherclass="datatype">table</refmiscinfo>
922 <refname>generate.toc</refname>
923 <refpurpose>Control generation of ToCs and LoTs</refpurpose>
927 <programlisting id="generate.toc.frag">
928 <xsl:param name="generate.toc">
932 book toc,title,figure,table,example,equation
951 <refsection><info><title>Description</title></info>
953 <para>This parameter has a structured value. It is a table of space-delimited
954 path/value pairs. Each path identifies some element in the source document
955 using a restricted subset of XPath (only the implicit child axis, no wildcards,
956 no predicates). Paths can be either relative or absolute.</para>
958 <para>When processing a particular element, the stylesheets consult this table to
959 determine if a ToC (or LoT(s)) should be generated.</para>
961 <para>For example, consider the entry:</para>
963 <screen>book toc,figure</screen>
965 <para>This indicates that whenever a <tag>book</tag> is formatted, a
966 Table Of Contents and a List of Figures should be generated. Similarly,</para>
968 <screen>/chapter toc</screen>
970 <para>indicates that whenever a document <emphasis>that has a root
971 of</emphasis> <tag>chapter</tag> is formatted, a Table of
972 Contents should be generated. The entry <literal>chapter</literal> would match
973 all chapters, but <literal>/chapter</literal> matches only <tag>chapter</tag>
974 document elements.</para>
976 <para>Generally, the longest match wins. So, for example, if you want to distinguish
977 articles in books from articles in parts, you could use these two entries:</para>
979 <screen>book/article toc,figure
980 part/article toc</screen>
982 <para>Note that an article in a part can never match a <literal>book/article</literal>,
983 so if you want nothing to be generated for articles in parts, you can simply leave
984 that rule out.</para>
986 <para>If you want to leave the rule in, to make it explicit that you're turning
987 something off, use the value <quote>nop</quote>. For example, the following
988 entry disables ToCs and LoTs for articles:</para>
990 <screen>article nop</screen>
992 <para>Do not simply leave the word <quote>article</quote> in the file
993 without a matching value. That'd be just begging the silly little
994 path/value parser to get confused.</para>
996 <para>Section ToCs are further controlled by the
997 <parameter>generate.section.toc.level</parameter> parameter.
998 For a given section level to have a ToC, it must have both an entry in
999 <parameter>generate.toc</parameter> and be within the range enabled by
1000 <parameter>generate.section.toc.level</parameter>.</para>
1004 <refentry version="5.0" id="generate.section.toc.level">
1006 <refentrytitle>generate.section.toc.level</refentrytitle>
1007 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
1010 <refname>generate.section.toc.level</refname>
1011 <refpurpose>Control depth of TOC generation in sections</refpurpose>
1015 <programlisting id="generate.section.toc.level.frag">
1016 <xsl:param name="generate.section.toc.level" select="0"></xsl:param>
1020 <refsection><info><title>Description</title></info>
1022 <para>The <parameter>generate.section.toc.level</parameter> parameter
1023 controls the depth of <tag>section</tag> in which TOCs will be generated. Note
1024 that this is related to, but not the same as
1025 <parameter>toc.section.depth</parameter>, which controls the depth to
1026 which TOC entries will be generated in a given TOC.</para>
1027 <para>If, for example, <parameter>generate.section.toc.level</parameter>
1028 is <literal>3</literal>, TOCs will be generated in first, second, and third
1029 level sections, but not in fourth level sections.
1035 <refentry version="5.0" id="generate.index">
1037 <refentrytitle>generate.index</refentrytitle>
1038 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
1041 <refname>generate.index</refname>
1042 <refpurpose>Do you want an index?</refpurpose>
1046 <programlisting id="generate.index.frag"><xsl:param name="generate.index" select="1"></xsl:param></programlisting>
1049 <refsection><info><title>Description</title></info>
1051 <para>Specify if an index should be generated. </para>
1056 <refentry version="5.0" id="index.method">
1058 <refentrytitle>index.method</refentrytitle>
1059 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
1060 <refmiscinfo class="other" otherclass="value">basic</refmiscinfo>
1061 <refmiscinfo class="other" otherclass="value">kosek</refmiscinfo>
1062 <refmiscinfo class="other" otherclass="value">kimber</refmiscinfo>
1065 <refname>index.method</refname>
1066 <refpurpose>Select method used to group index entries in an index</refpurpose>
1070 <programlisting id="index.method.frag">
1071 <xsl:param name="index.method">basic</xsl:param>
1075 <refsection><info><title>Description</title></info>
1077 <para>This parameter lets you select which method to use for sorting and grouping
1078 index entries in an index.
1079 Indexes in Latin-based languages that have accented characters typically
1080 sort together accented words and unaccented words.
1081 Thus <quote>Á</quote> (U+00C1 LATIN CAPITAL LETTER A WITH ACUTE) would sort together
1082 with <quote>A</quote> (U+0041 LATIN CAPITAL LETTER A), so both would appear in the <quote>A</quote>
1083 section of the index.
1084 Languages using other alphabets (such as Russian, which is written in the Cyrillic alphabet)
1085 and languages using ideographic chararacters (such as Japanese)
1086 require grouping specific to the languages and alphabets.
1089 <para>The default indexing method is limited.
1090 It can group accented characters in Latin-based languages only.
1091 It cannot handle non-Latin alphabets or ideographic languages.
1092 The other indexing methods require extensions of one type or
1093 another, and do not work with
1094 all XSLT processors, which is why they are not used by default.</para>
1096 <para>The three choices for indexing method are:</para>
1099 <term><literal>basic</literal></term>
1102 (default) Sort and groups words based only on the Latin alphabet.
1103 Words with accented Latin letters will group and sort with
1104 their respective primary letter, but
1105 words in non-Latin alphabets will be
1106 put in the <quote>Symbols</quote> section of the index.
1111 <term><literal>kosek</literal></term>
1114 This method sorts and groups words based on letter groups configured in
1115 the DocBook locale file for the given language.
1116 See, for example, the French locale file <filename>common/fr.xml</filename>.
1117 This method requires that the XSLT processor
1118 supports the EXSLT extensions (most do).
1119 It also requires support for using
1120 user-defined functions in xsl:key (xsltproc does not).
1122 <para>This method is suitable for any language for which you can
1123 list all the individual characters that should appear
1124 in each letter group in an index.
1125 It is probably not practical to use it for ideographic languages
1126 such as Chinese that have hundreds or thousands of characters.
1129 <para>To use the kosek method, you must:</para>
1133 <para>Use a processor that supports its extensions, such as
1134 Saxon 6 or Xalan (xsltproc and Saxon 8 do not).
1138 <para>Set the index.method parameter's value to <quote>kosek</quote>.
1142 <para>Import the appropriate index extensions stylesheet module
1143 <filename>fo/autoidx-kosek.xsl</filename> or
1144 <filename>html/autoidx-kosek.xsl</filename> into your
1153 <term><literal>kimber</literal></term>
1156 This method uses extensions to the Saxon processor to implement
1157 sophisticated indexing processes. It uses its own
1158 configuration file, which can include information for any number of
1159 languages. Each language's configuration can group
1160 words using one of two processes. In the
1161 enumerated process similar to that used in the kosek method,
1162 you indicate the groupings character-by-character.
1163 In the between-key process, you specify the
1164 break-points in the sort order that should start a new group.
1165 The latter configuration is useful for ideographic languages
1166 such as Chinese, Japanese, and Korean.
1167 You can also define your own collation algorithms and how you
1168 want mixed Latin-alphabet words sorted.</para>
1171 <para>For a whitepaper describing the extensions, see:
1172 <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>.
1176 <para>To download the extension library, see
1177 <link xlink:href="http://www.innodata-isogen.com/knowledge_center/tools_downloads/i18nsupport">http://www.innodata-isogen.com/knowledge_center/tools_downloads/i18nsupport</link>.
1182 <para>To use the kimber method, you must:</para>
1186 <para>Use Saxon (version 6 or 8) as your XSLT processor.
1190 <para>Install and configure the Innodata Isogen library, using
1191 the documentation that comes with it.
1195 <para>Set the index.method parameter's value to <quote>kimber</quote>.
1199 <para>Import the appropriate index extensions stylesheet module
1200 <filename>fo/autoidx-kimber.xsl</filename> or
1201 <filename>html/autoidx-kimber.xsl</filename> into your
1214 <refentry version="5.0" id="index.on.type">
1216 <refentrytitle>index.on.type</refentrytitle>
1217 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
1220 <refname>index.on.type</refname>
1221 <refpurpose>Select indexterms based on <tag class="attribute">type</tag>
1222 attribute value</refpurpose>
1226 <programlisting id="index.on.type.frag">
1227 <xsl:param name="index.on.type" select="0"></xsl:param>
1231 <refsection><info><title>Description</title></info>
1235 then an <tag>index</tag> element that has a
1236 <tag class="attribute">type</tag> attribute
1237 value will contain only those <tag>indexterm</tag>
1238 elements with a matching <tag class="attribute">type</tag> attribute value.
1239 If an <tag>index</tag> has no <tag class="attribute">type</tag>
1240 attribute or it is blank, then the index will contain
1241 all <tag>indexterm</tag>s in the current scope.
1245 If <literal>index.on.type</literal> is zero, then the
1246 <tag class="attribute">type</tag> attribute has no effect
1247 on selecting indexterms for an index.
1250 <para>For those using DocBook version 4.2 or earlier,
1251 the <tag class="attribute">type</tag> attribute is not available
1252 for index terms. However, you can achieve the same
1253 effect by using the <tag class="attribute">role</tag> attribute
1254 in the same manner on <tag>indexterm</tag>
1255 and <tag>index</tag>, and setting the stylesheet parameter
1256 <parameter>index.on.role</parameter> to a nonzero value.
1262 <refentry version="5.0" id="index.on.role">
1264 <refentrytitle>index.on.role</refentrytitle>
1265 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
1268 <refname>index.on.role</refname>
1269 <refpurpose>Select indexterms based on <tag class="attribute">role</tag> value</refpurpose>
1273 <programlisting id="index.on.role.frag">
1274 <xsl:param name="index.on.role" select="0"></xsl:param>
1278 <refsection><info><title>Description</title></info>
1282 then an <tag>index</tag> element that has a
1283 <tag class="attribute">role</tag> attribute
1284 value will contain only those <tag>indexterm</tag>
1285 elements with a matching role value.
1286 If an <tag>index</tag> has no <tag class="attribute">role</tag>
1287 attribute or it is blank, then the index will contain
1288 all <tag>indexterm</tag>s in the current scope.
1291 If <literal>index.on.role</literal> is zero, then the
1292 <tag class="attribute">role</tag> attribute has no effect
1293 on selecting indexterms for an index.
1296 <para>If you are using DocBook version 4.3 or later, you should
1297 use the <tag class="attribute">type</tag> attribute instead of <tag class="attribute">role</tag>
1298 on <tag>indexterm</tag> and <tag>index</tag>,
1299 and set the <parameter>index.on.type</parameter> to a nonzero
1306 <refentry version="5.0" id="index.links.to.section">
1308 <refentrytitle>index.links.to.section</refentrytitle>
1309 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
1312 <refname>index.links.to.section</refname>
1313 <refpurpose>HTML index entries link to container section title</refpurpose>
1317 <programlisting id="index.links.to.section.frag">
1318 <xsl:param name="index.links.to.section" select="1"></xsl:param>
1322 <refsection><info><title>Description</title></info>
1324 <para>If zero, then an index entry in an index links
1325 directly to the location of the
1326 generated <tag>anchor</tag> that is output
1327 for the indexterm. If two identical indexterm elements
1328 exist in the same section, then both entries appear
1329 in the index with the same title but link to different
1332 <para>If non-zero, then an index entry in an index links to the
1333 section title containing the <tag>indexterm</tag>, rather than
1334 directly to the <tag>anchor</tag> output for the indexterm.
1335 Duplicate indexterm entries in the same section are dropped.
1338 <para>The default value is 1, so index entries link to
1339 section titles by default.</para>
1341 <para>In both cases, the link text in an index entry is the
1342 title of the section containing the indexterm.
1343 That is because HTML does not have numbered pages.
1344 It also provides the reader with context information
1345 for each link.</para>
1347 <para>This parameter lets you choose which style of
1348 index linking you want. </para>
1352 <para>When set to 0, an index entry takes you
1353 to the precise location of its corresponding indexterm.
1354 However, if you have a lot of duplicate
1355 entries in sections, then you have a lot of duplicate
1356 titles in the index, which makes it more cluttered.
1357 The reader may not recognize why duplicate titles
1358 appear until they follow the links. Also, the links
1359 may land the reader in the middle of a section where the
1360 section title is not visible, which may also be
1361 confusing to the reader.</para>
1364 <para>When set to 1, an index entry link is
1365 less precise, but duplicate titles in the
1366 index entries are eliminated.
1367 Landing on the section title location may confirm the reader's
1368 expectation that a link that
1369 shows a section title will take them to that section title,
1370 not a location within the section.
1378 <refentry version="5.0" id="index.prefer.titleabbrev">
1380 <refentrytitle>index.prefer.titleabbrev</refentrytitle>
1381 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
1384 <refname>index.prefer.titleabbrev</refname>
1385 <refpurpose>Should abbreviated titles be used as back references?</refpurpose>
1389 <programlisting id="index.prefer.titleabbrev.frag">
1390 <xsl:param name="index.prefer.titleabbrev" select="0"></xsl:param>
1394 <refsection><info><title>Description</title></info>
1396 <para>If non-zero, and if a <tag>titleabbrev</tag> is defined, the abbreviated title
1397 is used as the link text of a back reference in the index.
1403 <refentry version="5.0" id="index.term.separator">
1405 <refentrytitle>index.term.separator</refentrytitle>
1406 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
1409 <refname>index.term.separator</refname>
1410 <refpurpose>Override for punctuation separating an index term
1411 from its list of page references in an index</refpurpose>
1415 <programlisting id="index.term.separator.frag">
1416 <xsl:param name="index.term.separator"></xsl:param>
1420 <refsection><info><title>Description</title></info>
1422 <para>This parameter permits you to override
1423 the text to insert between
1424 the end of an index term and its list of page references.
1425 Typically that might be a comma and a space.
1428 <para>Because this text may be locale dependent,
1429 this parameter's value is normally taken from a gentext
1430 template named 'term-separator' in the
1431 context 'index' in the stylesheet
1432 locale file for the language
1433 of the current document.
1434 This parameter can be used to override the gentext string,
1435 and would typically be used on the command line.
1436 This parameter would apply to all languages.
1439 <para>So this text string can be customized in two ways.
1440 You can reset the default gentext string using
1441 the <parameter>local.l10n.xml</parameter> parameter, or you can
1442 fill in the content for this normally empty
1444 The content can be a simple string, or it can be
1445 something more complex such as a call-template.
1446 For fo output, it could be an <tag>fo:leader</tag>
1447 element to provide space of a specific length, or a dot leader.
1453 <refentry version="5.0" id="index.number.separator">
1455 <refentrytitle>index.number.separator</refentrytitle>
1456 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
1459 <refname>index.number.separator</refname>
1460 <refpurpose>Override for punctuation separating page numbers in index</refpurpose>
1464 <programlisting id="index.number.separator.frag">
1465 <xsl:param name="index.number.separator"></xsl:param>
1469 <refsection><info><title>Description</title></info>
1471 <para>This parameter permits you to override the text to insert between
1472 page references in a formatted index entry. Typically
1473 that would be a comma and a space.
1476 <para>Because this text may be locale dependent,
1477 this parameter's value is normally taken from a gentext
1478 template named 'number-separator' in the
1479 context 'index' in the stylesheet
1480 locale file for the language
1481 of the current document.
1482 This parameter can be used to override the gentext string,
1483 and would typically be used on the command line.
1484 This parameter would apply to all languages.
1487 <para>So this text string can be customized in two ways.
1488 You can reset the default gentext string using
1489 the <parameter>local.l10n.xml</parameter> parameter, or you can
1490 override the gentext with the content of this parameter.
1491 The content can be a simple string, or it can be
1492 something more complex such as a call-template.
1495 <para>In HTML index output, section title references are used instead of
1496 page number references. This punctuation appears between
1497 such section titles in an HTML index.
1503 <refentry version="5.0" id="index.range.separator">
1505 <refentrytitle>index.range.separator</refentrytitle>
1506 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
1509 <refname>index.range.separator</refname>
1510 <refpurpose>Override for punctuation separating the two numbers
1511 in a page range in index</refpurpose>
1515 <programlisting id="index.range.separator.frag">
1516 <xsl:param name="index.range.separator"></xsl:param>
1520 <refsection><info><title>Description</title></info>
1522 <para>This parameter permits you
1523 to override the text to insert between
1524 the two numbers of a page range in an index.
1525 This parameter is only used by those XSL-FO processors
1526 that support an extension for generating such page ranges
1527 (such as XEP).</para>
1529 <para>Because this text may be locale dependent,
1530 this parameter's value is normally taken from a gentext
1531 template named 'range-separator' in the
1532 context 'index' in the stylesheet
1533 locale file for the language
1534 of the current document.
1535 This parameter can be used to override the gentext string,
1536 and would typically be used on the command line.
1537 This parameter would apply to all languages.
1540 <para>So this text string can be customized in two ways.
1541 You can reset the default gentext string using
1542 the <parameter>local.l10n.xml</parameter> parameter, or you can
1543 override the gentext with the content of this parameter.
1544 The content can be a simple string, or it can be
1545 something more complex such as a call-template.
1548 <para>In HTML index output, section title references are used instead of
1549 page number references. So there are no page ranges
1550 and this parameter has no effect.
1556 </reference><reference id="dbk_ext" xml:base="../html/param.xml"><title>Stylesheet Extensions</title>
1557 <refentry version="5.0" id="linenumbering.everyNth">
1559 <refentrytitle>linenumbering.everyNth</refentrytitle>
1560 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
1563 <refname>linenumbering.everyNth</refname>
1564 <refpurpose>Indicate which lines should be numbered</refpurpose>
1568 <programlisting id="linenumbering.everyNth.frag">
1569 <xsl:param name="linenumbering.everyNth">5</xsl:param>
1573 <refsection><info><title>Description</title></info>
1575 <para>If line numbering is enabled, everyNth line will be
1576 numbered. Note that numbering is one based, not zero based.
1582 <refentry version="5.0" id="linenumbering.extension">
1584 <refentrytitle>linenumbering.extension</refentrytitle>
1585 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
1588 <refname>linenumbering.extension</refname>
1589 <refpurpose>Enable the line numbering extension</refpurpose>
1593 <programlisting id="linenumbering.extension.frag">
1594 <xsl:param name="linenumbering.extension" select="1"></xsl:param>
1598 <refsection><info><title>Description</title></info>
1600 <para>If non-zero, verbatim environments (<tag>address</tag>, <tag>literallayout</tag>,
1601 <tag>programlisting</tag>, <tag>screen</tag>, <tag>synopsis</tag>) that specify line numbering will
1608 <refentry version="5.0" id="linenumbering.separator">
1610 <refentrytitle>linenumbering.separator</refentrytitle>
1611 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
1614 <refname>linenumbering.separator</refname>
1615 <refpurpose>Specify a separator between line numbers and lines</refpurpose>
1619 <programlisting id="linenumbering.separator.frag">
1620 <xsl:param name="linenumbering.separator"><xsl:text> </xsl:text></xsl:param>
1624 <refsection><info><title>Description</title></info>
1626 <para>The separator is inserted between line numbers and lines in the
1627 verbatim environment. The default value is a single white space.
1628 Note the interaction with <parameter>linenumbering.width</parameter>
1634 <refentry version="5.0" id="linenumbering.width">
1636 <refentrytitle>linenumbering.width</refentrytitle>
1637 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
1640 <refname>linenumbering.width</refname>
1641 <refpurpose>Indicates the width of line numbers</refpurpose>
1645 <programlisting id="linenumbering.width.frag">
1646 <xsl:param name="linenumbering.width">3</xsl:param>
1650 <refsection><info><title>Description</title></info>
1652 <para>If line numbering is enabled, line numbers will appear right
1653 justified in a field "width" characters wide.
1659 <refentry version="5.0" id="tablecolumns.extension">
1661 <refentrytitle>tablecolumns.extension</refentrytitle>
1662 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
1665 <refname>tablecolumns.extension</refname>
1666 <refpurpose>Enable the table columns extension function</refpurpose>
1670 <programlisting id="tablecolumns.extension.frag">
1671 <xsl:param name="tablecolumns.extension" select="1"></xsl:param>
1675 <refsection><info><title>Description</title></info>
1677 <para>The table columns extension function adjusts the widths of table
1678 columns in the HTML result to more accurately reflect the specifications
1685 <refentry version="5.0" id="textinsert.extension">
1687 <refentrytitle>textinsert.extension</refentrytitle>
1688 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
1691 <refname>textinsert.extension</refname>
1692 <refpurpose>Enables the textinsert extension element</refpurpose>
1695 <programlisting id="textinsert.extension.frag">
1696 <xsl:param name="textinsert.extension" select="1"></xsl:param>
1699 <refsection><info><title>Description</title></info>
1700 <para>The textinsert extension element inserts the contents of
1701 a file into the result tree (as text).</para>
1703 <para>To use the textinsert extension element, you must use
1704 either Saxon or Xalan as your XSLT processor (it doesn’t
1705 work with xsltproc), along with either the DocBook Saxon
1706 extensions or DocBook Xalan extensions (for more
1707 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
1708 the <parameter>use.extensions</parameter> and
1709 <parameter>textinsert.extension</parameter> parameters to
1710 <literal>1</literal>.</para>
1711 <para>As an alternative to using the textinsert element,
1712 consider using an Xinclude element with the
1713 <literal>parse="text"</literal> attribute and value
1714 specified, as detailed in <link role="tcg" xlink:href="ExternalCode.html#XIncludeCode">Using XInclude for text inclusions</link>.</para>
1717 <refsection><info><title>See Also</title></info>
1718 <para>You can also use the <tag class="xmlpi">dbhtml-include href</tag> processing
1719 instruction to insert external files — both files containing
1720 plain text and files with markup content (including HTML
1723 <refsection><info><title>More information</title></info>
1724 <para>For how-to documentation on inserting contents of
1725 external code files and other text files into output, see
1726 <link role="tcg" xlink:href="ExternalCode.html">External code files</link>.</para>
1727 <para>For guidelines on inserting contents of
1728 HTML files into output, see <link role="tcg" xlink:href="InsertExtHtml.html">Inserting external HTML code</link>.</para>
1732 <refentry version="5.0" id="textdata.default.encoding">
1734 <refentrytitle>textdata.default.encoding</refentrytitle>
1735 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
1738 <refname>textdata.default.encoding</refname>
1739 <refpurpose>Default encoding of external text files which are included
1740 using textdata element</refpurpose>
1744 <programlisting id="textdata.default.encoding.frag">
1745 <xsl:param name="textdata.default.encoding"></xsl:param>
1749 <refsection><info><title>Description</title></info>
1751 <para>Specifies the encoding of any external text files included using
1752 <tag>textdata</tag> element. This value is used only when you do
1753 not specify encoding by the appropriate attribute
1754 directly on textdata. An empty string is interpreted as the system
1755 default encoding.</para>
1760 <refentry version="5.0" id="graphicsize.extension">
1762 <refentrytitle>graphicsize.extension</refentrytitle>
1763 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
1766 <refname>graphicsize.extension</refname>
1767 <refpurpose>Enable the getWidth()/getDepth() extension functions</refpurpose>
1771 <programlisting id="graphicsize.extension.frag">
1772 <xsl:param name="graphicsize.extension" select="1"></xsl:param>
1776 <refsection><info><title>Description</title></info>
1778 <para>If non-zero (and if <parameter>use.extensions</parameter> is non-zero
1779 and if you're using a processor that supports extension functions), the
1780 <function>getWidth</function> and <function>getDepth</function> functions
1781 will be used to extract image sizes from graphics.</para>
1786 <refentry version="5.0" id="graphicsize.use.img.src.path">
1788 <refentrytitle>graphicsize.use.img.src.path</refentrytitle>
1789 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
1792 <refname>graphicsize.use.img.src.path</refname>
1793 <refpurpose>Prepend <parameter>img.src.path</parameter> before
1794 filenames passed to extension functions</refpurpose>
1798 <programlisting id="graphicsize.use.img.src.path.frag">
1799 <xsl:param name="graphicsize.use.img.src.path" select="0"></xsl:param>
1803 <refsection><info><title>Description</title></info>
1805 <para>If non-zero <parameter>img.src.path</parameter> parameter will
1806 be appended before filenames passed to extension functions for
1807 measuring image dimensions.</para>
1812 <refentry version="5.0" id="use.extensions">
1814 <refentrytitle>use.extensions</refentrytitle>
1815 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
1818 <refname>use.extensions</refname>
1819 <refpurpose>Enable extensions</refpurpose>
1823 <programlisting id="use.extensions.frag">
1824 <xsl:param name="use.extensions" select="0"></xsl:param>
1828 <refsection><info><title>Description</title></info>
1830 <para>If non-zero, extensions may be used. Each extension is
1831 further controlled by its own parameter. But if
1832 <parameter>use.extensions</parameter> is zero, no extensions will
1839 </reference><reference id="labels" xml:base="../html/param.xml"><title>Automatic labelling</title>
1840 <refentry version="5.0" id="chapter.autolabel">
1842 <refentrytitle>chapter.autolabel</refentrytitle>
1843 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
1844 <refmiscinfo class="other" otherclass="value">0<alt>none</alt></refmiscinfo>
1845 <refmiscinfo class="other" otherclass="value">1<alt>1,2,3...</alt></refmiscinfo>
1846 <refmiscinfo class="other" otherclass="value">A<alt>A,B,C...</alt></refmiscinfo>
1847 <refmiscinfo class="other" otherclass="value">a<alt>a,b,c...</alt></refmiscinfo>
1848 <refmiscinfo class="other" otherclass="value">i<alt>i,ii,iii...</alt></refmiscinfo>
1849 <refmiscinfo class="other" otherclass="value">I<alt>I,II,III...</alt></refmiscinfo>
1852 <refname>chapter.autolabel</refname>
1853 <refpurpose>Specifies the labeling format for Chapter titles</refpurpose>
1857 <programlisting id="chapter.autolabel.frag">
1858 <xsl:param name="chapter.autolabel" select="1"></xsl:param></programlisting>
1861 <refsection><info><title>Description</title></info>
1863 <para>If non-zero, then chapters will be numbered using the parameter
1864 value as the number format if the value matches one of the following:
1869 <term>1 or arabic</term>
1871 <para>Arabic numeration (1, 2, 3 ...).</para>
1875 <term>A or upperalpha</term>
1877 <para>Uppercase letter numeration (A, B, C ...).</para>
1881 <term>a or loweralpha</term>
1883 <para>Lowercase letter numeration (a, b, c ...).</para>
1887 <term>I or upperroman</term>
1889 <para>Uppercase roman numeration (I, II, III ...).</para>
1893 <term>i or lowerroman</term>
1895 <para>Lowercase roman letter numeration (i, ii, iii ...).</para>
1900 <para>Any nonzero value other than the above will generate
1901 the default number format (arabic).
1907 <refentry version="5.0" id="appendix.autolabel">
1909 <refentrytitle>appendix.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>appendix.autolabel</refname>
1920 <refpurpose>Specifies the labeling format for Appendix titles</refpurpose>
1924 <programlisting id="appendix.autolabel.frag">
1925 <xsl:param name="appendix.autolabel">A</xsl:param>
1929 <refsection><info><title>Description</title></info>
1931 <para>If non-zero, then appendices will be numbered using the
1932 parameter value as the number format if the value matches one of the
1938 <term>1 or arabic</term>
1940 <para>Arabic numeration (1, 2, 3 ...).</para>
1944 <term>A or upperalpha</term>
1946 <para>Uppercase letter numeration (A, B, C ...).</para>
1950 <term>a or loweralpha</term>
1952 <para>Lowercase letter numeration (a, b, c ...).</para>
1956 <term>I or upperroman</term>
1958 <para>Uppercase roman numeration (I, II, III ...).</para>
1962 <term>i or lowerroman</term>
1964 <para>Lowercase roman letter numeration (i, ii, iii ...).</para>
1969 <para>Any nonzero value other than the above will generate
1970 the default number format (upperalpha).
1976 <refentry version="5.0" id="part.autolabel">
1978 <refentrytitle>part.autolabel</refentrytitle>
1979 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
1980 <refmiscinfo class="other" otherclass="value">0<alt>none</alt></refmiscinfo>
1981 <refmiscinfo class="other" otherclass="value">1<alt>1,2,3...</alt></refmiscinfo>
1982 <refmiscinfo class="other" otherclass="value">A<alt>A,B,C...</alt></refmiscinfo>
1983 <refmiscinfo class="other" otherclass="value">a<alt>a,b,c...</alt></refmiscinfo>
1984 <refmiscinfo class="other" otherclass="value">i<alt>i,ii,iii...</alt></refmiscinfo>
1985 <refmiscinfo class="other" otherclass="value">I<alt>I,II,III...</alt></refmiscinfo>
1988 <refname>part.autolabel</refname>
1989 <refpurpose>Specifies the labeling format for Part titles</refpurpose>
1993 <programlisting id="part.autolabel.frag">
1994 <xsl:param name="part.autolabel">I</xsl:param>
1998 <refsection><info><title>Description</title></info>
2000 <para>If non-zero, then parts will be numbered using the parameter
2001 value as the number format if the value matches one of the following:
2006 <term>1 or arabic</term>
2008 <para>Arabic numeration (1, 2, 3 ...).</para>
2012 <term>A or upperalpha</term>
2014 <para>Uppercase letter numeration (A, B, C ...).</para>
2018 <term>a or loweralpha</term>
2020 <para>Lowercase letter numeration (a, b, c ...).</para>
2024 <term>I or upperroman</term>
2026 <para>Uppercase roman numeration (I, II, III ...).</para>
2030 <term>i or lowerroman</term>
2032 <para>Lowercase roman letter numeration (i, ii, iii ...).</para>
2037 <para>Any nonzero value other than the above will generate
2038 the default number format (upperroman).
2045 <refentry version="5.0" id="reference.autolabel">
2047 <refentrytitle>reference.autolabel</refentrytitle>
2048 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
2049 <refmiscinfo class="other" otherclass="value">0<alt>none</alt></refmiscinfo>
2050 <refmiscinfo class="other" otherclass="value">1<alt>1,2,3...</alt></refmiscinfo>
2051 <refmiscinfo class="other" otherclass="value">A<alt>A,B,C...</alt></refmiscinfo>
2052 <refmiscinfo class="other" otherclass="value">a<alt>a,b,c...</alt></refmiscinfo>
2053 <refmiscinfo class="other" otherclass="value">i<alt>i,ii,iii...</alt></refmiscinfo>
2054 <refmiscinfo class="other" otherclass="value">I<alt>I,II,III...</alt></refmiscinfo>
2057 <refname>reference.autolabel</refname>
2058 <refpurpose>Specifies the labeling format for Reference titles</refpurpose>
2061 <programlisting id="reference.autolabel.frag">
2062 <xsl:param name="reference.autolabel">I</xsl:param>
2065 <refsection><info><title>Description</title></info>
2066 <para>If non-zero, references will be numbered using the parameter
2067 value as the number format if the value matches one of the
2072 <term>1 or arabic</term>
2074 <para>Arabic numeration (1, 2, 3 ...).</para>
2078 <term>A or upperalpha</term>
2080 <para>Uppercase letter numeration (A, B, C ...).</para>
2084 <term>a or loweralpha</term>
2086 <para>Lowercase letter numeration (a, b, c ...).</para>
2090 <term>I or upperroman</term>
2092 <para>Uppercase roman numeration (I, II, III ...).</para>
2096 <term>i or lowerroman</term>
2098 <para>Lowercase roman letter numeration (i, ii, iii ...).</para>
2102 <para>Any non-zero value other than the above will generate
2103 the default number format (upperroman).
2108 <refentry version="5.0" id="preface.autolabel">
2110 <refentrytitle>preface.autolabel</refentrytitle>
2111 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
2112 <refmiscinfo class="other" otherclass="value">0<alt>none</alt></refmiscinfo>
2113 <refmiscinfo class="other" otherclass="value">1<alt>1,2,3...</alt></refmiscinfo>
2114 <refmiscinfo class="other" otherclass="value">A<alt>A,B,C...</alt></refmiscinfo>
2115 <refmiscinfo class="other" otherclass="value">a<alt>a,b,c...</alt></refmiscinfo>
2116 <refmiscinfo class="other" otherclass="value">i<alt>i,ii,iii...</alt></refmiscinfo>
2117 <refmiscinfo class="other" otherclass="value">I<alt>I,II,III...</alt></refmiscinfo>
2120 <refname>preface.autolabel</refname>
2121 <refpurpose>Specifices the labeling format for Preface titles</refpurpose>
2125 <programlisting id="preface.autolabel.frag"><xsl:param name="preface.autolabel" select="0"></xsl:param></programlisting>
2128 <refsection><info><title>Description</title></info>
2130 <para>If non-zero then prefaces will be numbered using the parameter
2131 value as the number format if the value matches one of the following:
2136 <term>1 or arabic</term>
2138 <para>Arabic numeration (1, 2, 3 ...).</para>
2142 <term>A or upperalpha</term>
2144 <para>Uppercase letter numeration (A, B, C ...).</para>
2148 <term>a or loweralpha</term>
2150 <para>Lowercase letter numeration (a, b, c ...).</para>
2154 <term>I or upperroman</term>
2156 <para>Uppercase roman numeration (I, II, III ...).</para>
2160 <term>i or lowerroman</term>
2162 <para>Lowercase roman letter numeration (i, ii, iii ...).</para>
2167 <para>Any nonzero value other than the above will generate
2168 the default number format (arabic).
2175 <refentry version="5.0" id="qandadiv.autolabel">
2177 <refentrytitle>qandadiv.autolabel</refentrytitle>
2178 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
2181 <refname>qandadiv.autolabel</refname>
2182 <refpurpose>Are divisions in QAndASets enumerated?</refpurpose>
2186 <programlisting id="qandadiv.autolabel.frag"><xsl:param name="qandadiv.autolabel" select="1"></xsl:param></programlisting>
2189 <refsection><info><title>Description</title></info>
2191 <para>If non-zero, unlabeled qandadivs will be enumerated.
2197 <refentry version="5.0" id="section.autolabel">
2199 <refentrytitle>section.autolabel</refentrytitle>
2200 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
2203 <refname>section.autolabel</refname>
2204 <refpurpose>Are sections enumerated?</refpurpose>
2208 <programlisting id="section.autolabel.frag"><xsl:param name="section.autolabel" select="0"></xsl:param></programlisting>
2211 <refsection><info><title>Description</title></info>
2213 <para>If true (non-zero), unlabeled sections will be enumerated.
2219 <refentry version="5.0" id="section.autolabel.max.depth">
2221 <refentrytitle>section.autolabel.max.depth</refentrytitle>
2222 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
2225 <refname>section.autolabel.max.depth</refname>
2226 <refpurpose>The deepest level of sections that are numbered.</refpurpose>
2230 <programlisting id="section.autolabel.max.depth.frag">
2231 <xsl:param name="section.autolabel.max.depth">8</xsl:param>
2235 <refsection><info><title>Description</title></info>
2237 <para>When section numbering is turned on by the
2238 <parameter>section.autolabel</parameter> parameter, then this
2239 parameter controls the depth of <tag>section</tag> nesting that is
2240 numbered. Sections nested to a level deeper than this value will not
2247 <refentry version="5.0" id="section.label.includes.component.label">
2249 <refentrytitle>section.label.includes.component.label</refentrytitle>
2250 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
2253 <refname>section.label.includes.component.label</refname>
2254 <refpurpose>Do section labels include the component label?</refpurpose>
2258 <programlisting id="section.label.includes.component.label.frag"><xsl:param name="section.label.includes.component.label" select="0"></xsl:param></programlisting>
2261 <refsection><info><title>Description</title></info>
2263 <para>If non-zero, section labels are prefixed with the label of the
2264 component that contains them.
2270 <refentry version="5.0" id="label.from.part">
2272 <refentrytitle>label.from.part</refentrytitle>
2273 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
2276 <refname>label.from.part</refname>
2277 <refpurpose>Renumber components in each part?</refpurpose>
2281 <programlisting id="label.from.part.frag">
2282 <xsl:param name="label.from.part" select="0"></xsl:param>
2286 <refsection><info><title>Description</title></info>
2288 <para>If <parameter>label.from.part</parameter> is non-zero, then
2289 numbering of components — <tag>preface</tag>,
2290 <tag>chapter</tag>, <tag>appendix</tag>, and
2291 <tag>reference</tag> (when <tag>reference</tag> occurs at the
2292 component level) — is re-started within each
2293 <tag>part</tag>.</para>
2294 <para>If <parameter>label.from.part</parameter> is zero (the
2295 default), numbering of components is <emphasis>not</emphasis>
2296 re-started within each <tag>part</tag>; instead, components are
2297 numbered sequentially throughout each <tag>book</tag>,
2298 regardless of whether or not they occur within <tag>part</tag>
2304 <refentry version="5.0" id="component.label.includes.part.label">
2306 <refentrytitle>component.label.includes.part.label</refentrytitle>
2307 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
2310 <refname>component.label.includes.part.label</refname>
2311 <refpurpose>Do component labels include the part label?</refpurpose>
2315 <programlisting id="component.label.includes.part.label.frag"><xsl:param name="component.label.includes.part.label" select="0"></xsl:param></programlisting>
2318 <refsection><info><title>Description</title></info>
2320 <para>If non-zero, number labels for <tag>chapter</tag>,
2321 <tag>appendix</tag>, and other component elements are prefixed with
2322 the label of the part element that contains them. So you might see
2323 Chapter II.3 instead of Chapter 3. Also, the labels for formal
2324 elements such as <tag>table</tag> and <tag>figure</tag> will include
2325 the part label. If there is no part element container, then no prefix
2329 This feature is most useful when the
2330 <parameter>label.from.part</parameter> parameter is turned on.
2331 In that case, there would be more than one <tag>chapter</tag>
2332 <quote>1</quote>, and the extra part label prefix will identify
2333 each chapter unambiguously.
2339 </reference><reference id="html" xml:base="../html/param.xml"><title>HTML</title>
2340 <refentry version="5.0" id="html.base">
2342 <refentrytitle>html.base</refentrytitle>
2343 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
2346 <refname>html.base</refname>
2347 <refpurpose>An HTML base URI</refpurpose>
2351 <programlisting id="html.base.frag">
2352 <xsl:param name="html.base"></xsl:param></programlisting>
2355 <refsection><info><title>Description</title></info>
2357 <para>If html.base is set, it is used for the <tag>base</tag> element
2358 in the <tag>head</tag> of the html documents. The parameter specifies
2359 the base URL for all relative URLs in the document. This is useful
2360 for dynamically served html where the base URI needs to be
2366 <refentry version="5.0" id="html.stylesheet.type">
2368 <refentrytitle>html.stylesheet.type</refentrytitle>
2369 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
2372 <refname>html.stylesheet.type</refname>
2373 <refpurpose>The type of the stylesheet used in the generated HTML</refpurpose>
2377 <programlisting id="html.stylesheet.type.frag"><xsl:param name="html.stylesheet.type">text/css</xsl:param></programlisting>
2380 <refsection><info><title>Description</title></info>
2382 <para>The type of the stylesheet to place in the HTML <tag>link</tag> tag.
2388 <refentry version="5.0" id="html.stylesheet">
2390 <refentrytitle>html.stylesheet</refentrytitle>
2391 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
2394 <refname>html.stylesheet</refname>
2395 <refpurpose>Name of the stylesheet(s) to use in the generated HTML</refpurpose>
2399 <programlisting id="html.stylesheet.frag">
2400 <xsl:param name="html.stylesheet"></xsl:param>
2404 <refsection><info><title>Description</title></info>
2406 <para>The <parameter>html.stylesheet</parameter> parameter is either
2407 empty, indicating that no stylesheet <tag>link</tag> tag should be
2408 generated in the html output, or it is a list of one or more
2409 stylesheet files.</para>
2411 <para>Multiple stylesheets are space-delimited. If you need to
2412 reference a stylesheet URI that includes a space, encode it with
2413 <literal>%20</literal>. A separate html <literal>link</literal> element will
2414 be generated for each stylesheet in the order they are listed in the
2420 <refentry version="5.0" id="css.decoration">
2422 <refentrytitle>css.decoration</refentrytitle>
2423 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
2426 <refname>css.decoration</refname>
2427 <refpurpose>Enable CSS decoration of elements</refpurpose>
2431 <programlisting id="css.decoration.frag">
2432 <xsl:param name="css.decoration" select="1"></xsl:param>
2436 <refsection><info><title>Description</title></info>
2439 If non-zero, then html elements produced by the stylesheet may be
2440 decorated with <literal>style</literal> attributes. For example, the
2441 <literal>li</literal> tags produced for list items may include a
2442 fragment of CSS in the <literal>style</literal> attribute which sets
2443 the CSS property "list-style-type".
2449 <refentry version="5.0" id="spacing.paras">
2451 <refentrytitle>spacing.paras</refentrytitle>
2452 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
2455 <refname>spacing.paras</refname>
2456 <refpurpose>Insert additional <p> elements for spacing?</refpurpose>
2460 <programlisting id="spacing.paras.frag">
2461 <xsl:param name="spacing.paras" select="0"></xsl:param>
2465 <refsection><info><title>Description</title></info>
2467 <para>When non-zero, additional, empty paragraphs are inserted in
2468 several contexts (for example, around informal figures), to create a
2469 more pleasing visual appearance in many browsers.
2475 <refentry version="5.0" id="emphasis.propagates.style">
2477 <refentrytitle>emphasis.propagates.style</refentrytitle>
2478 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
2481 <refname>emphasis.propagates.style</refname>
2482 <refpurpose>Pass emphasis role attribute through to HTML?</refpurpose>
2485 <programlisting id="emphasis.propagates.style.frag">
2486 <xsl:param name="emphasis.propagates.style" select="1"></xsl:param>
2489 <refsection><info><title>Description</title></info>
2490 <para>If non-zero, the <literal>role</literal> attribute of
2491 <tag>emphasis</tag> elements will be passed through to the HTML as a
2492 class attribute on a <literal>span</literal> that surrounds the
2497 <refentry version="5.0" id="para.propagates.style">
2499 <refentrytitle>para.propagates.style</refentrytitle>
2500 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
2503 <refname>para.propagates.style</refname>
2504 <refpurpose>Pass para role attribute through to HTML?</refpurpose>
2508 <programlisting id="para.propagates.style.frag">
2509 <xsl:param name="para.propagates.style" select="1"></xsl:param>
2513 <refsection><info><title>Description</title></info>
2515 <para>If true, the role attribute of <tag>para</tag> elements
2516 will be passed through to the HTML as a class attribute on the
2517 <tag>p</tag> generated for the paragraph.</para>
2522 <refentry version="5.0" id="phrase.propagates.style">
2524 <refentrytitle>phrase.propagates.style</refentrytitle>
2525 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
2528 <refname>phrase.propagates.style</refname>
2529 <refpurpose>Pass phrase role attribute through to HTML?</refpurpose>
2533 <programlisting id="phrase.propagates.style.frag">
2534 <xsl:param name="phrase.propagates.style" select="1"></xsl:param></programlisting>
2537 <refsection><info><title>Description</title></info>
2539 <para>If non-zero, the role attribute of <tag>phrase</tag> elements
2540 will be passed through to the HTML as a <literal>class</literal>
2541 attribute on a <literal>span</literal> that surrounds the
2547 <refentry version="5.0" id="entry.propagates.style">
2549 <refentrytitle>entry.propagates.style</refentrytitle>
2550 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
2553 <refname>entry.propagates.style</refname>
2554 <refpurpose>Pass entry role attribute through to HTML?</refpurpose>
2558 <programlisting id="entry.propagates.style.frag">
2559 <xsl:param name="entry.propagates.style" select="1"></xsl:param>
2563 <refsection><info><title>Description</title></info>
2565 <para>If true, the role attribute of <tag>entry</tag> elements
2566 will be passed through to the HTML as a class attribute on the
2567 <tag>td</tag> or <tag>th</tag> generated for the table
2573 <refentry version="5.0" id="html.longdesc">
2575 <refentrytitle>html.longdesc</refentrytitle>
2576 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
2579 <refname>html.longdesc</refname>
2580 <refpurpose>Should longdesc URIs be created?</refpurpose>
2583 <programlisting id="html.longdesc.frag">
2584 <xsl:param name="html.longdesc" select="1"></xsl:param>
2587 <refsection><info><title>Description</title></info>
2588 <para>If non-zero, HTML files will be created for the
2589 <literal>longdesc</literal> attribute. These files
2590 are created from the <tag>textobject</tag>s in
2591 <tag>mediaobject</tag>s and
2592 <tag>inlinemediaobject</tag>.
2597 <refentry version="5.0" id="html.longdesc.link">
2599 <refentrytitle>html.longdesc.link</refentrytitle>
2600 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
2603 <refname>html.longdesc.link</refname>
2604 <refpurpose>Should a link to the longdesc be included in the HTML?</refpurpose>
2608 <programlisting id="html.longdesc.link.frag">
2609 <xsl:param name="html.longdesc.link" select="$html.longdesc"></xsl:param>
2613 <refsection><info><title>Description</title></info>
2615 <para>If non-zero, links will be created to the
2616 HTML files created for the
2617 <literal>longdesc</literal> attribute. It makes no
2618 sense to enable this option without also enabling the
2619 <parameter>html.longdesc</parameter> parameter.</para>
2626 <refentry version="5.0" id="make.valid.html">
2628 <refentrytitle>make.valid.html</refentrytitle>
2629 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
2632 <refname>make.valid.html</refname>
2633 <refpurpose>Attempt to make sure the HTML output is valid HTML</refpurpose>
2637 <programlisting id="make.valid.html.frag">
2638 <xsl:param name="make.valid.html" select="0"></xsl:param>
2642 <refsection><info><title>Description</title></info>
2644 <para>If <parameter>make.valid.html</parameter> is true, the stylesheets take
2645 extra effort to ensure that the resulting HTML is valid. This may mean that some
2646 <tag>para</tag> tags are translated into HTML <tag>div</tag>s or
2647 that other substitutions occur.</para>
2649 <para>This parameter is different from <parameter>html.cleanup</parameter>
2650 because it changes the resulting markup; it does not use extension functions
2651 to manipulate result-tree-fragments and is therefore applicable to any
2652 XSLT processor.</para>
2657 <refentry version="5.0" id="html.cleanup">
2659 <refentrytitle>html.cleanup</refentrytitle>
2660 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
2663 <refname>html.cleanup</refname>
2664 <refpurpose>Attempt to clean up the resulting HTML?</refpurpose>
2668 <programlisting id="html.cleanup.frag">
2669 <xsl:param name="html.cleanup" select="1"></xsl:param>
2673 <refsection><info><title>Description</title></info>
2675 <para>If non-zero, and if the <link xlink:href="http://www.exslt.org/">EXSLT</link>
2676 extensions are supported by your processor, the resulting HTML will be
2677 <quote>cleaned up</quote>. This improves the chances that the
2678 resulting HTML will be valid. It may also improve the formatting of
2679 some elements.</para>
2681 <para>This parameter is different from <parameter>make.valid.html</parameter>
2682 because it uses extension functions to manipulate result-tree-fragments.</para>
2687 <refentry version="5.0" id="html.append">
2689 <refentrytitle>html.append</refentrytitle>
2690 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
2693 <refname>html.append</refname>
2694 <refpurpose>Specifies content to append to HTML output</refpurpose>
2698 <programlisting id="html.append.frag"><xsl:param name="html.append"></xsl:param></programlisting>
2701 <refsection><info><title>Description</title></info>
2703 <para>Specifies content to append to the end of HTML files output by
2704 the <filename>html/docbook.xsl</filename> stylesheet, after the
2705 closing <code><html></code> tag. You probably don’t want to set any
2706 value for this parameter; but if you do, the only value it should ever
2707 be set to is a newline character: <code>&#x0a;</code> or
2708 <code>&#10;</code></para>
2713 <refentry version="5.0" id="draft.mode">
2715 <refentrytitle>draft.mode</refentrytitle>
2716 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
2717 <refmiscinfo class="other" otherclass="value">no</refmiscinfo>
2718 <refmiscinfo class="other" otherclass="value">yes</refmiscinfo>
2719 <refmiscinfo class="other" otherclass="value">maybe</refmiscinfo>
2722 <refname>draft.mode</refname>
2723 <refpurpose>Select draft mode</refpurpose>
2727 <programlisting id="draft.mode.frag">
2728 <xsl:param name="draft.mode">no</xsl:param>
2732 <refsection><info><title>Description</title></info>
2734 <para>Selects draft mode. If <parameter>draft.mode</parameter> is
2735 <quote><literal>yes</literal></quote>, the entire document will be treated
2736 as a draft. If it is <quote><literal>no</literal></quote>, the entire document
2737 will be treated as a final copy. If it is <quote><literal>maybe</literal></quote>,
2738 individual sections will be treated as draft or final independently, depending
2739 on how their <literal>status</literal> attribute is set.
2745 <refentry version="5.0" id="draft.watermark.image">
2747 <refentrytitle>draft.watermark.image</refentrytitle>
2748 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
2751 <refname>draft.watermark.image</refname>
2752 <refpurpose>The URI of the image to be used for draft watermarks</refpurpose>
2756 <programlisting id="draft.watermark.image.frag">
2757 <xsl:param name="draft.watermark.image">images/draft.png</xsl:param>
2761 <refsection><info><title>Description</title></info>
2763 <para>The image to be used for draft watermarks.</para>
2768 <refentry version="5.0" id="generate.id.attributes">
2770 <refentrytitle>generate.id.attributes</refentrytitle>
2771 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
2774 <refname>generate.id.attributes</refname>
2775 <refpurpose>Generate ID attributes on container elements?</refpurpose>
2779 <programlisting id="generate.id.attributes.frag">
2780 <xsl:param name="generate.id.attributes" select="0"></xsl:param>
2784 <refsection><info><title>Description</title></info>
2786 <para>If non-zero, the HTML stylesheet will generate ID attributes on
2787 containers. For example, the markup:</para>
2789 <screen><section id="foo"><title>Some Title</title>
2790 <para>Some para.</para>
2791 </section></screen>
2793 <para>might produce:</para>
2795 <screen><div class="section" id="foo">
2796 <h2>Some Title</h2>
2797 <p>Some para.</p>
2798 </div></screen>
2800 <para>The alternative is to generate anchors:</para>
2802 <screen><div class="section">
2803 <h2><a name="foo"></a>Some Title</h2>
2804 <p>Some para.</p>
2805 </div></screen>
2807 <para>Because the <tag class="attribute">name</tag> attribute of
2808 the <tag>a</tag> element and the <tag class="attribute">id</tag>
2809 attribute of other tags are both of type <quote>ID</quote>, producing both
2810 generates invalid documents.</para>
2812 <para>As of version 1.50, you can use this switch to control which type of
2813 identifier is generated. For backwards-compatibility, generating
2814 <tag>a</tag> anchors is preferred.</para>
2816 <para>Note: at present, this switch is incompletely implemented.
2817 Disabling ID attributes will suppress them, but enabling ID attributes
2818 will not suppress the anchors.</para>
2823 <refentry version="5.0" id="generate.meta.abstract">
2825 <refentrytitle>generate.meta.abstract</refentrytitle>
2826 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
2829 <refname>generate.meta.abstract</refname>
2830 <refpurpose>Generate HTML <tag>META</tag> element from <tag>abstract</tag>?</refpurpose>
2834 <programlisting id="generate.meta.abstract.frag">
2835 <xsl:param name="generate.meta.abstract" select="1"></xsl:param>
2839 <refsection><info><title>Description</title></info>
2841 <para>If non-zero, document abstracts will be reproduced in the HTML
2842 <literal>head</literal>, with <literal>>meta name="description" content="..."</literal></para>
2848 <refentry version="5.0" id="make.clean.html">
2850 <refentrytitle>make.clean.html</refentrytitle>
2851 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
2854 <refname>make.clean.html</refname>
2855 <refpurpose>Make HTML conform to modern coding standards</refpurpose>
2859 <programlisting id="make.clean.html.frag">
2860 <xsl:param name="make.clean.html" select="0"></xsl:param>
2864 <refsection><info><title>Description</title></info>
2866 <para>If <parameter>make.clean.html</parameter> is true, the stylesheets take
2867 extra effort to ensure that the resulting HTML is conforms to
2868 modern HTML coding standards. In addition to eliminating
2869 excessive and noncompliant coding, it moves presentation
2870 HTML coding to a CSS stylesheet.</para>
2872 <para>The resulting HTML is dependent on
2873 CSS for formatting, and so the stylesheet is capable of
2874 generating a supporting CSS file. The <parameter>docbook.css.source</parameter>
2875 and <parameter>custom.css.source</parameter> parameters control
2876 how a CSS file is generated.</para>
2878 <para>If you require your CSS to reside in the HTML
2879 <tag>head</tag> element, then the <parameter>generate.css.header</parameter>
2880 can be used to do that.</para>
2882 <para>The <parameter>make.clean.html</parameter> parameter is
2883 different from <parameter>html.cleanup</parameter>
2884 because the former changes the resulting markup; it does not use extension functions
2885 like the latter to manipulate result-tree-fragments,
2886 and is therefore applicable to any XSLT processor.</para>
2888 <para>If <parameter>make.clean.html</parameter> is set to zero (the default),
2889 then the stylesheet retains its original
2890 <quote>old style</quote>
2891 HTML formatting features.</para>
2895 <refentry version="5.0" id="docbook.css.source">
2897 <refentrytitle>docbook.css.source</refentrytitle>
2898 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
2901 <refname>docbook.css.source</refname>
2902 <refpurpose>Name of the default CSS input file</refpurpose>
2906 <programlisting id="docbook.css.source.frag"><xsl:param name="docbook.css.source">docbook.css.xml</xsl:param></programlisting>
2909 <refsection><info><title>Description</title></info>
2911 <para>The <parameter>docbook.css.source</parameter> parameter
2912 specifies the name of the file containing the default DocBook
2913 CSS styles. Those styles are necessary when the
2914 <parameter>make.clean.html</parameter> parameter is nonzero.</para>
2916 <para>The file is a well-formed XML file that
2917 must consist of a single <tag>style</tag> root
2918 element that contains CSS styles as its text content.
2919 The default value of the parameter (and filename)
2920 is <literal>docbook.css.xml</literal>.
2921 The stylesheets ship with the default file. You can substitute
2922 your own and specify its path in this parameter.</para>
2924 <para>If <parameter>docbook.css.source</parameter> is not blank,
2925 and <parameter>make.clean.html</parameter> is nonzero, then
2926 the stylesheet takes the following actions:</para>
2930 <para>The stylesheet uses the XSLT <literal>document()</literal>
2931 function to open the file specified by the parameter and
2932 load it into a variable.</para>
2935 <para>The stylesheet forms an output pathname consisting of the
2936 value of the <parameter>base.dir</parameter> parameter (if it is set)
2937 and the value of <parameter>docbook.css.source</parameter>,
2938 with the <literal>.xml</literal> suffix stripped off.
2942 <para>The stylesheet removes the <tag>style</tag>
2943 wrapper element and writes just the CSS text content to the output file.</para>
2946 <para>The stylesheet adds a <tag>link</tag> element to the
2947 HTML <tag>HEAD</tag> element to reference the external CSS stylesheet.
2949 <programlisting><link rel="stylesheet" href="docbook.css" type="text/css">
2951 <para>However, if the <parameter>docbook.css.link</parameter>
2952 parameter is set to zero, then no <tag>link</tag> is written
2953 for the default CSS file. That is useful if a custom
2954 CSS file will import the default CSS stylesheet to ensure
2955 proper cascading of styles.</para>
2959 <para>If the <parameter>docbook.css.source</parameter> parameter
2960 is changed from its default <literal>docbook.css.xml</literal> to blank,
2961 then no default CSS is generated. Likewise if the
2962 <parameter>make.clean.html</parameter> parameter is set to zero,
2963 then no default CSS is generated. The
2964 <parameter>custom.css.source</parameter> parameter can be used
2965 instead to generate a complete custom CSS file.</para>
2967 <para>You can use the <parameter>generate.css.header</parameter>
2968 parameter to instead write the CSS to each HTML <tag>HEAD</tag>
2969 element in a <tag>style</tag> tag instead of an external CSS file.</para>
2974 <refentry version="5.0" id="docbook.css.link">
2976 <refentrytitle>docbook.css.link</refentrytitle>
2977 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
2980 <refname>docbook.css.link</refname>
2981 <refpurpose>Insert a link referencing the default CSS stylesheet</refpurpose>
2985 <programlisting id="docbook.css.link.frag">
2986 <xsl:param name="docbook.css.link" select="1"></xsl:param>
2990 <refsection><info><title>Description</title></info>
2992 <para>The stylesheets are capable of generating a default
2993 CSS stylesheet file. The parameters
2994 <parameter>make.clean.html</parameter> and
2995 <parameter>docbook.css.source</parameter> control that feature.</para>
2997 <para>Normally if a default CSS file is generated, then
2998 the stylesheet inserts a <tag>link</tag> tag in the HTML
2999 <tag>HEAD</tag> element to reference it.
3000 However, you can omit that <tag>link</tag> reference if
3001 you set the <parameter>docbook.css.link</parameter> to zero
3002 (1 is the default).</para>
3004 <para>This parameter is useful when you want to import the
3005 default CSS into a custom CSS file generated using the
3006 <parameter>custom.css.source</parameter> parameter.
3012 <refentry version="5.0" id="custom.css.source">
3014 <refentrytitle>custom.css.source</refentrytitle>
3015 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
3018 <refname>custom.css.source</refname>
3019 <refpurpose>Name of a custom CSS input file</refpurpose>
3023 <programlisting id="custom.css.source.frag"><xsl:param name="custom.css.source"></xsl:param></programlisting>
3026 <refsection><info><title>Description</title></info>
3028 <para>The <parameter>custom.css.source</parameter>
3029 parameter enables you to add CSS styles to DocBook's
3033 specifies the name of a file containing custom
3034 CSS styles. The file must be a well-formed XML file that
3035 consists of a single <tag>style</tag> root
3036 element that contains CSS styles as its text content.
3038 <programlisting><?xml version="1.0"?>
3048 <para>The filename specified by the parameter
3049 should have a <literal>.xml</literal>
3050 filename suffix, although that is not required.
3051 The default value of this parameter is blank.</para>
3053 <para>If <parameter>custom.css.source</parameter> is not blank, then
3054 the stylesheet takes the following actions.
3055 These actions take place regardless of the value of
3056 the <parameter>make.clean.html</parameter> parameter.</para>
3060 <para>The stylesheet uses the XSLT <literal>document()</literal>
3061 function to open the file specified by the parameter and
3062 load it into a variable.</para>
3065 <para>The stylesheet forms an output pathname consisting of the
3066 value of the <parameter>base.dir</parameter> parameter (if it is set)
3067 and the value of <parameter>custom.css.source</parameter>,
3068 with the <literal>.xml</literal> suffix stripped off.
3072 <para>The stylesheet removes the <tag>style</tag>
3073 wrapper element and writes just the CSS text content to the output file.</para>
3076 <para>The stylesheet adds a <tag>link</tag> element to the
3077 HTML <tag>HEAD</tag> element to reference this external CSS stylesheet.
3079 <programlisting><link rel="stylesheet" href="custom.css" type="text/css">
3087 <para>If the <parameter>make.clean.html</parameter> parameter is nonzero
3088 (the default is zero),
3089 and if the <parameter>docbook.css.source</parameter> parameter
3090 is not blank (the default is not blank),
3091 then the stylesheet will also generate a default CSS file
3092 and add a <tag>link</tag> tag to reference it.
3093 The <tag>link</tag> to the custom CSS comes after the
3094 <tag>link</tag> to the default, so it should cascade properly
3096 If you do not want two <tag>link</tag> tags, and
3097 instead want your custom CSS to import the default generated
3098 CSS file, then do the following:
3103 <para>Add a line like the following to your custom CSS source file:</para>
3104 <programlisting>@import url("docbook.css")
3108 <para>Set the <parameter>docbook.css.link</parameter> parameter
3109 to zero. This will omit the <tag>link</tag> tag
3110 that references the default CSS file.</para>
3114 <para>If you set <parameter>make.clean.html</parameter> to nonzero but
3115 you do not want the default CSS generated, then also set
3116 the <parameter>docbook.css.source</parameter> parameter to blank.
3117 Then no default CSS will be generated, and so
3118 all CSS styles must come from your custom CSS file.</para>
3120 <para>You can use the <parameter>generate.css.header</parameter>
3121 parameter to instead write the CSS to each HTML <tag>HEAD</tag>
3122 element in a <tag>style</tag> tag instead of an external CSS file.</para>
3127 <refentry version="5.0" id="generate.css.header">
3129 <refentrytitle>generate.css.header</refentrytitle>
3130 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3133 <refname>generate.css.header</refname>
3134 <refpurpose>Insert generated CSS styles in HEAD element</refpurpose>
3138 <programlisting id="generate.css.header.frag">
3139 <xsl:param name="generate.css.header" select="0"></xsl:param>
3143 <refsection><info><title>Description</title></info>
3145 <para>The stylesheets are capable of generating both default
3146 and custom CSS stylesheet files. The parameters
3147 <parameter>make.clean.html</parameter>,
3148 <parameter>docbook.css.source</parameter>, and
3149 <parameter>custom.css.source</parameter> control that feature.</para>
3151 <para>If you require that CSS styles reside in the HTML
3152 <tag>HEAD</tag> element instead of external CSS files,
3153 then set the <parameter>generate.css.header</parameter>
3154 parameter to nonzero (it is zero by default).
3155 Then instead of generating the CSS in external files,
3156 they are wrapped in <tag>style</tag> elements in
3157 the <tag>HEAD</tag> element of each HTML output file.
3163 </reference><reference id="xslt" xml:base="../html/param.xml"><title>XSLT Processing</title>
3164 <refentry version="5.0" id="rootid">
3166 <refentrytitle>rootid</refentrytitle>
3167 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
3170 <refname>rootid</refname>
3171 <refpurpose>Specify the root element to format</refpurpose>
3175 <programlisting id="rootid.frag">
3176 <xsl:param name="rootid"></xsl:param></programlisting>
3179 <refsection><info><title>Description</title></info>
3181 <para>If <parameter>rootid</parameter> is not empty, it must be the
3182 value of an ID that occurs in the document being formatted. The entire
3183 document will be loaded and parsed, but formatting will begin at the
3184 element identified, rather than at the root. For example, this allows
3185 you to process only <tag>chapter</tag> 4 of a <tag>book</tag>.</para>
3186 <para>Because the entire document is available to the processor, automatic
3187 numbering, cross references, and other dependencies are correctly
3193 <refentry version="5.0" id="suppress.navigation">
3195 <refentrytitle>suppress.navigation</refentrytitle>
3196 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3199 <refname>suppress.navigation</refname>
3200 <refpurpose>Disable header and footer navigation</refpurpose>
3204 <programlisting id="suppress.navigation.frag">
3205 <xsl:param name="suppress.navigation" select="0"></xsl:param>
3209 <refsection><info><title>Description</title></info>
3212 If non-zero, header and footer navigation will be suppressed.</para>
3217 <refentry version="5.0" id="suppress.header.navigation">
3219 <refentrytitle>suppress.header.navigation</refentrytitle>
3220 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3223 <refname>suppress.header.navigation</refname>
3224 <refpurpose>Disable header navigation</refpurpose>
3228 <programlisting id="suppress.header.navigation.frag">
3229 <xsl:param name="suppress.header.navigation" select="0"></xsl:param>
3233 <refsection><info><title>Description</title></info>
3235 <para>If non-zero, header navigation will be suppressed.</para>
3240 <refentry version="5.0" id="suppress.footer.navigation">
3242 <refentrytitle>suppress.footer.navigation</refentrytitle>
3243 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3246 <refname>suppress.footer.navigation</refname>
3247 <refpurpose>Disable footer navigation</refpurpose>
3251 <programlisting id="suppress.footer.navigation.frag"><xsl:param name="suppress.footer.navigation">0</xsl:param></programlisting>
3254 <refsection><info><title>Description</title></info>
3257 If non-zero, footer navigation will be suppressed.</para>
3262 <refentry version="5.0" id="header.rule">
3264 <refentrytitle>header.rule</refentrytitle>
3265 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3268 <refname>header.rule</refname>
3269 <refpurpose>Rule under headers?</refpurpose>
3273 <programlisting id="header.rule.frag">
3274 <xsl:param name="header.rule" select="1"></xsl:param>
3278 <refsection><info><title>Description</title></info>
3280 <para>If non-zero, a rule will be drawn below the page headers.</para>
3285 <refentry version="5.0" id="footer.rule">
3287 <refentrytitle>footer.rule</refentrytitle>
3288 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3291 <refname>footer.rule</refname>
3292 <refpurpose>Rule over footers?</refpurpose>
3296 <programlisting id="footer.rule.frag">
3297 <xsl:param name="footer.rule" select="1"></xsl:param>
3301 <refsection><info><title>Description</title></info>
3303 <para>If non-zero, a rule will be drawn above the page footers.</para>
3308 <refentry version="5.0" id="id.warnings">
3310 <refentrytitle>id.warnings</refentrytitle>
3311 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3314 <refname>id.warnings</refname>
3315 <refpurpose>Should warnings be generated for titled elements without IDs?</refpurpose>
3318 <programlisting id="id.warnings.frag">
3319 <xsl:param name="id.warnings" select="0"></xsl:param>
3322 <refsection><info><title>Description</title></info>
3323 <para>If non-zero, the stylesheet will issue a warning for any element
3324 (other than the root element) which has a <tag>title</tag> but does not have an
3329 </reference><reference id="meta" xml:base="../html/param.xml"><title>Meta/*Info and Titlepages</title>
3330 <refentry version="5.0" id="inherit.keywords">
3332 <refentrytitle>inherit.keywords</refentrytitle>
3333 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3336 <refname>inherit.keywords</refname>
3337 <refpurpose>Inherit keywords from ancestor elements?</refpurpose>
3341 <programlisting id="inherit.keywords.frag">
3342 <xsl:param name="inherit.keywords" select="1"></xsl:param></programlisting>
3345 <refsection><info><title>Description</title></info>
3347 <para>If <parameter>inherit.keywords</parameter>
3348 is non-zero, the keyword <literal>meta</literal> for each HTML
3349 <literal>head</literal> element will include all of the keywords from
3350 ancestor elements. Otherwise, only the keywords from the current section
3357 <refentry version="5.0" id="make.single.year.ranges">
3359 <refentrytitle>make.single.year.ranges</refentrytitle>
3360 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3363 <refname>make.single.year.ranges</refname>
3364 <refpurpose>Print single-year ranges (e.g., 1998-1999)</refpurpose>
3368 <programlisting id="make.single.year.ranges.frag">
3369 <xsl:param name="make.single.year.ranges" select="0"></xsl:param></programlisting>
3372 <refsection><info><title>Description</title></info>
3374 <para>If non-zero, year ranges that span a single year will be printed
3375 in range notation (1998-1999) instead of discrete notation
3376 (1998, 1999).</para>
3381 <refentry version="5.0" id="make.year.ranges">
3383 <refentrytitle>make.year.ranges</refentrytitle>
3384 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3387 <refname>make.year.ranges</refname>
3388 <refpurpose>Collate copyright years into ranges?</refpurpose>
3392 <programlisting id="make.year.ranges.frag"><xsl:param name="make.year.ranges" select="0"></xsl:param></programlisting>
3395 <refsection><info><title>Description</title></info>
3397 <para>If non-zero, multiple copyright <tag>year</tag> elements will be
3398 collated into ranges.
3399 This works only if each year number is put into a separate
3400 year element. The copyright element permits multiple
3401 year elements. If a year element contains a dash or
3402 a comma, then that year element will not be merged into
3409 <refentry version="5.0" id="author.othername.in.middle">
3411 <refentrytitle>author.othername.in.middle</refentrytitle>
3412 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3415 <refname>author.othername.in.middle</refname>
3416 <refpurpose>Is <tag>othername</tag> in <tag>author</tag> a
3417 middle name?</refpurpose>
3421 <programlisting id="author.othername.in.middle.frag">
3422 <xsl:param name="author.othername.in.middle" select="1"></xsl:param></programlisting>
3425 <refsection><info><title>Description</title></info>
3427 <para>If non-zero, the <tag>othername</tag> of an <tag>author</tag>
3428 appears between the <tag>firstname</tag> and
3429 <tag>surname</tag>. Otherwise, <tag>othername</tag>
3436 <refentry version="5.0" id="blurb.on.titlepage.enabled">
3438 <refentrytitle>blurb.on.titlepage.enabled</refentrytitle>
3439 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3442 <refname>blurb.on.titlepage.enabled</refname>
3443 <refpurpose>Display personblurb and authorblurb on title pages?</refpurpose>
3447 <programlisting id="blurb.on.titlepage.enabled.frag">
3448 <xsl:param name="blurb.on.titlepage.enabled" select="0"></xsl:param>
3452 <refsection><info><title>Description</title></info>
3454 <para>If non-zero, output from <tag>authorblurb</tag> and
3455 <tag>personblurb</tag> elements is displayed on title pages. If zero
3456 (the default), output from those elements is suppressed on title pages
3457 (unless you are using a <literal>titlepage</literal> customization
3458 that causes them to be included).</para>
3463 <refentry version="5.0" id="contrib.inline.enabled">
3465 <refentrytitle>contrib.inline.enabled</refentrytitle>
3466 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3469 <refname>contrib.inline.enabled</refname>
3470 <refpurpose>Display contrib output inline?</refpurpose>
3474 <programlisting id="contrib.inline.enabled.frag"><xsl:param name="contrib.inline.enabled">1</xsl:param></programlisting>
3477 <refsection><info><title>Description</title></info>
3479 <para>If non-zero (the default), output of the <tag>contrib</tag> element is
3480 displayed as inline content rather than as block content.</para>
3485 <refentry version="5.0" id="editedby.enabled">
3487 <refentrytitle>editedby.enabled</refentrytitle>
3488 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3491 <refname>editedby.enabled</refname>
3492 <refpurpose>Display “Edited by” heading above editor name?</refpurpose>
3496 <programlisting id="editedby.enabled.frag"><xsl:param name="editedby.enabled">1</xsl:param></programlisting>
3499 <refsection><info><title>Description</title></info>
3501 <para>If non-zero, a localized <emphasis role="bold">Edited
3502 by</emphasis> heading is displayed above editor names in output of the
3503 <tag>editor</tag> element.</para>
3508 <refentry version="5.0" id="abstract.notitle.enabled">
3510 <refentrytitle>abstract.notitle.enabled</refentrytitle>
3511 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3514 <refname>abstract.notitle.enabled</refname>
3515 <refpurpose>Suppress display of abstract titles?</refpurpose>
3518 <programlisting id="abstract.notitle.enabled.frag"><xsl:param name="abstract.notitle.enabled" select="0"></xsl:param></programlisting>
3520 <refsection><info><title>Description</title></info>
3521 <para>If non-zero, in output of the <tag>abstract</tag> element on titlepages,
3522 display of the abstract title is suppressed.</para>
3526 <refentry version="5.0" id="othercredit.like.author.enabled">
3528 <refentrytitle>othercredit.like.author.enabled</refentrytitle>
3529 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3532 <refname>othercredit.like.author.enabled</refname>
3533 <refpurpose>Display othercredit in same style as author?</refpurpose>
3537 <programlisting id="othercredit.like.author.enabled.frag"><xsl:param name="othercredit.like.author.enabled">0</xsl:param></programlisting>
3540 <refsection><info><title>Description</title></info>
3542 <para>If non-zero, output of the
3543 <tag>othercredit</tag> element on titlepages is displayed in
3544 the same style as <tag>author</tag> and
3545 <tag>editor</tag> output. If zero then
3546 <tag>othercredit</tag> output is displayed using a style
3547 different than that of <tag>author</tag> and
3548 <tag>editor</tag>.</para>
3553 <refentry version="5.0" id="generate.legalnotice.link">
3555 <refentrytitle>generate.legalnotice.link</refentrytitle>
3556 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3559 <refname>generate.legalnotice.link</refname>
3560 <refpurpose>Write legalnotice to separate chunk and generate link?</refpurpose>
3564 <programlisting id="generate.legalnotice.link.frag"><xsl:param name="generate.legalnotice.link" select="0"></xsl:param></programlisting>
3567 <refsection><info><title>Description</title></info>
3569 <para>If the value of <parameter>generate.legalnotice.link</parameter>
3570 is non-zero, the stylesheet:
3574 <para>writes the contents of <tag>legalnotice</tag> to a separate
3578 <para>inserts a hyperlink to the <tag>legalnotice</tag> file</para>
3581 <para>adds (in the HTML <literal>head</literal>) either a single
3582 <literal>link</literal> or element or multiple
3583 <literal>link</literal> elements (depending on the value of the
3584 <parameter>html.head.legalnotice.link.multiple</parameter>
3585 parameter), with the value or values derived from the
3586 <parameter>html.head.legalnotice.link.types</parameter>
3591 Otherwise, if <parameter>generate.legalnotice.link</parameter> is
3592 zero, <tag>legalnotice</tag> contents are rendered on the title
3595 <para>The name of the separate HTML file is computed as follows:
3599 <para>If a filename is given by the <tag class="xmlpi">dbhtml filename</tag>
3600 processing instruction, that filename is used.</para>
3603 <para>If the legalnotice has an <tag class="attribute">id</tag>/<tag class="attribute">xml:id</tag>
3604 attribute, and if <parameter>use.id.as.filename</parameter> != 0, the filename
3605 is the concatenation of the id value and the value of the <parameter>html.ext</parameter>
3609 <para>If the legalnotice does not have an <tag class="attribute">id</tag>/<tag class="attribute">xml:id</tag>
3610 attribute, or if <parameter>use.id.as.filename</parameter> = 0, the filename is the concatenation of "ln-",
3611 auto-generated id value, and <parameter>html.ext</parameter> value.
3621 <refentry version="5.0" id="generate.revhistory.link">
3623 <refentrytitle>generate.revhistory.link</refentrytitle>
3624 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3627 <refname>generate.revhistory.link</refname>
3628 <refpurpose>Write revhistory to separate chunk and generate link?</refpurpose>
3632 <programlisting id="generate.revhistory.link.frag"><xsl:param name="generate.revhistory.link" select="0"></xsl:param></programlisting>
3635 <refsection><info><title>Description</title></info>
3637 <para>If non-zero, the contents of <tag>revhistory</tag> are written
3638 to a separate HTML file and a link to the file is
3639 generated. Otherwise, <tag>revhistory</tag> contents are rendered on
3640 the title page.</para>
3642 <para>The name of the separate HTML file is computed as follows:
3646 <para>If a filename is given by the <tag class="xmlpi">dbhtml filename</tag> processing instruction,
3647 that filename is used.</para>
3650 <para>If the revhistory has an <tag class="attribute">id</tag>/<tag class="attribute">xml:id</tag>
3651 attribute, and if <parameter>use.id.as.filename</parameter> != 0, the filename is the concatenation of
3652 the id value and the value of the <parameter>html.ext</parameter> parameter.</para>
3655 <para>If the revhistory does not have an <tag class="attribute">id</tag>/<tag class="attribute">xml:id</tag>
3656 attribute, or if <parameter>use.id.as.filename</parameter> = 0, the filename is the concatenation of "rh-",
3657 auto-generated id value, and <parameter>html.ext</parameter> value.
3667 <refentry version="5.0" id="html.head.legalnotice.link.types">
3669 <refentrytitle>html.head.legalnotice.link.types</refentrytitle>
3670 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
3673 <refname>html.head.legalnotice.link.types</refname>
3674 <refpurpose>Specifies link types for legalnotice link in html head</refpurpose>
3678 <programlisting id="html.head.legalnotice.link.types.frag">
3679 <xsl:param name="html.head.legalnotice.link.types">copyright</xsl:param>
3683 <refsection><info><title>Description</title></info>
3686 <parameter>html.head.legalnotice.link.types</parameter> is a
3687 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
3688 of the HTML 4.01 specification</link>. If the value of the
3689 <parameter>generate.legalnotice.link</parameter> parameter is
3690 non-zero, then the stylesheet generates (in the
3691 <literal>head</literal> section of the HTML source) either a single
3692 HTML <literal>link</literal> element or, if the value of the
3693 <parameter>html.head.legalnotice.link.multiple</parameter> is
3694 non-zero, one <literal>link</literal> element for each link type
3695 specified. Each <literal>link</literal> has the following attributes:
3699 <para>a <tag class="attribute">rel</tag> attribute whose
3700 value is derived from the value of
3701 <parameter>html.head.legalnotice.link.types</parameter></para>
3704 <para>an <tag class="attribute">href</tag> attribute whose
3705 value is set to the URL of the file containing the
3706 <tag>legalnotice</tag></para>
3709 <para>a <tag class="attribute">title</tag> attribute whose
3710 value is set to the title of the corresponding
3711 <tag>legalnotice</tag> (or a title programatically
3712 determined by the stylesheet)</para>
3718 <screen> <link rel="license" href="ln-id2524073.html" title="Legal Notice"></screen>
3721 <refsection><info><title>About the default value</title></info>
3723 <para>In an ideal world, the default value of
3724 <parameter>html.head.legalnotice.link.types</parameter> would
3725 probably be “<literal>license</literal>”, since the content of the
3726 DocBook <tag>legalnotice</tag> is typically license
3727 information, not copyright information. However, the default value
3728 is “<literal>copyright</literal>” for pragmatic reasons: because
3729 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
3730 6.12 of the HTML 4.01 specification</link>, and because certain
3731 browsers and browser extensions are preconfigured to recognize that
3738 <refentry version="5.0" id="html.head.legalnotice.link.multiple">
3740 <refentrytitle>html.head.legalnotice.link.multiple</refentrytitle>
3741 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3744 <refname>html.head.legalnotice.link.multiple</refname>
3745 <refpurpose>Generate multiple link instances in html head for legalnotice?</refpurpose>
3749 <programlisting id="html.head.legalnotice.link.multiple.frag">
3750 <xsl:param name="html.head.legalnotice.link.multiple" select="1"></xsl:param>
3754 <refsection><info><title>Description</title></info>
3756 <para>If <parameter>html.head.legalnotice.link.multiple</parameter> is
3757 non-zero and the value of
3758 <parameter>html.head.legalnotice.link.types</parameter> contains
3759 multiple link types, then the stylesheet generates (in the
3760 <literal>head</literal> section of the HTML source) one
3761 <literal>link</literal> element for each link type specified. For
3762 example, if the value of
3763 <parameter>html.head.legalnotice.link.types</parameter> is
3764 “<literal>copyright license</literal>”:
3766 <screen> <link rel="copyright" href="ln-id2524073.html" title="Legal Notice">
3767 <link rel="license" href="ln-id2524073.html" title="Legal Notice"></screen>
3769 Otherwise, the stylesheet generates generates a single
3770 <literal>link</literal> instance; for example:
3772 <screen> <link rel="copyright license" href="ln-id2524073.html" title="Legal Notice"></screen>
3778 </reference><reference id="refentry" xml:base="../html/param.xml"><title>Reference Pages</title>
3779 <refentry version="5.0" id="funcsynopsis.decoration">
3781 <refentrytitle>funcsynopsis.decoration</refentrytitle>
3782 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3785 <refname>funcsynopsis.decoration</refname>
3786 <refpurpose>Decorate elements of a <tag>funcsynopsis</tag>?</refpurpose>
3790 <programlisting id="funcsynopsis.decoration.frag">
3791 <xsl:param name="funcsynopsis.decoration" select="1"></xsl:param>
3795 <refsection><info><title>Description</title></info>
3797 <para>If non-zero, elements of the <tag>funcsynopsis</tag> will be
3798 decorated (e.g. rendered as bold or italic text). The decoration is controlled by
3799 templates that can be redefined in a customization layer.
3805 <refentry version="5.0" id="funcsynopsis.style">
3807 <refentrytitle>funcsynopsis.style</refentrytitle>
3808 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
3809 <refmiscinfo class="other" otherclass="value">ansi</refmiscinfo>
3810 <refmiscinfo class="other" otherclass="value">kr</refmiscinfo>
3813 <refname>funcsynopsis.style</refname>
3814 <refpurpose>What style of <tag>funcsynopsis</tag> should be generated?</refpurpose>
3818 <programlisting id="funcsynopsis.style.frag"><xsl:param name="funcsynopsis.style">kr</xsl:param></programlisting>
3821 <refsection><info><title>Description</title></info>
3823 <para>If <parameter>funcsynopsis.style</parameter> is <literal>ansi</literal>,
3824 ANSI-style function synopses are generated for a
3825 <tag>funcsynopsis</tag>, otherwise K&R-style
3826 function synopses are generated.
3832 <refentry version="5.0" id="function.parens">
3834 <refentrytitle>function.parens</refentrytitle>
3835 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3838 <refname>function.parens</refname>
3839 <refpurpose>Generate parens after a function?</refpurpose>
3843 <programlisting id="function.parens.frag">
3844 <xsl:param name="function.parens" select="0"></xsl:param>
3848 <refsection><info><title>Description</title></info>
3850 <para>If non-zero, the formatting of a <tag>function</tag> element
3851 will include generated parentheses.
3857 <refentry version="5.0" id="refentry.generate.name">
3859 <refentrytitle>refentry.generate.name</refentrytitle>
3860 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3863 <refname>refentry.generate.name</refname>
3864 <refpurpose>Output NAME header before <tag>refname</tag>s?</refpurpose>
3868 <programlisting id="refentry.generate.name.frag">
3869 <xsl:param name="refentry.generate.name" select="1"></xsl:param>
3873 <refsection><info><title>Description</title></info>
3875 <para>If non-zero, a "NAME" section title is output before the list
3876 of <tag>refname</tag>s. This parameter and
3877 <parameter>refentry.generate.title</parameter> are mutually
3878 exclusive. This means that if you change this parameter to zero, you
3879 should set <parameter>refentry.generate.title</parameter> to non-zero unless
3880 you want get quite strange output.
3886 <refentry version="5.0" id="refentry.generate.title">
3888 <refentrytitle>refentry.generate.title</refentrytitle>
3889 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3892 <refname>refentry.generate.title</refname>
3893 <refpurpose>Output title before <tag>refname</tag>s?</refpurpose>
3897 <programlisting id="refentry.generate.title.frag">
3898 <xsl:param name="refentry.generate.title" select="0"></xsl:param>
3902 <refsection><info><title>Description</title></info>
3904 <para>If non-zero, the reference page title or first name is
3905 output before the list of <tag>refname</tag>s. This parameter and
3906 <parameter>refentry.generate.name</parameter> are mutually exclusive.
3907 This means that if you change this parameter to non-zero, you
3908 should set <parameter>refentry.generate.name</parameter> to zero unless
3909 you want get quite strange output.</para>
3915 <refentry version="5.0" id="refentry.xref.manvolnum">
3917 <refentrytitle>refentry.xref.manvolnum</refentrytitle>
3918 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3921 <refname>refentry.xref.manvolnum</refname>
3922 <refpurpose>Output <tag>manvolnum</tag> as part of
3923 <tag>refentry</tag> cross-reference?</refpurpose>
3927 <programlisting id="refentry.xref.manvolnum.frag">
3928 <xsl:param name="refentry.xref.manvolnum" select="1"></xsl:param>
3932 <refsection><info><title>Description</title></info>
3934 <para>if non-zero, the <tag>manvolnum</tag> is used when cross-referencing
3935 <tag>refentry</tag>s, either with <tag>xref</tag>
3936 or <tag>citerefentry</tag>.
3942 <refentry version="5.0" id="citerefentry.link">
3944 <refentrytitle>citerefentry.link</refentrytitle>
3945 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3948 <refname>citerefentry.link</refname>
3949 <refpurpose>Generate URL links when cross-referencing RefEntrys?</refpurpose>
3953 <programlisting id="citerefentry.link.frag">
3954 <xsl:param name="citerefentry.link" select="0"></xsl:param></programlisting>
3957 <refsection><info><title>Description</title></info>
3959 <para>If non-zero, a web link will be generated, presumably
3960 to an online man->HTML gateway. The text of the link is
3961 generated by the <literal>generate.citerefentry.link</literal> template.
3967 <refentry version="5.0" id="refentry.separator">
3969 <refentrytitle>refentry.separator</refentrytitle>
3970 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3973 <refname>refentry.separator</refname>
3974 <refpurpose>Generate a separator between consecutive RefEntry elements?</refpurpose>
3978 <programlisting id="refentry.separator.frag">
3979 <xsl:param name="refentry.separator" select="1"></xsl:param>
3983 <refsection><info><title>Description</title></info>
3985 <para>If true, a separator will be generated between consecutive
3992 <refentry version="5.0" id="refclass.suppress">
3994 <refentrytitle>refclass.suppress</refentrytitle>
3995 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3998 <refname>refclass.suppress</refname>
3999 <refpurpose>Suppress display of refclass contents?</refpurpose>
4003 <programlisting id="refclass.suppress.frag">
4004 <xsl:param name="refclass.suppress" select="0"></xsl:param></programlisting>
4007 <refsection><info><title>Description</title></info>
4009 <para>If the value of <parameter>refclass.suppress</parameter> is
4010 non-zero, then display of <tag>refclass</tag> contents is
4011 suppressed in output.</para>
4016 </reference><reference id="tables" xml:base="../html/param.xml"><title>Tables</title>
4017 <refentry version="5.0" id="default.table.width">
4019 <refentrytitle>default.table.width</refentrytitle>
4020 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
4023 <refname>default.table.width</refname>
4024 <refpurpose>The default width of tables</refpurpose>
4027 <programlisting id="default.table.width.frag">
4028 <xsl:param name="default.table.width"></xsl:param>
4031 <refsection><info><title>Description</title></info>
4032 <para>If non-zero, this value will be used for the
4033 <literal>width</literal> attribute on <tag>table</tag>s that do not specify an
4034 alternate width (with the <tag class="xmlpi">dbhtml table-width</tag> or
4035 <tag class="xmlpi">dbfo table-width</tag> processing instruction).</para>
4039 <refentry version="5.0" id="nominal.table.width">
4041 <refentrytitle>nominal.table.width</refentrytitle>
4042 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
4045 <refname>nominal.table.width</refname>
4046 <refpurpose>The (absolute) nominal width of tables</refpurpose>
4050 <programlisting id="nominal.table.width.frag">
4051 <xsl:param name="nominal.table.width">6in</xsl:param>
4055 <refsection><info><title>Description</title></info>
4057 <para>In order to convert CALS column widths into HTML column widths, it
4058 is sometimes necessary to have an absolute table width to use for conversion
4059 of mixed absolute and relative widths. This value must be an absolute
4060 length (not a percentage).</para>
4065 <refentry version="5.0" id="table.borders.with.css">
4067 <refentrytitle>table.borders.with.css</refentrytitle>
4068 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
4071 <refname>table.borders.with.css</refname>
4072 <refpurpose>Use CSS to specify table, row, and cell borders?</refpurpose>
4076 <programlisting id="table.borders.with.css.frag">
4077 <xsl:param name="table.borders.with.css" select="0"></xsl:param>
4081 <refsection><info><title>Description</title></info>
4083 <para>If non-zero, CSS will be used to draw table borders.
4089 <refentry version="5.0" id="table.cell.border.style">
4091 <refentrytitle>table.cell.border.style</refentrytitle>
4092 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
4093 <refmiscinfo class="other" otherclass="value">none</refmiscinfo>
4094 <refmiscinfo class="other" otherclass="value">solid</refmiscinfo>
4095 <refmiscinfo class="other" otherclass="value">dotted</refmiscinfo>
4096 <refmiscinfo class="other" otherclass="value">dashed</refmiscinfo>
4097 <refmiscinfo class="other" otherclass="value">double</refmiscinfo>
4098 <refmiscinfo class="other" otherclass="value">groove</refmiscinfo>
4099 <refmiscinfo class="other" otherclass="value">ridge</refmiscinfo>
4100 <refmiscinfo class="other" otherclass="value">inset</refmiscinfo>
4101 <refmiscinfo class="other" otherclass="value">outset</refmiscinfo>
4102 <refmiscinfo class="other" otherclass="value">solid</refmiscinfo>
4105 <refname>table.cell.border.style</refname>
4106 <refpurpose>Specifies the border style of table cells</refpurpose>
4110 <programlisting id="table.cell.border.style.frag">
4111 <xsl:param name="table.cell.border.style">solid</xsl:param>
4115 <refsection><info><title>Description</title></info>
4117 <para>Specifies the border style of table cells.</para>
4120 <para>To control properties of cell borders in HTML output, you must also turn on the
4121 <parameter>table.borders.with.css</parameter> parameter.</para>
4127 <refentry version="5.0" id="table.cell.border.thickness">
4129 <refentrytitle>table.cell.border.thickness</refentrytitle>
4130 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
4133 <refname>table.cell.border.thickness</refname>
4134 <refpurpose>Specifies the thickness of table cell borders</refpurpose>
4138 <programlisting id="table.cell.border.thickness.frag">
4139 <xsl:param name="table.cell.border.thickness">0.5pt</xsl:param>
4143 <refsection><info><title>Description</title></info>
4145 <para>If non-zero, specifies the thickness of borders on table
4146 cells. The units are points. See <link xlink:href="http://www.w3.org/TR/CSS21/box.html#border-width-properties">
4150 <para>To control properties of cell borders in HTML output, you must also turn on the
4151 <parameter>table.borders.with.css</parameter> parameter.</para>
4157 <refentry version="5.0" id="table.cell.border.color">
4159 <refentrytitle>table.cell.border.color</refentrytitle>
4160 <refmiscinfo class="other" otherclass="datatype">color</refmiscinfo>
4163 <refname>table.cell.border.color</refname>
4164 <refpurpose>Specifies the border color of table cells</refpurpose>
4168 <programlisting id="table.cell.border.color.frag">
4169 <xsl:param name="table.cell.border.color"></xsl:param>
4174 <refsection><info><title>Description</title></info>
4176 <para>Set the color of table cell borders. If non-zero, the value is used
4177 for the border coloration. See <link xlink:href="http://www.w3.org/TR/CSS21/syndata.html#value-def-color">CSS</link>. A
4178 <literal>color</literal> is either a keyword or a numerical RGB specification.
4179 Keywords are aqua, black, blue, fuchsia, gray, green, lime, maroon,
4180 navy, olive, orange, purple, red, silver, teal, white, and
4184 <para>To control properties of cell borders in HTML output, you must also turn on the
4185 <parameter>table.borders.with.css</parameter> parameter.</para>
4191 <refentry version="5.0" id="table.frame.border.style">
4193 <refentrytitle>table.frame.border.style</refentrytitle>
4194 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
4195 <refmiscinfo class="other" otherclass="value">none</refmiscinfo>
4196 <refmiscinfo class="other" otherclass="value">solid</refmiscinfo>
4197 <refmiscinfo class="other" otherclass="value">dotted</refmiscinfo>
4198 <refmiscinfo class="other" otherclass="value">dashed</refmiscinfo>
4199 <refmiscinfo class="other" otherclass="value">double</refmiscinfo>
4200 <refmiscinfo class="other" otherclass="value">groove</refmiscinfo>
4201 <refmiscinfo class="other" otherclass="value">ridge</refmiscinfo>
4202 <refmiscinfo class="other" otherclass="value">inset</refmiscinfo>
4203 <refmiscinfo class="other" otherclass="value">outset</refmiscinfo>
4204 <refmiscinfo class="other" otherclass="value">solid</refmiscinfo>
4207 <refname>table.frame.border.style</refname>
4208 <refpurpose>Specifies the border style of table frames</refpurpose>
4212 <programlisting id="table.frame.border.style.frag">
4213 <xsl:param name="table.frame.border.style">solid</xsl:param>
4217 <refsection><info><title>Description</title></info>
4219 <para>Specifies the border style of table frames.</para>
4224 <refentry version="5.0" id="table.frame.border.thickness">
4226 <refentrytitle>table.frame.border.thickness</refentrytitle>
4227 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
4230 <refname>table.frame.border.thickness</refname>
4231 <refpurpose>Specifies the thickness of the frame border</refpurpose>
4235 <programlisting id="table.frame.border.thickness.frag">
4236 <xsl:param name="table.frame.border.thickness">0.5pt</xsl:param>
4240 <refsection><info><title>Description</title></info>
4242 <para>Specifies the thickness of the border on the table's frame.</para>
4247 <refentry version="5.0" id="table.frame.border.color">
4249 <refentrytitle>table.frame.border.color</refentrytitle>
4250 <refmiscinfo class="other" otherclass="datatype">color</refmiscinfo>
4253 <refname>table.frame.border.color</refname>
4254 <refpurpose>Specifies the border color of table frames</refpurpose>
4258 <programlisting id="table.frame.border.color.frag">
4259 <xsl:param name="table.frame.border.color"></xsl:param>
4264 <refsection><info><title>Description</title></info>
4266 <para>Specifies the border color of table frames.</para>
4271 <refentry version="5.0" id="default.table.frame">
4273 <refentrytitle>default.table.frame</refentrytitle>
4274 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
4277 <refname>default.table.frame</refname>
4278 <refpurpose>The default framing of tables</refpurpose>
4282 <programlisting id="default.table.frame.frag">
4283 <xsl:param name="default.table.frame">all</xsl:param>
4287 <refsection><info><title>Description</title></info>
4289 <para>This value will be used when there is no frame attribute on the
4295 <refentry version="5.0" id="html.cellspacing">
4297 <refentrytitle>html.cellspacing</refentrytitle>
4298 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
4301 <refname>html.cellspacing</refname>
4302 <refpurpose>Default value for cellspacing in HTML tables</refpurpose>
4306 <programlisting id="html.cellspacing.frag">
4307 <xsl:param name="html.cellspacing"></xsl:param>
4311 <refsection><info><title>Description</title></info>
4313 <para>If non-zero, this value will be used as the default cellspacing
4314 value in HTML tables. nn for pixels or nn% for percentage
4315 length. E.g. 5 or 5%</para>
4320 <refentry version="5.0" id="html.cellpadding">
4322 <refentrytitle>html.cellpadding</refentrytitle>
4323 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
4326 <refname>html.cellpadding</refname>
4327 <refpurpose>Default value for cellpadding in HTML tables</refpurpose>
4331 <programlisting id="html.cellpadding.frag">
4332 <xsl:param name="html.cellpadding"></xsl:param>
4336 <refsection><info><title>Description</title></info>
4338 <para>If non-zero, this value will be used as the default cellpadding value
4339 in HTML tables. nn for pixels or nn% for percentage length. E.g. 5 or
4345 </reference><reference id="qa" xml:base="../html/param.xml"><title>QAndASet</title>
4346 <refentry version="5.0" id="qanda.defaultlabel">
4348 <refentrytitle>qanda.defaultlabel</refentrytitle>
4349 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
4350 <refmiscinfo class="other" otherclass="value">number</refmiscinfo>
4351 <refmiscinfo class="other" otherclass="value">qanda</refmiscinfo>
4352 <refmiscinfo class="other" otherclass="value">none</refmiscinfo>
4355 <refname>qanda.defaultlabel</refname>
4356 <refpurpose>Sets the default for defaultlabel on QandASet.</refpurpose>
4360 <programlisting id="qanda.defaultlabel.frag">
4361 <xsl:param name="qanda.defaultlabel">number</xsl:param>
4365 <refsection><info><title>Description</title></info>
4367 <para>If no <literal>defaultlabel</literal> attribute is specified on
4368 a <tag>qandaset</tag>, this value is used. It is generally one of the legal
4369 values for the defaultlabel attribute (<literal>none</literal>,
4370 <literal>number</literal> or
4371 <literal>qanda</literal>), or one of the additional stylesheet-specific values
4372 (<literal>qnumber</literal> or <literal>qnumberanda</literal>).
4373 The default value is 'number'.
4375 <para>The values are rendered as follows:</para>
4377 <varlistentry><term><literal>qanda</literal></term>
4379 <para><tag>question</tag>s are labeled "Q:" and
4380 <tag>answer</tag>s are labeled "A:". </para>
4384 <varlistentry><term><literal>number</literal></term>
4386 <para>The questions are enumerated and the answers
4387 are not labeled. </para>
4391 <varlistentry><term><literal>qnumber</literal></term>
4393 <para>The questions are labeled "Q:" followed by a number, and answers are not
4395 When sections are numbered, adding a label
4396 to the number distinguishes the question numbers
4397 from the section numbers.
4398 This value is not allowed in the
4399 <tag class="attribute">defaultlabel</tag> attribute
4400 of a <tag>qandaset</tag> element.</para>
4404 <varlistentry><term><literal>qnumberanda</literal></term>
4406 <para>The questions are labeled "Q:" followed by a number, and
4407 the answers are labeled "A:".
4408 When sections are numbered, adding a label
4409 to the number distinguishes the question numbers
4410 from the section numbers.
4411 This value is not allowed in the
4412 <tag class="attribute">defaultlabel</tag> attribute
4413 of a <tag>qandaset</tag> element.</para>
4417 <varlistentry><term><literal>none</literal></term>
4419 <para>No distinguishing label precedes Questions or Answers.
4428 <refentry version="5.0" id="qanda.inherit.numeration">
4430 <refentrytitle>qanda.inherit.numeration</refentrytitle>
4431 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
4434 <refname>qanda.inherit.numeration</refname>
4435 <refpurpose>Does enumeration of QandASet components inherit the numeration of parent elements?</refpurpose>
4439 <programlisting id="qanda.inherit.numeration.frag">
4440 <xsl:param name="qanda.inherit.numeration" select="1"></xsl:param>
4444 <refsection><info><title>Description</title></info>
4446 <para>If non-zero, numbered <tag>qandadiv</tag> elements and
4447 <tag>question</tag> and <tag>answer</tag> inherit the enumeration of
4448 the ancestors of the <tag>qandaset</tag>.
4454 <refentry version="5.0" id="qanda.in.toc">
4456 <refentrytitle>qanda.in.toc</refentrytitle>
4457 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
4460 <refname>qanda.in.toc</refname>
4461 <refpurpose>Should qandaentry questions appear in
4462 the document table of contents?</refpurpose>
4466 <programlisting id="qanda.in.toc.frag"><xsl:param name="qanda.in.toc" select="0"></xsl:param></programlisting>
4469 <refsection><info><title>Description</title></info>
4471 <para>If true (non-zero), then the generated table of contents
4472 for a document will include <tag>qandaset</tag> titles,
4473 <tag>qandadiv</tag> titles,
4474 and <tag>question</tag> elements. The default value (zero) excludes
4477 <para>This parameter does not affect any tables of contents
4478 that may be generated inside a qandaset or qandadiv.
4484 <refentry version="5.0" id="qanda.nested.in.toc">
4486 <refentrytitle>qanda.nested.in.toc</refentrytitle>
4487 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
4490 <refname>qanda.nested.in.toc</refname>
4491 <refpurpose>Should nested answer/qandaentry instances appear in TOC?</refpurpose>
4495 <programlisting id="qanda.nested.in.toc.frag">
4496 <xsl:param name="qanda.nested.in.toc" select="0"></xsl:param>
4500 <refsection><info><title>Description</title></info>
4502 <para>If non-zero, instances of <tag>qandaentry</tag>
4503 that are children of <tag>answer</tag> elements are shown in
4509 </reference><reference id="links" xml:base="../html/param.xml"><title>Linking</title>
4510 <refentry version="5.0" id="target.database.document">
4512 <refentrytitle>target.database.document</refentrytitle>
4513 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
4516 <refname>target.database.document</refname>
4517 <refpurpose>Name of master database file for resolving
4521 <programlisting id="target.database.document.frag">
4522 <xsl:param name="target.database.document">olinkdb.xml</xsl:param>
4525 <refsection><info><title>Description</title></info>
4528 To resolve olinks between documents, the stylesheets use a master
4529 database document that identifies the target datafiles for all the
4530 documents within the scope of the olinks. This parameter value is the
4531 URI of the master document to be read during processing to resolve
4532 olinks. The default value is <filename>olinkdb.xml</filename>.</para>
4534 <para>The data structure of the file is defined in the
4535 <filename>targetdatabase.dtd</filename> DTD. The database file
4536 provides the high level elements to record the identifiers, locations,
4537 and relationships of documents. The cross reference data for
4538 individual documents is generally pulled into the database using
4539 system entity references or XIncludes. See also
4540 <parameter>targets.filename</parameter>. </para> </refsection>
4543 <refentry version="5.0" id="targets.filename">
4545 <refentrytitle>targets.filename</refentrytitle>
4546 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
4549 <refname>targets.filename</refname>
4550 <refpurpose>Name of cross reference targets data file</refpurpose>
4552 <refsynopsisdiv> <programlisting id="targets.filename.frag">
4553 <xsl:param name="targets.filename">target.db</xsl:param>
4556 <refsection><info><title>Description</title></info>
4559 In order to resolve olinks efficiently, the stylesheets can
4560 generate an external data file containing information about
4561 all potential cross reference endpoints in a document.
4562 This parameter lets you change the name of the generated
4563 file from the default name <filename>target.db</filename>.
4564 The name must agree with that used in the target database
4565 used to resolve olinks during processing.
4566 See also <parameter>target.database.document</parameter>.
4571 <refentry version="5.0" id="olink.base.uri">
4573 <refentrytitle>olink.base.uri</refentrytitle>
4574 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
4577 <refname>olink.base.uri</refname>
4578 <refpurpose>Base URI used in olink hrefs</refpurpose>
4580 <refsynopsisdiv> <programlisting id="olink.base.uri.frag">
4581 <xsl:param name="olink.base.uri"></xsl:param>
4584 <refsection><info><title>Description</title></info>
4586 <para>When cross reference data is collected for resolving olinks, it
4587 may be necessary to prepend a base URI to each target's href. This
4588 parameter lets you set that base URI when cross reference data is
4589 collected. This feature is needed when you want to link to a document
4590 that is processed without chunking. The output filename for such a
4591 document is not known to the XSL stylesheet; the only target
4592 information consists of fragment identifiers such as
4593 <literal>#idref</literal>. To enable the resolution of olinks between
4594 documents, you should pass the name of the HTML output file as the
4595 value of this parameter. Then the hrefs recorded in the cross
4596 reference data collection look like
4597 <literal>outfile.html#idref</literal>, which can be reached as links
4598 from other documents.</para>
4602 <refentry version="5.0" id="use.local.olink.style">
4604 <refentrytitle>use.local.olink.style</refentrytitle>
4605 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
4608 <refname>use.local.olink.style</refname>
4609 <refpurpose>Process olinks using xref style of current
4610 document</refpurpose>
4612 <refsynopsisdiv> <programlisting id="use.local.olink.style.frag">
4613 <xsl:param name="use.local.olink.style" select="0"></xsl:param> </programlisting>
4615 <refsection><info><title>Description</title></info>
4617 <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
4618 reference string is formed again from the target title, number, and
4619 element name, using the stylesheet processing the targeting document.
4620 Then olinks will match the xref style in the targeting document
4621 rather than in the target document. If both documents are processed
4622 with the same stylesheet, then the results will be the same.</para>
4626 <refentry version="5.0" id="current.docid">
4628 <refentrytitle>current.docid</refentrytitle>
4629 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
4632 <refname>current.docid</refname>
4633 <refpurpose>targetdoc identifier for the document being
4634 processed</refpurpose>
4636 <refsynopsisdiv> <programlisting id="current.docid.frag">
4637 <xsl:param name="current.docid"></xsl:param>
4640 <refsection><info><title>Description</title></info>
4642 <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
4643 the targetdoc identifier of the current document, since that
4644 identifier does not appear in the document itself. </para>
4645 <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>
4649 <refentry version="5.0" id="olink.doctitle">
4651 <refentrytitle>olink.doctitle</refentrytitle>
4652 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
4653 <refmiscinfo class="other" otherclass="value">no</refmiscinfo>
4654 <refmiscinfo class="other" otherclass="value">yes</refmiscinfo>
4655 <refmiscinfo class="other" otherclass="value">maybe</refmiscinfo>
4658 <refname>olink.doctitle</refname>
4659 <refpurpose>show the document title for external olinks?</refpurpose>
4662 <refsynopsisdiv> <programlisting id="olink.doctitle.frag">
4663 <xsl:param name="olink.doctitle">no</xsl:param>
4666 <refsection><info><title>Description</title></info>
4668 <para>When olinks between documents are resolved, the generated text
4669 may not make it clear that the reference is to another document.
4670 It is possible for the stylesheets to append the other document's
4671 title to external olinks. For this to happen, two parameters must
4675 <para>This <parameter>olink.doctitle</parameter> parameter
4676 should be set to either <literal>yes</literal> or <literal>maybe</literal>
4677 to enable this feature.
4681 <para>And you should also set the <parameter>current.docid</parameter>
4682 parameter to the document id for the document currently
4683 being processed for output.
4689 Then if an olink's <literal>targetdoc</literal> id differs from
4690 the <literal>current.docid</literal> value, the stylesheet knows
4691 that it is a reference to another document and can
4692 append the target document's
4693 title to the generated olink text. </para>
4695 <para>The text for the target document's title is copied from the
4696 olink database from the <tag>ttl</tag> element
4697 of the top-level <tag>div</tag> for that document.
4698 If that <tag>ttl</tag> element is missing or empty,
4702 <para>The supported values for <parameter>olink.doctitle</parameter> are:
4706 <term><literal>yes</literal></term>
4709 Always insert the title to the target document if it is not
4710 the current document.
4715 <term><literal>no</literal></term>
4718 Never insert the title to the target document, even if requested
4719 in an <tag class="attribute">xrefstyle</tag> attribute.
4724 <term><literal>maybe</literal></term>
4727 Only insert the title to the target document, if requested
4728 in an <tag class="attribute">xrefstyle</tag> attribute.
4733 <para>An <tag class="attribute">xrefstyle</tag> attribute
4734 may override the global setting for individual olinks.
4735 The following values are supported in an
4736 <tag class="attribute">xrefstyle</tag>
4737 attribute using the <literal>select:</literal> syntax:
4742 <term><literal>docname</literal></term>
4745 Insert the target document name for this olink using the
4746 <literal>docname</literal> gentext template, but only
4747 if the value of <parameter>olink.doctitle</parameter>
4748 is not <literal>no</literal>.
4753 <term><literal>docnamelong</literal></term>
4756 Insert the target document name for this olink using the
4757 <literal>docnamelong</literal> gentext template, but only
4758 if the value of <parameter>olink.doctitle</parameter>
4759 is not <literal>no</literal>.
4764 <term><literal>nodocname</literal></term>
4767 Omit the target document name even if
4768 the value of <parameter>olink.doctitle</parameter>
4769 is <literal>yes</literal>.
4774 <para>Another way of inserting the target document name
4775 for a single olink is to employ an
4776 <tag class="attribute">xrefstyle</tag>
4777 attribute using the <literal>template:</literal> syntax.
4778 The <literal>%o</literal> placeholder (the letter o, not zero)
4780 will be filled in with the target document's title when it is processed.
4781 This will occur regardless of
4782 the value of <parameter>olink.doctitle</parameter>.
4784 <para>Note that prior to version 1.66 of the XSL stylesheets,
4785 the allowed values for this parameter were 0 and 1. Those
4786 values are still supported and mapped to 'no' and 'yes', respectively.
4791 <refentry version="5.0" id="olink.debug">
4793 <refentrytitle>olink.debug</refentrytitle>
4794 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
4797 <refname>olink.debug</refname>
4798 <refpurpose>Turn on debugging messages for olinks</refpurpose>
4802 <programlisting id="olink.debug.frag">
4803 <xsl:param name="olink.debug" select="0"></xsl:param>
4807 <refsection><info><title>Description</title></info>
4809 <para>If non-zero, then each olink will generate several
4810 messages about how it is being resolved during processing.
4811 This is useful when an olink does not resolve properly
4812 and the standard error messages are not sufficient to
4816 <para>You may need to read through the olink XSL templates
4817 to understand the context for some of the debug messages.
4823 <refentry version="5.0" id="olink.properties">
4825 <refentrytitle>olink.properties</refentrytitle>
4826 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
4829 <refname>olink.properties</refname>
4830 <refpurpose>Properties associated with the cross-reference
4831 text of an olink.</refpurpose>
4835 <programlisting id="olink.properties.frag">
4836 <xsl:attribute-set name="olink.properties">
4837 <xsl:attribute name="show-destination">replace</xsl:attribute>
4838 </xsl:attribute-set>
4842 <refsection><info><title>Description</title></info>
4844 <para>This <literal>attribute set</literal> is applied to the
4845 <literal>fo:basic-link</literal> element of an olink. It is not applied to the
4846 optional page number or optional title of the external
4852 <refentry version="5.0" id="olink.lang.fallback.sequence">
4854 <refentrytitle>olink.lang.fallback.sequence</refentrytitle>
4855 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
4858 <refname>olink.lang.fallback.sequence</refname>
4859 <refpurpose>look up translated documents if olink not found?</refpurpose>
4862 <refsynopsisdiv> <programlisting id="olink.lang.fallback.sequence.frag">
4863 <xsl:param name="olink.lang.fallback.sequence"></xsl:param>
4866 <refsection><info><title>Description</title></info>
4869 <para>This parameter defines a list of lang values
4870 to search among to resolve olinks.
4873 <para>Normally an olink tries to resolve to a document in the same
4874 language as the olink itself. The language of an olink
4875 is determined by its nearest ancestor element with a
4876 <tag class="attribute">lang</tag> attribute, otherwise the
4877 value of the <parameter>l10n.gentext.default.lang</parameter>
4881 <para>An olink database can contain target data for the same
4882 document in multiple languages. Each set of data has the
4883 same value for the <tag>targetdoc</tag> attribute in
4884 the <tag>document</tag> element in the database, but with a
4885 different <tag>lang</tag> attribute value.
4888 <para>When an olink is being resolved, the target is first
4889 sought in the document with the same language as the olink.
4890 If no match is found there, then this parameter is consulted
4891 for additional languages to try.</para>
4893 <para>The <parameter>olink.lang.fallback.sequence</parameter>
4894 must be a whitespace separated list of lang values to
4895 try. The first one with a match in the olink database is used.
4896 The default value is empty.</para>
4898 <para>For example, a document might be written in German
4899 and contain an olink with
4900 <literal>targetdoc="adminguide"</literal>.
4901 When the document is processed, the processor
4902 first looks for a target dataset in the
4903 olink database starting with:</para>
4905 <literallayout><literal><document targetdoc="adminguide" lang="de"></literal>.
4908 <para>If there is no such element, then the
4909 <parameter>olink.lang.fallback.sequence</parameter>
4910 parameter is consulted.
4911 If its value is, for example, <quote>fr en</quote>, then the processor next
4912 looks for <literal>targetdoc="adminguide" lang="fr"</literal>, and
4913 then for <literal>targetdoc="adminguide" lang="en"</literal>.
4914 If there is still no match, it looks for
4915 <literal>targetdoc="adminguide"</literal> with no
4919 <para>This parameter is useful when a set of documents is only
4920 partially translated, or is in the process of being translated.
4921 If a target of an olink has not yet been translated, then this
4922 parameter permits the processor to look for the document in
4923 other languages. This assumes the reader would rather have
4924 a link to a document in a different language than to have
4931 <refentry version="5.0" id="insert.olink.page.number">
4933 <refentrytitle>insert.olink.page.number</refentrytitle>
4934 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
4935 <refmiscinfo class="other" otherclass="value">no</refmiscinfo>
4936 <refmiscinfo class="other" otherclass="value">yes</refmiscinfo>
4937 <refmiscinfo class="other" otherclass="value">maybe</refmiscinfo>
4940 <refname>insert.olink.page.number</refname>
4941 <refpurpose>Turns page numbers in olinks on and off</refpurpose>
4945 <programlisting id="insert.olink.page.number.frag">
4946 <xsl:param name="insert.olink.page.number">no</xsl:param>
4950 <refsection><info><title>Description</title></info>
4952 <para>The value of this parameter determines if
4953 cross references made between documents with
4954 <tag>olink</tag> will
4955 include page number citations.
4956 In most cases this is only applicable to references in printed output.
4958 <para>The parameter has three possible values.
4963 <listitem><para>No page number references will be generated for olinks.
4968 <listitem><para>Page number references will be generated
4969 for all <tag>olink</tag> references.
4970 The style of page reference may be changed
4971 if an <tag class="attribute">xrefstyle</tag>
4977 <listitem><para>Page number references will not be generated
4978 for an <tag>olink</tag> element unless
4980 <tag class="attribute">xrefstyle</tag>
4981 attribute whose value specifies a page reference.
4985 <para>Olinks that point to targets within the same document
4986 are treated as <tag>xref</tag>s, and controlled by
4987 the <parameter>insert.xref.page.number</parameter> parameter.
4990 <para>Page number references for olinks to
4991 external documents can only be inserted if the
4992 information exists in the olink database.
4993 This means each olink target element
4994 (<tag>div</tag> or <tag>obj</tag>)
4995 must have a <tag class="attribute">page</tag> attribute
4996 whose value is its page number in the target document.
4997 The XSL stylesheets are not able to extract that information
4998 during processing because pages have not yet been created in
4999 XSLT transformation. Only the XSL-FO processor knows what
5000 page each element is placed on.
5001 Therefore some postprocessing must take place to populate
5002 page numbers in the olink database.
5010 <refentry version="5.0" id="insert.olink.pdf.frag">
5012 <refentrytitle>insert.olink.pdf.frag</refentrytitle>
5013 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
5016 <refname>insert.olink.pdf.frag</refname>
5017 <refpurpose>Add fragment identifiers for links into PDF files</refpurpose>
5021 <programlisting id="insert.olink.pdf.frag.frag">
5022 <xsl:param name="insert.olink.pdf.frag" select="0"></xsl:param>
5026 <refsection><info><title>Description</title></info>
5028 <para>The value of this parameter determines whether
5029 the cross reference URIs to PDF documents made with
5030 <tag>olink</tag> will
5031 include fragment identifiers.
5034 <para>When forming a URI to link to a PDF document,
5035 a fragment identifier (typically a '#' followed by an
5036 id value) appended to the PDF filename can be used by
5037 the PDF viewer to open
5038 the PDF file to a location within the document instead of
5040 However, not all PDF files have id
5041 values embedded in them, and not all PDF viewers can
5042 handle fragment identifiers.
5045 <para>If <parameter>insert.olink.pdf.frag</parameter> is set
5046 to a non-zero value, then any olink targeting a
5047 PDF file will have the fragment identifier appended to the URI.
5048 The URI is formed by concatenating the value of the
5049 <parameter>olink.base.uri</parameter> parameter, the
5050 value of the <tag class="attribute">baseuri</tag>
5051 attribute from the <tag class="element">document</tag>
5052 element in the olink database with the matching
5053 <tag class="attribute">targetdoc</tag> value,
5054 and the value of the <tag class="attribute">href</tag>
5055 attribute for the targeted element in the olink database.
5056 The <tag class="attribute">href</tag> attribute
5057 contains the fragment identifier.
5060 <para>If <parameter>insert.olink.pdf.frag</parameter> is set
5061 to zero (the default value), then
5062 the <tag class="attribute">href</tag> attribute
5063 from the olink database
5064 is not appended to PDF olinks, so the fragment identifier is left off.
5065 A PDF olink is any olink for which the
5066 <tag class="attribute">baseuri</tag> attribute
5067 from the matching <tag class="element">document</tag>
5068 element in the olink database ends with '.pdf'.
5069 Any other olinks will still have the fragment identifier added.
5074 <refentry version="5.0" id="prefer.internal.olink">
5076 <refentrytitle>prefer.internal.olink</refentrytitle>
5077 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
5080 <refname>prefer.internal.olink</refname>
5081 <refpurpose>Prefer a local olink reference to an external reference</refpurpose>
5085 <programlisting id="prefer.internal.olink.frag">
5086 <xsl:param name="prefer.internal.olink" select="0"></xsl:param>
5090 <refsection><info><title>Description</title></info>
5092 <para>If you are re-using XML content modules in multiple documents,
5093 you may want to redirect some of your olinks. This parameter
5094 permits you to redirect an olink to the current document.
5097 <para>For example: you are writing documentation for a product,
5098 which includes 3 manuals: a little installation
5099 booklet (booklet.xml), a user
5100 guide (user.xml), and a reference manual (reference.xml).
5101 All 3 documents begin with the same introduction section (intro.xml) that
5102 contains a reference to the customization section (custom.xml) which is
5103 included in both user.xml and reference.xml documents.
5106 <para>How do you write the link to custom.xml in intro.xml
5107 so that it is interpreted correctly in all 3 documents?</para>
5109 <listitem><para>If you use xref, it will fail in user.xml.</para>
5111 <listitem><para>If you use olink (pointing to reference.xml),
5112 the reference in user.xml
5113 will point to the customization section of the reference manual, while it is
5114 actually available in user.xml.</para>
5118 <para>If you set the <parameter>prefer.internal.olink</parameter>
5119 parameter to a non-zero value, then the processor will
5120 first look in the olink database
5121 for the olink's <tag>targetptr</tag> attribute value
5122 in document matching the <parameter>current.docid</parameter>
5123 parameter value. If it isn't found there, then
5124 it tries the document in the database
5125 with the <tag>targetdoc</tag>
5126 value that matches the olink's <tag>targetdoc</tag>
5130 <para>This feature permits an olink reference to resolve to
5131 the current document if there is an element
5132 with an id matching the olink's <tag>targetptr</tag>
5133 value. The current document's olink data must be
5134 included in the target database for this to work.</para>
5137 <para>There is a potential for incorrect links if
5138 the same <tag>id</tag> attribute value is used for different
5139 content in different documents.
5140 Some of your olinks may be redirected to the current document
5141 when they shouldn't be. It is not possible to control
5142 individual olink instances.</para>
5148 <refentry version="5.0" id="link.mailto.url">
5150 <refentrytitle>link.mailto.url</refentrytitle>
5151 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
5154 <refname>link.mailto.url</refname>
5155 <refpurpose>Mailto URL for the LINK REL=made HTML HEAD element</refpurpose>
5159 <programlisting id="link.mailto.url.frag">
5160 <xsl:param name="link.mailto.url"></xsl:param>
5164 <refsection><info><title>Description</title></info>
5166 <para>If not the empty string, this address will be used for the
5167 rel=made <literal>link</literal> element in the html <literal>head</literal>
5173 <refentry version="5.0" id="ulink.target">
5175 <refentrytitle>ulink.target</refentrytitle>
5176 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
5179 <refname>ulink.target</refname>
5180 <refpurpose>The HTML anchor target for ULinks</refpurpose>
5184 <programlisting id="ulink.target.frag">
5185 <xsl:param name="ulink.target">_top</xsl:param>
5189 <refsection><info><title>Description</title></info>
5191 <para>If <parameter>ulink.target</parameter> is non-zero, its value will
5192 be used for the <literal>target</literal> attribute
5193 on anchors generated for <tag>ulink</tag>s.</para>
5198 <refentry version="5.0" id="olink.fragid">
5200 <refentrytitle>olink.fragid</refentrytitle>
5201 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
5204 <refname>olink.fragid</refname>
5205 <refpurpose>Names the fragment identifier portion of an OLink resolver query</refpurpose>
5208 <programlisting id="olink.fragid.frag">
5209 <xsl:param name="olink.fragid">fragid=</xsl:param>
5212 <refsection><info><title>Description</title></info>
5213 <para>The fragment identifier portion of an <tag>olink</tag> target.</para>
5217 <refentry version="5.0" id="olink.outline.ext">
5219 <refentrytitle>olink.outline.ext</refentrytitle>
5220 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
5223 <refname>olink.outline.ext</refname>
5224 <refpurpose>The extension of OLink outline files</refpurpose>
5228 <programlisting id="olink.outline.ext.frag">
5229 <xsl:param name="olink.outline.ext">.olink</xsl:param>
5233 <refsection><info><title>Description</title></info>
5235 <para>The extension to be expected for OLink outline files</para>
5236 <para>Bob has this parameter as dead. Please don't use</para>
5241 <refentry version="5.0" id="olink.pubid">
5243 <refentrytitle>olink.pubid</refentrytitle>
5244 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
5247 <refname>olink.pubid</refname>
5248 <refpurpose>Names the public identifier portion of an OLink resolver query</refpurpose>
5252 <programlisting id="olink.pubid.frag">
5253 <xsl:param name="olink.pubid">pubid</xsl:param>
5257 <refsection><info><title>Description</title></info>
5264 <refentry version="5.0" id="olink.sysid">
5266 <refentrytitle>olink.sysid</refentrytitle>
5267 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
5270 <refname>olink.sysid</refname>
5271 <refpurpose>Names the system identifier portion of an OLink resolver query</refpurpose>
5275 <programlisting id="olink.sysid.frag">
5276 <xsl:param name="olink.sysid">sysid</xsl:param>
5280 <refsection><info><title>Description</title></info>
5287 <refentry version="5.0" id="olink.resolver">
5289 <refentrytitle>olink.resolver</refentrytitle>
5290 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
5293 <refname>olink.resolver</refname>
5294 <refpurpose>The root name of the OLink resolver (usually a script)</refpurpose>
5297 <programlisting id="olink.resolver.frag">
5298 <xsl:param name="olink.resolver">/cgi-bin/olink</xsl:param>
5301 <refsection><info><title>Description</title></info>
5306 </reference><reference id="xrefs" xml:base="../html/param.xml"><title>Cross References</title>
5307 <refentry version="5.0" id="collect.xref.targets">
5309 <refentrytitle>collect.xref.targets</refentrytitle>
5310 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
5311 <refmiscinfo class="other" otherclass="value">no</refmiscinfo>
5312 <refmiscinfo class="other" otherclass="value">yes</refmiscinfo>
5313 <refmiscinfo class="other" otherclass="value">only</refmiscinfo>
5316 <refname>collect.xref.targets</refname>
5317 <refpurpose>Controls whether cross reference data is
5318 collected</refpurpose>
5320 <refsynopsisdiv> <programlisting id="collect.xref.targets.frag">
5321 <xsl:param name="collect.xref.targets">no</xsl:param>
5324 <refsection><info><title>Description</title></info>
5327 In order to resolve olinks efficiently, the stylesheets can
5328 generate an external data file containing information about
5329 all potential cross reference endpoints in a document.
5330 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.
5331 See also <parameter>targets.filename</parameter>.
5336 <refentry version="5.0" id="insert.xref.page.number">
5338 <refentrytitle>insert.xref.page.number</refentrytitle>
5339 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
5340 <refmiscinfo class="other" otherclass="value">no</refmiscinfo>
5341 <refmiscinfo class="other" otherclass="value">yes</refmiscinfo>
5342 <refmiscinfo class="other" otherclass="value">maybe</refmiscinfo>
5345 <refname>insert.xref.page.number</refname>
5346 <refpurpose>Turns page numbers in xrefs on and off</refpurpose>
5350 <programlisting id="insert.xref.page.number.frag">
5351 <xsl:param name="insert.xref.page.number">no</xsl:param>
5355 <refsection><info><title>Description</title></info>
5357 <para>The value of this parameter determines if
5358 cross references (<tag>xref</tag>s) in
5360 include page number citations.
5361 It has three possible values.
5366 <listitem><para>No page number references will be generated.
5371 <listitem><para>Page number references will be generated
5372 for all <tag>xref</tag> elements.
5373 The style of page reference may be changed
5374 if an <tag class="attribute">xrefstyle</tag>
5380 <listitem><para>Page number references will not be generated
5381 for an <tag>xref</tag> element unless
5383 <tag class="attribute">xrefstyle</tag>
5384 attribute whose value specifies a page reference.
5392 <refentry version="5.0" id="use.role.as.xrefstyle">
5394 <refentrytitle>use.role.as.xrefstyle</refentrytitle>
5395 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
5398 <refname>use.role.as.xrefstyle</refname>
5399 <refpurpose>Use <tag class="attribute">role</tag> attribute for
5400 <tag class="attribute">xrefstyle</tag> on <tag>xref</tag>?</refpurpose>
5404 <programlisting id="use.role.as.xrefstyle.frag">
5405 <xsl:param name="use.role.as.xrefstyle" select="1"></xsl:param>
5409 <refsection><info><title>Description</title></info>
5411 <para>In DocBook documents that conform to a schema older than V4.3, this parameter allows
5412 <tag class="attribute">role</tag> to serve the purpose of specifying the cross reference style.</para>
5414 <para>If non-zero, the <tag class="attribute">role</tag> attribute on
5415 <tag>xref</tag> will be used to select the cross reference style.
5416 In DocBook V4.3, the <tag class="attribute">xrefstyle</tag> attribute was added for this purpose.
5417 If the <tag class="attribute">xrefstyle</tag> attribute is present,
5418 <tag class="attribute">role</tag> will be ignored, regardless of the setting
5419 of this parameter.</para>
5423 <refsection><info><title>Example</title></info>
5425 <para>The following small stylesheet shows how to configure the
5426 stylesheets to make use of the cross reference style:</para>
5428 <programlisting><?xml version="1.0"?>
5429 <xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
5432 <xsl:import href="../xsl/html/docbook.xsl"/>
5434 <xsl:output method="html"/>
5436 <xsl:param name="local.l10n.xml" select="document('')"/>
5437 <l:i18n xmlns:l="http://docbook.sourceforge.net/xmlns/l10n/1.0">
5438 <l:l10n xmlns:l="http://docbook.sourceforge.net/xmlns/l10n/1.0" language="en">
5439 <l:context name="xref">
5440 <l:template name="chapter" style="title" text="Chapter %n, %t"/>
5441 <l:template name="chapter" text="Chapter %n"/>
5446 </xsl:stylesheet></programlisting>
5448 <para>With this stylesheet, the cross references in the following document:</para>
5450 <programlisting><?xml version="1.0" encoding="utf-8"?>
5451 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
5452 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
5453 <book id="book"><title>Book</title>
5456 <title>Preface</title>
5458 <para>Normal: <xref linkend="ch1"/>.</para>
5459 <para>Title: <xref xrefstyle="title" linkend="ch1"/>.</para>
5463 <chapter id="ch1">
5464 <title>First Chapter</title>
5466 <para>Irrelevant.</para>
5469 </book></programlisting>
5471 <para>will appear as:</para>
5474 <para>Normal: Chapter 1.</para>
5475 <para>Title: Chapter 1, <emphasis>First Chapter</emphasis>.</para>
5481 <refentry version="5.0" id="xref.with.number.and.title">
5483 <refentrytitle>xref.with.number.and.title</refentrytitle>
5484 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
5487 <refname>xref.with.number.and.title</refname>
5488 <refpurpose>Use number and title in cross references</refpurpose>
5492 <programlisting id="xref.with.number.and.title.frag">
5493 <xsl:param name="xref.with.number.and.title" select="1"></xsl:param>
5497 <refsection><info><title>Description</title></info>
5499 <para>A cross reference may include the number (for example, the number of
5500 an example or figure) and the <tag>title</tag> which is a required child of some
5501 targets. This parameter inserts both the relevant number as well as
5502 the title into the link. </para>
5507 <refentry version="5.0" id="xref.label-page.separator">
5509 <refentrytitle>xref.label-page.separator</refentrytitle>
5510 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
5513 <refname>xref.label-page.separator</refname>
5514 <refpurpose>Punctuation or space separating label from page number in xref</refpurpose>
5518 <programlisting id="xref.label-page.separator.frag"><xsl:param name="xref.label-page.separator"><xsl:text> </xsl:text></xsl:param></programlisting>
5521 <refsection><info><title>Description</title></info>
5524 This parameter allows you to control the punctuation of certain
5525 types of generated cross reference text.
5526 When cross reference text is generated for an
5527 <tag class="element">xref</tag> or
5528 <tag class="element">olink</tag> element
5529 using an <tag class="attribute">xrefstyle</tag> attribute
5530 that makes use of the <literal>select:</literal> feature,
5531 and the selected components include both label and page
5533 then the value of this parameter is inserted between
5534 label and page number in the output.
5535 If a title is included, then other separators are used.
5541 <refentry version="5.0" id="xref.label-title.separator">
5543 <refentrytitle>xref.label-title.separator</refentrytitle>
5544 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
5547 <refname>xref.label-title.separator</refname>
5548 <refpurpose>Punctuation or space separating label from title in xref</refpurpose>
5552 <programlisting id="xref.label-title.separator.frag"><xsl:param name="xref.label-title.separator">: </xsl:param></programlisting>
5555 <refsection><info><title>Description</title></info>
5558 This parameter allows you to control the punctuation of certain
5559 types of generated cross reference text.
5560 When cross reference text is generated for an
5561 <tag class="element">xref</tag> or
5562 <tag class="element">olink</tag> element
5563 using an <tag class="attribute">xrefstyle</tag> attribute
5564 that makes use of the <literal>select:</literal> feature,
5565 and the selected components include both label and title,
5566 then the value of this parameter is inserted between
5567 label and title in the output.
5573 <refentry version="5.0" id="xref.title-page.separator">
5575 <refentrytitle>xref.title-page.separator</refentrytitle>
5576 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
5579 <refname>xref.title-page.separator</refname>
5580 <refpurpose>Punctuation or space separating title from page number in xref</refpurpose>
5584 <programlisting id="xref.title-page.separator.frag"><xsl:param name="xref.title-page.separator"><xsl:text> </xsl:text></xsl:param></programlisting>
5587 <refsection><info><title>Description</title></info>
5590 This parameter allows you to control the punctuation of certain
5591 types of generated cross reference text.
5592 When cross reference text is generated for an
5593 <tag class="element">xref</tag> or
5594 <tag class="element">olink</tag> element
5595 using an <tag class="attribute">xrefstyle</tag> attribute
5596 that makes use of the <literal>select:</literal> feature,
5597 and the selected components include both title and page number,
5598 then the value of this parameter is inserted between
5599 title and page number in the output.
5605 </reference><reference id="lists" xml:base="../html/param.xml"><title>Lists</title>
5606 <refentry version="5.0" id="segmentedlist.as.table">
5608 <refentrytitle>segmentedlist.as.table</refentrytitle>
5609 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
5612 <refname>segmentedlist.as.table</refname>
5613 <refpurpose>Format segmented lists as tables?</refpurpose>
5617 <programlisting id="segmentedlist.as.table.frag">
5618 <xsl:param name="segmentedlist.as.table" select="0"></xsl:param>
5622 <refsection><info><title>Description</title></info>
5624 <para>If non-zero, <tag>segmentedlist</tag>s will be formatted as
5630 <refentry version="5.0" id="variablelist.as.table">
5632 <refentrytitle>variablelist.as.table</refentrytitle>
5633 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
5636 <refname>variablelist.as.table</refname>
5637 <refpurpose>Format <tag>variablelist</tag>s as tables?</refpurpose>
5641 <programlisting id="variablelist.as.table.frag">
5642 <xsl:param name="variablelist.as.table" select="0"></xsl:param>
5646 <refsection><info><title>Description</title></info>
5648 <para>If non-zero, <tag>variablelist</tag>s will be formatted as
5649 tables. A processing instruction exists to specify a particular width for the
5650 column containing the <tag>term</tag>s:
5651 <tag class="xmlpi">dbhtml term-width=".25in"</tag></para>
5653 <para>You can override this setting with a processing instruction as the
5654 child of <tag>variablelist</tag>: <tag class="xmlpi">dbhtml
5655 list-presentation="table"</tag> or <tag class="xmlpi">dbhtml
5656 list-presentation="list"</tag>.</para>
5658 <para>This parameter only applies to the HTML transformations. In the
5659 FO case, proper list markup is robust enough to handle the formatting.
5660 But see also <parameter>variablelist.as.blocks</parameter>.</para>
5662 <programlisting> <variablelist>
5663 <?dbhtml list-presentation="table"?>
5664 <?dbhtml term-width="1.5in"?>
5665 <?dbfo list-presentation="list"?>
5666 <?dbfo term-width="1in"?>
5667 <varlistentry>
5668 <term>list</term>
5671 Formatted as a table even if variablelist.as.table is set to 0.
5674 </varlistentry>
5675 </variablelist></programlisting>
5680 <refentry version="5.0" id="variablelist.term.separator">
5682 <refentrytitle>variablelist.term.separator</refentrytitle>
5683 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
5686 <refname>variablelist.term.separator</refname>
5687 <refpurpose>Text to separate <tag>term</tag>s within a multi-term
5688 <tag>varlistentry</tag></refpurpose>
5692 <programlisting id="variablelist.term.separator.frag">
5693 <xsl:param name="variablelist.term.separator">, </xsl:param></programlisting>
5696 <refsection><info><title>Description</title></info>
5698 <para>When a <tag>varlistentry</tag> contains multiple <tag>term</tag>
5699 elements, the string specified in the value of the
5700 <parameter>variablelist.term.separator</parameter> parameter is placed
5701 after each <tag>term</tag> except the last.</para>
5704 <para>To generate a line break between multiple <tag>term</tag>s in
5705 a <tag>varlistentry</tag>, set a non-zero value for the
5706 <parameter>variablelist.term.break.after</parameter> parameter. If
5707 you do so, you may also want to set the value of the
5708 <parameter>variablelist.term.separator</parameter> parameter to an
5709 empty string (to suppress rendering of the default comma and space
5710 after each <tag>term</tag>).</para>
5716 <refentry version="5.0" id="variablelist.term.break.after">
5718 <refentrytitle>variablelist.term.break.after</refentrytitle>
5719 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
5722 <refname>variablelist.term.break.after</refname>
5723 <refpurpose>Generate line break after each <tag>term</tag> within a
5724 multi-term <tag>varlistentry</tag>?</refpurpose>
5728 <programlisting id="variablelist.term.break.after.frag">
5729 <xsl:param name="variablelist.term.break.after">0</xsl:param></programlisting>
5732 <refsection><info><title>Description</title></info>
5734 <para>Set a non-zero value for the
5735 <parameter>variablelist.term.break.after</parameter> parameter to
5736 generate a line break between <tag>term</tag>s in a
5737 multi-term <tag>varlistentry</tag>.</para>
5740 <para>If you set a non-zero value for
5741 <parameter>variablelist.term.break.after</parameter>, you may also
5742 want to set the value of the
5743 <parameter>variablelist.term.separator</parameter> parameter to an
5744 empty string (to suppress rendering of the default comma and space
5745 after each <tag>term</tag>).</para>
5751 </reference><reference id="biblio" xml:base="../html/param.xml"><title>Bibliography</title>
5752 <refentry version="5.0" id="bibliography.style">
5754 <refentrytitle>bibliography.style</refentrytitle>
5755 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
5756 <refmiscinfo class="other" otherclass="value">normal</refmiscinfo>
5757 <refmiscinfo class="other" otherclass="value">iso690</refmiscinfo>
5760 <refname>bibliography.style</refname>
5761 <refpurpose>Style used for formatting of biblioentries.</refpurpose>
5765 <programlisting id="bibliography.style.frag">
5766 <xsl:param name="bibliography.style">normal</xsl:param>
5770 <refsection><info><title>Description</title></info>
5772 <para>Currently only <literal>normal</literal> and
5773 <literal>iso690</literal> styles are supported.</para>
5775 <para>In order to use ISO690 style to the full extent you might need
5776 to use additional markup described on <link xlink:href="http://wiki.docbook.org/topic/ISO690Bibliography">the
5777 following WiKi page</link>.</para>
5782 <refentry version="5.0" id="biblioentry.item.separator">
5784 <refentrytitle>biblioentry.item.separator</refentrytitle>
5785 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
5788 <refname>biblioentry.item.separator</refname>
5789 <refpurpose>Text to separate bibliography entries</refpurpose>
5793 <programlisting id="biblioentry.item.separator.frag"><xsl:param name="biblioentry.item.separator">. </xsl:param></programlisting>
5796 <refsection><info><title>Description</title></info>
5798 <para>Text to separate bibliography entries
5804 <refentry version="5.0" id="bibliography.collection">
5806 <refentrytitle>bibliography.collection</refentrytitle>
5807 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
5810 <refname>bibliography.collection</refname>
5811 <refpurpose>Name of the bibliography collection file</refpurpose>
5815 <programlisting id="bibliography.collection.frag">
5816 <xsl:param name="bibliography.collection">http://docbook.sourceforge.net/release/bibliography/bibliography.xml</xsl:param>
5821 <refsection><info><title>Description</title></info>
5823 <para>Maintaining bibliography entries across a set of documents is tedious, time
5824 consuming, and error prone. It makes much more sense, usually, to store all of
5825 the bibliography entries in a single place and simply <quote>extract</quote>
5826 the ones you need in each document.</para>
5828 <para>That's the purpose of the
5829 <parameter>bibliography.collection</parameter> parameter. To setup a global
5830 bibliography <quote>database</quote>, follow these steps:</para>
5832 <para>First, create a stand-alone bibliography document that contains all of
5833 the documents that you wish to reference. Make sure that each bibliography
5834 entry (whether you use <tag>biblioentry</tag> or <tag>bibliomixed</tag>)
5837 <para>My global bibliography, <filename>~/bibliography.xml</filename> begins
5841 <programlisting><!DOCTYPE bibliography
5842 PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
5843 "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
5844 <bibliography><title>References</title>
5846 <bibliomixed id="xml-rec"><abbrev>XML 1.0</abbrev>Tim Bray,
5847 Jean Paoli, C. M. Sperberg-McQueen, and Eve Maler, editors.
5848 <citetitle><ulink url="http://www.w3.org/TR/REC-xml">Extensible Markup
5849 Language (XML) 1.0 Second Edition</ulink></citetitle>.
5850 World Wide Web Consortium, 2000.
5851 </bibliomixed>
5853 <bibliomixed id="xml-names"><abbrev>Namespaces</abbrev>Tim Bray,
5855 and Andrew Layman, editors.
5856 <citetitle><ulink url="http://www.w3.org/TR/REC-xml-names/">Namespaces in
5857 XML</ulink></citetitle>.
5858 World Wide Web Consortium, 1999.
5859 </bibliomixed>
5862 </bibliography>
5866 <para>When you create a bibliography in your document, simply
5867 provide <emphasis>empty</emphasis> <tag>bibliomixed</tag>
5868 entries for each document that you wish to cite. Make sure that these
5869 elements have the same ID as the corresponding <quote>real</quote>
5870 entry in your global bibliography.</para>
5872 <para>For example:</para>
5875 <programlisting><bibliography><title>Bibliography</title>
5877 <bibliomixed id="xml-rec"/>
5878 <bibliomixed id="xml-names"/>
5879 <bibliomixed id="DKnuth86">Donald E. Knuth. <citetitle>Computers and
5880 Typesetting: Volume B, TeX: The Program</citetitle>. Addison-Wesley,
5881 1986. ISBN 0-201-13437-3.
5882 </bibliomixed>
5883 <bibliomixed id="relaxng"/>
5885 </bibliography></programlisting>
5888 <para>Note that it's perfectly acceptable to mix entries from your
5889 global bibliography with <quote>normal</quote> entries. You can use
5890 <tag>xref</tag> or other elements to cross-reference your
5891 bibliography entries in exactly the same way you do now.</para>
5893 <para>Finally, when you are ready to format your document, simply set the
5894 <parameter>bibliography.collection</parameter> parameter (in either a
5895 customization layer or directly through your processor's interface) to
5896 point to your global bibliography.</para>
5898 <para>The stylesheets will format the bibliography in your document as if
5899 all of the entries referenced appeared there literally.</para>
5904 <refentry version="5.0" id="bibliography.numbered">
5906 <refentrytitle>bibliography.numbered</refentrytitle>
5907 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
5910 <refname>bibliography.numbered</refname>
5911 <refpurpose>Should bibliography entries be numbered?</refpurpose>
5915 <programlisting id="bibliography.numbered.frag">
5916 <xsl:param name="bibliography.numbered" select="0"></xsl:param>
5920 <refsection><info><title>Description</title></info>
5922 <para>If non-zero bibliography entries will be numbered</para>
5927 </reference><reference id="glossary" xml:base="../html/param.xml"><title>Glossary</title>
5928 <refentry version="5.0" id="glossterm.auto.link">
5930 <refentrytitle>glossterm.auto.link</refentrytitle>
5931 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
5934 <refname>glossterm.auto.link</refname>
5935 <refpurpose>Generate links from glossterm to glossentry automatically?</refpurpose>
5939 <programlisting id="glossterm.auto.link.frag">
5940 <xsl:param name="glossterm.auto.link" select="0"></xsl:param>
5944 <refsection><info><title>Description</title></info>
5946 <para>If non-zero, links from inline <tag>glossterm</tag>s to the corresponding
5947 <tag>glossentry</tag> elements in a <tag>glossary</tag> or <tag>glosslist</tag>
5948 will be automatically generated. This is useful when your glossterms are consistent
5949 and you don't want to add links manually.</para>
5951 <para>The automatic link generation feature is not used on <tag>glossterm</tag> elements
5952 that have a <tag class="attribute">linkend</tag> attribute.</para>
5957 <refentry version="5.0" id="firstterm.only.link">
5959 <refentrytitle>firstterm.only.link</refentrytitle>
5960 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
5963 <refname>firstterm.only.link</refname>
5964 <refpurpose>Does automatic glossterm linking only apply to firstterms?</refpurpose>
5968 <programlisting id="firstterm.only.link.frag">
5969 <xsl:param name="firstterm.only.link" select="0"></xsl:param>
5973 <refsection><info><title>Description</title></info>
5975 <para>If non-zero, only <tag>firstterm</tag>s will be automatically linked
5976 to the glossary. If glossary linking is not enabled, this parameter
5977 has no effect.</para>
5982 <refentry version="5.0" id="glossary.collection">
5984 <refentrytitle>glossary.collection</refentrytitle>
5985 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
5988 <refname>glossary.collection</refname>
5989 <refpurpose>Name of the glossary collection file</refpurpose>
5993 <programlisting id="glossary.collection.frag">
5994 <xsl:param name="glossary.collection"></xsl:param>
5998 <refsection><info><title>Description</title></info>
6000 <para>Glossaries maintained independently across a set of documents
6001 are likely to become inconsistent unless considerable effort is
6002 expended to keep them in sync. It makes much more sense, usually, to
6003 store all of the glossary entries in a single place and simply
6004 <quote>extract</quote> the ones you need in each document.</para>
6006 <para>That's the purpose of the
6007 <parameter>glossary.collection</parameter> parameter. To setup a global
6008 glossary <quote>database</quote>, follow these steps:</para>
6010 <refsection><info><title>Setting Up the Glossary Database</title></info>
6012 <para>First, create a stand-alone glossary document that contains all of
6013 the entries that you wish to reference. Make sure that each glossary
6014 entry has an ID.</para>
6016 <para>Here's an example glossary:</para>
6020 <?xml version="1.0" encoding="utf-8"?>
6021 <!DOCTYPE glossary
6022 PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
6023 "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
6025 <glossaryinfo>
6026 <editor><firstname>Eric</firstname><surname>Raymond</surname></editor>
6027 <title>Jargon File 4.2.3 (abridged)</title>
6028 <releaseinfo>Just some test data</releaseinfo>
6029 </glossaryinfo>
6031 <glossdiv><title>0</title>
6034 <glossterm>0</glossterm>
6036 <para>Numeric zero, as opposed to the letter `O' (the 15th letter of
6037 the English alphabet). In their unmodified forms they look a lot
6038 alike, and various kluges invented to make them visually distinct have
6039 compounded the confusion. If your zero is center-dotted and letter-O
6040 is not, or if letter-O looks almost rectangular but zero looks more
6041 like an American football stood on end (or the reverse), you're
6042 probably looking at a modern character display (though the dotted zero
6043 seems to have originated as an option on IBM 3270 controllers). If
6044 your zero is slashed but letter-O is not, you're probably looking at
6045 an old-style ASCII graphic set descended from the default typewheel on
6046 the venerable ASR-33 Teletype (Scandinavians, for whom /O is a letter,
6047 curse this arrangement). (Interestingly, the slashed zero long
6048 predates computers; Florian Cajori's monumental "A History of
6049 Mathematical Notations" notes that it was used in the twelfth and
6050 thirteenth centuries.) If letter-O has a slash across it and the zero
6051 does not, your display is tuned for a very old convention used at IBM
6052 and a few other early mainframe makers (Scandinavians curse <emphasis>this</emphasis>
6053 arrangement even more, because it means two of their letters collide).
6054 Some Burroughs/Unisys equipment displays a zero with a <emphasis>reversed</emphasis>
6055 slash. Old CDC computers rendered letter O as an unbroken oval and 0
6056 as an oval broken at upper right and lower left. And yet another
6057 convention common on early line printers left zero unornamented but
6058 added a tail or hook to the letter-O so that it resembled an inverted
6059 Q or cursive capital letter-O (this was endorsed by a draft ANSI
6060 standard for how to draw ASCII characters, but the final standard
6061 changed the distinguisher to a tick-mark in the upper-left corner).
6062 Are we sufficiently confused yet?</para>
6067 <glossterm>1TBS</glossterm>
6069 <para role="accidence">
6070 <phrase role="pronounce"></phrase>
6071 <phrase role="partsofspeach">n</phrase>
6073 <para>The "One True Brace Style"</para>
6074 <glossseealso>indent style</glossseealso>
6084 </glossary></programlisting>
6089 <refsection><info><title>Marking Up Glossary Terms</title></info>
6091 <para>That takes care of the glossary database, now you have to get the entries
6092 into your document. Unlike bibliography entries, which can be empty, creating
6093 <quote>placeholder</quote> glossary entries would be very tedious. So instead,
6094 support for <parameter>glossary.collection</parameter> relies on implicit linking.</para>
6096 <para>In your source document, simply use <tag>firstterm</tag> and
6097 <tag>glossterm</tag> to identify the terms you wish to have included
6098 in the glossary. The stylesheets assume that you will either set the
6099 <tag class="attribute">baseform</tag> attribute correctly, or that the
6100 content of the element exactly matches a term in your glossary.</para>
6102 <para>If you're using a <parameter>glossary.collection</parameter>, don't
6103 make explicit links on the terms in your document.</para>
6105 <para>So, in your document, you might write things like this:</para>
6108 <programlisting><para>This is dummy text, without any real meaning.
6109 The point is simply to reference glossary terms like <glossterm>0</glossterm>
6110 and the <firstterm baseform="1TBS">One True Brace Style (1TBS)</firstterm>.
6111 The <glossterm>1TBS</glossterm>, as you can probably imagine, is a nearly
6112 religious issue.</para></programlisting>
6115 <para>If you set the <parameter>firstterm.only.link</parameter> parameter,
6116 only the terms marked with <tag>firstterm</tag> will be links.
6117 Otherwise, all the terms will be linked.</para>
6121 <refsection><info><title>Marking Up the Glossary</title></info>
6123 <para>The glossary itself has to be identified for the stylesheets. For lack
6124 of a better choice, the <tag class="attribute">role</tag> is used.
6125 To identify the glossary as the target for automatic processing, set
6126 the role to <quote><literal>auto</literal></quote>. The title of this
6127 glossary (and any other information from the <tag>glossaryinfo</tag>
6128 that's rendered by your stylesheet) will be displayed, but the entries will
6129 come from the database.
6132 <para>Unfortunately, the glossary can't be empty, so you must put in
6133 at least one <tag>glossentry</tag>. The content of this entry
6134 is irrelevant, it will not be rendered:</para>
6137 <programlisting><glossary role="auto">
6139 <glossterm>Irrelevant</glossterm>
6141 <para>If you can see this, the document was processed incorrectly. Use
6142 the <parameter>glossary.collection</parameter> parameter.</para>
6145 </glossary></programlisting>
6148 <para>What about glossary divisions? If your glossary database has glossary
6149 divisions <emphasis>and</emphasis> your automatic glossary contains at least
6150 one <tag>glossdiv</tag>, the automic glossary will have divisions.
6151 If the <tag>glossdiv</tag> is missing from either location, no divisions
6152 will be rendered.</para>
6154 <para>Glossary entries (and divisions, if appropriate) in the glossary will
6155 occur in precisely the order they occur in your database.</para>
6159 <refsection><info><title>Formatting the Document</title></info>
6161 <para>Finally, when you are ready to format your document, simply set the
6162 <parameter>glossary.collection</parameter> parameter (in either a
6163 customization layer or directly through your processor's interface) to
6164 point to your global glossary.</para>
6166 <para>The stylesheets will format the glossary in your document as if
6167 all of the entries implicilty referenced appeared there literally.</para>
6170 <refsection><info><title>Limitations</title></info>
6172 <para>Glossary cross-references <emphasis>within the glossary</emphasis> are
6173 not supported. For example, this <emphasis>will not</emphasis> work:</para>
6176 <programlisting><glossentry>
6177 <glossterm>gloss-1</glossterm>
6178 <glossdef><para>A description that references <glossterm>gloss-2</glossterm>.</para>
6179 <glossseealso>gloss-2</glossseealso>
6181 </glossentry></programlisting>
6184 <para>If you put glossary cross-references in your glossary that way,
6185 you'll get the cryptic error: <computeroutput>Warning:
6186 glossary.collection specified, but there are 0 automatic
6187 glossaries</computeroutput>.</para>
6189 <para>Instead, you must do two things:</para>
6193 <para>Markup your glossary using <tag>glossseealso</tag>:</para>
6196 <programlisting><glossentry>
6197 <glossterm>gloss-1</glossterm>
6198 <glossdef><para>A description that references <glossterm>gloss-2</glossterm>.</para>
6199 <glossseealso>gloss-2</glossseealso>
6201 </glossentry></programlisting>
6206 <para>Make sure there is at least one <tag>glossterm</tag> reference to
6207 <glossterm>gloss-2</glossterm> <emphasis>in your document</emphasis>. The
6208 easiest way to do that is probably within a <tag>remark</tag> in your
6209 automatic glossary:</para>
6212 <programlisting><glossary role="auto">
6213 <remark>Make sure there's a reference to <glossterm>gloss-2</glossterm>.</remark>
6215 <glossterm>Irrelevant</glossterm>
6217 <para>If you can see this, the document was processed incorrectly. Use
6218 the <parameter>glossary.collection</parameter> parameter.</para>
6221 </glossary></programlisting>
6230 <refentry version="5.0" id="glossary.sort">
6232 <refentrytitle>glossary.sort</refentrytitle>
6233 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
6236 <refname>glossary.sort</refname>
6237 <refpurpose>Sort glossentry elements?</refpurpose>
6241 <programlisting id="glossary.sort.frag">
6242 <xsl:param name="glossary.sort" select="0"></xsl:param>
6246 <refsection><info><title>Description</title></info>
6248 <para>If non-zero, then the glossentry elements within a
6249 glossary, glossdiv, or glosslist are sorted on the glossterm, using
6250 the current lang setting. If zero (the default), then
6251 glossentry elements are not sorted and are presented
6258 <refentry version="5.0" id="glossentry.show.acronym">
6260 <refentrytitle>glossentry.show.acronym</refentrytitle>
6261 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
6262 <refmiscinfo class="other" otherclass="value">no</refmiscinfo>
6263 <refmiscinfo class="other" otherclass="value">yes</refmiscinfo>
6264 <refmiscinfo class="other" otherclass="value">primary</refmiscinfo>
6267 <refname>glossentry.show.acronym</refname>
6268 <refpurpose>Display <tag>glossentry</tag> acronyms?</refpurpose>
6272 <programlisting id="glossentry.show.acronym.frag">
6273 <xsl:param name="glossentry.show.acronym">no</xsl:param>
6277 <refsection><info><title>Description</title></info>
6279 <para>A setting of <quote>yes</quote> means they should be displayed;
6280 <quote>no</quote> means they shouldn't. If <quote>primary</quote> is used,
6281 then they are shown as the primary text for the entry.</para>
6284 <para>This setting controls both <tag>acronym</tag> and
6285 <tag>abbrev</tag> elements in the <tag>glossentry</tag>.</para>
6291 </reference><reference id="misc" xml:base="../html/param.xml"><title>Miscellaneous</title>
6292 <refentry version="5.0" id="formal.procedures">
6294 <refentrytitle>formal.procedures</refentrytitle>
6295 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
6298 <refname>formal.procedures</refname>
6299 <refpurpose>Selects formal or informal procedures</refpurpose>
6303 <programlisting id="formal.procedures.frag">
6304 <xsl:param name="formal.procedures" select="1"></xsl:param>
6308 <refsection><info><title>Description</title></info>
6310 <para>Formal procedures are numbered and always have a title.
6316 <refentry version="5.0" id="formal.title.placement">
6318 <refentrytitle>formal.title.placement</refentrytitle>
6319 <refmiscinfo class="other" otherclass="datatype">table</refmiscinfo>
6322 <refname>formal.title.placement</refname>
6323 <refpurpose>Specifies where formal object titles should occur</refpurpose>
6327 <programlisting id="formal.title.placement.frag">
6328 <xsl:param name="formal.title.placement">
6339 <refsection><info><title>Description</title></info>
6341 <para>Specifies where formal object titles should occur. For each formal object
6342 type (<tag>figure</tag>,
6344 <tag>equation</tag>,
6345 <tag>table</tag>, and <tag>procedure</tag>)
6346 you can specify either the keyword
6347 <quote><literal>before</literal></quote> or
6348 <quote><literal>after</literal></quote>.</para>
6353 <refentry version="5.0" id="runinhead.default.title.end.punct">
6355 <refentrytitle>runinhead.default.title.end.punct</refentrytitle>
6356 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
6359 <refname>runinhead.default.title.end.punct</refname>
6360 <refpurpose>Default punctuation character on a run-in-head</refpurpose>
6364 <programlisting id="runinhead.default.title.end.punct.frag"><xsl:param name="runinhead.default.title.end.punct">.</xsl:param>
6368 <refsection><info><title>Description</title></info>
6370 <para>If non-zero, For a <tag>formalpara</tag>, use the specified
6371 string as the separator between the title and following text. The period is the default value.</para>
6376 <refentry version="5.0" id="runinhead.title.end.punct">
6378 <refentrytitle>runinhead.title.end.punct</refentrytitle>
6379 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
6382 <refname>runinhead.title.end.punct</refname>
6383 <refpurpose>Characters that count as punctuation on a run-in-head</refpurpose>
6387 <programlisting id="runinhead.title.end.punct.frag">
6388 <xsl:param name="runinhead.title.end.punct">.!?:</xsl:param>
6392 <refsection><info><title>Description</title></info>
6394 <para>Specify which characters are to be counted as punctuation. These
6395 characters are checked for a match with the last character of the
6396 title. If no match is found, the
6397 <parameter>runinhead.default.title.end.punct</parameter> contents are
6398 inserted. This is to avoid duplicated punctuation in the output.
6404 <refentry version="5.0" id="show.comments">
6406 <refentrytitle>show.comments</refentrytitle>
6407 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
6410 <refname>show.comments</refname>
6411 <refpurpose>Display <tag>remark</tag> elements?</refpurpose>
6415 <programlisting id="show.comments.frag">
6416 <xsl:param name="show.comments" select="1"></xsl:param>
6420 <refsection><info><title>Description</title></info>
6422 <para>If non-zero, comments will be displayed, otherwise they
6423 are suppressed. Comments here refers to the <tag>remark</tag> element
6424 (which was called <literal>comment</literal> prior to DocBook
6425 4.0), not XML comments (<-- like this -->) which are
6432 <refentry version="5.0" id="show.revisionflag">
6434 <refentrytitle>show.revisionflag</refentrytitle>
6435 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
6438 <refname>show.revisionflag</refname>
6439 <refpurpose>Enable decoration of elements that have a revisionflag</refpurpose>
6443 <programlisting id="show.revisionflag.frag">
6444 <xsl:param name="show.revisionflag" select="0"></xsl:param>
6448 <refsection><info><title>Description</title></info>
6451 If <parameter>show.revisionflag</parameter> is turned on, then the stylesheets
6452 may produce additional markup designed to allow a CSS stylesheet to
6453 highlight elements that have specific revisionflag settings.</para>
6455 <para>The markup inserted will be usually be either a <span> or
6456 <div> with an appropriate <literal>class</literal>
6457 attribute. (The value of the class attribute will be the same as the
6458 value of the revisionflag attribute). In some contexts, for example
6459 tables, where extra markup would be structurally illegal, the class
6460 attribute will be added to the appropriate container element.</para>
6462 <para>In general, the stylesheets only test for revisionflag in contexts
6463 where an importing stylesheet would have to redefine whole templates.
6464 Most of the revisionflag processing is expected to be done by another
6465 stylesheet, for example <filename>changebars.xsl</filename>.</para>
6470 <refentry version="5.0" id="shade.verbatim">
6472 <refentrytitle>shade.verbatim</refentrytitle>
6473 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
6476 <refname>shade.verbatim</refname>
6477 <refpurpose>Should verbatim environments be shaded?</refpurpose>
6481 <programlisting id="shade.verbatim.frag"><xsl:param name="shade.verbatim" select="0"></xsl:param></programlisting>
6484 <refsection><info><title>Description</title></info>
6486 <para>In the FO stylesheet, if this parameter is non-zero then the
6487 <property>shade.verbatim.style</property> properties will be applied
6488 to verbatim environments.</para>
6490 <para>In the HTML stylesheet, this parameter is now deprecated. Use
6496 <refentry version="5.0" id="shade.verbatim.style">
6498 <refentrytitle>shade.verbatim.style</refentrytitle>
6499 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
6502 <refname>shade.verbatim.style</refname>
6503 <refpurpose>Properties that specify the style of shaded verbatim listings</refpurpose>
6507 <programlisting id="shade.verbatim.style.frag">
6508 <xsl:attribute-set name="shade.verbatim.style">
6509 <xsl:attribute name="border">0</xsl:attribute>
6510 <xsl:attribute name="bgcolor">#E0E0E0</xsl:attribute>
6511 </xsl:attribute-set>
6516 <refsection><info><title>Description</title></info>
6518 <para>Properties that specify the style of shaded verbatim listings. The
6519 parameters specified (the border and background color) are added to
6520 the styling of the xsl-fo output. A border might be specified as "thin
6521 black solid" for example. See <link xlink:href="http://www.w3.org/TR/2004/WD-xsl11-20041216/#border">xsl-fo</link></para>
6526 <refentry version="5.0" id="punct.honorific">
6528 <refentrytitle>punct.honorific</refentrytitle>
6529 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
6532 <refname>punct.honorific</refname>
6533 <refpurpose>Punctuation after an honorific in a personal name.</refpurpose>
6537 <programlisting id="punct.honorific.frag">
6538 <xsl:param name="punct.honorific">.</xsl:param>
6542 <refsection><info><title>Description</title></info>
6544 <para>This parameter specifies the punctuation that should be added after an
6545 honorific in a personal name.</para>
6550 <refentry version="5.0" id="tex.math.in.alt">
6552 <refentrytitle>tex.math.in.alt</refentrytitle>
6553 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
6554 <refmiscinfo class="other" otherclass="value">plain</refmiscinfo>
6555 <refmiscinfo class="other" otherclass="value">latex</refmiscinfo>
6558 <refname>tex.math.in.alt</refname>
6559 <refpurpose>TeX notation used for equations</refpurpose>
6563 <programlisting id="tex.math.in.alt.frag">
6564 <xsl:param name="tex.math.in.alt"></xsl:param>
6568 <refsection><info><title>Description</title></info>
6570 <para>If you want type math directly in TeX notation in equations,
6571 this parameter specifies notation used. Currently are supported two
6572 values -- <literal>plain</literal> and <literal>latex</literal>. Empty
6573 value means that you are not using TeX math at all.</para>
6575 <para>Preferred way for including TeX alternative of math is inside of
6576 <tag>textobject</tag> element. Eg.:</para>
6578 <programlisting><inlineequation>
6579 <inlinemediaobject>
6581 <imagedata fileref="eq1.gif"/>
6582 </imageobject>
6583 <textobject><phrase>E=mc squared</phrase></textobject>
6584 <textobject role="tex"><phrase>E=mc^2</phrase></textobject>
6585 </inlinemediaobject>
6586 </inlineequation></programlisting>
6588 <para>If you are using <tag>graphic</tag> element, you can
6589 store TeX inside <tag>alt</tag> element:</para>
6591 <programlisting><inlineequation>
6592 <alt role="tex">a^2+b^2=c^2</alt>
6593 <graphic fileref="a2b2c2.gif"/>
6594 </inlineequation></programlisting>
6596 <para>If you want use this feature, you should process your FO with
6597 PassiveTeX, which only supports TeX math notation. When calling
6598 stylsheet, don't forget to specify also
6599 passivetex.extensions=1.</para>
6601 <para>If you want equations in HTML, just process generated file
6602 <filename>tex-math-equations.tex</filename> by TeX or LaTeX. Then run
6603 dvi2bitmap program on result DVI file. You will get images for
6604 equations in your document.</para>
6607 <para>This feature is useful for print/PDF output only if you
6608 use the obsolete and now unsupported PassiveTeX XSL-FO
6614 <refsection><info><title>Related Parameters</title></info>
6615 <para><parameter>tex.math.delims</parameter>,
6616 <parameter>passivetex.extensions</parameter>,
6617 <parameter>tex.math.file</parameter></para>
6622 <refentry version="5.0" id="tex.math.file">
6624 <refentrytitle>tex.math.file</refentrytitle>
6625 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
6628 <refname>tex.math.file</refname>
6629 <refpurpose>Name of temporary file for generating images from equations</refpurpose>
6633 <programlisting id="tex.math.file.frag">
6634 <xsl:param name="tex.math.file">tex-math-equations.tex</xsl:param>
6638 <refsection><info><title>Description</title></info>
6640 <para>Name of auxiliary file for TeX equations. This file can be
6641 processed by dvi2bitmap to get bitmap versions of equations for HTML
6645 <refsection><info><title>Related Parameters</title></info>
6646 <para><parameter>tex.math.in.alt</parameter>,
6647 <parameter>tex.math.delims</parameter>,
6650 <refsection><info><title>More information</title></info>
6651 <para>For how-to documentation on embedding TeX equations and
6652 generating output from them, see
6653 <link role="tcg" xlink:href="TexMath.html">DBTeXMath</link>.</para>
6657 <refentry version="5.0" id="tex.math.delims">
6659 <refentrytitle>tex.math.delims</refentrytitle>
6660 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
6663 <refname>tex.math.delims</refname>
6664 <refpurpose>Should equations output for processing by TeX be
6665 surrounded by math mode delimiters?</refpurpose>
6669 <programlisting id="tex.math.delims.frag">
6670 <xsl:param name="tex.math.delims" select="1"></xsl:param>
6674 <refsection><info><title>Description</title></info>
6676 <para>For compatibility with DSSSL based DBTeXMath from Allin Cottrell
6677 you should set this parameter to 0.</para>
6680 <para>This feature is useful for print/PDF output only if you
6681 use the obsolete and now unsupported PassiveTeX XSL-FO
6686 <refsection><info><title>Related Parameters</title></info>
6687 <para><parameter>tex.math.in.alt</parameter>,
6688 <parameter>passivetex.extensions</parameter></para>
6691 <refsection><info><title>See Also</title></info>
6692 <para>You can also use the <tag class="xmlpi">dbtex delims</tag> processing
6693 instruction to control whether delimiters are output.</para>
6699 <refentry version="5.0" id="pixels.per.inch">
6701 <refentrytitle>pixels.per.inch</refentrytitle>
6702 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
6705 <refname>pixels.per.inch</refname>
6706 <refpurpose>How many pixels are there per inch?</refpurpose>
6710 <programlisting id="pixels.per.inch.frag">
6711 <xsl:param name="pixels.per.inch">90</xsl:param>
6715 <refsection><info><title>Description</title></info>
6717 <para>When lengths are converted to pixels, this value is used to
6718 determine the size of a pixel. The default value is taken from the
6719 <link xlink:href="http://www.w3.org/TR/2004/WD-xsl11-20041216/">XSL
6720 Recommendation</link>.
6726 <refentry version="5.0" id="points.per.em">
6728 <refentrytitle>points.per.em</refentrytitle>
6729 <refmiscinfo class="other" otherclass="datatype">number</refmiscinfo>
6732 <refname>points.per.em</refname>
6733 <refpurpose>Specify the nominal size of an em-space in points</refpurpose>
6737 <programlisting id="points.per.em.frag">
6738 <xsl:param name="points.per.em">10</xsl:param>
6742 <refsection><info><title>Description</title></info>
6744 <para>The fixed value used for calculations based upon the size of a
6745 character. The assumption made is that ten point font is in use. This
6746 assumption may not be valid.</para>
6751 <refentry version="5.0" id="use.svg">
6753 <refentrytitle>use.svg</refentrytitle>
6754 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
6757 <refname>use.svg</refname>
6758 <refpurpose>Allow SVG in the result tree?</refpurpose>
6762 <programlisting id="use.svg.frag">
6763 <xsl:param name="use.svg" select="1"></xsl:param>
6767 <refsection><info><title>Description</title></info>
6769 <para>If non-zero, SVG will be considered an acceptable image format. SVG
6770 is passed through to the result tree, so correct rendering of the resulting
6771 diagram depends on the formatter (FO processor or web browser) that is used
6772 to process the output from the stylesheet.</para>
6777 <refentry version="5.0" id="menuchoice.separator">
6779 <refentrytitle>menuchoice.separator</refentrytitle>
6780 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
6783 <refname>menuchoice.separator</refname>
6784 <refpurpose>Separator between items of a <tag>menuchoice</tag>
6785 other than <tag>guimenuitem</tag> and
6786 <tag>guisubmenu</tag></refpurpose>
6790 <programlisting id="menuchoice.separator.frag">
6791 <xsl:param name="menuchoice.separator">+</xsl:param>
6795 <refsection><info><title>Description</title></info>
6797 <para>Separator used to connect items of a <tag>menuchoice</tag> other
6798 than <tag>guimenuitem</tag> and <tag>guisubmenu</tag>. The latter
6799 elements are linked with <parameter>menuchoice.menu.separator</parameter>.
6805 <refentry version="5.0" id="menuchoice.menu.separator">
6807 <refentrytitle>menuchoice.menu.separator</refentrytitle>
6808 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
6811 <refname>menuchoice.menu.separator</refname>
6812 <refpurpose>Separator between items of a <tag>menuchoice</tag>
6813 with <tag>guimenuitem</tag> or
6814 <tag>guisubmenu</tag></refpurpose>
6818 <programlisting id="menuchoice.menu.separator.frag">
6819 <xsl:param name="menuchoice.menu.separator"> → </xsl:param>
6823 <refsection><info><title>Description</title></info>
6825 <para>Separator used to connect items of a <tag>menuchoice</tag> with
6826 <tag>guimenuitem</tag> or <tag>guisubmenu</tag>. Other elements
6827 are linked with <parameter>menuchoice.separator</parameter>.
6829 <para>The default value is &#x2192;, which is the
6830 &rarr; (right arrow) character entity.
6831 The current FOP (0.20.5) requires setting the font-family
6834 <para>The default value also includes spaces around the arrow,
6835 which will allow a line to break. Replace the spaces with
6836 &#xA0; (nonbreaking space) if you don't want those
6843 <refentry version="5.0" id="default.float.class">
6845 <refentrytitle>default.float.class</refentrytitle>
6846 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
6849 <refname>default.float.class</refname>
6850 <refpurpose>Specifies the default float class</refpurpose>
6854 <programlisting id="default.float.class.frag">
6855 <xsl:param name="default.float.class">
6857 <xsl:when test="contains($stylesheet.result.type,'html')">left</xsl:when>
6858 <xsl:otherwise>before</xsl:otherwise>
6864 <refsection><info><title>Description</title></info>
6866 <para>Selects the direction in which a float should be placed. for
6867 xsl-fo this is before, for html it is left. For Western texts, the
6868 before direction is the top of the page.</para>
6873 <refentry version="5.0" id="footnote.number.format">
6875 <refentrytitle>footnote.number.format</refentrytitle>
6876 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
6877 <refmiscinfo class="other" otherclass="value">1<alt>1,2,3...</alt></refmiscinfo>
6878 <refmiscinfo class="other" otherclass="value">A<alt>A,B,C...</alt></refmiscinfo>
6879 <refmiscinfo class="other" otherclass="value">a<alt>a,b,c...</alt></refmiscinfo>
6880 <refmiscinfo class="other" otherclass="value">i<alt>i,ii,iii...</alt></refmiscinfo>
6881 <refmiscinfo class="other" otherclass="value">I<alt>I,II,III...</alt></refmiscinfo>
6884 <refname>footnote.number.format</refname>
6885 <refpurpose>Identifies the format used for footnote numbers</refpurpose>
6889 <programlisting id="footnote.number.format.frag">
6890 <xsl:param name="footnote.number.format">1</xsl:param>
6894 <refsection><info><title>Description</title></info>
6896 <para>The <parameter>footnote.number.format</parameter> specifies the format
6897 to use for footnote numeration (1, i, I, a, or A).</para>
6902 <refentry version="5.0" id="table.footnote.number.format">
6904 <refentrytitle>table.footnote.number.format</refentrytitle>
6905 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
6906 <refmiscinfo class="other" otherclass="value">1<alt>1,2,3...</alt></refmiscinfo>
6907 <refmiscinfo class="other" otherclass="value">A<alt>A,B,C...</alt></refmiscinfo>
6908 <refmiscinfo class="other" otherclass="value">a<alt>a,b,c...</alt></refmiscinfo>
6909 <refmiscinfo class="other" otherclass="value">i<alt>i,ii,iii...</alt></refmiscinfo>
6910 <refmiscinfo class="other" otherclass="value">I<alt>I,II,III...</alt></refmiscinfo>
6913 <refname>table.footnote.number.format</refname>
6914 <refpurpose>Identifies the format used for footnote numbers in tables</refpurpose>
6918 <programlisting id="table.footnote.number.format.frag">
6919 <xsl:param name="table.footnote.number.format">a</xsl:param>
6923 <refsection><info><title>Description</title></info>
6925 <para>The <parameter>table.footnote.number.format</parameter> specifies the format
6926 to use for footnote numeration (1, i, I, a, or A) in tables.</para>
6931 <refentry version="5.0" id="footnote.number.symbols">
6933 <refentrytitle>footnote.number.symbols</refentrytitle>
6934 <refmiscinfo class="other" otherclass="datatype"/>
6937 <refname>footnote.number.symbols</refname>
6938 <refpurpose>Special characters to use as footnote markers</refpurpose>
6942 <programlisting id="footnote.number.symbols.frag">
6943 <xsl:param name="footnote.number.symbols"></xsl:param>
6947 <refsection><info><title>Description</title></info>
6949 <para>If <parameter>footnote.number.symbols</parameter> is not the empty string,
6950 footnotes will use the characters it contains as footnote symbols. For example,
6951 <quote>*&#x2020;&#x2021;&#x25CA;&#x2720;</quote> will identify
6952 footnotes with <quote>*</quote>, <quote>†</quote>, <quote>‡</quote>,
6953 <quote>◊</quote>, and <quote>✠</quote>. If there are more footnotes
6954 than symbols, the stylesheets will fall back to numbered footnotes using
6955 <parameter>footnote.number.format</parameter>.</para>
6957 <para>The use of symbols for footnotes depends on the ability of your
6958 processor (or browser) to render the symbols you select. Not all systems are
6959 capable of displaying the full range of Unicode characters. If the quoted characters
6960 in the preceding paragraph are not displayed properly, that's a good indicator
6961 that you may have trouble using those symbols for footnotes.</para>
6966 <refentry version="5.0" id="table.footnote.number.symbols">
6968 <refentrytitle>table.footnote.number.symbols</refentrytitle>
6969 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
6972 <refname>table.footnote.number.symbols</refname>
6973 <refpurpose>Special characters to use a footnote markers in tables</refpurpose>
6977 <programlisting id="table.footnote.number.symbols.frag">
6978 <xsl:param name="table.footnote.number.symbols"></xsl:param>
6982 <refsection><info><title>Description</title></info>
6984 <para>If <parameter>table.footnote.number.symbols</parameter> is not the empty string,
6985 table footnotes will use the characters it contains as footnote symbols. For example,
6986 <quote>*&#x2020;&#x2021;&#x25CA;&#x2720;</quote> will identify
6987 footnotes with <quote>*</quote>, <quote>†</quote>, <quote>‡</quote>,
6988 <quote>◊</quote>, and <quote>✠</quote>. If there are more footnotes
6989 than symbols, the stylesheets will fall back to numbered footnotes using
6990 <parameter>table.footnote.number.format</parameter>.</para>
6992 <para>The use of symbols for footnotes depends on the ability of your
6993 processor (or browser) to render the symbols you select. Not all systems are
6994 capable of displaying the full range of Unicode characters. If the quoted characters
6995 in the preceding paragraph are not displayed properly, that's a good indicator
6996 that you may have trouble using those symbols for footnotes.</para>
7001 <refentry version="5.0" id="highlight.source">
7003 <refentrytitle>highlight.source</refentrytitle>
7004 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
7007 <refname>highlight.source</refname>
7008 <refpurpose>Should the content of <tag>programlisting</tag>
7009 be syntactically highlighted?</refpurpose>
7013 <programlisting id="highlight.source.frag">
7014 <xsl:param name="highlight.source" select="0"></xsl:param>
7018 <refsection><info><title>Description</title></info>
7020 <para>When this parameter is non-zero, the stylesheets will try to do syntax highlighting of the
7021 content of <tag>programlisting</tag> elements. You specify the language for each programlisting
7022 by using the <tag class="attribute">language</tag> attribute. The <parameter>highlight.default.language</parameter>
7023 parameter can be used to specify the language for programlistings without a <tag class="attribute">language</tag>
7024 attribute. Syntax highlighting also works for <tag>screen</tag> and <tag>synopsis</tag> elements.</para>
7026 <para>The actual highlighting work is done by the XSLTHL extension module. This is an external Java library that has to be
7027 downloaded separately (see below).</para>
7030 <para>In order to use this extension, you must</para>
7032 <listitem><para>add <filename>xslthl-2.x.x.jar</filename> to your Java classpath. The latest version is available
7033 from <link xlink:href="http://sourceforge.net/projects/xslthl">the XSLT syntax highlighting project</link>
7034 at SourceForge.</para>
7037 <para>use a customization layer in which you import one of the following stylesheet modules:
7040 <para><filename>html/highlight.xsl</filename>
7044 <para><filename>xhtml/highlight.xsl</filename>
7048 <para><filename>xhtml-1_1/highlight.xsl</filename>
7052 <para><filename>fo/highlight.xsl</filename>
7058 <listitem><para>let either the <literal>xslthl.config</literal> Java system property or the
7059 <parameter>highlight.xslthl.config</parameter> parameter point to the configuration file for syntax
7060 highlighting (using URL syntax). DocBook XSL comes with a ready-to-use configuration file,
7061 <filename>highlighting/xslthl-config.xml</filename>.</para>
7065 <para>The extension works with Saxon 6.5.x and Xalan-J. (Saxon 8.5 or later is also supported, but since it is
7066 an XSLT 2.0 processor it is not guaranteed to work with DocBook XSL in all circumstances.)</para>
7068 <para>The following is an example of a Saxon 6 command adapted for syntax highlighting, to be used on Windows:</para>
7071 <para><command>java -cp c:/Java/saxon.jar;c:/Java/xslthl-2.0.1.jar
7072 -Dxslthl.config=file:///c:/docbook-xsl/highlighting/xslthl-config.xml com.icl.saxon.StyleSheet
7073 -o test.html test.xml myhtml.xsl</command></para>
7079 <refentry version="5.0" id="highlight.xslthl.config">
7081 <refentrytitle>highlight.xslthl.config</refentrytitle>
7082 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
7085 <refname>highlight.xslthl.config</refname>
7086 <refpurpose>Location of XSLTHL configuration file</refpurpose>
7090 <programlisting id="highlight.xslthl.config.frag">
7091 <xsl:param name="highlight.xslthl.config"></xsl:param>
7095 <refsection><info><title>Description</title></info>
7097 <para>This location has precedence over the corresponding Java property.</para>
7099 <para>Please note that usually you have to specify location as URL not
7100 just as a simple path on the local
7101 filesystem. E.g. <filename>file:///home/user/xslthl/my-xslthl-config.xml</filename>.</para>
7108 <refentry version="5.0" id="highlight.default.language">
7110 <refentrytitle>highlight.default.language</refentrytitle>
7111 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
7114 <refname>highlight.default.language</refname>
7115 <refpurpose>Default language of programlisting</refpurpose>
7119 <programlisting id="highlight.default.language.frag">
7120 <xsl:param name="highlight.default.language"></xsl:param>
7124 <refsection><info><title>Description</title></info>
7126 <para>This language is used when there is no language attribute on programlisting.</para>
7131 <refentry version="5.0" id="email.delimiters.enabled">
7133 <refentrytitle>email.delimiters.enabled</refentrytitle>
7134 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
7137 <refname>email.delimiters.enabled</refname>
7138 <refpurpose>Generate delimiters around email addresses?</refpurpose>
7142 <programlisting id="email.delimiters.enabled.frag">
7143 <xsl:param name="email.delimiters.enabled" select="1"></xsl:param>
7147 <refsection><info><title>Description</title></info>
7149 <para>If non-zero, delimiters
7151 <footnote><para>For delimiters, the
7152 stylesheets are currently hard-coded to output angle
7153 brackets.</para></footnote>
7155 are generated around e-mail addresses
7156 (the output of the <tag>email</tag> element).</para>
7161 <refentry version="5.0" id="exsl.node.set.available">
7163 <refentrytitle>exsl.node.set.available</refentrytitle>
7164 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
7167 <refname>exsl.node.set.available</refname>
7168 <refpurpose>Is the test function-available('exsl:node-set') true?</refpurpose>
7172 <programlisting id="exsl.node.set.available.frag"><xsl:param name="exsl.node.set.available">
7174 <xsl:when exsl:foo="" test="function-available('exsl:node-set') or contains(system-property('xsl:vendor'), 'Apache Software Foundation')">1</xsl:when>
7175 <xsl:otherwise>0</xsl:otherwise>
7181 <refsection><info><title>Description</title></info>
7184 then the exsl:node-set() function is available to be used in
7186 If zero, then the function is not available.
7187 This param automatically detects the presence of
7188 the function and does not normally need to be set manually.</para>
7190 <para>This param was created to handle a long-standing
7191 bug in the Xalan processor that fails to detect the
7192 function even though it is available.</para>
7197 </reference><reference id="annos" xml:base="../html/param.xml"><title>Annotations</title>
7198 <refentry version="5.0" id="annotation.support">
7200 <refentrytitle>annotation.support</refentrytitle>
7201 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
7204 <refname>annotation.support</refname>
7205 <refpurpose>Enable annotations?</refpurpose>
7209 <programlisting id="annotation.support.frag">
7210 <xsl:param name="annotation.support" select="0"></xsl:param>
7214 <refsection><info><title>Description</title></info>
7216 <para>If non-zero, the stylesheets will attempt to support annotation
7217 elements in HTML by including some JavaScript (see
7218 <parameter>annotation.js</parameter>).</para>
7223 <refentry version="5.0" id="annotation.js">
7225 <refentrytitle>annotation.js</refentrytitle>
7226 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
7229 <refname>annotation.js</refname>
7230 <refpurpose>URIs identifying JavaScript files with support for annotation popups</refpurpose>
7234 <programlisting id="annotation.js.frag">
7236 <xsl:param name="annotation.js">
7237 <xsl:text>http://docbook.sourceforge.net/release/script/AnchorPosition.js http://docbook.sourceforge.net/release/script/PopupWindow.js</xsl:text></xsl:param>
7242 <refsection><info><title>Description</title></info>
7244 <para>If <property>annotation.support</property> is enabled and the
7245 document contains <tag>annotation</tag>s, then the URIs listed
7246 in this parameter will be included. These JavaScript files are required
7247 for popup annotation support.</para>
7252 <refentry version="5.0" id="annotation.css">
7254 <refentrytitle>annotation.css</refentrytitle>
7255 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
7258 <refname>annotation.css</refname>
7259 <refpurpose>CSS rules for annotations</refpurpose>
7263 <programlisting id="annotation.css.frag">
7264 <xsl:param name="annotation.css">
7265 /* ======================================================================
7269 div.annotation-list { visibility: hidden;
7272 div.annotation-nocss { position: absolute;
7276 div.annotation-popup { position: absolute;
7281 border-style: solid;
7284 background-color: white;
7287 div.annotation-title { padding: 1px;
7289 border-bottom-style: solid;
7290 border-bottom-width: 1px;
7292 background-color: black;
7295 div.annotation-body { padding: 2px;
7298 div.annotation-body p { margin-top: 0px;
7302 div.annotation-close { position: absolute;
7310 <refsection><info><title>Description</title></info>
7312 <para>If <parameter>annotation.support</parameter> is enabled and the
7313 document contains <tag>annotation</tag>s, then the CSS in this
7314 parameter will be included in the document.</para>
7319 <refentry version="5.0" id="annotation.graphic.open">
7321 <refentrytitle>annotation.graphic.open</refentrytitle>
7322 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
7325 <refname>annotation.graphic.open</refname>
7326 <refpurpose>Image for identifying a link that opens an annotation popup</refpurpose>
7330 <programlisting id="annotation.graphic.open.frag">
7331 <xsl:param name="annotation.graphic.open">http://docbook.sourceforge.net/release/images/annot-open.png</xsl:param>
7335 <refsection><info><title>Description</title></info>
7337 <para>This image is used inline to identify the location of
7338 annotations. It may be replaced by a user provided graphic. The size should be approximately 10x10 pixels.</para>
7343 <refentry version="5.0" id="annotation.graphic.close">
7345 <refentrytitle>annotation.graphic.close</refentrytitle>
7346 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
7349 <refname>annotation.graphic.close</refname>
7350 <refpurpose>Image for identifying a link that closes an annotation popup</refpurpose>
7354 <programlisting id="annotation.graphic.close.frag">
7355 <xsl:param name="annotation.graphic.close">
7356 http://docbook.sourceforge.net/release/images/annot-close.png</xsl:param>
7360 <refsection><info><title>Description</title></info>
7362 <para>This image is used on popup annotations as the “x” that the
7363 user can click to dismiss the popup.</para>
7364 <para>This image is used on popup annotations as the “x” that the user can
7365 click to dismiss the popup. It may be replaced by a user provided graphic. The size should be approximately 10x10 pixels.</para>
7370 </reference><reference id="graphics" xml:base="../html/param.xml"><title>Graphics</title>
7371 <refentry version="5.0" id="img.src.path">
7373 <refentrytitle>img.src.path</refentrytitle>
7374 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
7377 <refname>img.src.path</refname>
7378 <refpurpose>Path to HTML/FO image files</refpurpose>
7382 <programlisting id="img.src.path.frag"><xsl:param name="img.src.path"></xsl:param></programlisting>
7385 <refsection><info><title>Description</title></info>
7387 <para>Add a path prefix to the value of the <tag class="attribute">fileref</tag>
7388 attribute of <tag>graphic</tag>, <tag>inlinegraphic</tag>, and <tag>imagedata</tag> elements. The resulting
7389 compound path is used in the output as the value of the <tag class="attribute">src</tag>
7390 attribute of <tag class="element">img</tag> (HTML) or <tag class="element">external-graphic</tag> (FO).
7394 The path given by <literal>img.src.path</literal> could be relative to the directory where the HTML/FO
7395 files are created, or it could be an absolute URI.
7396 The default value is empty.
7397 Be sure to include a trailing slash if needed.
7400 <para>This prefix is not applied to any filerefs that start
7401 with "/" or contain "//:".
7407 <refentry version="5.0" id="keep.relative.image.uris">
7409 <refentrytitle>keep.relative.image.uris</refentrytitle>
7410 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
7413 <refname>keep.relative.image.uris</refname>
7414 <refpurpose>Should image URIs be resolved against xml:base?</refpurpose>
7418 <programlisting id="keep.relative.image.uris.frag">
7419 <xsl:param name="keep.relative.image.uris" select="1"></xsl:param>
7424 <refsection><info><title>Description</title></info>
7426 <para>If non-zero, relative URIs (in, for example
7427 <literal>fileref</literal> attributes) will be used in the generated
7428 output. Otherwise, the URIs will be made absolute with respect to the
7431 <para>Note that the stylesheets calculate (and use) the absolute form
7432 for some purposes, this only applies to the resulting output.</para>
7437 <refentry version="5.0" id="graphic.default.extension">
7439 <refentrytitle>graphic.default.extension</refentrytitle>
7440 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
7443 <refname>graphic.default.extension</refname>
7444 <refpurpose>Default extension for graphic filenames</refpurpose>
7448 <programlisting id="graphic.default.extension.frag"><xsl:param name="graphic.default.extension"></xsl:param></programlisting>
7451 <refsection><info><title>Description</title></info>
7453 <para>If a <tag>graphic</tag> or <tag>mediaobject</tag>
7454 includes a reference to a filename that does not include an extension,
7455 and the <tag class="attribute">format</tag> attribute is
7456 <emphasis>unspecified</emphasis>, the default extension will be used.
7462 <refentry version="5.0" id="default.image.width">
7464 <refentrytitle>default.image.width</refentrytitle>
7465 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
7468 <refname>default.image.width</refname>
7469 <refpurpose>The default width of images</refpurpose>
7473 <programlisting id="default.image.width.frag">
7474 <xsl:param name="default.image.width"></xsl:param>
7478 <refsection><info><title>Description</title></info>
7480 <para>If specified, this value will be used for the
7481 <tag class="attribute">width</tag> attribute on images that do not specify any
7482 <emphasis xlink:title="DocBook 5: The Definitive Guide" xlink:href="http://docbook.org/tdg5/en/html/imagedata.html#viewport.area">viewport dimensions</emphasis>.</para>
7487 <refentry version="5.0" id="nominal.image.width">
7489 <refentrytitle>nominal.image.width</refentrytitle>
7490 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
7493 <refname>nominal.image.width</refname>
7494 <refpurpose>The nominal image width</refpurpose>
7498 <programlisting id="nominal.image.width.frag">
7499 <xsl:param name="nominal.image.width" select="6 * $pixels.per.inch"></xsl:param>
7503 <refsection><info><title>Description</title></info>
7505 <para>Graphic widths expressed as a percentage are problematic. In the
7506 following discussion, we speak of width and contentwidth, but
7507 the same issues apply to depth and contentdepth.</para>
7509 <para>A width of 50% means "half of the available space for the image."
7510 That's fine. But note that in HTML, this is a dynamic property and
7511 the image size will vary if the browser window is resized.</para>
7513 <para>A contentwidth of 50% means "half of the actual image width".
7514 But what does that mean if the stylesheets cannot assess the image's
7515 actual size? Treating this as a width of 50% is one possibility, but
7516 it produces behavior (dynamic scaling) that seems entirely out of
7517 character with the meaning.</para>
7519 <para>Instead, the stylesheets define a
7520 <parameter>nominal.image.width</parameter> and convert percentages to
7521 actual values based on that nominal size.</para>
7526 <refentry version="5.0" id="nominal.image.depth">
7528 <refentrytitle>nominal.image.depth</refentrytitle>
7529 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
7532 <refname>nominal.image.depth</refname>
7533 <refpurpose>Nominal image depth</refpurpose>
7537 <programlisting id="nominal.image.depth.frag">
7538 <xsl:param name="nominal.image.depth" select="4 * $pixels.per.inch"></xsl:param>
7542 <refsection><info><title>Description</title></info>
7544 <para>See <parameter>nominal.image.width</parameter>.</para>
7549 <refentry version="5.0" id="use.embed.for.svg">
7551 <refentrytitle>use.embed.for.svg</refentrytitle>
7552 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
7555 <refname>use.embed.for.svg</refname>
7556 <refpurpose>Use HTML <tag>embed</tag> for SVG?</refpurpose>
7560 <programlisting id="use.embed.for.svg.frag">
7561 <xsl:param name="use.embed.for.svg" select="0"></xsl:param>
7565 <refsection><info><title>Description</title></info>
7567 <para>If non-zero, an <tag>embed</tag> element will be created for
7568 SVG figures. An <tag>object</tag> is <emphasis>always</emphasis> created,
7569 this parameter merely controls whether or not an additional <tag>embed</tag>
7570 is generated inside the <tag>object</tag>.</para>
7572 <para>On the plus side, this may be more portable among browsers and plug-ins.
7573 On the minus side, it isn't valid HTML.</para>
7578 <refentry version="5.0" id="make.graphic.viewport">
7580 <refentrytitle>make.graphic.viewport</refentrytitle>
7581 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
7584 <refname>make.graphic.viewport</refname>
7585 <refpurpose>Use tables in HTML to make viewports for graphics</refpurpose>
7589 <programlisting id="make.graphic.viewport.frag">
7590 <xsl:param name="make.graphic.viewport" select="1"></xsl:param>
7594 <refsection><info><title>Description</title></info>
7596 <para>The HTML <tag>img</tag> element only supports the notion
7597 of content-area scaling; it doesn't support the distinction between a
7598 content-area and a viewport-area, so we have to make some compromises.</para>
7600 <para>If <parameter>make.graphic.viewport</parameter> is non-zero, a table
7601 will be used to frame the image. This creates an effective viewport-area.
7604 <para>Tables and alignment don't work together, so this parameter is ignored
7605 if alignment is specified on an image.</para>
7609 <refentry version="5.0" id="preferred.mediaobject.role">
7611 <refentrytitle>preferred.mediaobject.role</refentrytitle>
7612 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
7615 <refname>preferred.mediaobject.role</refname>
7616 <refpurpose>Select which mediaobject to use based on
7617 this value of an object's <tag class="attribute">role</tag> attribute.
7622 <programlisting id="preferred.mediaobject.role.frag">
7623 <xsl:param name="preferred.mediaobject.role"></xsl:param>
7627 <refsection><info><title>Description</title></info>
7629 <para>A mediaobject may contain several objects such as imageobjects.
7630 If the parameter <parameter>use.role.for.mediaobject</parameter> is
7631 non-zero, then the <literal>role</literal> attribute on
7632 <tag>imageobject</tag>s and other objects within a
7633 <tag>mediaobject</tag> container will be used to select which object
7634 will be used. If one of the objects has a role value that matches the
7635 <parameter>preferred.mediaobject.role</parameter> parameter, then it
7636 has first priority for selection. If more than one has such a role
7637 value, the first one is used.
7640 See the <parameter>use.role.for.mediaobject</parameter> parameter
7641 for the sequence of selection.</para>
7645 <refentry version="5.0" id="use.role.for.mediaobject">
7647 <refentrytitle>use.role.for.mediaobject</refentrytitle>
7648 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
7651 <refname>use.role.for.mediaobject</refname>
7652 <refpurpose>Use <tag class="attribute">role</tag> attribute
7653 value for selecting which of several objects within a mediaobject to use.
7658 <programlisting id="use.role.for.mediaobject.frag">
7659 <xsl:param name="use.role.for.mediaobject" select="1"></xsl:param>
7663 <refsection><info><title>Description</title></info>
7665 <para>If non-zero, the <tag class="attribute">role</tag> attribute on
7666 <tag>imageobject</tag>s or other objects within a <tag>mediaobject</tag> container will be used to select which object will be
7670 The order of selection when then parameter is non-zero is:
7674 <para>If the stylesheet parameter <parameter>preferred.mediaobject.role</parameter> has a value, then the object whose role equals that value is selected.</para>
7677 <para>Else if an object's role attribute has a value of
7678 <literal>html</literal> for HTML processing or
7679 <literal>fo</literal> for FO output, then the first
7680 of such objects is selected.
7684 <para>Else the first suitable object is selected.</para>
7689 <parameter>use.role.for.mediaobject</parameter>
7690 is zero, then role attributes are not considered
7691 and the first suitable object
7692 with or without a role value is used.
7697 <refentry version="5.0" id="ignore.image.scaling">
7699 <refentrytitle>ignore.image.scaling</refentrytitle>
7700 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
7703 <refname>ignore.image.scaling</refname>
7704 <refpurpose>Tell the stylesheets to ignore the author's image scaling attributes</refpurpose>
7708 <programlisting id="ignore.image.scaling.frag">
7709 <xsl:param name="ignore.image.scaling" select="0"></xsl:param>
7713 <refsection><info><title>Description</title></info>
7715 <para>If non-zero, the scaling attributes on graphics and media objects are
7721 </reference><reference id="chunking" xml:base="../html/param.xml"><title>Chunking</title>
7722 <refentry version="5.0" id="chunker.output.cdata-section-elements">
7724 <refentrytitle>chunker.output.cdata-section-elements</refentrytitle>
7725 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
7728 <refname>chunker.output.cdata-section-elements</refname>
7729 <refpurpose>List of elements to escape with CDATA sections</refpurpose>
7732 <programlisting id="chunker.output.cdata-section-elements.frag">
7733 <xsl:param name="chunker.output.cdata-section-elements"></xsl:param>
7736 <refsection><info><title>Description</title></info>
7737 <para>This parameter specifies the list of elements that should be escaped
7738 as CDATA sections by the chunking stylesheet. Not all processors support
7739 specification of this parameter.
7742 <para>This parameter is documented here, but the declaration is actually
7743 in the <filename>chunker.xsl</filename> stylesheet module.</para>
7748 <refentry version="5.0" id="chunker.output.doctype-public">
7750 <refentrytitle>chunker.output.doctype-public</refentrytitle>
7751 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
7754 <refname>chunker.output.doctype-public</refname>
7755 <refpurpose>Public identifer to use in the document type of generated pages</refpurpose>
7758 <programlisting id="chunker.output.doctype-public.frag">
7759 <xsl:param name="chunker.output.doctype-public"></xsl:param>
7762 <refsection><info><title>Description</title></info>
7763 <para>This parameter specifies the public identifier that should be used by
7764 the chunking stylesheet in the document type declaration of chunked pages.
7765 Not all processors support specification of
7769 <para>This parameter is documented here, but the declaration is actually
7770 in the <filename>chunker.xsl</filename> stylesheet module.</para>
7775 <refentry version="5.0" id="chunker.output.doctype-system">
7777 <refentrytitle>chunker.output.doctype-system</refentrytitle>
7778 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
7781 <refname>chunker.output.doctype-system</refname>
7782 <refpurpose>System identifier to use for the document type in generated pages</refpurpose>
7785 <programlisting id="chunker.output.doctype-system.frag">
7786 <xsl:param name="chunker.output.doctype-system"></xsl:param>
7789 <refsection><info><title>Description</title></info>
7790 <para>This parameter specifies the system identifier that should be used by
7791 the chunking stylesheet in the document type declaration of chunked pages.
7792 Not all processors support specification of
7796 <para>This parameter is documented here, but the declaration is actually
7797 in the <filename>chunker.xsl</filename> stylesheet module.</para>
7802 <refentry version="5.0" id="chunker.output.encoding">
7804 <refentrytitle>chunker.output.encoding</refentrytitle>
7805 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
7808 <refname>chunker.output.encoding</refname>
7809 <refpurpose>Encoding used in generated pages</refpurpose>
7812 <programlisting id="chunker.output.encoding.frag">
7813 <xsl:param name="chunker.output.encoding">ISO-8859-1</xsl:param>
7816 <refsection><info><title>Description</title></info>
7817 <para>This parameter specifies the encoding to be used in files
7818 generated by the chunking stylesheet. Not all processors support
7819 specification of this parameter.
7821 <para>This parameter used to be named <literal>default.encoding</literal>.</para>
7823 <para>This parameter is documented here, but the declaration is actually
7824 in the <filename>chunker.xsl</filename> stylesheet module.</para>
7829 <refentry version="5.0" id="chunker.output.indent">
7831 <refentrytitle>chunker.output.indent</refentrytitle>
7832 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
7835 <refname>chunker.output.indent</refname>
7836 <refpurpose>Specification of indentation on generated pages</refpurpose>
7839 <programlisting id="chunker.output.indent.frag">
7840 <xsl:param name="chunker.output.indent">no</xsl:param>
7843 <refsection><info><title>Description</title></info>
7844 <para>This parameter specifies the value of the indent
7845 specification for generated pages. Not all processors support
7846 specification of this parameter.
7849 <para>This parameter is documented here, but the declaration is actually
7850 in the <filename>chunker.xsl</filename> stylesheet module.</para>
7855 <refentry version="5.0" id="chunker.output.media-type">
7857 <refentrytitle>chunker.output.media-type</refentrytitle>
7858 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
7861 <refname>chunker.output.media-type</refname>
7862 <refpurpose>Media type to use in generated pages</refpurpose>
7865 <programlisting id="chunker.output.media-type.frag">
7866 <xsl:param name="chunker.output.media-type"></xsl:param>
7869 <refsection><info><title>Description</title></info>
7870 <para>This parameter specifies the media type that should be used by
7871 the chunking stylesheet. Not all processors support specification of
7874 <para>This parameter specifies the media type that should be used by the
7875 chunking stylesheet. This should be one from those defined in
7876 <link xlink:href="http://www.ietf.org/rfc/rfc2045.txt">[RFC2045]</link> and
7877 <link xlink:href="http://www.ietf.org/rfc/rfc2046.txt">[RFC2046]</link> </para>
7879 <para>This parameter is documented here, but the declaration is actually
7880 in the <filename>chunker.xsl</filename> stylesheet module.</para>
7881 <para>It must be one from html, xml or text</para>
7886 <refentry version="5.0" id="chunker.output.method">
7888 <refentrytitle>chunker.output.method</refentrytitle>
7889 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
7890 <refmiscinfo class="other" otherclass="value">html</refmiscinfo>
7891 <refmiscinfo class="other" otherclass="value">xml</refmiscinfo>
7894 <refname>chunker.output.method</refname>
7895 <refpurpose>Method used in generated pages</refpurpose>
7898 <programlisting id="chunker.output.method.frag">
7899 <xsl:param name="chunker.output.method">html</xsl:param>
7902 <refsection><info><title>Description</title></info>
7903 <para>This parameter specifies the output method to be used in files
7904 generated by the chunking stylesheet.
7906 <para>This parameter used to be named <literal>output.method</literal>.</para>
7908 <para>This parameter is documented here, but the declaration is actually
7909 in the <filename>chunker.xsl</filename> stylesheet module.</para>
7914 <refentry version="5.0" id="chunker.output.omit-xml-declaration">
7916 <refentrytitle>chunker.output.omit-xml-declaration</refentrytitle>
7917 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
7920 <refname>chunker.output.omit-xml-declaration</refname>
7921 <refpurpose>Omit-xml-declaration for generated pages</refpurpose>
7924 <programlisting id="chunker.output.omit-xml-declaration.frag">
7925 <xsl:param name="chunker.output.omit-xml-declaration">no</xsl:param>
7928 <refsection><info><title>Description</title></info>
7929 <para>This parameter specifies the value of the omit-xml-declaration
7930 specification for generated pages. Not all processors support
7931 specification of this parameter.
7934 <para>This parameter is documented here, but the declaration is actually
7935 in the <filename>chunker.xsl</filename> stylesheet module.</para>
7940 <refentry version="5.0" id="chunker.output.standalone">
7942 <refentrytitle>chunker.output.standalone</refentrytitle>
7943 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
7946 <refname>chunker.output.standalone</refname>
7947 <refpurpose>Standalone declaration for generated pages</refpurpose>
7950 <programlisting id="chunker.output.standalone.frag">
7951 <xsl:param name="chunker.output.standalone">no</xsl:param>
7954 <refsection><info><title>Description</title></info>
7955 <para>This parameter specifies the value of the standalone
7956 specification for generated pages. It must be either
7957 <literal>yes</literal> or <literal>no</literal>. Not all
7958 processors support specification of this parameter.
7961 <para>This parameter is documented here, but the declaration is actually
7962 in the <filename>chunker.xsl</filename> stylesheet module.</para>
7967 <refentry version="5.0" id="saxon.character.representation">
7969 <refentrytitle>saxon.character.representation</refentrytitle>
7970 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
7973 <refname>saxon.character.representation</refname>
7974 <refpurpose>Saxon character representation used in generated HTML pages</refpurpose>
7978 <programlisting id="saxon.character.representation.frag"><xsl:param name="saxon.character.representation" select="'entity;decimal'"></xsl:param></programlisting>
7981 <refsection><info><title>Description</title></info>
7983 <para>This parameter has effect only when Saxon 6 is used (version 6.4.2 or later).
7984 It sets the character representation in files generated by the chunking stylesheets.
7985 If you want to suppress entity references for characters with direct representations in
7986 <parameter>chunker.output.encoding</parameter>, set the parameter value to <literal>native</literal>.
7989 <para> For more information, see <link role="tcg" xlink:href="OutputEncoding.html#SaxonCharacter">Saxon output character representation</link>.</para>
7992 <para>This parameter is documented here, but the declaration is actually
7993 in the <filename>chunker.xsl</filename> stylesheet module.</para>
8000 <refentry version="5.0" id="html.ext">
8002 <refentrytitle>html.ext</refentrytitle>
8003 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
8006 <refname>html.ext</refname>
8007 <refpurpose>Identifies the extension of generated HTML files</refpurpose>
8011 <programlisting id="html.ext.frag">
8012 <xsl:param name="html.ext">.html</xsl:param>
8016 <refsection><info><title>Description</title></info>
8018 <para>The extension identified by <parameter>html.ext</parameter> will
8019 be used as the filename extension for chunks created by this
8025 <refentry version="5.0" id="use.id.as.filename">
8027 <refentrytitle>use.id.as.filename</refentrytitle>
8028 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
8031 <refname>use.id.as.filename</refname>
8032 <refpurpose>Use ID value of chunk elements as the filename?</refpurpose>
8036 <programlisting id="use.id.as.filename.frag">
8037 <xsl:param name="use.id.as.filename" select="0"></xsl:param>
8041 <refsection><info><title>Description</title></info>
8043 <para>If <parameter>use.id.as.filename</parameter>
8044 is non-zero, the filename of chunk elements that have IDs will be
8045 derived from the ID value.
8051 <refentry version="5.0" id="html.extra.head.links">
8053 <refentrytitle>html.extra.head.links</refentrytitle>
8054 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
8057 <refname>html.extra.head.links</refname>
8058 <refpurpose>Toggle extra HTML head link information</refpurpose>
8062 <programlisting id="html.extra.head.links.frag">
8063 <xsl:param name="html.extra.head.links" select="0"></xsl:param>
8067 <refsection><info><title>Description</title></info>
8069 <para>If non-zero, extra <tag>link</tag> elements will be
8070 generated in the <tag>head</tag> of chunked HTML files. These
8071 extra links point to chapters, appendixes, sections, etc. as supported
8072 by the <quote>Site Navigation Bar</quote> in Mozilla 1.0 (as of CR1, at least).
8078 <refentry version="5.0" id="root.filename">
8080 <refentrytitle>root.filename</refentrytitle>
8081 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
8084 <refname>root.filename</refname>
8085 <refpurpose>Identifies the name of the root HTML file when chunking</refpurpose>
8089 <programlisting id="root.filename.frag">
8090 <xsl:param name="root.filename">index</xsl:param>
8094 <refsection><info><title>Description</title></info>
8096 <para>The <parameter>root.filename</parameter> is the base filename for
8097 the chunk created for the root of each document processed.
8103 <refentry version="5.0" id="base.dir">
8105 <refentrytitle>base.dir</refentrytitle>
8106 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
8109 <refname>base.dir</refname>
8110 <refpurpose>The base directory of chunks</refpurpose>
8114 <programlisting id="base.dir.frag">
8115 <xsl:param name="base.dir"></xsl:param>
8119 <refsection><info><title>Description</title></info>
8121 <para>If specified, the <parameter>base.dir</parameter> identifies
8122 the output directory for chunks. (If not specified, the output directory
8123 is system dependent.)</para>
8128 <refentry version="5.0" id="generate.manifest">
8130 <refentrytitle>generate.manifest</refentrytitle>
8131 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
8134 <refname>generate.manifest</refname>
8135 <refpurpose>Generate a manifest file?</refpurpose>
8139 <programlisting id="generate.manifest.frag"><xsl:param name="generate.manifest" select="0"></xsl:param></programlisting>
8142 <refsection><info><title>Description</title></info>
8144 <para>If non-zero, a list of HTML files generated by the
8145 stylesheet transformation is written to the file named by
8146 the <parameter>manifest</parameter> parameter.</para>
8151 <refentry version="5.0" id="manifest">
8153 <refentrytitle>manifest</refentrytitle>
8154 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
8157 <refname>manifest</refname>
8158 <refpurpose>Name of manifest file</refpurpose>
8162 <programlisting id="manifest.frag">
8163 <xsl:param name="manifest">HTML.manifest</xsl:param>
8167 <refsection><info><title>Description</title></info>
8169 <para>The name of the file to which a manifest is written (if the
8170 value of the <parameter>generate.manifest</parameter> parameter
8171 is non-zero).</para>
8176 <refentry version="5.0" id="manifest.in.base.dir">
8178 <refentrytitle>manifest.in.base.dir</refentrytitle>
8179 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
8182 <refname>manifest.in.base.dir</refname>
8183 <refpurpose>Should the manifest file be written into <parameter>base.dir</parameter>?</refpurpose>
8187 <programlisting id="manifest.in.base.dir.frag">
8188 <xsl:param name="manifest.in.base.dir" select="0"></xsl:param>
8192 <refsection><info><title>Description</title></info>
8194 <para>If non-zero, the manifest file as well as project files for HTML Help and
8195 Eclipse Help are written into <parameter>base.dir</parameter> instead
8196 of the current directory.</para>
8201 <refentry version="5.0" id="chunk.toc">
8203 <refentrytitle>chunk.toc</refentrytitle>
8204 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
8207 <refname>chunk.toc</refname>
8208 <refpurpose>An explicit TOC to be used for chunking</refpurpose>
8212 <programlisting id="chunk.toc.frag">
8213 <xsl:param name="chunk.toc"></xsl:param>
8217 <refsection><info><title>Description</title></info>
8219 <para>The <parameter>chunk.toc</parameter> identifies an explicit TOC that
8220 will be used for chunking. This parameter is only used by the
8221 <filename>chunktoc.xsl</filename> stylesheet (and customization layers built
8227 <refentry version="5.0" id="chunk.tocs.and.lots">
8229 <refentrytitle>chunk.tocs.and.lots</refentrytitle>
8230 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
8233 <refname>chunk.tocs.and.lots</refname>
8234 <refpurpose>Should ToC and LoTs be in separate chunks?</refpurpose>
8238 <programlisting id="chunk.tocs.and.lots.frag">
8239 <xsl:param name="chunk.tocs.and.lots" select="0"></xsl:param>
8243 <refsection><info><title>Description</title></info>
8245 <para>If non-zero, ToC and LoT (List of Examples, List of Figures, etc.)
8246 will be put in a separate chunk. At the moment, this chunk is not in the
8247 normal forward/backward navigation list. Instead, a new link is added to the
8248 navigation footer.</para>
8250 <para>This feature is still somewhat experimental. Feedback welcome.</para>
8255 <refentry version="5.0" id="chunk.separate.lots">
8257 <refentrytitle>chunk.separate.lots</refentrytitle>
8258 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
8261 <refname>chunk.separate.lots</refname>
8262 <refpurpose>Should each LoT be in its own separate chunk?</refpurpose>
8266 <programlisting id="chunk.separate.lots.frag">
8267 <xsl:param name="chunk.separate.lots" select="0"></xsl:param>
8271 <refsection><info><title>Description</title></info>
8273 <para>If non-zero, each of the ToC and LoTs
8274 (List of Examples, List of Figures, etc.)
8275 will be put in its own separate chunk.
8276 The title page includes generated links to each of the separate files.
8279 This feature depends on the
8280 <parameter>chunk.tocs.and.lots</parameter>
8281 parameter also being non-zero.
8287 <refentry version="5.0" id="chunk.tocs.and.lots.has.title">
8289 <refentrytitle>chunk.tocs.and.lots.has.title</refentrytitle>
8290 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
8293 <refname>chunk.tocs.and.lots.has.title</refname>
8294 <refpurpose>Should ToC and LoTs in a separate chunks have title?</refpurpose>
8298 <programlisting id="chunk.tocs.and.lots.has.title.frag">
8299 <xsl:param name="chunk.tocs.and.lots.has.title" select="1"></xsl:param>
8303 <refsection><info><title>Description</title></info>
8305 <para>If non-zero title of document is shown before ToC/LoT in
8306 separate chunk.</para>
8311 <refentry version="5.0" id="chunk.section.depth">
8313 <refentrytitle>chunk.section.depth</refentrytitle>
8314 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
8317 <refname>chunk.section.depth</refname>
8318 <refpurpose>Depth to which sections should be chunked</refpurpose>
8322 <programlisting id="chunk.section.depth.frag">
8323 <xsl:param name="chunk.section.depth" select="1"></xsl:param>
8327 <refsection><info><title>Description</title></info>
8329 <para>This parameter sets the depth of section chunking.</para>
8334 <refentry version="5.0" id="chunk.first.sections">
8336 <refentrytitle>chunk.first.sections</refentrytitle>
8337 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
8340 <refname>chunk.first.sections</refname>
8341 <refpurpose>Chunk the first top-level section?</refpurpose>
8345 <programlisting id="chunk.first.sections.frag">
8346 <xsl:param name="chunk.first.sections" select="0"></xsl:param>
8350 <refsection><info><title>Description</title></info>
8352 <para>If non-zero, a chunk will be created for the first top-level
8353 <tag>sect1</tag> or <tag>section</tag> elements in
8354 each component. Otherwise, that section will be part of the chunk for
8361 <refentry version="5.0" id="chunk.quietly">
8363 <refentrytitle>chunk.quietly</refentrytitle>
8364 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
8367 <refname>chunk.quietly</refname>
8368 <refpurpose>Omit the chunked filename messages.</refpurpose>
8372 <programlisting id="chunk.quietly.frag">
8373 <xsl:param name="chunk.quietly" select="0"></xsl:param>
8377 <refsection><info><title>Description</title></info>
8379 <para>If zero (the default), the XSL processor emits a message naming
8380 each separate chunk filename as it is being output.
8381 If nonzero, then the messages are suppressed.
8387 <refentry version="5.0" id="chunk.append">
8389 <refentrytitle>chunk.append</refentrytitle>
8390 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
8393 <refname>chunk.append</refname>
8394 <refpurpose>Specifies content to append to chunked HTML output</refpurpose>
8398 <programlisting id="chunk.append.frag"><xsl:param name="chunk.append"></xsl:param></programlisting>
8401 <refsection><info><title>Description</title></info>
8403 <para>Specifies content to append to the end of HTML files output by
8404 the <filename>html/chunk.xsl</filename> stylesheet, after the closing
8405 <code><html></code> tag. You probably don’t want to set any value
8406 for this parameter; but if you do, the only value it should ever be
8407 set to is a newline character: <code>&#x0a;</code> or
8408 <code>&#10;</code></para>
8413 <refentry version="5.0" id="navig.graphics">
8415 <refentrytitle>navig.graphics</refentrytitle>
8416 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
8419 <refname>navig.graphics</refname>
8420 <refpurpose>Use graphics in navigational headers and footers?</refpurpose>
8424 <programlisting id="navig.graphics.frag">
8425 <xsl:param name="navig.graphics" select="0"></xsl:param>
8429 <refsection><info><title>Description</title></info>
8431 <para>If non-zero, the navigational headers and footers in chunked
8432 HTML are presented in an alternate style that uses graphical icons for
8433 Next, Previous, Up, and Home. Default graphics are provided in the
8434 distribution. If zero, text is used instead of graphics.
8440 <refentry version="5.0" id="navig.graphics.extension">
8442 <refentrytitle>navig.graphics.extension</refentrytitle>
8443 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
8446 <refname>navig.graphics.extension</refname>
8447 <refpurpose>Extension for navigational graphics</refpurpose>
8451 <programlisting id="navig.graphics.extension.frag">
8452 <xsl:param name="navig.graphics.extension">.gif</xsl:param>
8456 <refsection><info><title>Description</title></info>
8458 <para>Sets the filename extension to use on navigational graphics used
8459 in the headers and footers of chunked HTML.</para>
8464 <refentry version="5.0" id="navig.graphics.path">
8466 <refentrytitle>navig.graphics.path</refentrytitle>
8467 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
8470 <refname>navig.graphics.path</refname>
8471 <refpurpose>Path to navigational graphics</refpurpose>
8475 <programlisting id="navig.graphics.path.frag">
8476 <xsl:param name="navig.graphics.path">images/</xsl:param>
8480 <refsection><info><title>Description</title></info>
8482 <para>Sets the path, probably relative to the directory where the HTML
8483 files are created, to the navigational graphics used in the
8484 headers and footers of chunked HTML.
8490 <refentry version="5.0" id="navig.showtitles">
8492 <refentrytitle>navig.showtitles</refentrytitle>
8493 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
8496 <refname>navig.showtitles</refname>
8497 <refpurpose>Display titles in HTML headers and footers?</refpurpose>
8501 <programlisting id="navig.showtitles.frag"><xsl:param name="navig.showtitles">1</xsl:param></programlisting>
8504 <refsection><info><title>Description</title></info>
8507 the headers and footers of chunked HTML
8508 display the titles of the next and previous chunks,
8509 along with the words 'Next' and 'Previous' (or the
8510 equivalent graphical icons if navig.graphics is true).
8511 If false (zero), then only the words 'Next' and 'Previous'
8512 (or the icons) are displayed.
8518 </reference><reference id="profiling" xml:base="../html/param.xml"><title>Profiling</title>
8519 <partintro id="partintro">
8520 <para>The following parameters can be used for attribute-based
8521 profiling of your document. For more information about profiling, see
8522 <link role="tcg" xlink:href="Profiling.html">Profiling (conditional text)</link>.</para>
8524 <refentry version="5.0" id="profile.arch">
8526 <refentrytitle>profile.arch</refentrytitle>
8527 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
8530 <refname>profile.arch</refname>
8531 <refpurpose>Target profile for <tag class="attribute">arch</tag>
8532 attribute</refpurpose>
8536 <programlisting id="profile.arch.frag">
8537 <xsl:param name="profile.arch"></xsl:param>
8542 <refsection><info><title>Description</title></info>
8544 <para>The value of this parameter specifies profiles which should be
8545 included in the output. You can specify multiple profiles by
8546 separating them by semicolon. You can change separator character by
8547 <parameter>profile.separator</parameter>
8550 <para>This parameter has effect only when you are using profiling
8551 stylesheets (<filename>profile-docbook.xsl</filename>,
8552 <filename>profile-chunk.xsl</filename>, …) instead of normal
8553 ones (<filename>docbook.xsl</filename>,
8554 <filename>chunk.xsl</filename>, …).</para>
8559 <refentry version="5.0" id="profile.audience">
8561 <refentrytitle>profile.audience</refentrytitle>
8562 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
8565 <refname>profile.audience</refname>
8566 <refpurpose>Target profile for <tag class="attribute">audience</tag>
8567 attribute</refpurpose>
8571 <programlisting id="profile.audience.frag">
8572 <xsl:param name="profile.audience"></xsl:param>
8576 <refsection><info><title>Description</title></info>
8578 <para>Value of this parameter specifies profiles which should be
8579 included in the output. You can specify multiple profiles by
8580 separating them by semicolon. You can change separator character by
8581 <parameter>profile.separator</parameter>
8584 <para>This parameter has effect only when you are using profiling
8585 stylesheets (<filename>profile-docbook.xsl</filename>,
8586 <filename>profile-chunk.xsl</filename>, …) instead of normal
8587 ones (<filename>docbook.xsl</filename>,
8588 <filename>chunk.xsl</filename>, …).</para>
8593 <refentry version="5.0" id="profile.condition">
8595 <refentrytitle>profile.condition</refentrytitle>
8596 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
8599 <refname>profile.condition</refname>
8600 <refpurpose>Target profile for <tag class="attribute">condition</tag>
8601 attribute</refpurpose>
8605 <programlisting id="profile.condition.frag">
8606 <xsl:param name="profile.condition"></xsl:param>
8610 <refsection><info><title>Description</title></info>
8612 <para>The value of this parameter specifies profiles which should be
8613 included in the output. You can specify multiple profiles by
8614 separating them by semicolon. You can change separator character by
8615 <parameter>profile.separator</parameter>
8618 <para>This parameter has effect only when you are using profiling
8619 stylesheets (<filename>profile-docbook.xsl</filename>,
8620 <filename>profile-chunk.xsl</filename>, …) instead of normal
8621 ones (<filename>docbook.xsl</filename>,
8622 <filename>chunk.xsl</filename>, …).</para>
8627 <refentry version="5.0" id="profile.conformance">
8629 <refentrytitle>profile.conformance</refentrytitle>
8630 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
8633 <refname>profile.conformance</refname>
8634 <refpurpose>Target profile for <tag class="attribute">conformance</tag>
8635 attribute</refpurpose>
8639 <programlisting id="profile.conformance.frag">
8640 <xsl:param name="profile.conformance"></xsl:param>
8644 <refsection><info><title>Description</title></info>
8646 <para>The value of this parameter specifies profiles which should be
8647 included in the output. You can specify multiple profiles by
8648 separating them by semicolon. You can change separator character by
8649 <parameter>profile.separator</parameter>
8652 <para>This parameter has effect only when you are using profiling
8653 stylesheets (<filename>profile-docbook.xsl</filename>,
8654 <filename>profile-chunk.xsl</filename>, …) instead of normal
8655 ones (<filename>docbook.xsl</filename>,
8656 <filename>chunk.xsl</filename>, …).</para>
8661 <refentry version="5.0" id="profile.lang">
8663 <refentrytitle>profile.lang</refentrytitle>
8664 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
8667 <refname>profile.lang</refname>
8668 <refpurpose>Target profile for <tag class="attribute">lang</tag>
8669 attribute</refpurpose>
8673 <programlisting id="profile.lang.frag">
8674 <xsl:param name="profile.lang"></xsl:param>
8678 <refsection><info><title>Description</title></info>
8680 <para>The value of this parameter specifies profiles which should be
8681 included in the output. You can specify multiple profiles by
8682 separating them by semicolon. You can change separator character by
8683 <parameter>profile.separator</parameter>
8686 <para>This parameter has effect only when you are using profiling
8687 stylesheets (<filename>profile-docbook.xsl</filename>,
8688 <filename>profile-chunk.xsl</filename>, …) instead of normal
8689 ones (<filename>docbook.xsl</filename>,
8690 <filename>chunk.xsl</filename>, …).</para>
8695 <refentry version="5.0" id="profile.os">
8697 <refentrytitle>profile.os</refentrytitle>
8698 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
8701 <refname>profile.os</refname>
8702 <refpurpose>Target profile for <tag class="attribute">os</tag>
8703 attribute</refpurpose>
8707 <programlisting id="profile.os.frag">
8708 <xsl:param name="profile.os"></xsl:param>
8712 <refsection><info><title>Description</title></info>
8714 <para>The value of this parameter specifies profiles which should be
8715 included in the output. You can specify multiple profiles by
8716 separating them by semicolon. You can change separator character by
8717 <parameter>profile.separator</parameter>
8720 <para>This parameter has effect only when you are using profiling
8721 stylesheets (<filename>profile-docbook.xsl</filename>,
8722 <filename>profile-chunk.xsl</filename>, …) instead of normal
8723 ones (<filename>docbook.xsl</filename>,
8724 <filename>chunk.xsl</filename>, …).</para>
8729 <refentry version="5.0" id="profile.revision">
8731 <refentrytitle>profile.revision</refentrytitle>
8732 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
8735 <refname>profile.revision</refname>
8736 <refpurpose>Target profile for <tag class="attribute">revision</tag>
8737 attribute</refpurpose>
8741 <programlisting id="profile.revision.frag">
8742 <xsl:param name="profile.revision"></xsl:param>
8746 <refsection><info><title>Description</title></info>
8748 <para>The value of this parameter specifies profiles which should be
8749 included in the output. You can specify multiple profiles by
8750 separating them by semicolon. You can change separator character by
8751 <parameter>profile.separator</parameter>
8754 <para>This parameter has effect only when you are using profiling
8755 stylesheets (<filename>profile-docbook.xsl</filename>,
8756 <filename>profile-chunk.xsl</filename>, …) instead of normal
8757 ones (<filename>docbook.xsl</filename>,
8758 <filename>chunk.xsl</filename>, …).</para>
8763 <refentry version="5.0" id="profile.revisionflag">
8765 <refentrytitle>profile.revisionflag</refentrytitle>
8766 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
8769 <refname>profile.revisionflag</refname>
8770 <refpurpose>Target profile for <tag class="attribute">revisionflag</tag>
8771 attribute</refpurpose>
8775 <programlisting id="profile.revisionflag.frag">
8776 <xsl:param name="profile.revisionflag"></xsl:param>
8780 <refsection><info><title>Description</title></info>
8782 <para>The value of this parameter specifies profiles which should be
8783 included in the output. You can specify multiple profiles by
8784 separating them by semicolon. You can change separator character by
8785 <parameter>profile.separator</parameter>
8788 <para>This parameter has effect only when you are using profiling
8789 stylesheets (<filename>profile-docbook.xsl</filename>,
8790 <filename>profile-chunk.xsl</filename>, …) instead of normal
8791 ones (<filename>docbook.xsl</filename>,
8792 <filename>chunk.xsl</filename>, …).</para>
8797 <refentry version="5.0" id="profile.role">
8799 <refentrytitle>profile.role</refentrytitle>
8800 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
8803 <refname>profile.role</refname>
8804 <refpurpose>Target profile for <tag class="attribute">role</tag>
8805 attribute</refpurpose>
8809 <programlisting id="profile.role.frag">
8810 <xsl:param name="profile.role"></xsl:param>
8814 <refsection><info><title>Description</title></info>
8816 <para>The value of this parameter specifies profiles which should be
8817 included in the output. You can specify multiple profiles by
8818 separating them by semicolon. You can change separator character by
8819 <parameter>profile.separator</parameter>
8822 <para>This parameter has effect only when you are using profiling
8823 stylesheets (<filename>profile-docbook.xsl</filename>,
8824 <filename>profile-chunk.xsl</filename>, …) instead of normal
8825 ones (<filename>docbook.xsl</filename>,
8826 <filename>chunk.xsl</filename>, …).</para>
8829 <para>Note that <tag class="attribute">role</tag> is often
8830 used for other purposes than profiling. For example it is commonly
8831 used to get emphasize in bold font:</para>
8833 <programlisting><emphasis role="bold">very important</emphasis></programlisting>
8835 <para>If you are using <tag class="attribute">role</tag> for
8836 these purposes do not forget to add values like <literal>bold</literal> to
8837 value of this parameter. If you forgot you will get document with
8838 small pieces missing which are very hard to track.</para>
8840 <para>For this reason it is not recommended to use <tag class="attribute">role</tag> attribute for profiling. You should
8841 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>
8847 <refentry version="5.0" id="profile.security">
8849 <refentrytitle>profile.security</refentrytitle>
8850 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
8853 <refname>profile.security</refname>
8854 <refpurpose>Target profile for <tag class="attribute">security</tag>
8855 attribute</refpurpose>
8859 <programlisting id="profile.security.frag">
8860 <xsl:param name="profile.security"></xsl:param>
8864 <refsection><info><title>Description</title></info>
8866 <para>The value of this parameter specifies profiles which should be
8867 included in the output. You can specify multiple profiles by
8868 separating them by semicolon. You can change separator character by
8869 <parameter>profile.separator</parameter>
8872 <para>This parameter has effect only when you are using profiling
8873 stylesheets (<filename>profile-docbook.xsl</filename>,
8874 <filename>profile-chunk.xsl</filename>, …) instead of normal
8875 ones (<filename>docbook.xsl</filename>,
8876 <filename>chunk.xsl</filename>, …).</para>
8881 <refentry version="5.0" id="profile.status">
8883 <refentrytitle>profile.status</refentrytitle>
8884 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
8887 <refname>profile.status</refname>
8888 <refpurpose>Target profile for <tag class="attribute">status</tag>
8889 attribute</refpurpose>
8893 <programlisting id="profile.status.frag">
8894 <xsl:param name="profile.status"></xsl:param>
8898 <refsection><info><title>Description</title></info>
8900 <para>The value of this parameter specifies profiles which should be
8901 included in the output. You can specify multiple profiles by
8902 separating them by semicolon. You can change separator character by
8903 <parameter>profile.separator</parameter>
8906 <para>This parameter has effect only when you are using profiling
8907 stylesheets (<filename>profile-docbook.xsl</filename>,
8908 <filename>profile-chunk.xsl</filename>, …) instead of normal
8909 ones (<filename>docbook.xsl</filename>,
8910 <filename>chunk.xsl</filename>, …).</para>
8915 <refentry version="5.0" id="profile.userlevel">
8917 <refentrytitle>profile.userlevel</refentrytitle>
8918 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
8921 <refname>profile.userlevel</refname>
8922 <refpurpose>Target profile for <tag class="attribute">userlevel</tag>
8923 attribute</refpurpose>
8927 <programlisting id="profile.userlevel.frag">
8928 <xsl:param name="profile.userlevel"></xsl:param>
8932 <refsection><info><title>Description</title></info>
8934 <para>The value of this parameter specifies profiles which should be
8935 included in the output. You can specify multiple profiles by
8936 separating them by semicolon. You can change separator character by
8937 <parameter>profile.separator</parameter>
8940 <para>This parameter has effect only when you are using profiling
8941 stylesheets (<filename>profile-docbook.xsl</filename>,
8942 <filename>profile-chunk.xsl</filename>, …) instead of normal
8943 ones (<filename>docbook.xsl</filename>,
8944 <filename>chunk.xsl</filename>, …).</para>
8949 <refentry version="5.0" id="profile.vendor">
8951 <refentrytitle>profile.vendor</refentrytitle>
8952 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
8955 <refname>profile.vendor</refname>
8956 <refpurpose>Target profile for <tag class="attribute">vendor</tag>
8957 attribute</refpurpose>
8961 <programlisting id="profile.vendor.frag">
8962 <xsl:param name="profile.vendor"></xsl:param>
8966 <refsection><info><title>Description</title></info>
8968 <para>The value of this parameter specifies profiles which should be
8969 included in the output. You can specify multiple profiles by
8970 separating them by semicolon. You can change separator character by
8971 <parameter>profile.separator</parameter>
8974 <para>This parameter has effect only when you are using profiling
8975 stylesheets (<filename>profile-docbook.xsl</filename>,
8976 <filename>profile-chunk.xsl</filename>, …) instead of normal
8977 ones (<filename>docbook.xsl</filename>,
8978 <filename>chunk.xsl</filename>, …).</para>
8983 <refentry version="5.0" id="profile.wordsize">
8985 <refentrytitle>profile.wordsize</refentrytitle>
8986 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
8989 <refname>profile.wordsize</refname>
8990 <refpurpose>Target profile for <tag class="attribute">wordsize</tag>
8991 attribute</refpurpose>
8995 <programlisting id="profile.wordsize.frag">
8996 <xsl:param name="profile.wordsize"></xsl:param>
9000 <refsection><info><title>Description</title></info>
9002 <para>The value of this parameter specifies profiles which should be
9003 included in the output. You can specify multiple profiles by
9004 separating them by semicolon. You can change separator character by
9005 <parameter>profile.separator</parameter>
9008 <para>This parameter has effect only when you are using profiling
9009 stylesheets (<filename>profile-docbook.xsl</filename>,
9010 <filename>profile-chunk.xsl</filename>, …) instead of normal
9011 ones (<filename>docbook.xsl</filename>,
9012 <filename>chunk.xsl</filename>, …).</para>
9017 <refentry version="5.0" id="profile.attribute">
9019 <refentrytitle>profile.attribute</refentrytitle>
9020 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
9023 <refname>profile.attribute</refname>
9024 <refpurpose>Name of user-specified profiling attribute</refpurpose>
9028 <programlisting id="profile.attribute.frag">
9029 <xsl:param name="profile.attribute"></xsl:param>
9033 <refsection><info><title>Description</title></info>
9035 <para>This parameter is used in conjuction with
9036 <parameter>profile.value</parameter>.</para>
9038 <para>This parameter has effect only when you are using profiling
9039 stylesheets (<filename>profile-docbook.xsl</filename>,
9040 <filename>profile-chunk.xsl</filename>, …) instead of normal
9041 ones (<filename>docbook.xsl</filename>,
9042 <filename>chunk.xsl</filename>, …).</para>
9047 <refentry version="5.0" id="profile.value">
9049 <refentrytitle>profile.value</refentrytitle>
9050 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
9053 <refname>profile.value</refname>
9054 <refpurpose>Target profile for user-specified attribute</refpurpose>
9058 <programlisting id="profile.value.frag">
9059 <xsl:param name="profile.value"></xsl:param>
9063 <refsection><info><title>Description</title></info>
9065 <para>When you are using this parameter you must also specify name of
9066 profiling attribute with parameter
9067 <parameter>profile.attribute</parameter>.</para>
9069 <para>The value of this parameter specifies profiles which should be
9070 included in the output. You can specify multiple profiles by
9071 separating them by semicolon. You can change separator character by
9072 <parameter>profile.separator</parameter>
9075 <para>This parameter has effect only when you are using profiling
9076 stylesheets (<filename>profile-docbook.xsl</filename>,
9077 <filename>profile-chunk.xsl</filename>, …) instead of normal
9078 ones (<filename>docbook.xsl</filename>,
9079 <filename>chunk.xsl</filename>, …).</para>
9084 <refentry version="5.0" id="profile.separator">
9086 <refentrytitle>profile.separator</refentrytitle>
9087 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
9090 <refname>profile.separator</refname>
9091 <refpurpose>Separator character for compound profile values</refpurpose>
9095 <programlisting id="profile.separator.frag">
9096 <xsl:param name="profile.separator">;</xsl:param>
9100 <refsection><info><title>Description</title></info>
9102 <para>Separator character used for compound profile values. See <parameter>profile.arch</parameter></para>
9107 </reference><reference id="htmlhelp" xml:base="../html/param.xml"><title>HTML Help</title>
9108 <refentry version="5.0" id="htmlhelp.encoding">
9110 <refentrytitle>htmlhelp.encoding</refentrytitle>
9111 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
9114 <refname>htmlhelp.encoding</refname>
9115 <refpurpose>Character encoding to use in files for HTML Help compiler.</refpurpose>
9119 <programlisting id="htmlhelp.encoding.frag">
9120 <xsl:param name="htmlhelp.encoding">iso-8859-1</xsl:param>
9124 <refsection><info><title>Description</title></info>
9126 <para>HTML Help Compiler is not UTF-8 aware, so you should always use an
9127 appropriate single-byte encoding here. Use one from <link xlink:href="ftp://ftp.isi.edu/in-notes/iana/assignments/character-sets">iana</link>, the registered charset values.</para>
9132 <refentry version="5.0" id="htmlhelp.autolabel">
9134 <refentrytitle>htmlhelp.autolabel</refentrytitle>
9135 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
9138 <refname>htmlhelp.autolabel</refname>
9139 <refpurpose>Should tree-like ToC use autonumbering feature?</refpurpose>
9143 <programlisting id="htmlhelp.autolabel.frag">
9144 <xsl:param name="htmlhelp.autolabel" select="0"></xsl:param>
9148 <refsection><info><title>Description</title></info>
9150 <para>Set this to non-zero to include chapter and section numbers into ToC
9151 in the left panel.</para>
9156 <refentry version="5.0" id="htmlhelp.chm">
9158 <refentrytitle>htmlhelp.chm</refentrytitle>
9159 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
9162 <refname>htmlhelp.chm</refname>
9163 <refpurpose>Filename of output HTML Help file.</refpurpose>
9167 <programlisting id="htmlhelp.chm.frag">
9168 <xsl:param name="htmlhelp.chm">htmlhelp.chm</xsl:param>
9172 <refsection><info><title>Description</title></info>
9174 <para>Set the name of resulting CHM file</para>
9179 <refentry version="5.0" id="htmlhelp.default.topic">
9181 <refentrytitle>htmlhelp.default.topic</refentrytitle>
9182 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
9185 <refname>htmlhelp.default.topic</refname>
9186 <refpurpose>Name of file with default topic</refpurpose>
9190 <programlisting id="htmlhelp.default.topic.frag">
9191 <xsl:param name="htmlhelp.default.topic"></xsl:param>
9195 <refsection><info><title>Description</title></info>
9197 <para>Normally first chunk of document is displayed when you open HTML
9198 Help file. If you want to display another topic, simply set its
9199 filename by this parameter.</para>
9201 <para>This is useful especially if you don't generate ToC in front of
9202 your document and you also hide root element in ToC. E.g.:</para>
9204 <programlisting><xsl:param name="generate.book.toc" select="0"/>
9205 <xsl:param name="htmlhelp.hhc.show.root" select="0"/>
9206 <xsl:param name="htmlhelp.default.topic">pr01.html</xsl:param>
9212 <refentry version="5.0" id="htmlhelp.display.progress">
9214 <refentrytitle>htmlhelp.display.progress</refentrytitle>
9215 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
9218 <refname>htmlhelp.display.progress</refname>
9219 <refpurpose>Display compile progress?</refpurpose>
9223 <programlisting id="htmlhelp.display.progress.frag">
9224 <xsl:param name="htmlhelp.display.progress" select="1"></xsl:param>
9228 <refsection><info><title>Description</title></info>
9230 <para>Set to non-zero to to display compile progress
9236 <refentry version="5.0" id="htmlhelp.hhp">
9238 <refentrytitle>htmlhelp.hhp</refentrytitle>
9239 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
9242 <refname>htmlhelp.hhp</refname>
9243 <refpurpose>Filename of project file.</refpurpose>
9247 <programlisting id="htmlhelp.hhp.frag">
9248 <xsl:param name="htmlhelp.hhp">htmlhelp.hhp</xsl:param>
9252 <refsection><info><title>Description</title></info>
9254 <para>Change this parameter if you want different name of project
9255 file than htmlhelp.hhp.</para>
9260 <refentry version="5.0" id="htmlhelp.hhc">
9262 <refentrytitle>htmlhelp.hhc</refentrytitle>
9263 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
9266 <refname>htmlhelp.hhc</refname>
9267 <refpurpose>Filename of TOC file.</refpurpose>
9271 <programlisting id="htmlhelp.hhc.frag">
9272 <xsl:param name="htmlhelp.hhc">toc.hhc</xsl:param>
9276 <refsection><info><title>Description</title></info>
9278 <para>Set the name of the TOC file. The default is <filename>toc.hhc</filename>.</para>
9283 <refentry version="5.0" id="htmlhelp.hhk">
9285 <refentrytitle>htmlhelp.hhk</refentrytitle>
9286 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
9289 <refname>htmlhelp.hhk</refname>
9290 <refpurpose>Filename of index file.</refpurpose>
9294 <programlisting id="htmlhelp.hhk.frag">
9295 <xsl:param name="htmlhelp.hhk">index.hhk</xsl:param>
9299 <refsection><info><title>Description</title></info>
9301 <para>set the name of the index file. The default is <filename>index.hhk</filename>.</para>
9306 <refentry version="5.0" id="htmlhelp.hhp.tail">
9308 <refentrytitle>htmlhelp.hhp.tail</refentrytitle>
9309 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
9312 <refname>htmlhelp.hhp.tail</refname>
9313 <refpurpose>Additional content for project file.</refpurpose>
9317 <programlisting id="htmlhelp.hhp.tail.frag">
9318 <xsl:param name="htmlhelp.hhp.tail"></xsl:param>
9322 <refsection><info><title>Description</title></info>
9324 <para>If you want to include some additional parameters into project file,
9325 store appropriate part of project file into this parameter.</para>
9330 <refentry version="5.0" id="htmlhelp.hhp.window">
9332 <refentrytitle>htmlhelp.hhp.window</refentrytitle>
9333 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
9336 <refname>htmlhelp.hhp.window</refname>
9337 <refpurpose>Name of default window.</refpurpose>
9341 <programlisting id="htmlhelp.hhp.window.frag">
9342 <xsl:param name="htmlhelp.hhp.window">Main</xsl:param>
9346 <refsection><info><title>Description</title></info>
9348 <para>Name of default window. If empty no [WINDOWS] section will be
9349 added to project file.</para>
9354 <refentry version="5.0" id="htmlhelp.hhp.windows">
9356 <refentrytitle>htmlhelp.hhp.windows</refentrytitle>
9357 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
9360 <refname>htmlhelp.hhp.windows</refname>
9361 <refpurpose>Definition of additional windows</refpurpose>
9365 <programlisting id="htmlhelp.hhp.windows.frag">
9366 <xsl:param name="htmlhelp.hhp.windows"></xsl:param>
9370 <refsection><info><title>Description</title></info>
9372 <para>Content of this parameter is placed at the end of [WINDOWS]
9373 section of project file. You can use it for defining your own
9374 addtional windows.</para>
9379 <refentry version="5.0" id="htmlhelp.enhanced.decompilation">
9381 <refentrytitle>htmlhelp.enhanced.decompilation</refentrytitle>
9382 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
9385 <refname>htmlhelp.enhanced.decompilation</refname>
9386 <refpurpose>Allow enhanced decompilation of CHM?</refpurpose>
9390 <programlisting id="htmlhelp.enhanced.decompilation.frag">
9391 <xsl:param name="htmlhelp.enhanced.decompilation" select="0"></xsl:param>
9395 <refsection><info><title>Description</title></info>
9397 <para>When non-zero this parameter enables enhanced decompilation of CHM.</para>
9402 <refentry version="5.0" id="htmlhelp.enumerate.images">
9404 <refentrytitle>htmlhelp.enumerate.images</refentrytitle>
9405 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
9408 <refname>htmlhelp.enumerate.images</refname>
9409 <refpurpose>Should the paths to all used images be added to the project file?</refpurpose>
9413 <programlisting id="htmlhelp.enumerate.images.frag">
9414 <xsl:param name="htmlhelp.enumerate.images" select="0"></xsl:param>
9418 <refsection><info><title>Description</title></info>
9420 <para>Set to non-zero if you insert images into your documents as
9421 external binary entities or if you are using absolute image paths.</para>
9426 <refentry version="5.0" id="htmlhelp.force.map.and.alias">
9428 <refentrytitle>htmlhelp.force.map.and.alias</refentrytitle>
9429 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
9432 <refname>htmlhelp.force.map.and.alias</refname>
9433 <refpurpose>Should [MAP] and [ALIAS] sections be added to the project file unconditionally?</refpurpose>
9436 <programlisting id="htmlhelp.force.map.and.alias.frag">
9437 <xsl:param name="htmlhelp.force.map.and.alias" select="0"></xsl:param>
9440 <refsection><info><title>Description</title></info>
9441 <para>Set to non-zero if you have your own
9442 <literal>alias.h</literal> and <literal>context.h</literal>
9443 files and you want to include references to them in the project
9448 <refentry version="5.0" id="htmlhelp.map.file">
9450 <refentrytitle>htmlhelp.map.file</refentrytitle>
9451 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
9454 <refname>htmlhelp.map.file</refname>
9455 <refpurpose>Filename of map file.</refpurpose>
9458 <programlisting id="htmlhelp.map.file.frag">
9459 <xsl:param name="htmlhelp.map.file">context.h</xsl:param>
9462 <refsection><info><title>Description</title></info>
9463 <para>Set the name of map file. The default is
9464 <filename>context.h</filename>. (used for context-sensitive
9469 <refentry version="5.0" id="htmlhelp.alias.file">
9471 <refentrytitle>htmlhelp.alias.file</refentrytitle>
9472 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
9475 <refname>htmlhelp.alias.file</refname>
9476 <refpurpose>Filename of alias file.</refpurpose>
9480 <programlisting id="htmlhelp.alias.file.frag">
9481 <xsl:param name="htmlhelp.alias.file">alias.h</xsl:param>
9485 <refsection><info><title>Description</title></info>
9487 <para>Specifies the filename of the alias file (used for context-sensitive help).</para>
9492 <refentry version="5.0" id="htmlhelp.hhc.section.depth">
9494 <refentrytitle>htmlhelp.hhc.section.depth</refentrytitle>
9495 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
9498 <refname>htmlhelp.hhc.section.depth</refname>
9499 <refpurpose>Depth of TOC for sections in a left pane.</refpurpose>
9503 <programlisting id="htmlhelp.hhc.section.depth.frag">
9504 <xsl:param name="htmlhelp.hhc.section.depth">5</xsl:param>
9508 <refsection><info><title>Description</title></info>
9510 <para>Set the section depth in the left pane of HTML Help viewer. </para>
9515 <refentry version="5.0" id="htmlhelp.hhc.show.root">
9517 <refentrytitle>htmlhelp.hhc.show.root</refentrytitle>
9518 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
9521 <refname>htmlhelp.hhc.show.root</refname>
9522 <refpurpose>Should there be an entry for the root element in the ToC?</refpurpose>
9526 <programlisting id="htmlhelp.hhc.show.root.frag">
9527 <xsl:param name="htmlhelp.hhc.show.root" select="1"></xsl:param>
9531 <refsection><info><title>Description</title></info>
9533 <para>If set to zero, there will be no entry for the root element in the
9534 ToC. This is useful when you want to provide the user with an expanded
9535 ToC as a default.</para>
9540 <refentry version="5.0" id="htmlhelp.hhc.folders.instead.books">
9542 <refentrytitle>htmlhelp.hhc.folders.instead.books</refentrytitle>
9543 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
9546 <refname>htmlhelp.hhc.folders.instead.books</refname>
9547 <refpurpose>Use folder icons in ToC (instead of book icons)?</refpurpose>
9551 <programlisting id="htmlhelp.hhc.folders.instead.books.frag">
9552 <xsl:param name="htmlhelp.hhc.folders.instead.books" select="1"></xsl:param>
9556 <refsection><info><title>Description</title></info>
9558 <para>Set to non-zero for folder-like icons or zero for book-like icons in the ToC.
9559 If you want to use folder-like icons, you must switch off the binary ToC using
9560 <parameter>htmlhelp.hhc.binary</parameter>.
9567 <refentry version="5.0" id="htmlhelp.hhc.binary">
9569 <refentrytitle>htmlhelp.hhc.binary</refentrytitle>
9570 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
9573 <refname>htmlhelp.hhc.binary</refname>
9574 <refpurpose>Generate binary ToC?</refpurpose>
9578 <programlisting id="htmlhelp.hhc.binary.frag">
9579 <xsl:param name="htmlhelp.hhc.binary" select="1"></xsl:param>
9583 <refsection><info><title>Description</title></info>
9585 <para>Set to non-zero to generate a binary TOC. You must create a binary TOC
9586 if you want to add Prev/Next buttons to toolbar (which is default
9587 behaviour). Files with binary TOC can't be merged.</para>
9592 <refentry version="5.0" id="htmlhelp.hhc.width">
9594 <refentrytitle>htmlhelp.hhc.width</refentrytitle>
9595 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
9598 <refname>htmlhelp.hhc.width</refname>
9599 <refpurpose>Width of navigation pane</refpurpose>
9603 <programlisting id="htmlhelp.hhc.width.frag">
9604 <xsl:param name="htmlhelp.hhc.width"></xsl:param>
9608 <refsection><info><title>Description</title></info>
9610 <para>This parameter specifies the width of the navigation pane (containing TOC and
9611 other navigation tabs) in pixels.</para>
9616 <refentry version="5.0" id="htmlhelp.title">
9618 <refentrytitle>htmlhelp.title</refentrytitle>
9619 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
9622 <refname>htmlhelp.title</refname>
9623 <refpurpose>Title of HTML Help</refpurpose>
9627 <programlisting id="htmlhelp.title.frag">
9628 <xsl:param name="htmlhelp.title"></xsl:param>
9632 <refsection><info><title>Description</title></info>
9634 <para>Content of this parameter will be used as a title for generated
9635 HTML Help. If empty, title will be automatically taken from document.</para>
9640 <refentry version="5.0" id="htmlhelp.show.menu">
9642 <refentrytitle>htmlhelp.show.menu</refentrytitle>
9643 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
9646 <refname>htmlhelp.show.menu</refname>
9647 <refpurpose>Should the menu bar be shown?</refpurpose>
9651 <programlisting id="htmlhelp.show.menu.frag">
9652 <xsl:param name="htmlhelp.show.menu" select="0"></xsl:param>
9656 <refsection><info><title>Description</title></info>
9658 <para>Set to non-zero to have an application menu bar in your HTML Help window.
9664 <refentry version="5.0" id="htmlhelp.show.toolbar.text">
9666 <refentrytitle>htmlhelp.show.toolbar.text</refentrytitle>
9667 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
9670 <refname>htmlhelp.show.toolbar.text</refname>
9671 <refpurpose>Show text under toolbar buttons?</refpurpose>
9675 <programlisting id="htmlhelp.show.toolbar.text.frag">
9676 <xsl:param name="htmlhelp.show.toolbar.text" select="1"></xsl:param>
9680 <refsection><info><title>Description</title></info>
9682 <para>Set to non-zero to display texts under toolbar buttons, zero to switch
9683 off displays.</para>
9688 <refentry version="5.0" id="htmlhelp.show.advanced.search">
9690 <refentrytitle>htmlhelp.show.advanced.search</refentrytitle>
9691 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
9694 <refname>htmlhelp.show.advanced.search</refname>
9695 <refpurpose>Should advanced search features be available?</refpurpose>
9699 <programlisting id="htmlhelp.show.advanced.search.frag">
9700 <xsl:param name="htmlhelp.show.advanced.search" select="0"></xsl:param>
9704 <refsection><info><title>Description</title></info>
9706 <para>If you want advanced search features in your help, turn this
9707 parameter to 1.</para>
9712 <refentry version="5.0" id="htmlhelp.show.favorities">
9714 <refentrytitle>htmlhelp.show.favorities</refentrytitle>
9715 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
9718 <refname>htmlhelp.show.favorities</refname>
9719 <refpurpose>Should the Favorites tab be shown?</refpurpose>
9723 <programlisting id="htmlhelp.show.favorities.frag">
9724 <xsl:param name="htmlhelp.show.favorities" select="0"></xsl:param>
9728 <refsection><info><title>Description</title></info>
9730 <para>Set to non-zero to include a Favorites tab in the navigation pane
9731 of the help window.</para>
9736 <refentry version="5.0" id="htmlhelp.button.hideshow">
9738 <refentrytitle>htmlhelp.button.hideshow</refentrytitle>
9739 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
9742 <refname>htmlhelp.button.hideshow</refname>
9743 <refpurpose>Should the Hide/Show button be shown?</refpurpose>
9747 <programlisting id="htmlhelp.button.hideshow.frag">
9748 <xsl:param name="htmlhelp.button.hideshow" select="1"></xsl:param>
9752 <refsection><info><title>Description</title></info>
9754 <para>Set to non-zero to include the Hide/Show button shown on toolbar</para>
9759 <refentry version="5.0" id="htmlhelp.button.back">
9761 <refentrytitle>htmlhelp.button.back</refentrytitle>
9762 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
9765 <refname>htmlhelp.button.back</refname>
9766 <refpurpose>Should the Back button be shown?</refpurpose>
9770 <programlisting id="htmlhelp.button.back.frag">
9771 <xsl:param name="htmlhelp.button.back" select="1"></xsl:param>
9775 <refsection><info><title>Description</title></info>
9777 <para>Set to non-zero to include the Hide/Show button shown on toolbar</para>
9782 <refentry version="5.0" id="htmlhelp.button.forward">
9784 <refentrytitle>htmlhelp.button.forward</refentrytitle>
9785 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
9788 <refname>htmlhelp.button.forward</refname>
9789 <refpurpose>Should the Forward button be shown?</refpurpose>
9793 <programlisting id="htmlhelp.button.forward.frag">
9794 <xsl:param name="htmlhelp.button.forward" select="0"></xsl:param>
9798 <refsection><info><title>Description</title></info>
9800 <para>Set to non-zero to include the Forward button on the toolbar.</para>
9805 <refentry version="5.0" id="htmlhelp.button.stop">
9807 <refentrytitle>htmlhelp.button.stop</refentrytitle>
9808 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
9811 <refname>htmlhelp.button.stop</refname>
9812 <refpurpose>Should the Stop button be shown?</refpurpose>
9816 <programlisting id="htmlhelp.button.stop.frag">
9817 <xsl:param name="htmlhelp.button.stop" select="0"></xsl:param>
9821 <refsection><info><title>Description</title></info>
9823 <para>If you want Stop button shown on toolbar, turn this
9824 parameter to 1.</para>
9829 <refentry version="5.0" id="htmlhelp.button.refresh">
9831 <refentrytitle>htmlhelp.button.refresh</refentrytitle>
9832 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
9835 <refname>htmlhelp.button.refresh</refname>
9836 <refpurpose>Should the Refresh button be shown?</refpurpose>
9840 <programlisting id="htmlhelp.button.refresh.frag">
9841 <xsl:param name="htmlhelp.button.refresh" select="0"></xsl:param>
9845 <refsection><info><title>Description</title></info>
9847 <para>Set to non-zero to include the Stop button on the toolbar.</para>
9852 <refentry version="5.0" id="htmlhelp.button.home">
9854 <refentrytitle>htmlhelp.button.home</refentrytitle>
9855 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
9858 <refname>htmlhelp.button.home</refname>
9859 <refpurpose>Should the Home button be shown?</refpurpose>
9863 <programlisting id="htmlhelp.button.home.frag">
9864 <xsl:param name="htmlhelp.button.home" select="0"></xsl:param>
9868 <refsection><info><title>Description</title></info>
9870 <para>Set to non-zero to include the Home button on the toolbar.</para>
9875 <refentry version="5.0" id="htmlhelp.button.home.url">
9877 <refentrytitle>htmlhelp.button.home.url</refentrytitle>
9878 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
9881 <refname>htmlhelp.button.home.url</refname>
9882 <refpurpose>URL address of page accessible by Home button</refpurpose>
9886 <programlisting id="htmlhelp.button.home.url.frag">
9887 <xsl:param name="htmlhelp.button.home.url"></xsl:param>
9891 <refsection><info><title>Description</title></info>
9893 <para>URL address of page accessible by Home button.</para>
9898 <refentry version="5.0" id="htmlhelp.button.options">
9900 <refentrytitle>htmlhelp.button.options</refentrytitle>
9901 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
9904 <refname>htmlhelp.button.options</refname>
9905 <refpurpose>Should the Options button be shown?</refpurpose>
9909 <programlisting id="htmlhelp.button.options.frag">
9910 <xsl:param name="htmlhelp.button.options" select="1"></xsl:param>
9914 <refsection><info><title>Description</title></info>
9916 <para>If you want Options button shown on toolbar, turn this
9917 parameter to 1.</para>
9922 <refentry version="5.0" id="htmlhelp.button.print">
9924 <refentrytitle>htmlhelp.button.print</refentrytitle>
9925 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
9928 <refname>htmlhelp.button.print</refname>
9929 <refpurpose>Should the Print button be shown?</refpurpose>
9933 <programlisting id="htmlhelp.button.print.frag">
9934 <xsl:param name="htmlhelp.button.print" select="1"></xsl:param>
9938 <refsection><info><title>Description</title></info>
9940 <para>Set to non-zero to include the Print button on the toolbar.
9946 <refentry version="5.0" id="htmlhelp.button.locate">
9948 <refentrytitle>htmlhelp.button.locate</refentrytitle>
9949 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
9952 <refname>htmlhelp.button.locate</refname>
9953 <refpurpose>Should the Locate button be shown?</refpurpose>
9957 <programlisting id="htmlhelp.button.locate.frag">
9958 <xsl:param name="htmlhelp.button.locate" select="0"></xsl:param>
9962 <refsection><info><title>Description</title></info>
9964 <para>If you want Locate button shown on toolbar, turn this
9965 parameter to 1.</para>
9970 <refentry version="5.0" id="htmlhelp.button.jump1">
9972 <refentrytitle>htmlhelp.button.jump1</refentrytitle>
9973 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
9976 <refname>htmlhelp.button.jump1</refname>
9977 <refpurpose>Should the Jump1 button be shown?</refpurpose>
9980 <programlisting id="htmlhelp.button.jump1.frag">
9981 <xsl:param name="htmlhelp.button.jump1" select="0"></xsl:param>
9984 <refsection><info><title>Description</title></info>
9985 <para>Set to non-zero to include the <literal>Jump1</literal> button on the toolbar.</para>
9989 <refentry version="5.0" id="htmlhelp.button.jump1.url">
9991 <refentrytitle>htmlhelp.button.jump1.url</refentrytitle>
9992 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
9995 <refname>htmlhelp.button.jump1.url</refname>
9996 <refpurpose>URL address of page accessible by Jump1 button</refpurpose>
10000 <programlisting id="htmlhelp.button.jump1.url.frag">
10001 <xsl:param name="htmlhelp.button.jump1.url"></xsl:param>
10005 <refsection><info><title>Description</title></info>
10007 <para>URL address of page accessible by Jump1 button.</para>
10012 <refentry version="5.0" id="htmlhelp.button.jump1.title">
10014 <refentrytitle>htmlhelp.button.jump1.title</refentrytitle>
10015 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
10018 <refname>htmlhelp.button.jump1.title</refname>
10019 <refpurpose>Title of Jump1 button</refpurpose>
10023 <programlisting id="htmlhelp.button.jump1.title.frag">
10024 <xsl:param name="htmlhelp.button.jump1.title">User1</xsl:param>
10028 <refsection><info><title>Description</title></info>
10030 <para>Title of Jump1 button.</para>
10035 <refentry version="5.0" id="htmlhelp.button.jump2">
10037 <refentrytitle>htmlhelp.button.jump2</refentrytitle>
10038 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
10041 <refname>htmlhelp.button.jump2</refname>
10042 <refpurpose>Should the Jump2 button be shown?</refpurpose>
10046 <programlisting id="htmlhelp.button.jump2.frag">
10047 <xsl:param name="htmlhelp.button.jump2" select="0"></xsl:param>
10051 <refsection><info><title>Description</title></info>
10053 <para>Set to non-zero to include the Jump2 button on the toolbar.</para>
10058 <refentry version="5.0" id="htmlhelp.button.jump2.url">
10060 <refentrytitle>htmlhelp.button.jump2.url</refentrytitle>
10061 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
10064 <refname>htmlhelp.button.jump2.url</refname>
10065 <refpurpose>URL address of page accessible by Jump2 button</refpurpose>
10069 <programlisting id="htmlhelp.button.jump2.url.frag">
10070 <xsl:param name="htmlhelp.button.jump2.url"></xsl:param>
10074 <refsection><info><title>Description</title></info>
10076 <para>URL address of page accessible by Jump2 button.</para>
10081 <refentry version="5.0" id="htmlhelp.button.jump2.title">
10083 <refentrytitle>htmlhelp.button.jump2.title</refentrytitle>
10084 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
10087 <refname>htmlhelp.button.jump2.title</refname>
10088 <refpurpose>Title of Jump2 button</refpurpose>
10092 <programlisting id="htmlhelp.button.jump2.title.frag">
10093 <xsl:param name="htmlhelp.button.jump2.title">User2</xsl:param>
10097 <refsection><info><title>Description</title></info>
10099 <para>Title of Jump2 button.</para>
10104 <refentry version="5.0" id="htmlhelp.button.next">
10106 <refentrytitle>htmlhelp.button.next</refentrytitle>
10107 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
10110 <refname>htmlhelp.button.next</refname>
10111 <refpurpose>Should the Next button be shown?</refpurpose>
10115 <programlisting id="htmlhelp.button.next.frag">
10116 <xsl:param name="htmlhelp.button.next" select="1"></xsl:param>
10120 <refsection><info><title>Description</title></info>
10122 <para>Set to non-zero to include the Next button on the toolbar.</para>
10127 <refentry version="5.0" id="htmlhelp.button.prev">
10129 <refentrytitle>htmlhelp.button.prev</refentrytitle>
10130 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
10133 <refname>htmlhelp.button.prev</refname>
10134 <refpurpose>Should the Prev button be shown?</refpurpose>
10138 <programlisting id="htmlhelp.button.prev.frag">
10139 <xsl:param name="htmlhelp.button.prev" select="1"></xsl:param>
10143 <refsection><info><title>Description</title></info>
10145 <para>Set to non-zero to include the Prev button on the toolbar.
10151 <refentry version="5.0" id="htmlhelp.button.zoom">
10153 <refentrytitle>htmlhelp.button.zoom</refentrytitle>
10154 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
10157 <refname>htmlhelp.button.zoom</refname>
10158 <refpurpose>Should the Zoom button be shown?</refpurpose>
10162 <programlisting id="htmlhelp.button.zoom.frag">
10163 <xsl:param name="htmlhelp.button.zoom" select="0"></xsl:param>
10167 <refsection><info><title>Description</title></info>
10169 <para>Set to non-zero to include the Zoom button on the toolbar.
10175 <refentry version="5.0" id="htmlhelp.remember.window.position">
10177 <refentrytitle>htmlhelp.remember.window.position</refentrytitle>
10178 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
10181 <refname>htmlhelp.remember.window.position</refname>
10182 <refpurpose>Remember help window position?</refpurpose>
10186 <programlisting id="htmlhelp.remember.window.position.frag">
10187 <xsl:param name="htmlhelp.remember.window.position" select="0"></xsl:param>
10191 <refsection><info><title>Description</title></info>
10193 <para>Set to non-zero to remember help window position between starts.</para>
10198 <refentry version="5.0" id="htmlhelp.window.geometry">
10200 <refentrytitle>htmlhelp.window.geometry</refentrytitle>
10201 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
10204 <refname>htmlhelp.window.geometry</refname>
10205 <refpurpose>Set initial geometry of help window</refpurpose>
10209 <programlisting id="htmlhelp.window.geometry.frag">
10210 <xsl:param name="htmlhelp.window.geometry"></xsl:param>
10214 <refsection><info><title>Description</title></info>
10216 <para>This parameter specifies initial position of help
10217 window. E.g.</para>
10219 <programlisting><xsl:param name="htmlhelp.window.geometry">[160,64,992,704]</xsl:param></programlisting>
10224 <refentry version="5.0" id="htmlhelp.use.hhk">
10226 <refentrytitle>htmlhelp.use.hhk</refentrytitle>
10227 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
10230 <refname>htmlhelp.use.hhk</refname>
10231 <refpurpose>Should the index be built using the HHK file?</refpurpose>
10235 <programlisting id="htmlhelp.use.hhk.frag">
10236 <xsl:param name="htmlhelp.use.hhk" select="0"></xsl:param>
10240 <refsection><info><title>Description</title></info>
10242 <para>If non-zero, the index is created using the HHK file (instead of using <tag role="html">object</tag>
10243 elements in the HTML files). For more information, see <link role="tcg" xlink:href="HtmlHelp.html#HHGenIndex">Generating an index</link>.</para>
10247 <refentry version="5.0" id="htmlhelp.only">
10249 <refentrytitle>htmlhelp.only</refentrytitle>
10250 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
10253 <refname>htmlhelp.only</refname>
10254 <refpurpose>Should only project files be generated?</refpurpose>
10258 <programlisting id="htmlhelp.only.frag">
10259 <xsl:param name="htmlhelp.only" select="0"></xsl:param>
10263 <refsection><info><title>Description</title></info>
10266 <para>Set to non-zero if you want to play with various HTML Help parameters
10267 and you don't need to regenerate all HTML files. This setting will not
10268 process whole document, only project files (hhp, hhc, hhk,...) will be
10275 </reference><reference id="eclipse_help" xml:base="../html/param.xml"><title>Eclipse Help Platform</title>
10276 <refentry version="5.0" id="eclipse.autolabel">
10278 <refentrytitle>eclipse.autolabel</refentrytitle>
10279 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
10282 <refname>eclipse.autolabel</refname>
10283 <refpurpose>Should tree-like ToC use autonumbering feature?</refpurpose>
10287 <programlisting id="eclipse.autolabel.frag">
10288 <xsl:param name="eclipse.autolabel" select="0"></xsl:param>
10292 <refsection><info><title>Description</title></info>
10294 <para>If you want to include chapter and section numbers into ToC in
10295 the left panel, set this parameter to 1.</para>
10300 <refentry version="5.0" id="eclipse.plugin.name">
10302 <refentrytitle>eclipse.plugin.name</refentrytitle>
10303 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
10306 <refname>eclipse.plugin.name</refname>
10307 <refpurpose>Eclipse Help plugin name</refpurpose>
10311 <programlisting id="eclipse.plugin.name.frag">
10312 <xsl:param name="eclipse.plugin.name">DocBook Online Help Sample</xsl:param>
10316 <refsection><info><title>Description</title></info>
10318 <para>Eclipse Help plugin name.</para>
10323 <refentry version="5.0" id="eclipse.plugin.id">
10325 <refentrytitle>eclipse.plugin.id</refentrytitle>
10326 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
10329 <refname>eclipse.plugin.id</refname>
10330 <refpurpose>Eclipse Help plugin id</refpurpose>
10334 <programlisting id="eclipse.plugin.id.frag">
10335 <xsl:param name="eclipse.plugin.id">com.example.help</xsl:param>
10339 <refsection><info><title>Description</title></info>
10341 <para>Eclipse Help plugin id. You should change this id to something
10342 unique for each help.</para>
10347 <refentry version="5.0" id="eclipse.plugin.provider">
10349 <refentrytitle>eclipse.plugin.provider</refentrytitle>
10350 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
10353 <refname>eclipse.plugin.provider</refname>
10354 <refpurpose>Eclipse Help plugin provider name</refpurpose>
10358 <programlisting id="eclipse.plugin.provider.frag">
10359 <xsl:param name="eclipse.plugin.provider">Example provider</xsl:param>
10363 <refsection><info><title>Description</title></info>
10365 <para>Eclipse Help plugin provider name.</para>
10370 </reference><reference id="javahelp" xml:base="../html/param.xml"><title>JavaHelp</title>
10371 <refentry version="5.0" id="javahelp.encoding">
10373 <refentrytitle>javahelp.encoding</refentrytitle>
10374 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
10377 <refname>javahelp.encoding</refname>
10378 <refpurpose>Character encoding to use in control files for JavaHelp.</refpurpose>
10382 <programlisting id="javahelp.encoding.frag">
10383 <xsl:param name="javahelp.encoding">iso-8859-1</xsl:param>
10387 <refsection><info><title>Description</title></info>
10389 <para>JavaHelp crashes on some characters when written as character
10390 references. In that case you can use this parameter to select an appropriate encoding.</para>
10398 </reference><reference id="l10n" xml:base="../html/param.xml"><title>Localization</title>
10399 <refentry version="5.0" id="l10n.gentext.language">
10401 <refentrytitle>l10n.gentext.language</refentrytitle>
10402 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
10405 <refname>l10n.gentext.language</refname>
10406 <refpurpose>Sets the gentext language</refpurpose>
10410 <programlisting id="l10n.gentext.language.frag">
10411 <xsl:param name="l10n.gentext.language"></xsl:param>
10415 <refsection><info><title>Description</title></info>
10417 <para>If this parameter is set to any value other than the empty string, its
10418 value will be used as the value for the language when generating text. Setting
10419 <parameter>l10n.gentext.language</parameter> overrides any settings within the
10420 document being formatted.</para>
10422 <para>It's much more likely that you might want to set the
10423 <parameter>l10n.gentext.default.language</parameter> parameter.</para>
10428 <refentry version="5.0" id="l10n.gentext.default.language">
10430 <refentrytitle>l10n.gentext.default.language</refentrytitle>
10431 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
10434 <refname>l10n.gentext.default.language</refname>
10435 <refpurpose>Sets the default language for generated text</refpurpose>
10439 <programlisting id="l10n.gentext.default.language.frag">
10440 <xsl:param name="l10n.gentext.default.language">en</xsl:param>
10444 <refsection><info><title>Description</title></info>
10446 <para>The value of the <parameter>l10n.gentext.default.language</parameter>
10447 parameter is used as the language for generated text if no setting is provided
10448 in the source document.</para>
10453 <refentry version="5.0" id="l10n.gentext.use.xref.language">
10455 <refentrytitle>l10n.gentext.use.xref.language</refentrytitle>
10456 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
10459 <refname>l10n.gentext.use.xref.language</refname>
10460 <refpurpose>Use the language of target when generating cross-reference text?</refpurpose>
10464 <programlisting id="l10n.gentext.use.xref.language.frag">
10465 <xsl:param name="l10n.gentext.use.xref.language" select="0"></xsl:param>
10469 <refsection><info><title>Description</title></info>
10471 <para>If non-zero, the language of the target will be used when
10472 generating cross reference text. Usually, the <quote>current</quote>
10473 language is used when generating text (that is, the language of the
10474 element that contains the cross-reference element). But setting this parameter
10475 allows the language of the element <emphasis>pointed to</emphasis> to control
10476 the generated text.</para>
10478 <para>Consider the following example:</para>
10481 <programlisting><para lang="en">See also <xref linkend="chap3"/>.</para>
10485 <para>Suppose that Chapter 3 happens to be written in German.
10486 If <parameter>l10n.gentext.use.xref.language</parameter> is non-zero, the
10487 resulting text will be something like this:</para>
10490 <para>See also Kapital 3.</para>
10493 <para>Where the more traditional rendering would be:</para>
10496 <para>See also Chapter 3.</para>
10502 <refentry version="5.0" id="l10n.lang.value.rfc.compliant">
10504 <refentrytitle>l10n.lang.value.rfc.compliant</refentrytitle>
10505 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
10508 <refname>l10n.lang.value.rfc.compliant</refname>
10509 <refpurpose>Make value of lang attribute RFC compliant?</refpurpose>
10513 <programlisting id="l10n.lang.value.rfc.compliant.frag">
10514 <xsl:param name="l10n.lang.value.rfc.compliant" select="1"></xsl:param>
10518 <refsection><info><title>Description</title></info>
10520 <para>If non-zero, ensure that the values for all <tag class="attribute">lang</tag> attributes in HTML output are RFC
10521 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:
10523 <blockquote><para>[RFC1766] defines and explains the language codes
10524 that must be used in HTML documents.</para>
10525 <para>Briefly, language codes consist of a primary code and a possibly
10526 empty series of subcodes:
10528 <literallayout class="monospaced">language-code = primary-code ( "-" subcode )*</literallayout>
10530 <para>And in RFC 1766, <link xlink:href="http://www.ietf.org/rfc/rfc1766.txt">Tags for the Identification
10531 of Languages</link>, the EBNF for "language tag" is given as:
10533 <literallayout class="monospaced">Language-Tag = Primary-tag *( "-" Subtag )
10534 Primary-tag = 1*8ALPHA
10535 Subtag = 1*8ALPHA</literallayout>
10538 </para></footnote>.
10540 by taking any underscore characters in any <tag class="attribute">lang</tag> values found in source documents, and
10541 replacing them with hyphen characters in output HTML files. For
10542 example, <literal>zh_CN</literal> in a source document becomes
10543 <literal>zh-CN</literal> in the HTML output form that source.
10546 <para>This parameter does not cause any case change in <tag class="attribute">lang</tag> values, because RFC 1766
10547 explicitly states that all "language tags" (as it calls them) "are
10548 to be treated as case insensitive".</para>
10555 <refentry version="5.0" id="writing.mode">
10557 <refentrytitle>writing.mode</refentrytitle>
10558 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
10561 <refname>writing.mode</refname>
10562 <refpurpose>Direction of text flow based on locale</refpurpose>
10566 <programlisting id="writing.mode.frag">
10567 <xsl:param name="writing.mode">
10568 <xsl:call-template name="gentext">
10569 <xsl:with-param name="key">writing-mode</xsl:with-param>
10570 <xsl:with-param name="lang">
10571 <xsl:call-template name="l10n.language">
10572 <xsl:with-param name="target" select="/*[1]"></xsl:with-param>
10573 </xsl:call-template>
10574 </xsl:with-param>
10575 </xsl:call-template>
10580 <refsection><info><title>Description</title></info>
10582 <para>Sets direction of text flow and text alignment based on locale.
10583 The value is normally taken from the gentext file for the
10584 lang attribute of the document's root element, using the
10585 key name 'writing-mode' to look it up in the gentext file.
10586 But the param can also be
10587 set on the command line to override that gentext value.
10589 <para>Accepted values are:
10594 <para>Left-to-right text flow in each line, lines stack top to bottom.</para>
10600 <para>Right-to-left text flow in each line, lines stack top to bottom.</para>
10606 <para>Top-to-bottom text flow in each vertical line, lines stack right to left.
10607 Supported by only a few XSL-FO processors. Not supported in HTML output.</para>
10613 <para>Shorthand for lr-tb.</para>
10619 <para>Shorthand for rl-tb.</para>
10625 <para>Shorthand for tb-rl.</para>
10637 <?dbhtml dir="fo"?>
10638 <?dbhtml filename="index.html"?>
10639 <title xml:base="../fo/param.xml">FO Parameter Reference</title>
10640 <partintro id="fointro">
10642 <para xml:base="../fo/param.xml">This is reference documentation for all user-configurable
10643 parameters in the DocBook XSL FO stylesheets (for generating
10644 XSL-FO output destined for final print/PDF output).</para>
10647 <reference id="admons" xml:base="../fo/param.xml"><title>Admonitions</title>
10648 <refentry version="5.0" id="admon.graphics">
10650 <refentrytitle>admon.graphics</refentrytitle>
10651 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
10654 <refname>admon.graphics</refname>
10655 <refpurpose>Use graphics in admonitions?</refpurpose>
10659 <programlisting id="admon.graphics.frag">
10660 <xsl:param name="admon.graphics" select="0"></xsl:param>
10664 <refsection><info><title>Description</title></info>
10666 <para>If true (non-zero), admonitions are presented in an alternate style that uses
10667 a graphic. Default graphics are provided in the distribution.
10673 <refentry version="5.0" id="admon.graphics.extension">
10675 <refentrytitle>admon.graphics.extension</refentrytitle>
10676 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
10679 <refname>admon.graphics.extension</refname>
10680 <refpurpose>Filename extension for admonition graphics</refpurpose>
10684 <programlisting id="admon.graphics.extension.frag">
10685 <xsl:param name="admon.graphics.extension">.png</xsl:param>
10689 <refsection><info><title>Description</title></info>
10691 <para>Sets the filename extension to use on admonition graphics.</para>
10696 <refentry version="5.0" id="admon.graphics.path">
10698 <refentrytitle>admon.graphics.path</refentrytitle>
10699 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
10702 <refname>admon.graphics.path</refname>
10703 <refpurpose>Path to admonition graphics</refpurpose>
10707 <programlisting id="admon.graphics.path.frag"><xsl:param name="admon.graphics.path">images/</xsl:param></programlisting>
10710 <refsection><info><title>Description</title></info>
10712 <para>Sets the path to the directory containing the admonition graphics
10713 (caution.png, important.png etc). This location is normally relative
10714 to the output html directory. See <parameter>base.dir</parameter></para>
10719 <refentry version="5.0" id="admon.textlabel">
10721 <refentrytitle>admon.textlabel</refentrytitle>
10722 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
10725 <refname>admon.textlabel</refname>
10726 <refpurpose>Use text label in admonitions?</refpurpose>
10730 <programlisting id="admon.textlabel.frag">
10731 <xsl:param name="admon.textlabel" select="1"></xsl:param>
10735 <refsection><info><title>Description</title></info>
10737 <para>If true (non-zero), admonitions are presented with a generated
10738 text label such as Note or Warning in the appropriate language.
10739 If zero, such labels are turned off, but any title child
10740 of the admonition element are still output.
10741 The default value is 1.
10747 <refentry version="5.0" id="admonition.title.properties">
10750 <refentrytitle>admonition.title.properties</refentrytitle>
10751 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
10754 <refname>admonition.title.properties</refname>
10755 <refpurpose>To set the style for admonitions titles.</refpurpose>
10759 <programlisting id="admonition.title.properties.frag">
10760 <xsl:attribute-set name="admonition.title.properties">
10761 <xsl:attribute name="font-size">14pt</xsl:attribute>
10762 <xsl:attribute name="font-weight">bold</xsl:attribute>
10763 <xsl:attribute name="hyphenate">false</xsl:attribute>
10764 <xsl:attribute name="keep-with-next.within-column">always</xsl:attribute>
10765 </xsl:attribute-set>
10768 <refsection><info><title>Description</title></info>
10769 <para>How do you want admonitions titles styled? </para>
10770 <para>Set the font-size, weight etc to the style required.</para>
10775 <refentry version="5.0" id="admonition.properties">
10777 <refentrytitle>admonition.properties</refentrytitle>
10778 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
10781 <refname>admonition.properties</refname>
10782 <refpurpose>To set the style for admonitions.</refpurpose>
10786 <programlisting id="admonition.properties.frag"><xsl:attribute-set name="admonition.properties"></xsl:attribute-set>
10789 <refsection><info><title>Description</title></info>
10790 <para>How do you want admonitions styled? </para>
10791 <para>Set the font-size, weight, etc. to the style required</para>
10796 <refentry version="5.0" id="graphical.admonition.properties">
10798 <refentrytitle>graphical.admonition.properties</refentrytitle>
10799 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
10802 <refname>graphical.admonition.properties</refname>
10803 <refpurpose>To add properties to the outer block of a graphical admonition.</refpurpose>
10807 <programlisting id="graphical.admonition.properties.frag"><xsl:attribute-set name="graphical.admonition.properties">
10808 <xsl:attribute name="space-before.optimum">1em</xsl:attribute>
10809 <xsl:attribute name="space-before.minimum">0.8em</xsl:attribute>
10810 <xsl:attribute name="space-before.maximum">1.2em</xsl:attribute>
10811 <xsl:attribute name="space-after.optimum">1em</xsl:attribute>
10812 <xsl:attribute name="space-after.minimum">0.8em</xsl:attribute>
10813 <xsl:attribute name="space-after.maximum">1.2em</xsl:attribute>
10814 </xsl:attribute-set>
10817 <refsection><info><title>Description</title></info>
10818 <para>These properties are added to the outer block containing the
10819 entire graphical admonition, including its title.
10820 It is used when the parameter
10821 <parameter>admon.graphics</parameter> is set to nonzero.
10822 Use this attribute-set to set the space above and below,
10823 and any indent for the whole admonition.</para>
10825 <para>In addition to these properties, a graphical admonition
10826 also applies the <parameter>admonition.title.properties</parameter>
10827 attribute-set to the title, and applies the
10828 <parameter>admonition.properties</parameter> attribute-set
10829 to the rest of the content.</para>
10834 <refentry version="5.0" id="nongraphical.admonition.properties">
10836 <refentrytitle>nongraphical.admonition.properties</refentrytitle>
10837 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
10840 <refname>nongraphical.admonition.properties</refname>
10841 <refpurpose>To add properties to the outer block of a nongraphical admonition.</refpurpose>
10845 <programlisting id="nongraphical.admonition.properties.frag"><xsl:attribute-set name="nongraphical.admonition.properties">
10846 <xsl:attribute name="space-before.minimum">0.8em</xsl:attribute>
10847 <xsl:attribute name="space-before.optimum">1em</xsl:attribute>
10848 <xsl:attribute name="space-before.maximum">1.2em</xsl:attribute>
10849 <xsl:attribute name="margin-{$direction.align.start}">0.25in</xsl:attribute>
10850 <xsl:attribute name="margin-{$direction.align.end}">0.25in</xsl:attribute>
10851 </xsl:attribute-set>
10854 <refsection><info><title>Description</title></info>
10855 <para>These properties are added to the outer block containing the
10856 entire nongraphical admonition, including its title.
10857 It is used when the parameter
10858 <parameter>admon.graphics</parameter> is set to zero.
10859 Use this attribute-set to set the space above and below,
10860 and any indent for the whole admonition.</para>
10862 <para>In addition to these properties, a nongraphical admonition
10863 also applies the <parameter>admonition.title.properties</parameter>
10864 attribute-set to the title, and the
10865 <parameter>admonition.properties</parameter> attribute-set
10866 to the rest of the content.</para>
10871 </reference><reference id="callouts" xml:base="../fo/param.xml"><title>Callouts</title>
10872 <refentry version="5.0" id="callout.defaultcolumn">
10874 <refentrytitle>callout.defaultcolumn</refentrytitle>
10875 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
10878 <refname>callout.defaultcolumn</refname>
10879 <refpurpose>Indicates what column callouts appear in by default</refpurpose>
10883 <programlisting id="callout.defaultcolumn.frag">
10884 <xsl:param name="callout.defaultcolumn">60</xsl:param>
10888 <refsection><info><title>Description</title></info>
10890 <para>If a callout does not identify a column (for example, if it uses
10891 the <literal>linerange</literal> <tag class="attribute">unit</tag>),
10892 it will appear in the default column.
10898 <refentry version="5.0" id="callout.graphics">
10900 <refentrytitle>callout.graphics</refentrytitle>
10901 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
10904 <refname>callout.graphics</refname>
10905 <refpurpose>Use graphics for callouts?</refpurpose>
10909 <programlisting id="callout.graphics.frag">
10910 <xsl:param name="callout.graphics" select="1"></xsl:param>
10914 <refsection><info><title>Description</title></info>
10916 <para>If non-zero, callouts are presented with graphics (e.g., reverse-video
10917 circled numbers instead of "(1)", "(2)", etc.).
10918 Default graphics are provided in the distribution.
10924 <refentry version="5.0" id="callout.graphics.extension">
10926 <refentrytitle>callout.graphics.extension</refentrytitle>
10927 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
10930 <refname>callout.graphics.extension</refname>
10931 <refpurpose>Filename extension for callout graphics</refpurpose>
10935 <programlisting id="callout.graphics.extension.frag">
10937 <xsl:param name="callout.graphics.extension">.svg</xsl:param>
10941 <refsection><info><title>Description</title></info>
10942 <para>Sets the filename extension to use on callout graphics. </para>
10945 <para>The Docbook XSL distribution provides callout graphics in the following formats:</para>
10946 <listitem><para>SVG (extension: <filename class="extension">.svg</filename>)</para></listitem>
10947 <listitem><para>PNG (extension: <filename class="extension">.png</filename>)</para></listitem>
10948 <listitem><para>GIF (extension: <filename class="extension">.gif</filename>)</para></listitem>
10953 <refentry version="5.0" id="callout.graphics.number.limit">
10955 <refentrytitle>callout.graphics.number.limit</refentrytitle>
10956 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
10959 <refname>callout.graphics.number.limit</refname>
10960 <refpurpose>Number of the largest callout graphic</refpurpose>
10964 <programlisting id="callout.graphics.number.limit.frag">
10966 <xsl:param name="callout.graphics.number.limit">30</xsl:param>
10970 <refsection><info><title>Description</title></info>
10972 <para>If <parameter>callout.graphics</parameter> is non-zero, graphics
10973 are used to represent callout numbers instead of plain text. The value
10974 of <parameter>callout.graphics.number.limit</parameter> is the largest
10975 number for which a graphic exists. If the callout number exceeds this
10976 limit, the default presentation "(plain text instead of a graphic)"
10983 <refentry version="5.0" id="callout.graphics.path">
10985 <refentrytitle>callout.graphics.path</refentrytitle>
10986 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
10989 <refname>callout.graphics.path</refname>
10990 <refpurpose>Path to callout graphics</refpurpose>
10994 <programlisting id="callout.graphics.path.frag">
10995 <xsl:param name="callout.graphics.path">images/callouts/</xsl:param>
10999 <refsection><info><title>Description</title></info>
11001 <para>Sets the path to the directory holding the callout graphics. his
11002 location is normally relative to the output html directory. see
11003 base.dir. Always terminate the directory with / since the graphic file
11004 is appended to this string, hence needs the separator.
11010 <refentry version="5.0" id="callout.icon.size">
11012 <refentrytitle>callout.icon.size</refentrytitle>
11013 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
11016 <refname>callout.icon.size</refname>
11017 <refpurpose>Specifies the size of callout marker icons</refpurpose>
11021 <programlisting id="callout.icon.size.frag">
11022 <xsl:param name="callout.icon.size">7pt</xsl:param>
11026 <refsection><info><title>Description</title></info>
11028 <para>Specifies the size of the callout marker icons.
11029 The default size is 7 points.</para>
11034 <refentry version="5.0" id="callout.unicode">
11036 <refentrytitle>callout.unicode</refentrytitle>
11037 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
11040 <refname>callout.unicode</refname>
11041 <refpurpose>Use Unicode characters rather than images for callouts.</refpurpose>
11045 <programlisting id="callout.unicode.frag"><xsl:param name="callout.unicode" select="0"></xsl:param></programlisting>
11048 <refsection><info><title>Description</title></info>
11050 <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.
11056 <refentry version="5.0" id="callout.unicode.font">
11058 <refentrytitle>callout.unicode.font</refentrytitle>
11059 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
11062 <refname>callout.unicode.font</refname>
11063 <refpurpose>Specify a font for Unicode glyphs</refpurpose>
11067 <programlisting id="callout.unicode.font.frag">
11068 <xsl:param name="callout.unicode.font">ZapfDingbats</xsl:param>
11072 <refsection><info><title>Description</title></info>
11074 <para>The name of the font to specify around Unicode callout glyphs.
11075 If set to the empty string, no font change will occur.
11081 <refentry version="5.0" id="callout.unicode.number.limit">
11083 <refentrytitle>callout.unicode.number.limit</refentrytitle>
11084 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
11087 <refname>callout.unicode.number.limit</refname>
11088 <refpurpose>Number of the largest unicode callout character</refpurpose>
11092 <programlisting id="callout.unicode.number.limit.frag">
11093 <xsl:param name="callout.unicode.number.limit">10</xsl:param>
11097 <refsection><info><title>Description</title></info>
11099 <para>If <parameter>callout.unicode</parameter>
11100 is non-zero, unicode characters are used to represent
11101 callout numbers. The value of
11102 <parameter>callout.unicode.number.limit</parameter>
11104 the largest number for which a unicode character exists. If the callout number
11105 exceeds this limit, the default presentation "(nnn)" will always
11112 <refentry version="5.0" id="callout.unicode.start.character">
11114 <refentrytitle>callout.unicode.start.character</refentrytitle>
11115 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
11118 <refname>callout.unicode.start.character</refname>
11119 <refpurpose>First Unicode character to use, decimal value.</refpurpose>
11123 <programlisting id="callout.unicode.start.character.frag">
11124 <xsl:param name="callout.unicode.start.character">10102</xsl:param>
11128 <refsection><info><title>Description</title></info>
11130 <para>If <parameter>callout.graphics</parameter> is zero and <parameter>callout.unicode</parameter>
11131 is non-zero, unicode characters are used to represent
11132 callout numbers. The value of
11133 <parameter>callout.unicode.start.character</parameter>
11134 is the decimal unicode value used for callout number one. Currently,
11135 only 10102 is supported in the stylesheets for this parameter.
11141 <refentry version="5.0" id="callouts.extension">
11143 <refentrytitle>callouts.extension</refentrytitle>
11144 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
11147 <refname>callouts.extension</refname>
11148 <refpurpose>Enable the callout extension</refpurpose>
11152 <programlisting id="callouts.extension.frag">
11153 <xsl:param name="callouts.extension" select="1"></xsl:param>
11157 <refsection><info><title>Description</title></info>
11159 <para>The callouts extension processes <tag>areaset</tag>
11160 elements in <tag>programlistingco</tag> and other text-based
11167 </reference><reference id="toc_index" xml:base="../fo/param.xml"><title>ToC/LoT/Index Generation</title>
11168 <refentry version="5.0" id="autotoc.label.separator">
11170 <refentrytitle>autotoc.label.separator</refentrytitle>
11171 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
11174 <refname>autotoc.label.separator</refname>
11175 <refpurpose>Separator between labels and titles in the ToC</refpurpose>
11179 <programlisting id="autotoc.label.separator.frag">
11180 <xsl:param name="autotoc.label.separator">. </xsl:param>
11184 <refsection><info><title>Description</title></info>
11186 <para>String used to separate labels and titles in a table of contents.</para>
11191 <refentry version="5.0" id="process.empty.source.toc">
11193 <refentrytitle>process.empty.source.toc</refentrytitle>
11194 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
11197 <refname>process.empty.source.toc</refname>
11198 <refpurpose>Generate automated TOC if <tag>toc</tag> element occurs in a source document?</refpurpose>
11202 <programlisting id="process.empty.source.toc.frag"><xsl:param name="process.empty.source.toc" select="0"></xsl:param></programlisting>
11205 <refsection><info><title>Description</title></info>
11207 <para>Specifies that if an empty <tag>toc</tag> element is found in a
11208 source document, an automated TOC is generated at this point in the
11211 <para>Depending on what the value of the
11212 <parameter>generate.toc</parameter> parameter is, setting this
11213 parameter to <literal>1</literal> could result in generation of
11214 duplicate automated TOCs. So the
11215 <parameter>process.empty.source.toc</parameter> is primarily useful
11216 as an "override": by placing an empty <tag>toc</tag> in your
11217 document and setting this parameter to <literal>1</literal>, you can
11218 force a TOC to be generated even if <tag>generate.toc</tag>
11219 says not to.</para>
11226 <refentry version="5.0" id="process.source.toc">
11228 <refentrytitle>process.source.toc</refentrytitle>
11229 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
11232 <refname>process.source.toc</refname>
11233 <refpurpose>Process a non-empty <tag>toc</tag> element if it occurs in a source document?</refpurpose>
11237 <programlisting id="process.source.toc.frag"><xsl:param name="process.source.toc" select="0"></xsl:param></programlisting>
11240 <refsection><info><title>Description</title></info>
11242 <para>Specifies that the contents of a non-empty "hard-coded"
11243 <tag>toc</tag> element in a source document are processed to
11244 generate a TOC in output.
11246 <para>This parameter has no effect on automated generation of
11247 TOCs. An automated TOC may still be generated along with the
11248 "hard-coded" TOC. To suppress automated TOC generation, adjust the
11249 value of the <parameter>generate.toc</parameter> paramameter.</para>
11251 <para>The <tag>process.source.toc</tag> parameter also has
11252 no effect if the <tag>toc</tag> element is empty; handling
11253 for empty <tag>toc</tag> is controlled by the
11254 <parameter>process.empty.source.toc</parameter> parameter.</para>
11261 <refentry version="5.0" id="generate.toc">
11263 <refentrytitle>generate.toc</refentrytitle>
11264 <refmiscinfo class="other" otherclass="datatype">table</refmiscinfo>
11267 <refname>generate.toc</refname>
11268 <refpurpose>Control generation of ToCs and LoTs</refpurpose>
11272 <programlisting id="generate.toc.frag">
11274 <xsl:param name="generate.toc">
11275 /appendix toc,title
11276 article/appendix nop
11278 book toc,title,figure,table,example,equation
11282 reference toc,title
11294 <refsection><info><title>Description</title></info>
11296 <para>This parameter has a structured value. It is a table of space-delimited
11297 path/value pairs. Each path identifies some element in the source document
11298 using a restricted subset of XPath (only the implicit child axis, no wildcards,
11299 no predicates). Paths can be either relative or absolute.</para>
11301 <para>When processing a particular element, the stylesheets consult this table to
11302 determine if a ToC (or LoT(s)) should be generated.</para>
11304 <para>For example, consider the entry:</para>
11306 <screen>book toc,figure</screen>
11308 <para>This indicates that whenever a <tag>book</tag> is formatted, a
11309 Table Of Contents and a List of Figures should be generated. Similarly,</para>
11311 <screen>/chapter toc</screen>
11313 <para>indicates that whenever a document <emphasis>that has a root
11314 of</emphasis> <tag>chapter</tag> is formatted, a Table of
11315 Contents should be generated. The entry <literal>chapter</literal> would match
11316 all chapters, but <literal>/chapter</literal> matches only <tag>chapter</tag>
11317 document elements.</para>
11319 <para>Generally, the longest match wins. So, for example, if you want to distinguish
11320 articles in books from articles in parts, you could use these two entries:</para>
11322 <screen>book/article toc,figure
11323 part/article toc</screen>
11325 <para>Note that an article in a part can never match a <literal>book/article</literal>,
11326 so if you want nothing to be generated for articles in parts, you can simply leave
11327 that rule out.</para>
11329 <para>If you want to leave the rule in, to make it explicit that you're turning
11330 something off, use the value <quote>nop</quote>. For example, the following
11331 entry disables ToCs and LoTs for articles:</para>
11333 <screen>article nop</screen>
11335 <para>Do not simply leave the word <quote>article</quote> in the file
11336 without a matching value. That'd be just begging the silly little
11337 path/value parser to get confused.</para>
11339 <para>Section ToCs are further controlled by the
11340 <parameter>generate.section.toc.level</parameter> parameter.
11341 For a given section level to have a ToC, it must have both an entry in
11342 <parameter>generate.toc</parameter> and be within the range enabled by
11343 <parameter>generate.section.toc.level</parameter>.</para>
11347 <refentry version="5.0" id="generate.index">
11349 <refentrytitle>generate.index</refentrytitle>
11350 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
11353 <refname>generate.index</refname>
11354 <refpurpose>Do you want an index?</refpurpose>
11358 <programlisting id="generate.index.frag"><xsl:param name="generate.index" select="1"></xsl:param></programlisting>
11361 <refsection><info><title>Description</title></info>
11363 <para>Specify if an index should be generated. </para>
11368 <refentry version="5.0" id="make.index.markup">
11370 <refentrytitle>make.index.markup</refentrytitle>
11371 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
11374 <refname>make.index.markup</refname>
11375 <refpurpose>Generate XML index markup in the index?</refpurpose>
11379 <programlisting id="make.index.markup.frag">
11380 <xsl:param name="make.index.markup" select="0"></xsl:param>
11384 <refsection><info><title>Description</title></info>
11386 <para>This parameter enables a very neat trick for getting properly
11387 merged, collated back-of-the-book indexes. G. Ken Holman suggested
11388 this trick at Extreme Markup Languages 2002 and I'm indebted to him
11391 <para>Jeni Tennison's excellent code in
11392 <filename>autoidx.xsl</filename> does a great job of merging and
11393 sorting <tag>indexterm</tag>s in the document and building a
11394 back-of-the-book index. However, there's one thing that it cannot
11395 reasonably be expected to do: merge page numbers into ranges. (I would
11396 not have thought that it could collate and suppress duplicate page
11397 numbers, but in fact it appears to manage that task somehow.)</para>
11399 <para>Ken's trick is to produce a document in which the index at the
11400 back of the book is <quote>displayed</quote> in XML. Because the index
11401 is generated by the FO processor, all of the page numbers have been resolved.
11402 It's a bit hard to explain, but what it boils down to is that instead of having
11403 an index at the back of the book that looks like this:</para>
11406 <formalpara><info><title>A</title></info>
11407 <para>ap1, 1, 2, 3</para>
11411 <para>you get one that looks like this:</para>
11414 <programlisting><indexdiv>A</indexdiv>
11416 <primaryie>ap1</primaryie>,
11417 <phrase role="pageno">1</phrase>,
11418 <phrase role="pageno">2</phrase>,
11419 <phrase role="pageno">3</phrase>
11420 </indexentry></programlisting>
11423 <para>After building a PDF file with this sort of odd-looking index, you can
11424 extract the text from the PDF file and the result is a proper index expressed in
11427 <para>Now you have data that's amenable to processing and a simple Perl script
11428 (such as <filename>fo/pdf2index</filename>) can
11429 merge page ranges and generate a proper index.</para>
11431 <para>Finally, reformat your original document using this literal index instead of
11432 an automatically generated one and <quote>bingo</quote>!</para>
11437 <refentry version="5.0" id="index.method">
11439 <refentrytitle>index.method</refentrytitle>
11440 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
11441 <refmiscinfo class="other" otherclass="value">basic</refmiscinfo>
11442 <refmiscinfo class="other" otherclass="value">kosek</refmiscinfo>
11443 <refmiscinfo class="other" otherclass="value">kimber</refmiscinfo>
11446 <refname>index.method</refname>
11447 <refpurpose>Select method used to group index entries in an index</refpurpose>
11451 <programlisting id="index.method.frag">
11452 <xsl:param name="index.method">basic</xsl:param>
11456 <refsection><info><title>Description</title></info>
11458 <para>This parameter lets you select which method to use for sorting and grouping
11459 index entries in an index.
11460 Indexes in Latin-based languages that have accented characters typically
11461 sort together accented words and unaccented words.
11462 Thus <quote>Á</quote> (U+00C1 LATIN CAPITAL LETTER A WITH ACUTE) would sort together
11463 with <quote>A</quote> (U+0041 LATIN CAPITAL LETTER A), so both would appear in the <quote>A</quote>
11464 section of the index.
11465 Languages using other alphabets (such as Russian, which is written in the Cyrillic alphabet)
11466 and languages using ideographic chararacters (such as Japanese)
11467 require grouping specific to the languages and alphabets.
11470 <para>The default indexing method is limited.
11471 It can group accented characters in Latin-based languages only.
11472 It cannot handle non-Latin alphabets or ideographic languages.
11473 The other indexing methods require extensions of one type or
11474 another, and do not work with
11475 all XSLT processors, which is why they are not used by default.</para>
11477 <para>The three choices for indexing method are:</para>
11480 <term><literal>basic</literal></term>
11483 (default) Sort and groups words based only on the Latin alphabet.
11484 Words with accented Latin letters will group and sort with
11485 their respective primary letter, but
11486 words in non-Latin alphabets will be
11487 put in the <quote>Symbols</quote> section of the index.
11492 <term><literal>kosek</literal></term>
11495 This method sorts and groups words based on letter groups configured in
11496 the DocBook locale file for the given language.
11497 See, for example, the French locale file <filename>common/fr.xml</filename>.
11498 This method requires that the XSLT processor
11499 supports the EXSLT extensions (most do).
11500 It also requires support for using
11501 user-defined functions in xsl:key (xsltproc does not).
11503 <para>This method is suitable for any language for which you can
11504 list all the individual characters that should appear
11505 in each letter group in an index.
11506 It is probably not practical to use it for ideographic languages
11507 such as Chinese that have hundreds or thousands of characters.
11510 <para>To use the kosek method, you must:</para>
11514 <para>Use a processor that supports its extensions, such as
11515 Saxon 6 or Xalan (xsltproc and Saxon 8 do not).
11519 <para>Set the index.method parameter's value to <quote>kosek</quote>.
11523 <para>Import the appropriate index extensions stylesheet module
11524 <filename>fo/autoidx-kosek.xsl</filename> or
11525 <filename>html/autoidx-kosek.xsl</filename> into your
11534 <term><literal>kimber</literal></term>
11537 This method uses extensions to the Saxon processor to implement
11538 sophisticated indexing processes. It uses its own
11539 configuration file, which can include information for any number of
11540 languages. Each language's configuration can group
11541 words using one of two processes. In the
11542 enumerated process similar to that used in the kosek method,
11543 you indicate the groupings character-by-character.
11544 In the between-key process, you specify the
11545 break-points in the sort order that should start a new group.
11546 The latter configuration is useful for ideographic languages
11547 such as Chinese, Japanese, and Korean.
11548 You can also define your own collation algorithms and how you
11549 want mixed Latin-alphabet words sorted.</para>
11552 <para>For a whitepaper describing the extensions, see:
11553 <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>.
11557 <para>To download the extension library, see
11558 <link xlink:href="http://www.innodata-isogen.com/knowledge_center/tools_downloads/i18nsupport">http://www.innodata-isogen.com/knowledge_center/tools_downloads/i18nsupport</link>.
11563 <para>To use the kimber method, you must:</para>
11567 <para>Use Saxon (version 6 or 8) as your XSLT processor.
11571 <para>Install and configure the Innodata Isogen library, using
11572 the documentation that comes with it.
11576 <para>Set the index.method parameter's value to <quote>kimber</quote>.
11580 <para>Import the appropriate index extensions stylesheet module
11581 <filename>fo/autoidx-kimber.xsl</filename> or
11582 <filename>html/autoidx-kimber.xsl</filename> into your
11595 <refentry version="5.0" id="index.on.type">
11597 <refentrytitle>index.on.type</refentrytitle>
11598 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
11601 <refname>index.on.type</refname>
11602 <refpurpose>Select indexterms based on <tag class="attribute">type</tag>
11603 attribute value</refpurpose>
11607 <programlisting id="index.on.type.frag">
11608 <xsl:param name="index.on.type" select="0"></xsl:param>
11612 <refsection><info><title>Description</title></info>
11616 then an <tag>index</tag> element that has a
11617 <tag class="attribute">type</tag> attribute
11618 value will contain only those <tag>indexterm</tag>
11619 elements with a matching <tag class="attribute">type</tag> attribute value.
11620 If an <tag>index</tag> has no <tag class="attribute">type</tag>
11621 attribute or it is blank, then the index will contain
11622 all <tag>indexterm</tag>s in the current scope.
11626 If <literal>index.on.type</literal> is zero, then the
11627 <tag class="attribute">type</tag> attribute has no effect
11628 on selecting indexterms for an index.
11631 <para>For those using DocBook version 4.2 or earlier,
11632 the <tag class="attribute">type</tag> attribute is not available
11633 for index terms. However, you can achieve the same
11634 effect by using the <tag class="attribute">role</tag> attribute
11635 in the same manner on <tag>indexterm</tag>
11636 and <tag>index</tag>, and setting the stylesheet parameter
11637 <parameter>index.on.role</parameter> to a nonzero value.
11643 <refentry version="5.0" id="index.on.role">
11645 <refentrytitle>index.on.role</refentrytitle>
11646 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
11649 <refname>index.on.role</refname>
11650 <refpurpose>Select indexterms based on <tag class="attribute">role</tag> value</refpurpose>
11654 <programlisting id="index.on.role.frag">
11655 <xsl:param name="index.on.role" select="0"></xsl:param>
11659 <refsection><info><title>Description</title></info>
11663 then an <tag>index</tag> element that has a
11664 <tag class="attribute">role</tag> attribute
11665 value will contain only those <tag>indexterm</tag>
11666 elements with a matching role value.
11667 If an <tag>index</tag> has no <tag class="attribute">role</tag>
11668 attribute or it is blank, then the index will contain
11669 all <tag>indexterm</tag>s in the current scope.
11672 If <literal>index.on.role</literal> is zero, then the
11673 <tag class="attribute">role</tag> attribute has no effect
11674 on selecting indexterms for an index.
11677 <para>If you are using DocBook version 4.3 or later, you should
11678 use the <tag class="attribute">type</tag> attribute instead of <tag class="attribute">role</tag>
11679 on <tag>indexterm</tag> and <tag>index</tag>,
11680 and set the <parameter>index.on.type</parameter> to a nonzero
11687 <refentry version="5.0" id="index.preferred.page.properties">
11689 <refentrytitle>index.preferred.page.properties</refentrytitle>
11690 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
11693 <refname>index.preferred.page.properties</refname>
11694 <refpurpose>Properties used to emphasize page number references for
11695 significant index terms</refpurpose>
11699 <programlisting id="index.preferred.page.properties.frag">
11700 <xsl:attribute-set name="index.preferred.page.properties">
11701 <xsl:attribute name="font-weight">bold</xsl:attribute>
11702 </xsl:attribute-set>
11706 <refsection><info><title>Description</title></info>
11708 <para>Properties used to emphasize page number references for
11709 significant index terms (<tag class="attribute">significance</tag>=<tag class="attvalue">preferred</tag>). Currently works only with
11715 <refentry version="5.0" id="index.entry.properties">
11717 <refentrytitle>index.entry.properties</refentrytitle>
11718 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
11721 <refname>index.entry.properties</refname>
11722 <refpurpose>Properties applied to the formatted entries
11723 in an index</refpurpose>
11727 <programlisting id="index.entry.properties.frag">
11728 <xsl:attribute-set name="index.entry.properties">
11729 <xsl:attribute name="start-indent">0pt</xsl:attribute>
11730 </xsl:attribute-set>
11734 <refsection><info><title>Description</title></info>
11736 <para>This attribute set is applied to the block containing
11737 the entries in a letter division in an index. It can be used to set the
11738 font-size, font-family, and other inheritable properties that will be
11739 applied to all index entries.</para>
11744 <refentry version="5.0" id="index.div.title.properties">
11746 <refentrytitle>index.div.title.properties</refentrytitle>
11747 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
11750 <refname>index.div.title.properties</refname>
11751 <refpurpose>Properties associated with the letter headings in an
11756 <programlisting id="index.div.title.properties.frag">
11757 <xsl:attribute-set name="index.div.title.properties">
11758 <xsl:attribute name="margin-{$direction.align.start}">0pt</xsl:attribute>
11759 <xsl:attribute name="font-size">14.4pt</xsl:attribute>
11760 <xsl:attribute name="font-family"><xsl:value-of select="$title.fontset"></xsl:value-of></xsl:attribute>
11761 <xsl:attribute name="font-weight">bold</xsl:attribute>
11762 <xsl:attribute name="keep-with-next.within-column">always</xsl:attribute>
11763 <xsl:attribute name="space-before.optimum"><xsl:value-of select="concat($body.font.master,'pt')"></xsl:value-of></xsl:attribute>
11764 <xsl:attribute name="space-before.minimum"><xsl:value-of select="concat($body.font.master,'pt * 0.8')"></xsl:value-of></xsl:attribute>
11765 <xsl:attribute name="space-before.maximum"><xsl:value-of select="concat($body.font.master,'pt * 1.2')"></xsl:value-of></xsl:attribute>
11766 <xsl:attribute name="start-indent">0pt</xsl:attribute>
11767 </xsl:attribute-set>
11771 <refsection><info><title>Description</title></info>
11773 <para>This attribute set is used on the letter headings that separate
11774 the divisions in an index.</para>
11779 <refentry version="5.0" id="index.number.separator">
11781 <refentrytitle>index.number.separator</refentrytitle>
11782 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
11785 <refname>index.number.separator</refname>
11786 <refpurpose>Override for punctuation separating page numbers in index</refpurpose>
11790 <programlisting id="index.number.separator.frag">
11791 <xsl:param name="index.number.separator"></xsl:param>
11795 <refsection><info><title>Description</title></info>
11797 <para>This parameter permits you to override the text to insert between
11798 page references in a formatted index entry. Typically
11799 that would be a comma and a space.
11802 <para>Because this text may be locale dependent,
11803 this parameter's value is normally taken from a gentext
11804 template named 'number-separator' in the
11805 context 'index' in the stylesheet
11806 locale file for the language
11807 of the current document.
11808 This parameter can be used to override the gentext string,
11809 and would typically be used on the command line.
11810 This parameter would apply to all languages.
11813 <para>So this text string can be customized in two ways.
11814 You can reset the default gentext string using
11815 the <parameter>local.l10n.xml</parameter> parameter, or you can
11816 override the gentext with the content of this parameter.
11817 The content can be a simple string, or it can be
11818 something more complex such as a call-template.
11821 <para>In HTML index output, section title references are used instead of
11822 page number references. This punctuation appears between
11823 such section titles in an HTML index.
11829 <refentry version="5.0" id="index.range.separator">
11831 <refentrytitle>index.range.separator</refentrytitle>
11832 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
11835 <refname>index.range.separator</refname>
11836 <refpurpose>Override for punctuation separating the two numbers
11837 in a page range in index</refpurpose>
11841 <programlisting id="index.range.separator.frag">
11842 <xsl:param name="index.range.separator"></xsl:param>
11846 <refsection><info><title>Description</title></info>
11848 <para>This parameter permits you
11849 to override the text to insert between
11850 the two numbers of a page range in an index.
11851 This parameter is only used by those XSL-FO processors
11852 that support an extension for generating such page ranges
11853 (such as XEP).</para>
11855 <para>Because this text may be locale dependent,
11856 this parameter's value is normally taken from a gentext
11857 template named 'range-separator' in the
11858 context 'index' in the stylesheet
11859 locale file for the language
11860 of the current document.
11861 This parameter can be used to override the gentext string,
11862 and would typically be used on the command line.
11863 This parameter would apply to all languages.
11866 <para>So this text string can be customized in two ways.
11867 You can reset the default gentext string using
11868 the <parameter>local.l10n.xml</parameter> parameter, or you can
11869 override the gentext with the content of this parameter.
11870 The content can be a simple string, or it can be
11871 something more complex such as a call-template.
11874 <para>In HTML index output, section title references are used instead of
11875 page number references. So there are no page ranges
11876 and this parameter has no effect.
11882 <refentry version="5.0" id="index.term.separator">
11884 <refentrytitle>index.term.separator</refentrytitle>
11885 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
11888 <refname>index.term.separator</refname>
11889 <refpurpose>Override for punctuation separating an index term
11890 from its list of page references in an index</refpurpose>
11894 <programlisting id="index.term.separator.frag">
11895 <xsl:param name="index.term.separator"></xsl:param>
11899 <refsection><info><title>Description</title></info>
11901 <para>This parameter permits you to override
11902 the text to insert between
11903 the end of an index term and its list of page references.
11904 Typically that might be a comma and a space.
11907 <para>Because this text may be locale dependent,
11908 this parameter's value is normally taken from a gentext
11909 template named 'term-separator' in the
11910 context 'index' in the stylesheet
11911 locale file for the language
11912 of the current document.
11913 This parameter can be used to override the gentext string,
11914 and would typically be used on the command line.
11915 This parameter would apply to all languages.
11918 <para>So this text string can be customized in two ways.
11919 You can reset the default gentext string using
11920 the <parameter>local.l10n.xml</parameter> parameter, or you can
11921 fill in the content for this normally empty
11922 override parameter.
11923 The content can be a simple string, or it can be
11924 something more complex such as a call-template.
11925 For fo output, it could be an <tag>fo:leader</tag>
11926 element to provide space of a specific length, or a dot leader.
11932 <refentry version="5.0" id="xep.index.item.properties">
11934 <refentrytitle>xep.index.item.properties</refentrytitle>
11935 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
11938 <refname>xep.index.item.properties</refname>
11939 <refpurpose>Properties associated with XEP index-items</refpurpose>
11943 <programlisting id="xep.index.item.properties.frag">
11944 <xsl:attribute-set name="xep.index.item.properties" use-attribute-sets="index.page.number.properties">
11945 <xsl:attribute name="merge-subsequent-page-numbers">true</xsl:attribute>
11946 <xsl:attribute name="link-back">true</xsl:attribute>
11947 </xsl:attribute-set>
11951 <refsection><info><title>Description</title></info>
11953 <para>Properties associated with XEP index-items, which generate
11954 page numbers in an index processed by XEP. For more info see
11955 the XEP documentation section "Indexes" in
11956 <uri xlink:href="http://www.renderx.com/reference.html#Indexes">http://www.renderx.com/reference.html#Indexes</uri>.</para>
11958 <para>This attribute-set also adds by default any properties from the
11959 <tag class="attribute">index.page.number.properties</tag>
11960 attribute-set.</para>
11964 <refentry version="5.0" id="toc.section.depth">
11966 <refentrytitle>toc.section.depth</refentrytitle>
11967 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
11970 <refname>toc.section.depth</refname>
11971 <refpurpose>How deep should recursive <tag>section</tag>s appear
11972 in the TOC?</refpurpose>
11976 <programlisting id="toc.section.depth.frag"><xsl:param name="toc.section.depth">2</xsl:param></programlisting>
11979 <refsection><info><title>Description</title></info>
11981 <para>Specifies the depth to which recursive sections should appear in the
11988 <refentry version="5.0" id="toc.max.depth">
11990 <refentrytitle>toc.max.depth</refentrytitle>
11991 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
11994 <refname>toc.max.depth</refname>
11995 <refpurpose>How many levels should be created for each TOC?</refpurpose>
11999 <programlisting id="toc.max.depth.frag"><xsl:param name="toc.max.depth">8</xsl:param></programlisting>
12002 <refsection><info><title>Description</title></info>
12004 <para>Specifies the maximal depth of TOC on all levels.</para>
12009 <refentry version="5.0" id="toc.indent.width">
12011 <refentrytitle>toc.indent.width</refentrytitle>
12012 <refmiscinfo class="other" otherclass="datatype">float</refmiscinfo>
12015 <refname>toc.indent.width</refname>
12016 <refpurpose>Amount of indentation for TOC entries</refpurpose>
12020 <programlisting id="toc.indent.width.frag">
12021 <xsl:param name="toc.indent.width">24</xsl:param>
12022 <!-- inconsistant point specification? -->
12026 <refsection><info><title>Description</title></info>
12028 <para>Specifies, in points, the distance by which each level of the
12029 TOC is indented from its parent.</para>
12031 <para>This value is expressed in points, without
12032 a unit (in other words, it is a bare number). Using a bare number allows the stylesheet
12033 to perform calculations that would otherwise have to be performed by the FO processor
12034 because not all processors support expressions.</para>
12039 <refentry version="5.0" id="toc.line.properties">
12041 <refentrytitle>toc.line.properties</refentrytitle>
12042 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
12045 <refname>toc.line.properties</refname>
12046 <refpurpose>Properties for lines in ToCs and LoTs</refpurpose>
12050 <programlisting id="toc.line.properties.frag">
12051 <xsl:attribute-set name="toc.line.properties">
12052 <xsl:attribute name="text-align-last">justify</xsl:attribute>
12053 <xsl:attribute name="text-align">start</xsl:attribute>
12054 <xsl:attribute name="end-indent"><xsl:value-of select="concat($toc.indent.width, 'pt')"></xsl:value-of></xsl:attribute>
12055 <xsl:attribute name="last-line-end-indent"><xsl:value-of select="concat('-', $toc.indent.width, 'pt')"></xsl:value-of></xsl:attribute>
12056 </xsl:attribute-set>
12060 <refsection><info><title>Description</title></info>
12062 <para>Properties which are applied to every line in ToC (or LoT). You can
12063 modify them in order to change appearance of all, or some lines. For
12064 example, in order to make lines for chapters bold, specify the
12065 following in your customization layer:</para>
12067 <programlisting><xsl:attribute-set name="toc.line.properties">
12068 <xsl:attribute name="font-weight">
12070 <xsl:when test="self::chapter">bold</xsl:when>
12071 <xsl:otherwise>normal</xsl:otherwise>
12072 </xsl:choose>
12073 </xsl:attribute>
12074 </xsl:attribute-set></programlisting>
12079 <refentry version="5.0" id="toc.margin.properties">
12081 <refentrytitle>toc.margin.properties</refentrytitle>
12082 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
12085 <refname>toc.margin.properties</refname>
12086 <refpurpose>Margin properties used on Tables of Contents</refpurpose>
12090 <programlisting id="toc.margin.properties.frag">
12091 <xsl:attribute-set name="toc.margin.properties">
12092 <xsl:attribute name="space-before.minimum">0.5em</xsl:attribute>
12093 <xsl:attribute name="space-before.optimum">1em</xsl:attribute>
12094 <xsl:attribute name="space-before.maximum">2em</xsl:attribute>
12095 <xsl:attribute name="space-after.minimum">0.5em</xsl:attribute>
12096 <xsl:attribute name="space-after.optimum">1em</xsl:attribute>
12097 <xsl:attribute name="space-after.maximum">2em</xsl:attribute>
12098 </xsl:attribute-set>
12102 <refsection><info><title>Description</title></info>
12103 <para>This attribute set is used on Tables of Contents. These attributes are set
12104 on the wrapper that surrounds the ToC block, not on each individual lines.</para>
12108 <refentry version="5.0" id="bridgehead.in.toc">
12110 <refentrytitle>bridgehead.in.toc</refentrytitle>
12111 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
12114 <refname>bridgehead.in.toc</refname>
12115 <refpurpose>Should bridgehead elements appear in the TOC?</refpurpose>
12119 <programlisting id="bridgehead.in.toc.frag"><xsl:param name="bridgehead.in.toc" select="0"></xsl:param></programlisting>
12122 <refsection><info><title>Description</title></info>
12124 <para>If non-zero, <tag>bridgehead</tag>s appear in the TOC. Note that
12125 this option is not fully supported and may be removed in a future
12126 version of the stylesheets.
12132 <refentry version="5.0" id="simplesect.in.toc">
12134 <refentrytitle>simplesect.in.toc</refentrytitle>
12135 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
12138 <refname>simplesect.in.toc</refname>
12139 <refpurpose>Should <tag>simplesect</tag> elements appear in the TOC?</refpurpose>
12143 <programlisting id="simplesect.in.toc.frag"><xsl:param name="simplesect.in.toc" select="0"></xsl:param></programlisting>
12146 <refsection><info><title>Description</title></info>
12148 <para>If non-zero, <tag>simplesect</tag>s will be included in the TOC.
12154 <refentry version="5.0" id="generate.section.toc.level">
12156 <refentrytitle>generate.section.toc.level</refentrytitle>
12157 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
12160 <refname>generate.section.toc.level</refname>
12161 <refpurpose>Control depth of TOC generation in sections</refpurpose>
12165 <programlisting id="generate.section.toc.level.frag">
12166 <xsl:param name="generate.section.toc.level" select="0"></xsl:param>
12170 <refsection><info><title>Description</title></info>
12172 <para>The <parameter>generate.section.toc.level</parameter> parameter
12173 controls the depth of <tag>section</tag> in which TOCs will be generated. Note
12174 that this is related to, but not the same as
12175 <parameter>toc.section.depth</parameter>, which controls the depth to
12176 which TOC entries will be generated in a given TOC.</para>
12177 <para>If, for example, <parameter>generate.section.toc.level</parameter>
12178 is <literal>3</literal>, TOCs will be generated in first, second, and third
12179 level sections, but not in fourth level sections.
12188 </reference><reference id="fo_ext" xml:base="../fo/param.xml"><title>Processor Extensions</title>
12189 <refentry version="5.0" id="arbortext.extensions">
12191 <refentrytitle>arbortext.extensions</refentrytitle>
12192 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
12195 <refname>arbortext.extensions</refname>
12196 <refpurpose>Enable Arbortext extensions?</refpurpose>
12200 <programlisting id="arbortext.extensions.frag"><xsl:param name="arbortext.extensions" select="0"></xsl:param></programlisting>
12203 <refsection><info><title>Description</title></info>
12206 <link xlink:href="http://www.arbortext.com/">Arbortext</link>
12207 extensions will be used.
12209 <para>This parameter can also affect which graphics file formats
12210 are supported</para>
12215 <refentry version="5.0" id="axf.extensions">
12217 <refentrytitle>axf.extensions</refentrytitle>
12218 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
12221 <refname>axf.extensions</refname>
12222 <refpurpose>Enable XSL Formatter extensions?</refpurpose>
12226 <programlisting id="axf.extensions.frag">
12227 <xsl:param name="axf.extensions" select="0"></xsl:param>
12231 <refsection><info><title>Description</title></info>
12234 <link xlink:href="http://www.antennahouse.com/">XSL Formatter</link>
12235 extensions will be used. XSL Formatter extensions consists of PDF bookmarks,
12236 document information and better index processing.</para>
12238 <para>This parameter can also affect which graphics file formats
12239 are supported</para>
12244 <refentry version="5.0" id="fop.extensions">
12246 <refentrytitle>fop.extensions</refentrytitle>
12247 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
12250 <refname>fop.extensions</refname>
12251 <refpurpose>Enable extensions for FOP version 0.20.5 and earlier</refpurpose>
12255 <programlisting id="fop.extensions.frag"><xsl:param name="fop.extensions" select="0"></xsl:param></programlisting>
12258 <refsection><info><title>Description</title></info>
12260 <para>If non-zero, extensions intended for
12261 <link xlink:href="http://xml.apache.org/fop/">FOP</link>
12262 version 0.20.5 and earlier will be used.
12263 At present, this consists of PDF bookmarks.
12266 <para>This parameter can also affect which graphics file formats
12267 are supported.</para>
12269 <para>If you are using a version of FOP beyond
12270 version 0.20.5, then use the <parameter>fop1.extensions</parameter> parameter
12276 <refentry version="5.0" id="fop1.extensions">
12278 <refentrytitle>fop1.extensions</refentrytitle>
12279 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
12282 <refname>fop1.extensions</refname>
12283 <refpurpose>Enable extensions for FOP version 0.90 and later</refpurpose>
12287 <programlisting id="fop1.extensions.frag"><xsl:param name="fop1.extensions" select="0"></xsl:param></programlisting>
12290 <refsection><info><title>Description</title></info>
12292 <para>If non-zero, extensions for
12293 <link xlink:href="http://xml.apache.org/fop/">FOP</link>
12294 version 0.90 and later will be used.
12297 <para>This parameter can also affect which graphics file formats
12298 are supported.</para>
12300 <para>The original <parameter>fop.extensions</parameter> parameter
12301 should still be used for FOP version 0.20.5 and earlier.
12306 <refentry version="5.0" id="passivetex.extensions">
12308 <refentrytitle>passivetex.extensions</refentrytitle>
12309 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
12312 <refname>passivetex.extensions</refname>
12313 <refpurpose>Enable PassiveTeX extensions?</refpurpose>
12317 <programlisting id="passivetex.extensions.frag"><xsl:param name="passivetex.extensions" select="0"></xsl:param></programlisting>
12320 <refsection><info><title>Description</title></info>
12323 <link xlink:href="http://www.tei-c.org.uk/Software/passivetex/">PassiveTeX</link>
12324 extensions will be used. At present, this consists of PDF bookmarks
12325 and sorted index terms.
12328 <para>This parameter can also affect which graphics file formats
12329 are supported</para>
12332 <para>PassiveTeX is incomplete and development has ceased. In most cases,
12333 another XSL-FO engine is probably a better choice.</para>
12339 <refentry version="5.0" id="tex.math.in.alt">
12341 <refentrytitle>tex.math.in.alt</refentrytitle>
12342 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
12343 <refmiscinfo class="other" otherclass="value">plain</refmiscinfo>
12344 <refmiscinfo class="other" otherclass="value">latex</refmiscinfo>
12347 <refname>tex.math.in.alt</refname>
12348 <refpurpose>TeX notation used for equations</refpurpose>
12352 <programlisting id="tex.math.in.alt.frag">
12353 <xsl:param name="tex.math.in.alt"></xsl:param>
12357 <refsection><info><title>Description</title></info>
12359 <para>If you want type math directly in TeX notation in equations,
12360 this parameter specifies notation used. Currently are supported two
12361 values -- <literal>plain</literal> and <literal>latex</literal>. Empty
12362 value means that you are not using TeX math at all.</para>
12364 <para>Preferred way for including TeX alternative of math is inside of
12365 <tag>textobject</tag> element. Eg.:</para>
12367 <programlisting><inlineequation>
12368 <inlinemediaobject>
12369 <imageobject>
12370 <imagedata fileref="eq1.gif"/>
12371 </imageobject>
12372 <textobject><phrase>E=mc squared</phrase></textobject>
12373 <textobject role="tex"><phrase>E=mc^2</phrase></textobject>
12374 </inlinemediaobject>
12375 </inlineequation></programlisting>
12377 <para>If you are using <tag>graphic</tag> element, you can
12378 store TeX inside <tag>alt</tag> element:</para>
12380 <programlisting><inlineequation>
12381 <alt role="tex">a^2+b^2=c^2</alt>
12382 <graphic fileref="a2b2c2.gif"/>
12383 </inlineequation></programlisting>
12385 <para>If you want use this feature, you should process your FO with
12386 PassiveTeX, which only supports TeX math notation. When calling
12387 stylsheet, don't forget to specify also
12388 passivetex.extensions=1.</para>
12390 <para>If you want equations in HTML, just process generated file
12391 <filename>tex-math-equations.tex</filename> by TeX or LaTeX. Then run
12392 dvi2bitmap program on result DVI file. You will get images for
12393 equations in your document.</para>
12396 <para>This feature is useful for print/PDF output only if you
12397 use the obsolete and now unsupported PassiveTeX XSL-FO
12403 <refsection><info><title>Related Parameters</title></info>
12404 <para><parameter>tex.math.delims</parameter>,
12405 <parameter>passivetex.extensions</parameter>,
12406 <parameter>tex.math.file</parameter></para>
12411 <refentry version="5.0" id="tex.math.delims">
12413 <refentrytitle>tex.math.delims</refentrytitle>
12414 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
12417 <refname>tex.math.delims</refname>
12418 <refpurpose>Should equations output for processing by TeX be
12419 surrounded by math mode delimiters?</refpurpose>
12423 <programlisting id="tex.math.delims.frag">
12424 <xsl:param name="tex.math.delims" select="1"></xsl:param>
12428 <refsection><info><title>Description</title></info>
12430 <para>For compatibility with DSSSL based DBTeXMath from Allin Cottrell
12431 you should set this parameter to 0.</para>
12434 <para>This feature is useful for print/PDF output only if you
12435 use the obsolete and now unsupported PassiveTeX XSL-FO
12440 <refsection><info><title>Related Parameters</title></info>
12441 <para><parameter>tex.math.in.alt</parameter>,
12442 <parameter>passivetex.extensions</parameter></para>
12445 <refsection><info><title>See Also</title></info>
12446 <para>You can also use the <tag class="xmlpi">dbtex delims</tag> processing
12447 instruction to control whether delimiters are output.</para>
12453 <refentry version="5.0" id="xep.extensions">
12455 <refentrytitle>xep.extensions</refentrytitle>
12456 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
12459 <refname>xep.extensions</refname>
12460 <refpurpose>Enable XEP extensions?</refpurpose>
12464 <programlisting id="xep.extensions.frag"><xsl:param name="xep.extensions" select="0"></xsl:param></programlisting>
12467 <refsection><info><title>Description</title></info>
12470 <link xlink:href="http://www.renderx.com/">XEP</link>
12471 extensions will be used. XEP extensions consists of PDF bookmarks,
12472 document information and better index processing.
12475 <para>This parameter can also affect which graphics file formats
12476 are supported</para>
12480 </reference><reference id="dbk_ext" xml:base="../fo/param.xml"><title>Stylesheet Extensions</title>
12481 <refentry version="5.0" id="linenumbering.everyNth">
12483 <refentrytitle>linenumbering.everyNth</refentrytitle>
12484 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
12487 <refname>linenumbering.everyNth</refname>
12488 <refpurpose>Indicate which lines should be numbered</refpurpose>
12492 <programlisting id="linenumbering.everyNth.frag">
12493 <xsl:param name="linenumbering.everyNth">5</xsl:param>
12497 <refsection><info><title>Description</title></info>
12499 <para>If line numbering is enabled, everyNth line will be
12500 numbered. Note that numbering is one based, not zero based.
12506 <refentry version="5.0" id="linenumbering.extension">
12508 <refentrytitle>linenumbering.extension</refentrytitle>
12509 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
12512 <refname>linenumbering.extension</refname>
12513 <refpurpose>Enable the line numbering extension</refpurpose>
12517 <programlisting id="linenumbering.extension.frag">
12518 <xsl:param name="linenumbering.extension" select="1"></xsl:param>
12522 <refsection><info><title>Description</title></info>
12524 <para>If non-zero, verbatim environments (<tag>address</tag>, <tag>literallayout</tag>,
12525 <tag>programlisting</tag>, <tag>screen</tag>, <tag>synopsis</tag>) that specify line numbering will
12532 <refentry version="5.0" id="linenumbering.separator">
12534 <refentrytitle>linenumbering.separator</refentrytitle>
12535 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
12538 <refname>linenumbering.separator</refname>
12539 <refpurpose>Specify a separator between line numbers and lines</refpurpose>
12543 <programlisting id="linenumbering.separator.frag">
12544 <xsl:param name="linenumbering.separator"><xsl:text> </xsl:text></xsl:param>
12548 <refsection><info><title>Description</title></info>
12550 <para>The separator is inserted between line numbers and lines in the
12551 verbatim environment. The default value is a single white space.
12552 Note the interaction with <parameter>linenumbering.width</parameter>
12558 <refentry version="5.0" id="linenumbering.width">
12560 <refentrytitle>linenumbering.width</refentrytitle>
12561 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
12564 <refname>linenumbering.width</refname>
12565 <refpurpose>Indicates the width of line numbers</refpurpose>
12569 <programlisting id="linenumbering.width.frag">
12570 <xsl:param name="linenumbering.width">3</xsl:param>
12574 <refsection><info><title>Description</title></info>
12576 <para>If line numbering is enabled, line numbers will appear right
12577 justified in a field "width" characters wide.
12583 <refentry version="5.0" id="tablecolumns.extension">
12585 <refentrytitle>tablecolumns.extension</refentrytitle>
12586 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
12589 <refname>tablecolumns.extension</refname>
12590 <refpurpose>Enable the table columns extension function</refpurpose>
12594 <programlisting id="tablecolumns.extension.frag">
12595 <xsl:param name="tablecolumns.extension" select="1"></xsl:param>
12599 <refsection><info><title>Description</title></info>
12601 <para>The table columns extension function adjusts the widths of table
12602 columns in the HTML result to more accurately reflect the specifications
12609 <refentry version="5.0" id="textinsert.extension">
12611 <refentrytitle>textinsert.extension</refentrytitle>
12612 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
12615 <refname>textinsert.extension</refname>
12616 <refpurpose>Enables the textinsert extension element</refpurpose>
12619 <programlisting id="textinsert.extension.frag">
12620 <xsl:param name="textinsert.extension" select="1"></xsl:param>
12623 <refsection><info><title>Description</title></info>
12624 <para>The textinsert extension element inserts the contents of
12625 a file into the result tree (as text).</para>
12627 <para>To use the textinsert extension element, you must use
12628 either Saxon or Xalan as your XSLT processor (it doesn’t
12629 work with xsltproc), along with either the DocBook Saxon
12630 extensions or DocBook Xalan extensions (for more
12631 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
12632 the <parameter>use.extensions</parameter> and
12633 <parameter>textinsert.extension</parameter> parameters to
12634 <literal>1</literal>.</para>
12635 <para>As an alternative to using the textinsert element,
12636 consider using an Xinclude element with the
12637 <literal>parse="text"</literal> attribute and value
12638 specified, as detailed in <link role="tcg" xlink:href="ExternalCode.html#XIncludeCode">Using XInclude for text inclusions</link>.</para>
12641 <refsection><info><title>See Also</title></info>
12642 <para>You can also use the <tag class="xmlpi">dbhtml-include href</tag> processing
12643 instruction to insert external files — both files containing
12644 plain text and files with markup content (including HTML
12647 <refsection><info><title>More information</title></info>
12648 <para>For how-to documentation on inserting contents of
12649 external code files and other text files into output, see
12650 <link role="tcg" xlink:href="ExternalCode.html">External code files</link>.</para>
12651 <para>For guidelines on inserting contents of
12652 HTML files into output, see <link role="tcg" xlink:href="InsertExtHtml.html">Inserting external HTML code</link>.</para>
12656 <refentry version="5.0" id="textdata.default.encoding">
12658 <refentrytitle>textdata.default.encoding</refentrytitle>
12659 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
12662 <refname>textdata.default.encoding</refname>
12663 <refpurpose>Default encoding of external text files which are included
12664 using textdata element</refpurpose>
12668 <programlisting id="textdata.default.encoding.frag">
12669 <xsl:param name="textdata.default.encoding"></xsl:param>
12673 <refsection><info><title>Description</title></info>
12675 <para>Specifies the encoding of any external text files included using
12676 <tag>textdata</tag> element. This value is used only when you do
12677 not specify encoding by the appropriate attribute
12678 directly on textdata. An empty string is interpreted as the system
12679 default encoding.</para>
12684 <refentry version="5.0" id="use.extensions">
12686 <refentrytitle>use.extensions</refentrytitle>
12687 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
12690 <refname>use.extensions</refname>
12691 <refpurpose>Enable extensions</refpurpose>
12695 <programlisting id="use.extensions.frag">
12696 <xsl:param name="use.extensions" select="0"></xsl:param>
12700 <refsection><info><title>Description</title></info>
12702 <para>If non-zero, extensions may be used. Each extension is
12703 further controlled by its own parameter. But if
12704 <parameter>use.extensions</parameter> is zero, no extensions will
12711 </reference><reference id="labels" xml:base="../fo/param.xml"><title>Automatic labelling</title>
12712 <refentry version="5.0" id="appendix.autolabel">
12714 <refentrytitle>appendix.autolabel</refentrytitle>
12715 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
12716 <refmiscinfo class="other" otherclass="value">0<alt>none</alt></refmiscinfo>
12717 <refmiscinfo class="other" otherclass="value">1<alt>1,2,3...</alt></refmiscinfo>
12718 <refmiscinfo class="other" otherclass="value">A<alt>A,B,C...</alt></refmiscinfo>
12719 <refmiscinfo class="other" otherclass="value">a<alt>a,b,c...</alt></refmiscinfo>
12720 <refmiscinfo class="other" otherclass="value">i<alt>i,ii,iii...</alt></refmiscinfo>
12721 <refmiscinfo class="other" otherclass="value">I<alt>I,II,III...</alt></refmiscinfo>
12724 <refname>appendix.autolabel</refname>
12725 <refpurpose>Specifies the labeling format for Appendix titles</refpurpose>
12729 <programlisting id="appendix.autolabel.frag">
12730 <xsl:param name="appendix.autolabel">A</xsl:param>
12734 <refsection><info><title>Description</title></info>
12736 <para>If non-zero, then appendices will be numbered using the
12737 parameter value as the number format if the value matches one of the
12743 <term>1 or arabic</term>
12745 <para>Arabic numeration (1, 2, 3 ...).</para>
12749 <term>A or upperalpha</term>
12751 <para>Uppercase letter numeration (A, B, C ...).</para>
12755 <term>a or loweralpha</term>
12757 <para>Lowercase letter numeration (a, b, c ...).</para>
12761 <term>I or upperroman</term>
12763 <para>Uppercase roman numeration (I, II, III ...).</para>
12767 <term>i or lowerroman</term>
12769 <para>Lowercase roman letter numeration (i, ii, iii ...).</para>
12774 <para>Any nonzero value other than the above will generate
12775 the default number format (upperalpha).
12781 <refentry version="5.0" id="chapter.autolabel">
12783 <refentrytitle>chapter.autolabel</refentrytitle>
12784 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
12785 <refmiscinfo class="other" otherclass="value">0<alt>none</alt></refmiscinfo>
12786 <refmiscinfo class="other" otherclass="value">1<alt>1,2,3...</alt></refmiscinfo>
12787 <refmiscinfo class="other" otherclass="value">A<alt>A,B,C...</alt></refmiscinfo>
12788 <refmiscinfo class="other" otherclass="value">a<alt>a,b,c...</alt></refmiscinfo>
12789 <refmiscinfo class="other" otherclass="value">i<alt>i,ii,iii...</alt></refmiscinfo>
12790 <refmiscinfo class="other" otherclass="value">I<alt>I,II,III...</alt></refmiscinfo>
12793 <refname>chapter.autolabel</refname>
12794 <refpurpose>Specifies the labeling format for Chapter titles</refpurpose>
12798 <programlisting id="chapter.autolabel.frag">
12799 <xsl:param name="chapter.autolabel" select="1"></xsl:param></programlisting>
12802 <refsection><info><title>Description</title></info>
12804 <para>If non-zero, then chapters will be numbered using the parameter
12805 value as the number format if the value matches one of the following:
12810 <term>1 or arabic</term>
12812 <para>Arabic numeration (1, 2, 3 ...).</para>
12816 <term>A or upperalpha</term>
12818 <para>Uppercase letter numeration (A, B, C ...).</para>
12822 <term>a or loweralpha</term>
12824 <para>Lowercase letter numeration (a, b, c ...).</para>
12828 <term>I or upperroman</term>
12830 <para>Uppercase roman numeration (I, II, III ...).</para>
12834 <term>i or lowerroman</term>
12836 <para>Lowercase roman letter numeration (i, ii, iii ...).</para>
12841 <para>Any nonzero value other than the above will generate
12842 the default number format (arabic).
12848 <refentry version="5.0" id="part.autolabel">
12850 <refentrytitle>part.autolabel</refentrytitle>
12851 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
12852 <refmiscinfo class="other" otherclass="value">0<alt>none</alt></refmiscinfo>
12853 <refmiscinfo class="other" otherclass="value">1<alt>1,2,3...</alt></refmiscinfo>
12854 <refmiscinfo class="other" otherclass="value">A<alt>A,B,C...</alt></refmiscinfo>
12855 <refmiscinfo class="other" otherclass="value">a<alt>a,b,c...</alt></refmiscinfo>
12856 <refmiscinfo class="other" otherclass="value">i<alt>i,ii,iii...</alt></refmiscinfo>
12857 <refmiscinfo class="other" otherclass="value">I<alt>I,II,III...</alt></refmiscinfo>
12860 <refname>part.autolabel</refname>
12861 <refpurpose>Specifies the labeling format for Part titles</refpurpose>
12865 <programlisting id="part.autolabel.frag">
12866 <xsl:param name="part.autolabel">I</xsl:param>
12870 <refsection><info><title>Description</title></info>
12872 <para>If non-zero, then parts will be numbered using the parameter
12873 value as the number format if the value matches one of the following:
12878 <term>1 or arabic</term>
12880 <para>Arabic numeration (1, 2, 3 ...).</para>
12884 <term>A or upperalpha</term>
12886 <para>Uppercase letter numeration (A, B, C ...).</para>
12890 <term>a or loweralpha</term>
12892 <para>Lowercase letter numeration (a, b, c ...).</para>
12896 <term>I or upperroman</term>
12898 <para>Uppercase roman numeration (I, II, III ...).</para>
12902 <term>i or lowerroman</term>
12904 <para>Lowercase roman letter numeration (i, ii, iii ...).</para>
12909 <para>Any nonzero value other than the above will generate
12910 the default number format (upperroman).
12917 <refentry version="5.0" id="reference.autolabel">
12919 <refentrytitle>reference.autolabel</refentrytitle>
12920 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
12921 <refmiscinfo class="other" otherclass="value">0<alt>none</alt></refmiscinfo>
12922 <refmiscinfo class="other" otherclass="value">1<alt>1,2,3...</alt></refmiscinfo>
12923 <refmiscinfo class="other" otherclass="value">A<alt>A,B,C...</alt></refmiscinfo>
12924 <refmiscinfo class="other" otherclass="value">a<alt>a,b,c...</alt></refmiscinfo>
12925 <refmiscinfo class="other" otherclass="value">i<alt>i,ii,iii...</alt></refmiscinfo>
12926 <refmiscinfo class="other" otherclass="value">I<alt>I,II,III...</alt></refmiscinfo>
12929 <refname>reference.autolabel</refname>
12930 <refpurpose>Specifies the labeling format for Reference titles</refpurpose>
12933 <programlisting id="reference.autolabel.frag">
12934 <xsl:param name="reference.autolabel">I</xsl:param>
12937 <refsection><info><title>Description</title></info>
12938 <para>If non-zero, references will be numbered using the parameter
12939 value as the number format if the value matches one of the
12944 <term>1 or arabic</term>
12946 <para>Arabic numeration (1, 2, 3 ...).</para>
12950 <term>A or upperalpha</term>
12952 <para>Uppercase letter numeration (A, B, C ...).</para>
12956 <term>a or loweralpha</term>
12958 <para>Lowercase letter numeration (a, b, c ...).</para>
12962 <term>I or upperroman</term>
12964 <para>Uppercase roman numeration (I, II, III ...).</para>
12968 <term>i or lowerroman</term>
12970 <para>Lowercase roman letter numeration (i, ii, iii ...).</para>
12974 <para>Any non-zero value other than the above will generate
12975 the default number format (upperroman).
12980 <refentry version="5.0" id="preface.autolabel">
12982 <refentrytitle>preface.autolabel</refentrytitle>
12983 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
12984 <refmiscinfo class="other" otherclass="value">0<alt>none</alt></refmiscinfo>
12985 <refmiscinfo class="other" otherclass="value">1<alt>1,2,3...</alt></refmiscinfo>
12986 <refmiscinfo class="other" otherclass="value">A<alt>A,B,C...</alt></refmiscinfo>
12987 <refmiscinfo class="other" otherclass="value">a<alt>a,b,c...</alt></refmiscinfo>
12988 <refmiscinfo class="other" otherclass="value">i<alt>i,ii,iii...</alt></refmiscinfo>
12989 <refmiscinfo class="other" otherclass="value">I<alt>I,II,III...</alt></refmiscinfo>
12992 <refname>preface.autolabel</refname>
12993 <refpurpose>Specifices the labeling format for Preface titles</refpurpose>
12997 <programlisting id="preface.autolabel.frag"><xsl:param name="preface.autolabel" select="0"></xsl:param></programlisting>
13000 <refsection><info><title>Description</title></info>
13002 <para>If non-zero then prefaces will be numbered using the parameter
13003 value as the number format if the value matches one of the following:
13008 <term>1 or arabic</term>
13010 <para>Arabic numeration (1, 2, 3 ...).</para>
13014 <term>A or upperalpha</term>
13016 <para>Uppercase letter numeration (A, B, C ...).</para>
13020 <term>a or loweralpha</term>
13022 <para>Lowercase letter numeration (a, b, c ...).</para>
13026 <term>I or upperroman</term>
13028 <para>Uppercase roman numeration (I, II, III ...).</para>
13032 <term>i or lowerroman</term>
13034 <para>Lowercase roman letter numeration (i, ii, iii ...).</para>
13039 <para>Any nonzero value other than the above will generate
13040 the default number format (arabic).
13047 <refentry version="5.0" id="section.autolabel">
13049 <refentrytitle>section.autolabel</refentrytitle>
13050 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
13053 <refname>section.autolabel</refname>
13054 <refpurpose>Are sections enumerated?</refpurpose>
13058 <programlisting id="section.autolabel.frag"><xsl:param name="section.autolabel" select="0"></xsl:param></programlisting>
13061 <refsection><info><title>Description</title></info>
13063 <para>If true (non-zero), unlabeled sections will be enumerated.
13069 <refentry version="5.0" id="section.autolabel.max.depth">
13071 <refentrytitle>section.autolabel.max.depth</refentrytitle>
13072 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
13075 <refname>section.autolabel.max.depth</refname>
13076 <refpurpose>The deepest level of sections that are numbered.</refpurpose>
13080 <programlisting id="section.autolabel.max.depth.frag">
13081 <xsl:param name="section.autolabel.max.depth">8</xsl:param>
13085 <refsection><info><title>Description</title></info>
13087 <para>When section numbering is turned on by the
13088 <parameter>section.autolabel</parameter> parameter, then this
13089 parameter controls the depth of <tag>section</tag> nesting that is
13090 numbered. Sections nested to a level deeper than this value will not
13097 <refentry version="5.0" id="section.label.includes.component.label">
13099 <refentrytitle>section.label.includes.component.label</refentrytitle>
13100 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
13103 <refname>section.label.includes.component.label</refname>
13104 <refpurpose>Do section labels include the component label?</refpurpose>
13108 <programlisting id="section.label.includes.component.label.frag"><xsl:param name="section.label.includes.component.label" select="0"></xsl:param></programlisting>
13111 <refsection><info><title>Description</title></info>
13113 <para>If non-zero, section labels are prefixed with the label of the
13114 component that contains them.
13120 <refentry version="5.0" id="label.from.part">
13122 <refentrytitle>label.from.part</refentrytitle>
13123 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
13126 <refname>label.from.part</refname>
13127 <refpurpose>Renumber components in each part?</refpurpose>
13131 <programlisting id="label.from.part.frag">
13132 <xsl:param name="label.from.part" select="0"></xsl:param>
13136 <refsection><info><title>Description</title></info>
13138 <para>If <parameter>label.from.part</parameter> is non-zero, then
13139 numbering of components — <tag>preface</tag>,
13140 <tag>chapter</tag>, <tag>appendix</tag>, and
13141 <tag>reference</tag> (when <tag>reference</tag> occurs at the
13142 component level) — is re-started within each
13143 <tag>part</tag>.</para>
13144 <para>If <parameter>label.from.part</parameter> is zero (the
13145 default), numbering of components is <emphasis>not</emphasis>
13146 re-started within each <tag>part</tag>; instead, components are
13147 numbered sequentially throughout each <tag>book</tag>,
13148 regardless of whether or not they occur within <tag>part</tag>
13154 <refentry version="5.0" id="component.label.includes.part.label">
13156 <refentrytitle>component.label.includes.part.label</refentrytitle>
13157 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
13160 <refname>component.label.includes.part.label</refname>
13161 <refpurpose>Do component labels include the part label?</refpurpose>
13165 <programlisting id="component.label.includes.part.label.frag"><xsl:param name="component.label.includes.part.label" select="0"></xsl:param></programlisting>
13168 <refsection><info><title>Description</title></info>
13170 <para>If non-zero, number labels for <tag>chapter</tag>,
13171 <tag>appendix</tag>, and other component elements are prefixed with
13172 the label of the part element that contains them. So you might see
13173 Chapter II.3 instead of Chapter 3. Also, the labels for formal
13174 elements such as <tag>table</tag> and <tag>figure</tag> will include
13175 the part label. If there is no part element container, then no prefix
13179 This feature is most useful when the
13180 <parameter>label.from.part</parameter> parameter is turned on.
13181 In that case, there would be more than one <tag>chapter</tag>
13182 <quote>1</quote>, and the extra part label prefix will identify
13183 each chapter unambiguously.
13189 </reference><reference id="xslt" xml:base="../fo/param.xml"><title>XSLT Processing</title>
13190 <refentry version="5.0" id="rootid">
13192 <refentrytitle>rootid</refentrytitle>
13193 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
13196 <refname>rootid</refname>
13197 <refpurpose>Specify the root element to format</refpurpose>
13201 <programlisting id="rootid.frag">
13202 <xsl:param name="rootid"></xsl:param></programlisting>
13205 <refsection><info><title>Description</title></info>
13207 <para>If <parameter>rootid</parameter> is not empty, it must be the
13208 value of an ID that occurs in the document being formatted. The entire
13209 document will be loaded and parsed, but formatting will begin at the
13210 element identified, rather than at the root. For example, this allows
13211 you to process only <tag>chapter</tag> 4 of a <tag>book</tag>.</para>
13212 <para>Because the entire document is available to the processor, automatic
13213 numbering, cross references, and other dependencies are correctly
13219 </reference><reference id="meta" xml:base="../fo/param.xml"><title>Meta/*Info</title>
13220 <refentry version="5.0" id="make.single.year.ranges">
13222 <refentrytitle>make.single.year.ranges</refentrytitle>
13223 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
13226 <refname>make.single.year.ranges</refname>
13227 <refpurpose>Print single-year ranges (e.g., 1998-1999)</refpurpose>
13231 <programlisting id="make.single.year.ranges.frag">
13232 <xsl:param name="make.single.year.ranges" select="0"></xsl:param></programlisting>
13235 <refsection><info><title>Description</title></info>
13237 <para>If non-zero, year ranges that span a single year will be printed
13238 in range notation (1998-1999) instead of discrete notation
13239 (1998, 1999).</para>
13244 <refentry version="5.0" id="make.year.ranges">
13246 <refentrytitle>make.year.ranges</refentrytitle>
13247 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
13250 <refname>make.year.ranges</refname>
13251 <refpurpose>Collate copyright years into ranges?</refpurpose>
13255 <programlisting id="make.year.ranges.frag"><xsl:param name="make.year.ranges" select="0"></xsl:param></programlisting>
13258 <refsection><info><title>Description</title></info>
13260 <para>If non-zero, multiple copyright <tag>year</tag> elements will be
13261 collated into ranges.
13262 This works only if each year number is put into a separate
13263 year element. The copyright element permits multiple
13264 year elements. If a year element contains a dash or
13265 a comma, then that year element will not be merged into
13272 <refentry version="5.0" id="author.othername.in.middle">
13274 <refentrytitle>author.othername.in.middle</refentrytitle>
13275 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
13278 <refname>author.othername.in.middle</refname>
13279 <refpurpose>Is <tag>othername</tag> in <tag>author</tag> a
13280 middle name?</refpurpose>
13284 <programlisting id="author.othername.in.middle.frag">
13285 <xsl:param name="author.othername.in.middle" select="1"></xsl:param></programlisting>
13288 <refsection><info><title>Description</title></info>
13290 <para>If non-zero, the <tag>othername</tag> of an <tag>author</tag>
13291 appears between the <tag>firstname</tag> and
13292 <tag>surname</tag>. Otherwise, <tag>othername</tag>
13299 </reference><reference id="refentry" xml:base="../fo/param.xml"><title>Reference Pages</title>
13300 <refentry version="5.0" id="funcsynopsis.decoration">
13302 <refentrytitle>funcsynopsis.decoration</refentrytitle>
13303 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
13306 <refname>funcsynopsis.decoration</refname>
13307 <refpurpose>Decorate elements of a <tag>funcsynopsis</tag>?</refpurpose>
13311 <programlisting id="funcsynopsis.decoration.frag">
13312 <xsl:param name="funcsynopsis.decoration" select="1"></xsl:param>
13316 <refsection><info><title>Description</title></info>
13318 <para>If non-zero, elements of the <tag>funcsynopsis</tag> will be
13319 decorated (e.g. rendered as bold or italic text). The decoration is controlled by
13320 templates that can be redefined in a customization layer.
13326 <refentry version="5.0" id="funcsynopsis.style">
13328 <refentrytitle>funcsynopsis.style</refentrytitle>
13329 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
13330 <refmiscinfo class="other" otherclass="value">ansi</refmiscinfo>
13331 <refmiscinfo class="other" otherclass="value">kr</refmiscinfo>
13334 <refname>funcsynopsis.style</refname>
13335 <refpurpose>What style of <tag>funcsynopsis</tag> should be generated?</refpurpose>
13339 <programlisting id="funcsynopsis.style.frag"><xsl:param name="funcsynopsis.style">kr</xsl:param></programlisting>
13342 <refsection><info><title>Description</title></info>
13344 <para>If <parameter>funcsynopsis.style</parameter> is <literal>ansi</literal>,
13345 ANSI-style function synopses are generated for a
13346 <tag>funcsynopsis</tag>, otherwise K&R-style
13347 function synopses are generated.
13353 <refentry version="5.0" id="function.parens">
13355 <refentrytitle>function.parens</refentrytitle>
13356 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
13359 <refname>function.parens</refname>
13360 <refpurpose>Generate parens after a function?</refpurpose>
13364 <programlisting id="function.parens.frag">
13365 <xsl:param name="function.parens" select="0"></xsl:param>
13369 <refsection><info><title>Description</title></info>
13371 <para>If non-zero, the formatting of a <tag>function</tag> element
13372 will include generated parentheses.
13378 <refentry version="5.0" id="refentry.generate.name">
13380 <refentrytitle>refentry.generate.name</refentrytitle>
13381 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
13384 <refname>refentry.generate.name</refname>
13385 <refpurpose>Output NAME header before <tag>refname</tag>s?</refpurpose>
13389 <programlisting id="refentry.generate.name.frag">
13390 <xsl:param name="refentry.generate.name" select="1"></xsl:param>
13394 <refsection><info><title>Description</title></info>
13396 <para>If non-zero, a "NAME" section title is output before the list
13397 of <tag>refname</tag>s. This parameter and
13398 <parameter>refentry.generate.title</parameter> are mutually
13399 exclusive. This means that if you change this parameter to zero, you
13400 should set <parameter>refentry.generate.title</parameter> to non-zero unless
13401 you want get quite strange output.
13407 <refentry version="5.0" id="refentry.generate.title">
13409 <refentrytitle>refentry.generate.title</refentrytitle>
13410 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
13413 <refname>refentry.generate.title</refname>
13414 <refpurpose>Output title before <tag>refname</tag>s?</refpurpose>
13418 <programlisting id="refentry.generate.title.frag">
13419 <xsl:param name="refentry.generate.title" select="0"></xsl:param>
13423 <refsection><info><title>Description</title></info>
13425 <para>If non-zero, the reference page title or first name is
13426 output before the list of <tag>refname</tag>s. This parameter and
13427 <parameter>refentry.generate.name</parameter> are mutually exclusive.
13428 This means that if you change this parameter to non-zero, you
13429 should set <parameter>refentry.generate.name</parameter> to zero unless
13430 you want get quite strange output.</para>
13436 <refentry version="5.0" id="refentry.pagebreak">
13438 <refentrytitle>refentry.pagebreak</refentrytitle>
13439 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
13442 <refname>refentry.pagebreak</refname>
13443 <refpurpose>Start each refentry on a new page</refpurpose>
13447 <programlisting id="refentry.pagebreak.frag"><xsl:param name="refentry.pagebreak" select="1"></xsl:param></programlisting>
13450 <refsection><info><title>Description</title></info>
13452 <para>If non-zero (the default), each <tag>refentry</tag>
13453 element will start on a new page. If zero, a page
13454 break will not be generated between <tag>refentry</tag> elements.
13455 The exception is when the <tag>refentry</tag> elements are children of
13456 a <tag>part</tag> element, in which case the page breaks are always
13457 retained. That is because a <tag>part</tag> element does not generate
13458 a page-sequence for its children, so each <tag>refentry</tag> must
13459 start its own page-sequence.
13465 <refentry version="5.0" id="refentry.title.properties">
13467 <refentrytitle>refentry.title.properties</refentrytitle>
13468 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
13471 <refname>refentry.title.properties</refname>
13472 <refpurpose>Title properties for a refentry title</refpurpose>
13476 <programlisting id="refentry.title.properties.frag">
13477 <xsl:attribute-set name="refentry.title.properties">
13478 <xsl:attribute name="font-family">
13479 <xsl:value-of select="$title.font.family"></xsl:value-of>
13480 </xsl:attribute>
13481 <xsl:attribute name="font-size">18pt</xsl:attribute>
13482 <xsl:attribute name="font-weight">bold</xsl:attribute>
13483 <xsl:attribute name="space-after">1em</xsl:attribute>
13484 <xsl:attribute name="hyphenate">false</xsl:attribute>
13485 <xsl:attribute name="keep-with-next.within-column">always</xsl:attribute>
13486 <xsl:attribute name="space-before.minimum">0.8em</xsl:attribute>
13487 <xsl:attribute name="space-before.optimum">1.0em</xsl:attribute>
13488 <xsl:attribute name="space-before.maximum">1.2em</xsl:attribute>
13489 <xsl:attribute name="space-after.optimum">0.5em</xsl:attribute>
13490 <xsl:attribute name="space-after.minimum">0.4em</xsl:attribute>
13491 <xsl:attribute name="space-after.maximum">0.6em</xsl:attribute>
13492 <xsl:attribute name="start-indent"><xsl:value-of select="$title.margin.left"></xsl:value-of></xsl:attribute>
13493 </xsl:attribute-set>
13497 <refsection><info><title>Description</title></info>
13499 <para>Formatting properties applied to the title generated for the
13500 <tag>refnamediv</tag> part of output for
13501 <tag>refentry</tag> when the value of the
13502 <parameter>refentry.generate.title</parameter> parameter is
13503 non-zero. The font size is supplied by the appropriate <parameter>section.level<replaceable>X</replaceable>.title.properties</parameter>
13504 attribute-set, computed from the location of the
13505 <tag>refentry</tag> in the section hierarchy.</para>
13508 <para>This parameter has no effect on the the title generated for
13509 the <tag>refnamediv</tag> part of output for
13510 <tag>refentry</tag> when the value of the
13511 <parameter>refentry.generate.name</parameter> parameter is
13512 non-zero. By default, that title is formatted with the same
13513 properties as the titles for all other first-level children of
13514 <tag>refentry</tag>.</para>
13520 <refentry version="5.0" id="refentry.xref.manvolnum">
13522 <refentrytitle>refentry.xref.manvolnum</refentrytitle>
13523 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
13526 <refname>refentry.xref.manvolnum</refname>
13527 <refpurpose>Output <tag>manvolnum</tag> as part of
13528 <tag>refentry</tag> cross-reference?</refpurpose>
13532 <programlisting id="refentry.xref.manvolnum.frag">
13533 <xsl:param name="refentry.xref.manvolnum" select="1"></xsl:param>
13537 <refsection><info><title>Description</title></info>
13539 <para>if non-zero, the <tag>manvolnum</tag> is used when cross-referencing
13540 <tag>refentry</tag>s, either with <tag>xref</tag>
13541 or <tag>citerefentry</tag>.
13547 <refentry version="5.0" id="refclass.suppress">
13549 <refentrytitle>refclass.suppress</refentrytitle>
13550 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
13553 <refname>refclass.suppress</refname>
13554 <refpurpose>Suppress display of refclass contents?</refpurpose>
13558 <programlisting id="refclass.suppress.frag">
13559 <xsl:param name="refclass.suppress" select="0"></xsl:param></programlisting>
13562 <refsection><info><title>Description</title></info>
13564 <para>If the value of <parameter>refclass.suppress</parameter> is
13565 non-zero, then display of <tag>refclass</tag> contents is
13566 suppressed in output.</para>
13571 </reference><reference id="tables" xml:base="../fo/param.xml"><title>Tables</title>
13572 <refentry version="5.0" id="default.table.width">
13574 <refentrytitle>default.table.width</refentrytitle>
13575 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
13578 <refname>default.table.width</refname>
13579 <refpurpose>The default width of tables</refpurpose>
13582 <programlisting id="default.table.width.frag">
13583 <xsl:param name="default.table.width"></xsl:param>
13586 <refsection><info><title>Description</title></info>
13587 <para>If non-zero, this value will be used for the
13588 <literal>width</literal> attribute on <tag>table</tag>s that do not specify an
13589 alternate width (with the <tag class="xmlpi">dbhtml table-width</tag> or
13590 <tag class="xmlpi">dbfo table-width</tag> processing instruction).</para>
13594 <refentry version="5.0" id="nominal.table.width">
13596 <refentrytitle>nominal.table.width</refentrytitle>
13597 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
13600 <refname>nominal.table.width</refname>
13601 <refpurpose>The (absolute) nominal width of tables</refpurpose>
13605 <programlisting id="nominal.table.width.frag">
13606 <xsl:param name="nominal.table.width">6in</xsl:param>
13610 <refsection><info><title>Description</title></info>
13612 <para>In order to convert CALS column widths into HTML column widths, it
13613 is sometimes necessary to have an absolute table width to use for conversion
13614 of mixed absolute and relative widths. This value must be an absolute
13615 length (not a percentage).</para>
13620 <refentry version="5.0" id="default.table.frame">
13622 <refentrytitle>default.table.frame</refentrytitle>
13623 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
13626 <refname>default.table.frame</refname>
13627 <refpurpose>The default framing of tables</refpurpose>
13631 <programlisting id="default.table.frame.frag">
13632 <xsl:param name="default.table.frame">all</xsl:param>
13636 <refsection><info><title>Description</title></info>
13638 <para>This value will be used when there is no frame attribute on the
13644 <refentry version="5.0" id="default.table.rules">
13646 <refentrytitle>default.table.rules</refentrytitle>
13647 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
13650 <refname>default.table.rules</refname>
13651 <refpurpose>The default column and row rules for tables using HTML markup</refpurpose>
13655 <programlisting id="default.table.rules.frag">
13656 <xsl:param name="default.table.rules">none</xsl:param>
13660 <refsection><info><title>Description</title></info>
13662 <para>Tables using HTML markup elements can use an attribute
13663 named <tag class="attribute">rules</tag> on the <tag>table</tag> or
13664 <tag>informaltable</tag> element
13665 to specify whether column and row border rules should be
13666 displayed. This parameter lets you specify a global default
13667 style for all HTML tables that don't otherwise have
13668 that attribute.</para>
13669 <para>These are the supported values:</para>
13672 <varlistentry><term>all</term>
13674 <para>Rules will appear between all rows and columns.</para>
13678 <varlistentry><term>rows</term>
13680 <para>Rules will appear between rows only.</para>
13684 <varlistentry><term>cols</term>
13686 <para>Rules will appear between columns only.</para>
13690 <varlistentry><term>groups</term>
13692 <para>Rules will appear between row groups (thead, tfoot, tbody).
13693 No support for rules between column groups yet.
13698 <varlistentry><term>none</term>
13700 <para>No rules. This is the default value.
13707 <para>The border after the last row and the border after
13708 the last column are not affected by
13709 this setting. Those borders are controlled by
13710 the <tag class="attribute">frame</tag> attribute on the table element.
13716 <refentry version="5.0" id="table.cell.padding">
13718 <refentrytitle>table.cell.padding</refentrytitle>
13719 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
13722 <refname>table.cell.padding</refname>
13723 <refpurpose>Specifies the padding of table cells</refpurpose>
13727 <programlisting id="table.cell.padding.frag">
13728 <xsl:attribute-set name="table.cell.padding">
13729 <xsl:attribute name="padding-start">2pt</xsl:attribute>
13730 <xsl:attribute name="padding-end">2pt</xsl:attribute>
13731 <xsl:attribute name="padding-top">2pt</xsl:attribute>
13732 <xsl:attribute name="padding-bottom">2pt</xsl:attribute>
13733 </xsl:attribute-set>
13737 <refsection><info><title>Description</title></info>
13739 <para>Specifies the padding of table cells.</para>
13744 <refentry version="5.0" id="table.frame.border.thickness">
13746 <refentrytitle>table.frame.border.thickness</refentrytitle>
13747 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
13750 <refname>table.frame.border.thickness</refname>
13751 <refpurpose>Specifies the thickness of the frame border</refpurpose>
13755 <programlisting id="table.frame.border.thickness.frag">
13756 <xsl:param name="table.frame.border.thickness">0.5pt</xsl:param>
13760 <refsection><info><title>Description</title></info>
13762 <para>Specifies the thickness of the border on the table's frame.</para>
13767 <refentry version="5.0" id="table.frame.border.style">
13769 <refentrytitle>table.frame.border.style</refentrytitle>
13770 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
13771 <refmiscinfo class="other" otherclass="value">none</refmiscinfo>
13772 <refmiscinfo class="other" otherclass="value">solid</refmiscinfo>
13773 <refmiscinfo class="other" otherclass="value">dotted</refmiscinfo>
13774 <refmiscinfo class="other" otherclass="value">dashed</refmiscinfo>
13775 <refmiscinfo class="other" otherclass="value">double</refmiscinfo>
13776 <refmiscinfo class="other" otherclass="value">groove</refmiscinfo>
13777 <refmiscinfo class="other" otherclass="value">ridge</refmiscinfo>
13778 <refmiscinfo class="other" otherclass="value">inset</refmiscinfo>
13779 <refmiscinfo class="other" otherclass="value">outset</refmiscinfo>
13780 <refmiscinfo class="other" otherclass="value">solid</refmiscinfo>
13783 <refname>table.frame.border.style</refname>
13784 <refpurpose>Specifies the border style of table frames</refpurpose>
13788 <programlisting id="table.frame.border.style.frag">
13789 <xsl:param name="table.frame.border.style">solid</xsl:param>
13793 <refsection><info><title>Description</title></info>
13795 <para>Specifies the border style of table frames.</para>
13800 <refentry version="5.0" id="table.frame.border.color">
13802 <refentrytitle>table.frame.border.color</refentrytitle>
13803 <refmiscinfo class="other" otherclass="datatype">color</refmiscinfo>
13806 <refname>table.frame.border.color</refname>
13807 <refpurpose>Specifies the border color of table frames</refpurpose>
13811 <programlisting id="table.frame.border.color.frag">
13813 <xsl:param name="table.frame.border.color">black</xsl:param>
13817 <refsection><info><title>Description</title></info>
13819 <para>Specifies the border color of table frames.</para>
13824 <refentry version="5.0" id="table.cell.border.thickness">
13826 <refentrytitle>table.cell.border.thickness</refentrytitle>
13827 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
13830 <refname>table.cell.border.thickness</refname>
13831 <refpurpose>Specifies the thickness of table cell borders</refpurpose>
13835 <programlisting id="table.cell.border.thickness.frag">
13836 <xsl:param name="table.cell.border.thickness">0.5pt</xsl:param>
13840 <refsection><info><title>Description</title></info>
13842 <para>If non-zero, specifies the thickness of borders on table
13843 cells. The units are points. See <link xlink:href="http://www.w3.org/TR/CSS21/box.html#border-width-properties">
13847 <para>To control properties of cell borders in HTML output, you must also turn on the
13848 <parameter>table.borders.with.css</parameter> parameter.</para>
13854 <refentry version="5.0" id="table.cell.border.style">
13856 <refentrytitle>table.cell.border.style</refentrytitle>
13857 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
13858 <refmiscinfo class="other" otherclass="value">none</refmiscinfo>
13859 <refmiscinfo class="other" otherclass="value">solid</refmiscinfo>
13860 <refmiscinfo class="other" otherclass="value">dotted</refmiscinfo>
13861 <refmiscinfo class="other" otherclass="value">dashed</refmiscinfo>
13862 <refmiscinfo class="other" otherclass="value">double</refmiscinfo>
13863 <refmiscinfo class="other" otherclass="value">groove</refmiscinfo>
13864 <refmiscinfo class="other" otherclass="value">ridge</refmiscinfo>
13865 <refmiscinfo class="other" otherclass="value">inset</refmiscinfo>
13866 <refmiscinfo class="other" otherclass="value">outset</refmiscinfo>
13867 <refmiscinfo class="other" otherclass="value">solid</refmiscinfo>
13870 <refname>table.cell.border.style</refname>
13871 <refpurpose>Specifies the border style of table cells</refpurpose>
13875 <programlisting id="table.cell.border.style.frag">
13876 <xsl:param name="table.cell.border.style">solid</xsl:param>
13880 <refsection><info><title>Description</title></info>
13882 <para>Specifies the border style of table cells.</para>
13885 <para>To control properties of cell borders in HTML output, you must also turn on the
13886 <parameter>table.borders.with.css</parameter> parameter.</para>
13892 <refentry version="5.0" id="table.cell.border.color">
13894 <refentrytitle>table.cell.border.color</refentrytitle>
13895 <refmiscinfo class="other" otherclass="datatype">color</refmiscinfo>
13898 <refname>table.cell.border.color</refname>
13899 <refpurpose>Specifies the border color of table cells</refpurpose>
13903 <programlisting id="table.cell.border.color.frag">
13905 <xsl:param name="table.cell.border.color">black</xsl:param>
13909 <refsection><info><title>Description</title></info>
13911 <para>Set the color of table cell borders. If non-zero, the value is used
13912 for the border coloration. See <link xlink:href="http://www.w3.org/TR/CSS21/syndata.html#value-def-color">CSS</link>. A
13913 <literal>color</literal> is either a keyword or a numerical RGB specification.
13914 Keywords are aqua, black, blue, fuchsia, gray, green, lime, maroon,
13915 navy, olive, orange, purple, red, silver, teal, white, and
13919 <para>To control properties of cell borders in HTML output, you must also turn on the
13920 <parameter>table.borders.with.css</parameter> parameter.</para>
13926 <refentry version="5.0" id="table.table.properties">
13928 <refentrytitle>table.table.properties</refentrytitle>
13929 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
13932 <refname>table.table.properties</refname>
13933 <refpurpose>Properties associated with a table</refpurpose>
13937 <programlisting id="table.table.properties.frag">
13938 <xsl:attribute-set name="table.table.properties">
13939 <xsl:attribute name="border-before-width.conditionality">retain</xsl:attribute>
13940 <xsl:attribute name="border-collapse">collapse</xsl:attribute>
13941 </xsl:attribute-set>
13945 <refsection><info><title>Description</title></info>
13947 <para>The styling for tables. This parameter should really
13948 have been called <literal>table.properties</literal>, but that parameter
13949 name was inadvertently established for the block-level properties
13950 of the table as a whole.
13953 <para>See also <parameter>table.properties</parameter>.</para>
13958 </reference><reference id="links" xml:base="../fo/param.xml"><title>Linking</title>
13959 <refentry version="5.0" id="current.docid">
13961 <refentrytitle>current.docid</refentrytitle>
13962 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
13965 <refname>current.docid</refname>
13966 <refpurpose>targetdoc identifier for the document being
13967 processed</refpurpose>
13969 <refsynopsisdiv> <programlisting id="current.docid.frag">
13970 <xsl:param name="current.docid"></xsl:param>
13973 <refsection><info><title>Description</title></info>
13975 <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
13976 the targetdoc identifier of the current document, since that
13977 identifier does not appear in the document itself. </para>
13978 <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>
13982 <refentry version="5.0" id="collect.xref.targets">
13984 <refentrytitle>collect.xref.targets</refentrytitle>
13985 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
13986 <refmiscinfo class="other" otherclass="value">no</refmiscinfo>
13987 <refmiscinfo class="other" otherclass="value">yes</refmiscinfo>
13988 <refmiscinfo class="other" otherclass="value">only</refmiscinfo>
13991 <refname>collect.xref.targets</refname>
13992 <refpurpose>Controls whether cross reference data is
13993 collected</refpurpose>
13995 <refsynopsisdiv> <programlisting id="collect.xref.targets.frag">
13996 <xsl:param name="collect.xref.targets">no</xsl:param>
13999 <refsection><info><title>Description</title></info>
14002 In order to resolve olinks efficiently, the stylesheets can
14003 generate an external data file containing information about
14004 all potential cross reference endpoints in a document.
14005 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.
14006 See also <parameter>targets.filename</parameter>.
14011 <refentry version="5.0" id="insert.olink.page.number">
14013 <refentrytitle>insert.olink.page.number</refentrytitle>
14014 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
14015 <refmiscinfo class="other" otherclass="value">no</refmiscinfo>
14016 <refmiscinfo class="other" otherclass="value">yes</refmiscinfo>
14017 <refmiscinfo class="other" otherclass="value">maybe</refmiscinfo>
14020 <refname>insert.olink.page.number</refname>
14021 <refpurpose>Turns page numbers in olinks on and off</refpurpose>
14025 <programlisting id="insert.olink.page.number.frag">
14026 <xsl:param name="insert.olink.page.number">no</xsl:param>
14030 <refsection><info><title>Description</title></info>
14032 <para>The value of this parameter determines if
14033 cross references made between documents with
14034 <tag>olink</tag> will
14035 include page number citations.
14036 In most cases this is only applicable to references in printed output.
14038 <para>The parameter has three possible values.
14043 <listitem><para>No page number references will be generated for olinks.
14048 <listitem><para>Page number references will be generated
14049 for all <tag>olink</tag> references.
14050 The style of page reference may be changed
14051 if an <tag class="attribute">xrefstyle</tag>
14057 <listitem><para>Page number references will not be generated
14058 for an <tag>olink</tag> element unless
14060 <tag class="attribute">xrefstyle</tag>
14061 attribute whose value specifies a page reference.
14065 <para>Olinks that point to targets within the same document
14066 are treated as <tag>xref</tag>s, and controlled by
14067 the <parameter>insert.xref.page.number</parameter> parameter.
14070 <para>Page number references for olinks to
14071 external documents can only be inserted if the
14072 information exists in the olink database.
14073 This means each olink target element
14074 (<tag>div</tag> or <tag>obj</tag>)
14075 must have a <tag class="attribute">page</tag> attribute
14076 whose value is its page number in the target document.
14077 The XSL stylesheets are not able to extract that information
14078 during processing because pages have not yet been created in
14079 XSLT transformation. Only the XSL-FO processor knows what
14080 page each element is placed on.
14081 Therefore some postprocessing must take place to populate
14082 page numbers in the olink database.
14090 <refentry version="5.0" id="insert.olink.pdf.frag">
14092 <refentrytitle>insert.olink.pdf.frag</refentrytitle>
14093 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
14096 <refname>insert.olink.pdf.frag</refname>
14097 <refpurpose>Add fragment identifiers for links into PDF files</refpurpose>
14101 <programlisting id="insert.olink.pdf.frag.frag">
14102 <xsl:param name="insert.olink.pdf.frag" select="0"></xsl:param>
14106 <refsection><info><title>Description</title></info>
14108 <para>The value of this parameter determines whether
14109 the cross reference URIs to PDF documents made with
14110 <tag>olink</tag> will
14111 include fragment identifiers.
14114 <para>When forming a URI to link to a PDF document,
14115 a fragment identifier (typically a '#' followed by an
14116 id value) appended to the PDF filename can be used by
14117 the PDF viewer to open
14118 the PDF file to a location within the document instead of
14120 However, not all PDF files have id
14121 values embedded in them, and not all PDF viewers can
14122 handle fragment identifiers.
14125 <para>If <parameter>insert.olink.pdf.frag</parameter> is set
14126 to a non-zero value, then any olink targeting a
14127 PDF file will have the fragment identifier appended to the URI.
14128 The URI is formed by concatenating the value of the
14129 <parameter>olink.base.uri</parameter> parameter, the
14130 value of the <tag class="attribute">baseuri</tag>
14131 attribute from the <tag class="element">document</tag>
14132 element in the olink database with the matching
14133 <tag class="attribute">targetdoc</tag> value,
14134 and the value of the <tag class="attribute">href</tag>
14135 attribute for the targeted element in the olink database.
14136 The <tag class="attribute">href</tag> attribute
14137 contains the fragment identifier.
14140 <para>If <parameter>insert.olink.pdf.frag</parameter> is set
14141 to zero (the default value), then
14142 the <tag class="attribute">href</tag> attribute
14143 from the olink database
14144 is not appended to PDF olinks, so the fragment identifier is left off.
14145 A PDF olink is any olink for which the
14146 <tag class="attribute">baseuri</tag> attribute
14147 from the matching <tag class="element">document</tag>
14148 element in the olink database ends with '.pdf'.
14149 Any other olinks will still have the fragment identifier added.
14154 <refentry version="5.0" id="olink.base.uri">
14156 <refentrytitle>olink.base.uri</refentrytitle>
14157 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
14160 <refname>olink.base.uri</refname>
14161 <refpurpose>Base URI used in olink hrefs</refpurpose>
14163 <refsynopsisdiv> <programlisting id="olink.base.uri.frag">
14164 <xsl:param name="olink.base.uri"></xsl:param>
14167 <refsection><info><title>Description</title></info>
14169 <para>When cross reference data is collected for resolving olinks, it
14170 may be necessary to prepend a base URI to each target's href. This
14171 parameter lets you set that base URI when cross reference data is
14172 collected. This feature is needed when you want to link to a document
14173 that is processed without chunking. The output filename for such a
14174 document is not known to the XSL stylesheet; the only target
14175 information consists of fragment identifiers such as
14176 <literal>#idref</literal>. To enable the resolution of olinks between
14177 documents, you should pass the name of the HTML output file as the
14178 value of this parameter. Then the hrefs recorded in the cross
14179 reference data collection look like
14180 <literal>outfile.html#idref</literal>, which can be reached as links
14181 from other documents.</para>
14185 <refentry version="5.0" id="olink.debug">
14187 <refentrytitle>olink.debug</refentrytitle>
14188 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
14191 <refname>olink.debug</refname>
14192 <refpurpose>Turn on debugging messages for olinks</refpurpose>
14196 <programlisting id="olink.debug.frag">
14197 <xsl:param name="olink.debug" select="0"></xsl:param>
14201 <refsection><info><title>Description</title></info>
14203 <para>If non-zero, then each olink will generate several
14204 messages about how it is being resolved during processing.
14205 This is useful when an olink does not resolve properly
14206 and the standard error messages are not sufficient to
14210 <para>You may need to read through the olink XSL templates
14211 to understand the context for some of the debug messages.
14217 <refentry version="5.0" id="olink.doctitle">
14219 <refentrytitle>olink.doctitle</refentrytitle>
14220 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
14221 <refmiscinfo class="other" otherclass="value">no</refmiscinfo>
14222 <refmiscinfo class="other" otherclass="value">yes</refmiscinfo>
14223 <refmiscinfo class="other" otherclass="value">maybe</refmiscinfo>
14226 <refname>olink.doctitle</refname>
14227 <refpurpose>show the document title for external olinks?</refpurpose>
14230 <refsynopsisdiv> <programlisting id="olink.doctitle.frag">
14231 <xsl:param name="olink.doctitle">no</xsl:param>
14234 <refsection><info><title>Description</title></info>
14236 <para>When olinks between documents are resolved, the generated text
14237 may not make it clear that the reference is to another document.
14238 It is possible for the stylesheets to append the other document's
14239 title to external olinks. For this to happen, two parameters must
14243 <para>This <parameter>olink.doctitle</parameter> parameter
14244 should be set to either <literal>yes</literal> or <literal>maybe</literal>
14245 to enable this feature.
14249 <para>And you should also set the <parameter>current.docid</parameter>
14250 parameter to the document id for the document currently
14251 being processed for output.
14257 Then if an olink's <literal>targetdoc</literal> id differs from
14258 the <literal>current.docid</literal> value, the stylesheet knows
14259 that it is a reference to another document and can
14260 append the target document's
14261 title to the generated olink text. </para>
14263 <para>The text for the target document's title is copied from the
14264 olink database from the <tag>ttl</tag> element
14265 of the top-level <tag>div</tag> for that document.
14266 If that <tag>ttl</tag> element is missing or empty,
14267 no title is output.
14270 <para>The supported values for <parameter>olink.doctitle</parameter> are:
14274 <term><literal>yes</literal></term>
14277 Always insert the title to the target document if it is not
14278 the current document.
14283 <term><literal>no</literal></term>
14286 Never insert the title to the target document, even if requested
14287 in an <tag class="attribute">xrefstyle</tag> attribute.
14292 <term><literal>maybe</literal></term>
14295 Only insert the title to the target document, if requested
14296 in an <tag class="attribute">xrefstyle</tag> attribute.
14301 <para>An <tag class="attribute">xrefstyle</tag> attribute
14302 may override the global setting for individual olinks.
14303 The following values are supported in an
14304 <tag class="attribute">xrefstyle</tag>
14305 attribute using the <literal>select:</literal> syntax:
14310 <term><literal>docname</literal></term>
14313 Insert the target document name for this olink using the
14314 <literal>docname</literal> gentext template, but only
14315 if the value of <parameter>olink.doctitle</parameter>
14316 is not <literal>no</literal>.
14321 <term><literal>docnamelong</literal></term>
14324 Insert the target document name for this olink using the
14325 <literal>docnamelong</literal> gentext template, but only
14326 if the value of <parameter>olink.doctitle</parameter>
14327 is not <literal>no</literal>.
14332 <term><literal>nodocname</literal></term>
14335 Omit the target document name even if
14336 the value of <parameter>olink.doctitle</parameter>
14337 is <literal>yes</literal>.
14342 <para>Another way of inserting the target document name
14343 for a single olink is to employ an
14344 <tag class="attribute">xrefstyle</tag>
14345 attribute using the <literal>template:</literal> syntax.
14346 The <literal>%o</literal> placeholder (the letter o, not zero)
14348 will be filled in with the target document's title when it is processed.
14349 This will occur regardless of
14350 the value of <parameter>olink.doctitle</parameter>.
14352 <para>Note that prior to version 1.66 of the XSL stylesheets,
14353 the allowed values for this parameter were 0 and 1. Those
14354 values are still supported and mapped to 'no' and 'yes', respectively.
14359 <refentry version="5.0" id="olink.lang.fallback.sequence">
14361 <refentrytitle>olink.lang.fallback.sequence</refentrytitle>
14362 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
14365 <refname>olink.lang.fallback.sequence</refname>
14366 <refpurpose>look up translated documents if olink not found?</refpurpose>
14369 <refsynopsisdiv> <programlisting id="olink.lang.fallback.sequence.frag">
14370 <xsl:param name="olink.lang.fallback.sequence"></xsl:param>
14373 <refsection><info><title>Description</title></info>
14376 <para>This parameter defines a list of lang values
14377 to search among to resolve olinks.
14380 <para>Normally an olink tries to resolve to a document in the same
14381 language as the olink itself. The language of an olink
14382 is determined by its nearest ancestor element with a
14383 <tag class="attribute">lang</tag> attribute, otherwise the
14384 value of the <parameter>l10n.gentext.default.lang</parameter>
14388 <para>An olink database can contain target data for the same
14389 document in multiple languages. Each set of data has the
14390 same value for the <tag>targetdoc</tag> attribute in
14391 the <tag>document</tag> element in the database, but with a
14392 different <tag>lang</tag> attribute value.
14395 <para>When an olink is being resolved, the target is first
14396 sought in the document with the same language as the olink.
14397 If no match is found there, then this parameter is consulted
14398 for additional languages to try.</para>
14400 <para>The <parameter>olink.lang.fallback.sequence</parameter>
14401 must be a whitespace separated list of lang values to
14402 try. The first one with a match in the olink database is used.
14403 The default value is empty.</para>
14405 <para>For example, a document might be written in German
14406 and contain an olink with
14407 <literal>targetdoc="adminguide"</literal>.
14408 When the document is processed, the processor
14409 first looks for a target dataset in the
14410 olink database starting with:</para>
14412 <literallayout><literal><document targetdoc="adminguide" lang="de"></literal>.
14415 <para>If there is no such element, then the
14416 <parameter>olink.lang.fallback.sequence</parameter>
14417 parameter is consulted.
14418 If its value is, for example, <quote>fr en</quote>, then the processor next
14419 looks for <literal>targetdoc="adminguide" lang="fr"</literal>, and
14420 then for <literal>targetdoc="adminguide" lang="en"</literal>.
14421 If there is still no match, it looks for
14422 <literal>targetdoc="adminguide"</literal> with no
14426 <para>This parameter is useful when a set of documents is only
14427 partially translated, or is in the process of being translated.
14428 If a target of an olink has not yet been translated, then this
14429 parameter permits the processor to look for the document in
14430 other languages. This assumes the reader would rather have
14431 a link to a document in a different language than to have
14438 <refentry version="5.0" id="olink.properties">
14440 <refentrytitle>olink.properties</refentrytitle>
14441 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
14444 <refname>olink.properties</refname>
14445 <refpurpose>Properties associated with the cross-reference
14446 text of an olink.</refpurpose>
14450 <programlisting id="olink.properties.frag">
14451 <xsl:attribute-set name="olink.properties">
14452 <xsl:attribute name="show-destination">replace</xsl:attribute>
14453 </xsl:attribute-set>
14457 <refsection><info><title>Description</title></info>
14459 <para>This <literal>attribute set</literal> is applied to the
14460 <literal>fo:basic-link</literal> element of an olink. It is not applied to the
14461 optional page number or optional title of the external
14467 <refentry version="5.0" id="prefer.internal.olink">
14469 <refentrytitle>prefer.internal.olink</refentrytitle>
14470 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
14473 <refname>prefer.internal.olink</refname>
14474 <refpurpose>Prefer a local olink reference to an external reference</refpurpose>
14478 <programlisting id="prefer.internal.olink.frag">
14479 <xsl:param name="prefer.internal.olink" select="0"></xsl:param>
14483 <refsection><info><title>Description</title></info>
14485 <para>If you are re-using XML content modules in multiple documents,
14486 you may want to redirect some of your olinks. This parameter
14487 permits you to redirect an olink to the current document.
14490 <para>For example: you are writing documentation for a product,
14491 which includes 3 manuals: a little installation
14492 booklet (booklet.xml), a user
14493 guide (user.xml), and a reference manual (reference.xml).
14494 All 3 documents begin with the same introduction section (intro.xml) that
14495 contains a reference to the customization section (custom.xml) which is
14496 included in both user.xml and reference.xml documents.
14499 <para>How do you write the link to custom.xml in intro.xml
14500 so that it is interpreted correctly in all 3 documents?</para>
14502 <listitem><para>If you use xref, it will fail in user.xml.</para>
14504 <listitem><para>If you use olink (pointing to reference.xml),
14505 the reference in user.xml
14506 will point to the customization section of the reference manual, while it is
14507 actually available in user.xml.</para>
14511 <para>If you set the <parameter>prefer.internal.olink</parameter>
14512 parameter to a non-zero value, then the processor will
14513 first look in the olink database
14514 for the olink's <tag>targetptr</tag> attribute value
14515 in document matching the <parameter>current.docid</parameter>
14516 parameter value. If it isn't found there, then
14517 it tries the document in the database
14518 with the <tag>targetdoc</tag>
14519 value that matches the olink's <tag>targetdoc</tag>
14523 <para>This feature permits an olink reference to resolve to
14524 the current document if there is an element
14525 with an id matching the olink's <tag>targetptr</tag>
14526 value. The current document's olink data must be
14527 included in the target database for this to work.</para>
14530 <para>There is a potential for incorrect links if
14531 the same <tag>id</tag> attribute value is used for different
14532 content in different documents.
14533 Some of your olinks may be redirected to the current document
14534 when they shouldn't be. It is not possible to control
14535 individual olink instances.</para>
14541 <refentry version="5.0" id="target.database.document">
14543 <refentrytitle>target.database.document</refentrytitle>
14544 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
14547 <refname>target.database.document</refname>
14548 <refpurpose>Name of master database file for resolving
14549 olinks</refpurpose>
14552 <programlisting id="target.database.document.frag">
14553 <xsl:param name="target.database.document">olinkdb.xml</xsl:param>
14556 <refsection><info><title>Description</title></info>
14559 To resolve olinks between documents, the stylesheets use a master
14560 database document that identifies the target datafiles for all the
14561 documents within the scope of the olinks. This parameter value is the
14562 URI of the master document to be read during processing to resolve
14563 olinks. The default value is <filename>olinkdb.xml</filename>.</para>
14565 <para>The data structure of the file is defined in the
14566 <filename>targetdatabase.dtd</filename> DTD. The database file
14567 provides the high level elements to record the identifiers, locations,
14568 and relationships of documents. The cross reference data for
14569 individual documents is generally pulled into the database using
14570 system entity references or XIncludes. See also
14571 <parameter>targets.filename</parameter>. </para> </refsection>
14574 <refentry version="5.0" id="targets.filename">
14576 <refentrytitle>targets.filename</refentrytitle>
14577 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
14580 <refname>targets.filename</refname>
14581 <refpurpose>Name of cross reference targets data file</refpurpose>
14583 <refsynopsisdiv> <programlisting id="targets.filename.frag">
14584 <xsl:param name="targets.filename">target.db</xsl:param>
14587 <refsection><info><title>Description</title></info>
14590 In order to resolve olinks efficiently, the stylesheets can
14591 generate an external data file containing information about
14592 all potential cross reference endpoints in a document.
14593 This parameter lets you change the name of the generated
14594 file from the default name <filename>target.db</filename>.
14595 The name must agree with that used in the target database
14596 used to resolve olinks during processing.
14597 See also <parameter>target.database.document</parameter>.
14602 <refentry version="5.0" id="use.local.olink.style">
14604 <refentrytitle>use.local.olink.style</refentrytitle>
14605 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
14608 <refname>use.local.olink.style</refname>
14609 <refpurpose>Process olinks using xref style of current
14610 document</refpurpose>
14612 <refsynopsisdiv> <programlisting id="use.local.olink.style.frag">
14613 <xsl:param name="use.local.olink.style" select="0"></xsl:param> </programlisting>
14615 <refsection><info><title>Description</title></info>
14617 <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
14618 reference string is formed again from the target title, number, and
14619 element name, using the stylesheet processing the targeting document.
14620 Then olinks will match the xref style in the targeting document
14621 rather than in the target document. If both documents are processed
14622 with the same stylesheet, then the results will be the same.</para>
14626 </reference><reference id="xrefs" xml:base="../fo/param.xml"><title>Cross References</title>
14627 <refentry version="5.0" id="insert.xref.page.number">
14629 <refentrytitle>insert.xref.page.number</refentrytitle>
14630 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
14631 <refmiscinfo class="other" otherclass="value">no</refmiscinfo>
14632 <refmiscinfo class="other" otherclass="value">yes</refmiscinfo>
14633 <refmiscinfo class="other" otherclass="value">maybe</refmiscinfo>
14636 <refname>insert.xref.page.number</refname>
14637 <refpurpose>Turns page numbers in xrefs on and off</refpurpose>
14641 <programlisting id="insert.xref.page.number.frag">
14642 <xsl:param name="insert.xref.page.number">no</xsl:param>
14646 <refsection><info><title>Description</title></info>
14648 <para>The value of this parameter determines if
14649 cross references (<tag>xref</tag>s) in
14650 printed output will
14651 include page number citations.
14652 It has three possible values.
14657 <listitem><para>No page number references will be generated.
14662 <listitem><para>Page number references will be generated
14663 for all <tag>xref</tag> elements.
14664 The style of page reference may be changed
14665 if an <tag class="attribute">xrefstyle</tag>
14671 <listitem><para>Page number references will not be generated
14672 for an <tag>xref</tag> element unless
14674 <tag class="attribute">xrefstyle</tag>
14675 attribute whose value specifies a page reference.
14683 <refentry version="5.0" id="xref.properties">
14685 <refentrytitle>xref.properties</refentrytitle>
14686 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
14689 <refname>xref.properties</refname>
14690 <refpurpose>Properties associated with cross-reference text</refpurpose>
14694 <programlisting id="xref.properties.frag">
14695 <xsl:attribute-set name="xref.properties">
14696 </xsl:attribute-set>
14700 <refsection><info><title>Description</title></info>
14702 <para>This attribute set is used to set properties
14703 on cross reference text.</para>
14708 <refentry version="5.0" id="xref.label-title.separator">
14710 <refentrytitle>xref.label-title.separator</refentrytitle>
14711 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
14714 <refname>xref.label-title.separator</refname>
14715 <refpurpose>Punctuation or space separating label from title in xref</refpurpose>
14719 <programlisting id="xref.label-title.separator.frag"><xsl:param name="xref.label-title.separator">: </xsl:param></programlisting>
14722 <refsection><info><title>Description</title></info>
14725 This parameter allows you to control the punctuation of certain
14726 types of generated cross reference text.
14727 When cross reference text is generated for an
14728 <tag class="element">xref</tag> or
14729 <tag class="element">olink</tag> element
14730 using an <tag class="attribute">xrefstyle</tag> attribute
14731 that makes use of the <literal>select:</literal> feature,
14732 and the selected components include both label and title,
14733 then the value of this parameter is inserted between
14734 label and title in the output.
14740 <refentry version="5.0" id="xref.label-page.separator">
14742 <refentrytitle>xref.label-page.separator</refentrytitle>
14743 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
14746 <refname>xref.label-page.separator</refname>
14747 <refpurpose>Punctuation or space separating label from page number in xref</refpurpose>
14751 <programlisting id="xref.label-page.separator.frag"><xsl:param name="xref.label-page.separator"><xsl:text> </xsl:text></xsl:param></programlisting>
14754 <refsection><info><title>Description</title></info>
14757 This parameter allows you to control the punctuation of certain
14758 types of generated cross reference text.
14759 When cross reference text is generated for an
14760 <tag class="element">xref</tag> or
14761 <tag class="element">olink</tag> element
14762 using an <tag class="attribute">xrefstyle</tag> attribute
14763 that makes use of the <literal>select:</literal> feature,
14764 and the selected components include both label and page
14766 then the value of this parameter is inserted between
14767 label and page number in the output.
14768 If a title is included, then other separators are used.
14774 <refentry version="5.0" id="xref.title-page.separator">
14776 <refentrytitle>xref.title-page.separator</refentrytitle>
14777 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
14780 <refname>xref.title-page.separator</refname>
14781 <refpurpose>Punctuation or space separating title from page number in xref</refpurpose>
14785 <programlisting id="xref.title-page.separator.frag"><xsl:param name="xref.title-page.separator"><xsl:text> </xsl:text></xsl:param></programlisting>
14788 <refsection><info><title>Description</title></info>
14791 This parameter allows you to control the punctuation of certain
14792 types of generated cross reference text.
14793 When cross reference text is generated for an
14794 <tag class="element">xref</tag> or
14795 <tag class="element">olink</tag> element
14796 using an <tag class="attribute">xrefstyle</tag> attribute
14797 that makes use of the <literal>select:</literal> feature,
14798 and the selected components include both title and page number,
14799 then the value of this parameter is inserted between
14800 title and page number in the output.
14806 <refentry version="5.0" id="insert.link.page.number">
14808 <refentrytitle>insert.link.page.number</refentrytitle>
14809 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
14810 <refmiscinfo class="other" otherclass="value">no</refmiscinfo>
14811 <refmiscinfo class="other" otherclass="value">yes</refmiscinfo>
14812 <refmiscinfo class="other" otherclass="value">maybe</refmiscinfo>
14815 <refname>insert.link.page.number</refname>
14816 <refpurpose>Turns page numbers in link elements on and off</refpurpose>
14820 <programlisting id="insert.link.page.number.frag">
14821 <xsl:param name="insert.link.page.number">no</xsl:param>
14825 <refsection><info><title>Description</title></info>
14827 <para>The value of this parameter determines if
14828 cross references using the <tag>link</tag> element in
14829 printed output will
14830 include standard page number citations.
14831 It has three possible values.
14836 <listitem><para>No page number references will be generated.
14841 <listitem><para>Page number references will be generated
14842 for all <tag>link</tag> elements.
14843 The style of page reference may be changed
14844 if an <tag class="attribute">xrefstyle</tag>
14850 <listitem><para>Page number references will not be generated
14851 for a <tag>link</tag> element unless
14853 <tag class="attribute">xrefstyle</tag>
14854 attribute whose value specifies a page reference.
14859 <para>Although the <tag>xrefstyle</tag> attribute
14860 can be used to turn the page reference on or off, it cannot be
14861 used to control the formatting of the page number as it
14862 can in <tag>xref</tag>.
14863 In <tag>link</tag> it will always format with
14864 the style established by the
14865 gentext template with <literal>name="page.citation"</literal>
14866 in the <literal>l:context name="xref"</literal>.
14871 </reference><reference id="lists" xml:base="../fo/param.xml"><title>Lists</title>
14872 <refentry version="5.0" id="compact.list.item.spacing">
14874 <refentrytitle>compact.list.item.spacing</refentrytitle>
14875 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
14878 <refname>compact.list.item.spacing</refname>
14879 <refpurpose>What space do you want between list items (when spacing="compact")?</refpurpose>
14883 <programlisting id="compact.list.item.spacing.frag"><xsl:attribute-set name="compact.list.item.spacing">
14884 <xsl:attribute name="space-before.optimum">0em</xsl:attribute>
14885 <xsl:attribute name="space-before.minimum">0em</xsl:attribute>
14886 <xsl:attribute name="space-before.maximum">0.2em</xsl:attribute>
14887 </xsl:attribute-set></programlisting>
14889 <refsection><info><title>Description</title></info>
14890 <para>Specify what spacing you want between each list item when
14891 <tag class="attribute">spacing</tag> is
14892 <quote><literal>compact</literal></quote>.</para>
14896 <refentry version="5.0" id="itemizedlist.properties">
14898 <refentrytitle>itemizedlist.properties</refentrytitle>
14899 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
14902 <refname>itemizedlist.properties</refname>
14903 <refpurpose>Properties that apply to each list-block generated by itemizedlist.</refpurpose>
14907 <programlisting id="itemizedlist.properties.frag"><xsl:attribute-set name="itemizedlist.properties" use-attribute-sets="list.block.properties">
14908 </xsl:attribute-set></programlisting>
14910 <refsection><info><title>Description</title></info>
14911 <para>Properties that apply to each fo:list-block generated by itemizedlist.</para>
14915 <refentry version="5.0" id="itemizedlist.label.properties">
14917 <refentrytitle>itemizedlist.label.properties</refentrytitle>
14918 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
14921 <refname>itemizedlist.label.properties</refname>
14922 <refpurpose>Properties that apply to each label inside itemized list.</refpurpose>
14926 <programlisting id="itemizedlist.label.properties.frag"><xsl:attribute-set name="itemizedlist.label.properties">
14927 </xsl:attribute-set></programlisting>
14929 <refsection><info><title>Description</title></info>
14930 <para>Properties that apply to each label inside itemized list. E.g.:</para>
14931 <programlisting><xsl:attribute-set name="itemizedlist.label.properties">
14932 <xsl:attribute name="text-align">right</xsl:attribute>
14933 </xsl:attribute-set></programlisting>
14937 <refentry version="5.0" id="itemizedlist.label.width">
14939 <refentrytitle>itemizedlist.label.width</refentrytitle>
14940 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
14943 <refname>itemizedlist.label.width</refname>
14944 <refpurpose>The default width of the label (bullet) in an itemized list.</refpurpose>
14948 <programlisting id="itemizedlist.label.width.frag">
14949 <xsl:param name="itemizedlist.label.width">1.0em</xsl:param>
14953 <refsection><info><title>Description</title></info>
14954 <para>Specifies the default width of the label (usually a bullet or other
14955 symbol) in an itemized list. You can override the default value on any
14956 particular list with the “dbfo” processing instruction using the
14957 “label-width” pseudoattribute.</para>
14961 <refentry version="5.0" id="list.block.properties">
14963 <refentrytitle>list.block.properties</refentrytitle>
14964 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
14967 <refname>list.block.properties</refname>
14968 <refpurpose>Properties that apply to each list-block generated by list.</refpurpose>
14972 <programlisting id="list.block.properties.frag"><xsl:attribute-set name="list.block.properties">
14973 <xsl:attribute name="provisional-label-separation">0.2em</xsl:attribute>
14974 <xsl:attribute name="provisional-distance-between-starts">1.5em</xsl:attribute>
14975 </xsl:attribute-set></programlisting>
14977 <refsection><info><title>Description</title></info>
14978 <para>Properties that apply to each fo:list-block generated by itemizedlist/orderedlist.</para>
14982 <refentry version="5.0" id="list.block.spacing">
14984 <refentrytitle>list.block.spacing</refentrytitle>
14985 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
14988 <refname>list.block.spacing</refname>
14989 <refpurpose>What spacing do you want before and after lists?</refpurpose>
14993 <programlisting id="list.block.spacing.frag"><xsl:attribute-set name="list.block.spacing">
14994 <xsl:attribute name="space-before.optimum">1em</xsl:attribute>
14995 <xsl:attribute name="space-before.minimum">0.8em</xsl:attribute>
14996 <xsl:attribute name="space-before.maximum">1.2em</xsl:attribute>
14997 <xsl:attribute name="space-after.optimum">1em</xsl:attribute>
14998 <xsl:attribute name="space-after.minimum">0.8em</xsl:attribute>
14999 <xsl:attribute name="space-after.maximum">1.2em</xsl:attribute>
15000 </xsl:attribute-set></programlisting>
15002 <refsection><info><title>Description</title></info>
15003 <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>
15007 <refentry version="5.0" id="list.item.spacing">
15009 <refentrytitle>list.item.spacing</refentrytitle>
15010 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
15013 <refname>list.item.spacing</refname>
15014 <refpurpose>What space do you want between list items?</refpurpose>
15018 <programlisting id="list.item.spacing.frag"><xsl:attribute-set name="list.item.spacing">
15019 <xsl:attribute name="space-before.optimum">1em</xsl:attribute>
15020 <xsl:attribute name="space-before.minimum">0.8em</xsl:attribute>
15021 <xsl:attribute name="space-before.maximum">1.2em</xsl:attribute>
15022 </xsl:attribute-set></programlisting>
15024 <refsection><info><title>Description</title></info>
15025 <para>Specify what spacing you want between each list item.</para>
15029 <refentry version="5.0" id="orderedlist.properties">
15031 <refentrytitle>orderedlist.properties</refentrytitle>
15032 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
15035 <refname>orderedlist.properties</refname>
15036 <refpurpose>Properties that apply to each list-block generated by orderedlist.</refpurpose>
15040 <programlisting id="orderedlist.properties.frag"><xsl:attribute-set name="orderedlist.properties" use-attribute-sets="list.block.properties">
15041 <xsl:attribute name="provisional-distance-between-starts">2em</xsl:attribute>
15042 </xsl:attribute-set></programlisting>
15044 <refsection><info><title>Description</title></info>
15045 <para>Properties that apply to each fo:list-block generated by orderedlist.</para>
15049 <refentry version="5.0" id="orderedlist.label.properties">
15051 <refentrytitle>orderedlist.label.properties</refentrytitle>
15052 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
15055 <refname>orderedlist.label.properties</refname>
15056 <refpurpose>Properties that apply to each label inside ordered list.</refpurpose>
15060 <programlisting id="orderedlist.label.properties.frag"><xsl:attribute-set name="orderedlist.label.properties">
15061 </xsl:attribute-set></programlisting>
15063 <refsection><info><title>Description</title></info>
15064 <para>Properties that apply to each label inside ordered list. E.g.:</para>
15065 <programlisting><xsl:attribute-set name="orderedlist.label.properties">
15066 <xsl:attribute name="text-align">right</xsl:attribute>
15067 </xsl:attribute-set></programlisting>
15071 <refentry version="5.0" id="orderedlist.label.width">
15073 <refentrytitle>orderedlist.label.width</refentrytitle>
15074 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
15077 <refname>orderedlist.label.width</refname>
15078 <refpurpose>The default width of the label (number) in an ordered list.</refpurpose>
15082 <programlisting id="orderedlist.label.width.frag">
15083 <xsl:param name="orderedlist.label.width">1.2em</xsl:param>
15087 <refsection><info><title>Description</title></info>
15088 <para>Specifies the default width of the label (usually a number or
15089 sequence of numbers) in an ordered list. You can override the default
15090 value on any particular list with the “dbfo” processing instruction
15091 using the “label-width” pseudoattribute.</para>
15095 <refentry version="5.0" id="variablelist.max.termlength">
15097 <refentrytitle>variablelist.max.termlength</refentrytitle>
15098 <refmiscinfo class="other" otherclass="datatype">number</refmiscinfo>
15101 <refname>variablelist.max.termlength</refname>
15102 <refpurpose>Specifies the longest term in variablelists</refpurpose>
15106 <programlisting id="variablelist.max.termlength.frag">
15107 <xsl:param name="variablelist.max.termlength">24</xsl:param>
15111 <refsection><info><title>Description</title></info>
15113 <para>In variablelists, the <tag>listitem</tag>
15114 is indented to leave room for the
15115 <tag>term</tag> elements. That indent may be computed
15116 if it is not specified with a <tag class="attribute">termlength</tag>
15117 attribute on the <tag>variablelist</tag> element.
15120 The computation counts characters in the
15121 <tag>term</tag> elements in the list
15122 to find the longest term. However, some terms are very long
15123 and would produce extreme indents. This parameter lets you
15124 set a maximum character count. Any terms longer than the maximum
15125 would line wrap. The default value is 24.
15128 The character counts are converted to physical widths
15129 by multiplying by 0.50em. There will be some variability
15130 in how many actual characters fit in the space
15131 since some characters are wider than others.
15137 <refentry version="5.0" id="variablelist.term.separator">
15139 <refentrytitle>variablelist.term.separator</refentrytitle>
15140 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
15143 <refname>variablelist.term.separator</refname>
15144 <refpurpose>Text to separate <tag>term</tag>s within a multi-term
15145 <tag>varlistentry</tag></refpurpose>
15149 <programlisting id="variablelist.term.separator.frag">
15150 <xsl:param name="variablelist.term.separator">, </xsl:param></programlisting>
15153 <refsection><info><title>Description</title></info>
15155 <para>When a <tag>varlistentry</tag> contains multiple <tag>term</tag>
15156 elements, the string specified in the value of the
15157 <parameter>variablelist.term.separator</parameter> parameter is placed
15158 after each <tag>term</tag> except the last.</para>
15161 <para>To generate a line break between multiple <tag>term</tag>s in
15162 a <tag>varlistentry</tag>, set a non-zero value for the
15163 <parameter>variablelist.term.break.after</parameter> parameter. If
15164 you do so, you may also want to set the value of the
15165 <parameter>variablelist.term.separator</parameter> parameter to an
15166 empty string (to suppress rendering of the default comma and space
15167 after each <tag>term</tag>).</para>
15173 <refentry version="5.0" id="variablelist.term.properties">
15175 <refentrytitle>variablelist.term.properties</refentrytitle>
15176 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
15179 <refname>variablelist.term.properties</refname>
15180 <refpurpose>To add properties to the term elements in a variablelist.</refpurpose>
15184 <programlisting id="variablelist.term.properties.frag">
15185 <xsl:attribute-set name="variablelist.term.properties">
15186 </xsl:attribute-set>
15189 <refsection><info><title>Description</title></info>
15190 <para>These properties are added to the block containing a
15191 term in a variablelist.
15192 Use this attribute-set to set
15193 font properties or alignment, for example.</para>
15198 <refentry version="5.0" id="variablelist.term.break.after">
15200 <refentrytitle>variablelist.term.break.after</refentrytitle>
15201 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
15204 <refname>variablelist.term.break.after</refname>
15205 <refpurpose>Generate line break after each <tag>term</tag> within a
15206 multi-term <tag>varlistentry</tag>?</refpurpose>
15210 <programlisting id="variablelist.term.break.after.frag">
15211 <xsl:param name="variablelist.term.break.after">0</xsl:param></programlisting>
15214 <refsection><info><title>Description</title></info>
15216 <para>Set a non-zero value for the
15217 <parameter>variablelist.term.break.after</parameter> parameter to
15218 generate a line break between <tag>term</tag>s in a
15219 multi-term <tag>varlistentry</tag>.</para>
15222 <para>If you set a non-zero value for
15223 <parameter>variablelist.term.break.after</parameter>, you may also
15224 want to set the value of the
15225 <parameter>variablelist.term.separator</parameter> parameter to an
15226 empty string (to suppress rendering of the default comma and space
15227 after each <tag>term</tag>).</para>
15233 </reference><reference id="qa" xml:base="../fo/param.xml"><title>QAndASet</title>
15234 <refentry version="5.0" id="qandadiv.autolabel">
15236 <refentrytitle>qandadiv.autolabel</refentrytitle>
15237 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
15240 <refname>qandadiv.autolabel</refname>
15241 <refpurpose>Are divisions in QAndASets enumerated?</refpurpose>
15245 <programlisting id="qandadiv.autolabel.frag"><xsl:param name="qandadiv.autolabel" select="1"></xsl:param></programlisting>
15248 <refsection><info><title>Description</title></info>
15250 <para>If non-zero, unlabeled qandadivs will be enumerated.
15256 <refentry version="5.0" id="qanda.inherit.numeration">
15258 <refentrytitle>qanda.inherit.numeration</refentrytitle>
15259 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
15262 <refname>qanda.inherit.numeration</refname>
15263 <refpurpose>Does enumeration of QandASet components inherit the numeration of parent elements?</refpurpose>
15267 <programlisting id="qanda.inherit.numeration.frag">
15268 <xsl:param name="qanda.inherit.numeration" select="1"></xsl:param>
15272 <refsection><info><title>Description</title></info>
15274 <para>If non-zero, numbered <tag>qandadiv</tag> elements and
15275 <tag>question</tag> and <tag>answer</tag> inherit the enumeration of
15276 the ancestors of the <tag>qandaset</tag>.
15282 <refentry version="5.0" id="qanda.defaultlabel">
15284 <refentrytitle>qanda.defaultlabel</refentrytitle>
15285 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
15286 <refmiscinfo class="other" otherclass="value">number</refmiscinfo>
15287 <refmiscinfo class="other" otherclass="value">qanda</refmiscinfo>
15288 <refmiscinfo class="other" otherclass="value">none</refmiscinfo>
15291 <refname>qanda.defaultlabel</refname>
15292 <refpurpose>Sets the default for defaultlabel on QandASet.</refpurpose>
15296 <programlisting id="qanda.defaultlabel.frag">
15297 <xsl:param name="qanda.defaultlabel">number</xsl:param>
15301 <refsection><info><title>Description</title></info>
15303 <para>If no <literal>defaultlabel</literal> attribute is specified on
15304 a <tag>qandaset</tag>, this value is used. It is generally one of the legal
15305 values for the defaultlabel attribute (<literal>none</literal>,
15306 <literal>number</literal> or
15307 <literal>qanda</literal>), or one of the additional stylesheet-specific values
15308 (<literal>qnumber</literal> or <literal>qnumberanda</literal>).
15309 The default value is 'number'.
15311 <para>The values are rendered as follows:</para>
15313 <varlistentry><term><literal>qanda</literal></term>
15315 <para><tag>question</tag>s are labeled "Q:" and
15316 <tag>answer</tag>s are labeled "A:". </para>
15320 <varlistentry><term><literal>number</literal></term>
15322 <para>The questions are enumerated and the answers
15323 are not labeled. </para>
15327 <varlistentry><term><literal>qnumber</literal></term>
15329 <para>The questions are labeled "Q:" followed by a number, and answers are not
15331 When sections are numbered, adding a label
15332 to the number distinguishes the question numbers
15333 from the section numbers.
15334 This value is not allowed in the
15335 <tag class="attribute">defaultlabel</tag> attribute
15336 of a <tag>qandaset</tag> element.</para>
15340 <varlistentry><term><literal>qnumberanda</literal></term>
15342 <para>The questions are labeled "Q:" followed by a number, and
15343 the answers are labeled "A:".
15344 When sections are numbered, adding a label
15345 to the number distinguishes the question numbers
15346 from the section numbers.
15347 This value is not allowed in the
15348 <tag class="attribute">defaultlabel</tag> attribute
15349 of a <tag>qandaset</tag> element.</para>
15353 <varlistentry><term><literal>none</literal></term>
15355 <para>No distinguishing label precedes Questions or Answers.
15364 <refentry version="5.0" id="qanda.in.toc">
15366 <refentrytitle>qanda.in.toc</refentrytitle>
15367 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
15370 <refname>qanda.in.toc</refname>
15371 <refpurpose>Should qandaentry questions appear in
15372 the document table of contents?</refpurpose>
15376 <programlisting id="qanda.in.toc.frag"><xsl:param name="qanda.in.toc" select="0"></xsl:param></programlisting>
15379 <refsection><info><title>Description</title></info>
15381 <para>If true (non-zero), then the generated table of contents
15382 for a document will include <tag>qandaset</tag> titles,
15383 <tag>qandadiv</tag> titles,
15384 and <tag>question</tag> elements. The default value (zero) excludes
15387 <para>This parameter does not affect any tables of contents
15388 that may be generated inside a qandaset or qandadiv.
15394 <refentry version="5.0" id="qanda.nested.in.toc">
15396 <refentrytitle>qanda.nested.in.toc</refentrytitle>
15397 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
15400 <refname>qanda.nested.in.toc</refname>
15401 <refpurpose>Should nested answer/qandaentry instances appear in TOC?</refpurpose>
15405 <programlisting id="qanda.nested.in.toc.frag">
15406 <xsl:param name="qanda.nested.in.toc" select="0"></xsl:param>
15410 <refsection><info><title>Description</title></info>
15412 <para>If non-zero, instances of <tag>qandaentry</tag>
15413 that are children of <tag>answer</tag> elements are shown in
15419 </reference><reference id="biblio" xml:base="../fo/param.xml"><title>Bibliography</title>
15420 <refentry version="5.0" id="bibliography.style">
15422 <refentrytitle>bibliography.style</refentrytitle>
15423 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
15424 <refmiscinfo class="other" otherclass="value">normal</refmiscinfo>
15425 <refmiscinfo class="other" otherclass="value">iso690</refmiscinfo>
15428 <refname>bibliography.style</refname>
15429 <refpurpose>Style used for formatting of biblioentries.</refpurpose>
15433 <programlisting id="bibliography.style.frag">
15434 <xsl:param name="bibliography.style">normal</xsl:param>
15438 <refsection><info><title>Description</title></info>
15440 <para>Currently only <literal>normal</literal> and
15441 <literal>iso690</literal> styles are supported.</para>
15443 <para>In order to use ISO690 style to the full extent you might need
15444 to use additional markup described on <link xlink:href="http://wiki.docbook.org/topic/ISO690Bibliography">the
15445 following WiKi page</link>.</para>
15450 <refentry version="5.0" id="biblioentry.item.separator">
15452 <refentrytitle>biblioentry.item.separator</refentrytitle>
15453 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
15456 <refname>biblioentry.item.separator</refname>
15457 <refpurpose>Text to separate bibliography entries</refpurpose>
15461 <programlisting id="biblioentry.item.separator.frag"><xsl:param name="biblioentry.item.separator">. </xsl:param></programlisting>
15464 <refsection><info><title>Description</title></info>
15466 <para>Text to separate bibliography entries
15472 <refentry version="5.0" id="bibliography.collection">
15474 <refentrytitle>bibliography.collection</refentrytitle>
15475 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
15478 <refname>bibliography.collection</refname>
15479 <refpurpose>Name of the bibliography collection file</refpurpose>
15483 <programlisting id="bibliography.collection.frag">
15484 <xsl:param name="bibliography.collection">http://docbook.sourceforge.net/release/bibliography/bibliography.xml</xsl:param>
15489 <refsection><info><title>Description</title></info>
15491 <para>Maintaining bibliography entries across a set of documents is tedious, time
15492 consuming, and error prone. It makes much more sense, usually, to store all of
15493 the bibliography entries in a single place and simply <quote>extract</quote>
15494 the ones you need in each document.</para>
15496 <para>That's the purpose of the
15497 <parameter>bibliography.collection</parameter> parameter. To setup a global
15498 bibliography <quote>database</quote>, follow these steps:</para>
15500 <para>First, create a stand-alone bibliography document that contains all of
15501 the documents that you wish to reference. Make sure that each bibliography
15502 entry (whether you use <tag>biblioentry</tag> or <tag>bibliomixed</tag>)
15505 <para>My global bibliography, <filename>~/bibliography.xml</filename> begins
15509 <programlisting><!DOCTYPE bibliography
15510 PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
15511 "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
15512 <bibliography><title>References</title>
15514 <bibliomixed id="xml-rec"><abbrev>XML 1.0</abbrev>Tim Bray,
15515 Jean Paoli, C. M. Sperberg-McQueen, and Eve Maler, editors.
15516 <citetitle><ulink url="http://www.w3.org/TR/REC-xml">Extensible Markup
15517 Language (XML) 1.0 Second Edition</ulink></citetitle>.
15518 World Wide Web Consortium, 2000.
15519 </bibliomixed>
15521 <bibliomixed id="xml-names"><abbrev>Namespaces</abbrev>Tim Bray,
15523 and Andrew Layman, editors.
15524 <citetitle><ulink url="http://www.w3.org/TR/REC-xml-names/">Namespaces in
15525 XML</ulink></citetitle>.
15526 World Wide Web Consortium, 1999.
15527 </bibliomixed>
15530 </bibliography>
15534 <para>When you create a bibliography in your document, simply
15535 provide <emphasis>empty</emphasis> <tag>bibliomixed</tag>
15536 entries for each document that you wish to cite. Make sure that these
15537 elements have the same ID as the corresponding <quote>real</quote>
15538 entry in your global bibliography.</para>
15540 <para>For example:</para>
15543 <programlisting><bibliography><title>Bibliography</title>
15545 <bibliomixed id="xml-rec"/>
15546 <bibliomixed id="xml-names"/>
15547 <bibliomixed id="DKnuth86">Donald E. Knuth. <citetitle>Computers and
15548 Typesetting: Volume B, TeX: The Program</citetitle>. Addison-Wesley,
15549 1986. ISBN 0-201-13437-3.
15550 </bibliomixed>
15551 <bibliomixed id="relaxng"/>
15553 </bibliography></programlisting>
15556 <para>Note that it's perfectly acceptable to mix entries from your
15557 global bibliography with <quote>normal</quote> entries. You can use
15558 <tag>xref</tag> or other elements to cross-reference your
15559 bibliography entries in exactly the same way you do now.</para>
15561 <para>Finally, when you are ready to format your document, simply set the
15562 <parameter>bibliography.collection</parameter> parameter (in either a
15563 customization layer or directly through your processor's interface) to
15564 point to your global bibliography.</para>
15566 <para>The stylesheets will format the bibliography in your document as if
15567 all of the entries referenced appeared there literally.</para>
15572 <refentry version="5.0" id="bibliography.numbered">
15574 <refentrytitle>bibliography.numbered</refentrytitle>
15575 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
15578 <refname>bibliography.numbered</refname>
15579 <refpurpose>Should bibliography entries be numbered?</refpurpose>
15583 <programlisting id="bibliography.numbered.frag">
15584 <xsl:param name="bibliography.numbered" select="0"></xsl:param>
15588 <refsection><info><title>Description</title></info>
15590 <para>If non-zero bibliography entries will be numbered</para>
15595 <refentry version="5.0" id="biblioentry.properties">
15597 <refentrytitle>biblioentry.properties</refentrytitle>
15598 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
15601 <refname>biblioentry.properties</refname>
15602 <refpurpose>To set the style for biblioentry.</refpurpose>
15606 <programlisting id="biblioentry.properties.frag"><xsl:attribute-set name="biblioentry.properties" use-attribute-sets="normal.para.spacing">
15607 <xsl:attribute name="start-indent">0.5in</xsl:attribute>
15608 <xsl:attribute name="text-indent">-0.5in</xsl:attribute>
15609 </xsl:attribute-set>
15612 <refsection><info><title>Description</title></info>
15613 <para>How do you want biblioentry styled? </para>
15614 <para>Set the font-size, weight, space-above and space-below, indents, etc. to the style required</para>
15619 </reference><reference id="glossary" xml:base="../fo/param.xml"><title>Glossary</title>
15620 <refentry version="5.0" id="glossterm.auto.link">
15622 <refentrytitle>glossterm.auto.link</refentrytitle>
15623 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
15626 <refname>glossterm.auto.link</refname>
15627 <refpurpose>Generate links from glossterm to glossentry automatically?</refpurpose>
15631 <programlisting id="glossterm.auto.link.frag">
15632 <xsl:param name="glossterm.auto.link" select="0"></xsl:param>
15636 <refsection><info><title>Description</title></info>
15638 <para>If non-zero, links from inline <tag>glossterm</tag>s to the corresponding
15639 <tag>glossentry</tag> elements in a <tag>glossary</tag> or <tag>glosslist</tag>
15640 will be automatically generated. This is useful when your glossterms are consistent
15641 and you don't want to add links manually.</para>
15643 <para>The automatic link generation feature is not used on <tag>glossterm</tag> elements
15644 that have a <tag class="attribute">linkend</tag> attribute.</para>
15649 <refentry version="5.0" id="firstterm.only.link">
15651 <refentrytitle>firstterm.only.link</refentrytitle>
15652 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
15655 <refname>firstterm.only.link</refname>
15656 <refpurpose>Does automatic glossterm linking only apply to firstterms?</refpurpose>
15660 <programlisting id="firstterm.only.link.frag">
15661 <xsl:param name="firstterm.only.link" select="0"></xsl:param>
15665 <refsection><info><title>Description</title></info>
15667 <para>If non-zero, only <tag>firstterm</tag>s will be automatically linked
15668 to the glossary. If glossary linking is not enabled, this parameter
15669 has no effect.</para>
15674 <refentry version="5.0" id="glossary.collection">
15676 <refentrytitle>glossary.collection</refentrytitle>
15677 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
15680 <refname>glossary.collection</refname>
15681 <refpurpose>Name of the glossary collection file</refpurpose>
15685 <programlisting id="glossary.collection.frag">
15686 <xsl:param name="glossary.collection"></xsl:param>
15690 <refsection><info><title>Description</title></info>
15692 <para>Glossaries maintained independently across a set of documents
15693 are likely to become inconsistent unless considerable effort is
15694 expended to keep them in sync. It makes much more sense, usually, to
15695 store all of the glossary entries in a single place and simply
15696 <quote>extract</quote> the ones you need in each document.</para>
15698 <para>That's the purpose of the
15699 <parameter>glossary.collection</parameter> parameter. To setup a global
15700 glossary <quote>database</quote>, follow these steps:</para>
15702 <refsection><info><title>Setting Up the Glossary Database</title></info>
15704 <para>First, create a stand-alone glossary document that contains all of
15705 the entries that you wish to reference. Make sure that each glossary
15706 entry has an ID.</para>
15708 <para>Here's an example glossary:</para>
15712 <?xml version="1.0" encoding="utf-8"?>
15713 <!DOCTYPE glossary
15714 PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
15715 "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
15717 <glossaryinfo>
15718 <editor><firstname>Eric</firstname><surname>Raymond</surname></editor>
15719 <title>Jargon File 4.2.3 (abridged)</title>
15720 <releaseinfo>Just some test data</releaseinfo>
15721 </glossaryinfo>
15723 <glossdiv><title>0</title>
15726 <glossterm>0</glossterm>
15728 <para>Numeric zero, as opposed to the letter `O' (the 15th letter of
15729 the English alphabet). In their unmodified forms they look a lot
15730 alike, and various kluges invented to make them visually distinct have
15731 compounded the confusion. If your zero is center-dotted and letter-O
15732 is not, or if letter-O looks almost rectangular but zero looks more
15733 like an American football stood on end (or the reverse), you're
15734 probably looking at a modern character display (though the dotted zero
15735 seems to have originated as an option on IBM 3270 controllers). If
15736 your zero is slashed but letter-O is not, you're probably looking at
15737 an old-style ASCII graphic set descended from the default typewheel on
15738 the venerable ASR-33 Teletype (Scandinavians, for whom /O is a letter,
15739 curse this arrangement). (Interestingly, the slashed zero long
15740 predates computers; Florian Cajori's monumental "A History of
15741 Mathematical Notations" notes that it was used in the twelfth and
15742 thirteenth centuries.) If letter-O has a slash across it and the zero
15743 does not, your display is tuned for a very old convention used at IBM
15744 and a few other early mainframe makers (Scandinavians curse <emphasis>this</emphasis>
15745 arrangement even more, because it means two of their letters collide).
15746 Some Burroughs/Unisys equipment displays a zero with a <emphasis>reversed</emphasis>
15747 slash. Old CDC computers rendered letter O as an unbroken oval and 0
15748 as an oval broken at upper right and lower left. And yet another
15749 convention common on early line printers left zero unornamented but
15750 added a tail or hook to the letter-O so that it resembled an inverted
15751 Q or cursive capital letter-O (this was endorsed by a draft ANSI
15752 standard for how to draw ASCII characters, but the final standard
15753 changed the distinguisher to a tick-mark in the upper-left corner).
15754 Are we sufficiently confused yet?</para>
15756 </glossentry>
15759 <glossterm>1TBS</glossterm>
15761 <para role="accidence">
15762 <phrase role="pronounce"></phrase>
15763 <phrase role="partsofspeach">n</phrase>
15765 <para>The "One True Brace Style"</para>
15766 <glossseealso>indent style</glossseealso>
15768 </glossentry>
15776 </glossary></programlisting>
15781 <refsection><info><title>Marking Up Glossary Terms</title></info>
15783 <para>That takes care of the glossary database, now you have to get the entries
15784 into your document. Unlike bibliography entries, which can be empty, creating
15785 <quote>placeholder</quote> glossary entries would be very tedious. So instead,
15786 support for <parameter>glossary.collection</parameter> relies on implicit linking.</para>
15788 <para>In your source document, simply use <tag>firstterm</tag> and
15789 <tag>glossterm</tag> to identify the terms you wish to have included
15790 in the glossary. The stylesheets assume that you will either set the
15791 <tag class="attribute">baseform</tag> attribute correctly, or that the
15792 content of the element exactly matches a term in your glossary.</para>
15794 <para>If you're using a <parameter>glossary.collection</parameter>, don't
15795 make explicit links on the terms in your document.</para>
15797 <para>So, in your document, you might write things like this:</para>
15800 <programlisting><para>This is dummy text, without any real meaning.
15801 The point is simply to reference glossary terms like <glossterm>0</glossterm>
15802 and the <firstterm baseform="1TBS">One True Brace Style (1TBS)</firstterm>.
15803 The <glossterm>1TBS</glossterm>, as you can probably imagine, is a nearly
15804 religious issue.</para></programlisting>
15807 <para>If you set the <parameter>firstterm.only.link</parameter> parameter,
15808 only the terms marked with <tag>firstterm</tag> will be links.
15809 Otherwise, all the terms will be linked.</para>
15813 <refsection><info><title>Marking Up the Glossary</title></info>
15815 <para>The glossary itself has to be identified for the stylesheets. For lack
15816 of a better choice, the <tag class="attribute">role</tag> is used.
15817 To identify the glossary as the target for automatic processing, set
15818 the role to <quote><literal>auto</literal></quote>. The title of this
15819 glossary (and any other information from the <tag>glossaryinfo</tag>
15820 that's rendered by your stylesheet) will be displayed, but the entries will
15821 come from the database.
15824 <para>Unfortunately, the glossary can't be empty, so you must put in
15825 at least one <tag>glossentry</tag>. The content of this entry
15826 is irrelevant, it will not be rendered:</para>
15829 <programlisting><glossary role="auto">
15831 <glossterm>Irrelevant</glossterm>
15833 <para>If you can see this, the document was processed incorrectly. Use
15834 the <parameter>glossary.collection</parameter> parameter.</para>
15836 </glossentry>
15837 </glossary></programlisting>
15840 <para>What about glossary divisions? If your glossary database has glossary
15841 divisions <emphasis>and</emphasis> your automatic glossary contains at least
15842 one <tag>glossdiv</tag>, the automic glossary will have divisions.
15843 If the <tag>glossdiv</tag> is missing from either location, no divisions
15844 will be rendered.</para>
15846 <para>Glossary entries (and divisions, if appropriate) in the glossary will
15847 occur in precisely the order they occur in your database.</para>
15851 <refsection><info><title>Formatting the Document</title></info>
15853 <para>Finally, when you are ready to format your document, simply set the
15854 <parameter>glossary.collection</parameter> parameter (in either a
15855 customization layer or directly through your processor's interface) to
15856 point to your global glossary.</para>
15858 <para>The stylesheets will format the glossary in your document as if
15859 all of the entries implicilty referenced appeared there literally.</para>
15862 <refsection><info><title>Limitations</title></info>
15864 <para>Glossary cross-references <emphasis>within the glossary</emphasis> are
15865 not supported. For example, this <emphasis>will not</emphasis> work:</para>
15868 <programlisting><glossentry>
15869 <glossterm>gloss-1</glossterm>
15870 <glossdef><para>A description that references <glossterm>gloss-2</glossterm>.</para>
15871 <glossseealso>gloss-2</glossseealso>
15873 </glossentry></programlisting>
15876 <para>If you put glossary cross-references in your glossary that way,
15877 you'll get the cryptic error: <computeroutput>Warning:
15878 glossary.collection specified, but there are 0 automatic
15879 glossaries</computeroutput>.</para>
15881 <para>Instead, you must do two things:</para>
15885 <para>Markup your glossary using <tag>glossseealso</tag>:</para>
15888 <programlisting><glossentry>
15889 <glossterm>gloss-1</glossterm>
15890 <glossdef><para>A description that references <glossterm>gloss-2</glossterm>.</para>
15891 <glossseealso>gloss-2</glossseealso>
15893 </glossentry></programlisting>
15898 <para>Make sure there is at least one <tag>glossterm</tag> reference to
15899 <glossterm>gloss-2</glossterm> <emphasis>in your document</emphasis>. The
15900 easiest way to do that is probably within a <tag>remark</tag> in your
15901 automatic glossary:</para>
15904 <programlisting><glossary role="auto">
15905 <remark>Make sure there's a reference to <glossterm>gloss-2</glossterm>.</remark>
15907 <glossterm>Irrelevant</glossterm>
15909 <para>If you can see this, the document was processed incorrectly. Use
15910 the <parameter>glossary.collection</parameter> parameter.</para>
15912 </glossentry>
15913 </glossary></programlisting>
15922 <refentry version="5.0" id="glossary.as.blocks">
15924 <refentrytitle>glossary.as.blocks</refentrytitle>
15925 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
15928 <refname>glossary.as.blocks</refname>
15929 <refpurpose>Present glossarys using blocks instead of lists?</refpurpose>
15933 <programlisting id="glossary.as.blocks.frag">
15934 <xsl:param name="glossary.as.blocks" select="0"></xsl:param>
15938 <refsection><info><title>Description</title></info>
15940 <para>If non-zero, <tag>glossary</tag>s will be formatted as
15943 <para>If you have long <tag>glossterm</tag>s, proper list
15944 markup in the FO case may produce unattractive lists. By setting this
15945 parameter, you can force the stylesheets to produce block markup
15946 instead of proper lists.</para>
15948 <para>You can override this setting with a processing instruction as the
15949 child of <tag>glossary</tag>: <tag class="xmlpi">dbfo
15950 glossary-presentation="blocks"</tag> or <tag class="xmlpi">dbfo
15951 glossary-presentation="list"</tag></para>
15956 <refentry version="5.0" id="glosslist.as.blocks">
15958 <refentrytitle>glosslist.as.blocks</refentrytitle>
15959 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
15962 <refname>glosslist.as.blocks</refname>
15963 <refpurpose>Use blocks for glosslists?</refpurpose>
15967 <programlisting id="glosslist.as.blocks.frag">
15968 <xsl:param name="glosslist.as.blocks" select="0"></xsl:param>
15972 <refsection><info><title>Description</title></info>
15974 <para>See <parameter>glossary.as.blocks</parameter>.</para>
15979 <refentry version="5.0" id="glossentry.list.item.properties">
15981 <refentrytitle>glossentry.list.item.properties</refentrytitle>
15982 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
15985 <refname>glossentry.list.item.properties</refname>
15986 <refpurpose>To add properties to each glossentry in a list.</refpurpose>
15990 <programlisting id="glossentry.list.item.properties.frag"><xsl:attribute-set name="glossentry.list.item.properties">
15991 <xsl:attribute name="space-before.optimum">1em</xsl:attribute>
15992 <xsl:attribute name="space-before.minimum">0.8em</xsl:attribute>
15993 <xsl:attribute name="space-before.maximum">1.2em</xsl:attribute>
15994 </xsl:attribute-set>
15997 <refsection><info><title>Description</title></info>
15998 <para>These properties are added to the fo:list-item containing a
15999 glossentry in a glossary when the <parameter>glossary.as.blocks</parameter> parameter
16001 Use this attribute-set to set
16002 spacing between entries, for example.</para>
16007 <refentry version="5.0" id="glossterm.block.properties">
16009 <refentrytitle>glossterm.block.properties</refentrytitle>
16010 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
16013 <refname>glossterm.block.properties</refname>
16014 <refpurpose>To add properties to the block of a glossentry's glossterm.</refpurpose>
16018 <programlisting id="glossterm.block.properties.frag"><xsl:attribute-set name="glossterm.block.properties">
16019 <xsl:attribute name="space-before.optimum">1em</xsl:attribute>
16020 <xsl:attribute name="space-before.minimum">0.8em</xsl:attribute>
16021 <xsl:attribute name="space-before.maximum">1.2em</xsl:attribute>
16022 <xsl:attribute name="keep-with-next.within-column">always</xsl:attribute>
16023 <xsl:attribute name="keep-together.within-column">always</xsl:attribute>
16024 </xsl:attribute-set>
16027 <refsection><info><title>Description</title></info>
16028 <para>These properties are added to the block containing a
16029 glossary term in a glossary when the <parameter>glossary.as.blocks</parameter> parameter
16031 Use this attribute-set to set the space above and below,
16033 and any indent for the glossary term.</para>
16038 <refentry version="5.0" id="glossdef.block.properties">
16040 <refentrytitle>glossdef.block.properties</refentrytitle>
16041 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
16044 <refname>glossdef.block.properties</refname>
16045 <refpurpose>To add properties to the block of a glossary definition.</refpurpose>
16049 <programlisting id="glossdef.block.properties.frag"><xsl:attribute-set name="glossdef.block.properties">
16050 <xsl:attribute name="margin-{$direction.align.start}">.25in</xsl:attribute>
16051 </xsl:attribute-set>
16054 <refsection><info><title>Description</title></info>
16055 <para>These properties are added to the block containing a
16056 glossary definition in a glossary when
16057 the <parameter>glossary.as.blocks</parameter> parameter
16059 Use this attribute-set to set the space above and below,
16060 any font properties,
16061 and any indent for the glossary definition.</para>
16066 <refentry version="5.0" id="glossterm.list.properties">
16068 <refentrytitle>glossterm.list.properties</refentrytitle>
16069 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
16072 <refname>glossterm.list.properties</refname>
16073 <refpurpose>To add properties to the glossterm in a list.</refpurpose>
16077 <programlisting id="glossterm.list.properties.frag">
16078 <xsl:attribute-set name="glossterm.list.properties">
16079 </xsl:attribute-set>
16082 <refsection><info><title>Description</title></info>
16083 <para>These properties are added to the block containing a
16084 glossary term in a glossary when the <parameter>glossary.as.blocks</parameter> parameter
16086 Use this attribute-set to set
16087 font properties, for example.</para>
16092 <refentry version="5.0" id="glossdef.list.properties">
16094 <refentrytitle>glossdef.list.properties</refentrytitle>
16095 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
16098 <refname>glossdef.list.properties</refname>
16099 <refpurpose>To add properties to the glossary definition in a list.</refpurpose>
16103 <programlisting id="glossdef.list.properties.frag">
16104 <xsl:attribute-set name="glossdef.list.properties">
16105 </xsl:attribute-set>
16108 <refsection><info><title>Description</title></info>
16109 <para>These properties are added to the block containing a
16110 glossary definition in a glossary when
16111 the <parameter>glossary.as.blocks</parameter> parameter
16113 Use this attribute-set to set font properties, for example.</para>
16118 <refentry version="5.0" id="glossterm.width">
16120 <refentrytitle>glossterm.width</refentrytitle>
16121 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
16124 <refname>glossterm.width</refname>
16125 <refpurpose>Width of glossterm in list presentation mode</refpurpose>
16129 <programlisting id="glossterm.width.frag">
16130 <xsl:param name="glossterm.width">2in</xsl:param>
16134 <refsection><info><title>Description</title></info>
16136 <para>This parameter specifies the width reserved for glossary terms when
16137 a list presentation is used.</para>
16142 <refentry version="5.0" id="glossterm.separation">
16144 <refentrytitle>glossterm.separation</refentrytitle>
16145 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
16148 <refname>glossterm.separation</refname>
16149 <refpurpose>Separation between glossary terms and descriptions in list mode</refpurpose>
16153 <programlisting id="glossterm.separation.frag">
16154 <xsl:param name="glossterm.separation">0.25in</xsl:param>
16158 <refsection><info><title>Description</title></info>
16160 <para>Specifies the miminum horizontal
16161 separation between glossary terms and descriptions when
16162 they are presented side-by-side using lists
16163 when the <parameter>glossary.as.blocks</parameter>
16169 <refentry version="5.0" id="glossentry.show.acronym">
16171 <refentrytitle>glossentry.show.acronym</refentrytitle>
16172 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
16173 <refmiscinfo class="other" otherclass="value">no</refmiscinfo>
16174 <refmiscinfo class="other" otherclass="value">yes</refmiscinfo>
16175 <refmiscinfo class="other" otherclass="value">primary</refmiscinfo>
16178 <refname>glossentry.show.acronym</refname>
16179 <refpurpose>Display <tag>glossentry</tag> acronyms?</refpurpose>
16183 <programlisting id="glossentry.show.acronym.frag">
16184 <xsl:param name="glossentry.show.acronym">no</xsl:param>
16188 <refsection><info><title>Description</title></info>
16190 <para>A setting of <quote>yes</quote> means they should be displayed;
16191 <quote>no</quote> means they shouldn't. If <quote>primary</quote> is used,
16192 then they are shown as the primary text for the entry.</para>
16195 <para>This setting controls both <tag>acronym</tag> and
16196 <tag>abbrev</tag> elements in the <tag>glossentry</tag>.</para>
16202 <refentry version="5.0" id="glossary.sort">
16204 <refentrytitle>glossary.sort</refentrytitle>
16205 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
16208 <refname>glossary.sort</refname>
16209 <refpurpose>Sort glossentry elements?</refpurpose>
16213 <programlisting id="glossary.sort.frag">
16214 <xsl:param name="glossary.sort" select="0"></xsl:param>
16218 <refsection><info><title>Description</title></info>
16220 <para>If non-zero, then the glossentry elements within a
16221 glossary, glossdiv, or glosslist are sorted on the glossterm, using
16222 the current lang setting. If zero (the default), then
16223 glossentry elements are not sorted and are presented
16230 </reference><reference id="misc" xml:base="../fo/param.xml"><title>Miscellaneous</title>
16231 <refentry version="5.0" id="formal.procedures">
16233 <refentrytitle>formal.procedures</refentrytitle>
16234 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
16237 <refname>formal.procedures</refname>
16238 <refpurpose>Selects formal or informal procedures</refpurpose>
16242 <programlisting id="formal.procedures.frag">
16243 <xsl:param name="formal.procedures" select="1"></xsl:param>
16247 <refsection><info><title>Description</title></info>
16249 <para>Formal procedures are numbered and always have a title.
16255 <refentry version="5.0" id="formal.title.placement">
16257 <refentrytitle>formal.title.placement</refentrytitle>
16258 <refmiscinfo class="other" otherclass="datatype">table</refmiscinfo>
16261 <refname>formal.title.placement</refname>
16262 <refpurpose>Specifies where formal object titles should occur</refpurpose>
16266 <programlisting id="formal.title.placement.frag">
16267 <xsl:param name="formal.title.placement">
16278 <refsection><info><title>Description</title></info>
16280 <para>Specifies where formal object titles should occur. For each formal object
16281 type (<tag>figure</tag>,
16282 <tag>example</tag>,
16283 <tag>equation</tag>,
16284 <tag>table</tag>, and <tag>procedure</tag>)
16285 you can specify either the keyword
16286 <quote><literal>before</literal></quote> or
16287 <quote><literal>after</literal></quote>.</para>
16292 <refentry version="5.0" id="runinhead.default.title.end.punct">
16294 <refentrytitle>runinhead.default.title.end.punct</refentrytitle>
16295 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
16298 <refname>runinhead.default.title.end.punct</refname>
16299 <refpurpose>Default punctuation character on a run-in-head</refpurpose>
16303 <programlisting id="runinhead.default.title.end.punct.frag"><xsl:param name="runinhead.default.title.end.punct">.</xsl:param>
16307 <refsection><info><title>Description</title></info>
16309 <para>If non-zero, For a <tag>formalpara</tag>, use the specified
16310 string as the separator between the title and following text. The period is the default value.</para>
16315 <refentry version="5.0" id="runinhead.title.end.punct">
16317 <refentrytitle>runinhead.title.end.punct</refentrytitle>
16318 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
16321 <refname>runinhead.title.end.punct</refname>
16322 <refpurpose>Characters that count as punctuation on a run-in-head</refpurpose>
16326 <programlisting id="runinhead.title.end.punct.frag">
16327 <xsl:param name="runinhead.title.end.punct">.!?:</xsl:param>
16331 <refsection><info><title>Description</title></info>
16333 <para>Specify which characters are to be counted as punctuation. These
16334 characters are checked for a match with the last character of the
16335 title. If no match is found, the
16336 <parameter>runinhead.default.title.end.punct</parameter> contents are
16337 inserted. This is to avoid duplicated punctuation in the output.
16343 <refentry version="5.0" id="show.comments">
16345 <refentrytitle>show.comments</refentrytitle>
16346 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
16349 <refname>show.comments</refname>
16350 <refpurpose>Display <tag>remark</tag> elements?</refpurpose>
16354 <programlisting id="show.comments.frag">
16355 <xsl:param name="show.comments" select="1"></xsl:param>
16359 <refsection><info><title>Description</title></info>
16361 <para>If non-zero, comments will be displayed, otherwise they
16362 are suppressed. Comments here refers to the <tag>remark</tag> element
16363 (which was called <literal>comment</literal> prior to DocBook
16364 4.0), not XML comments (<-- like this -->) which are
16371 <refentry version="5.0" id="punct.honorific">
16373 <refentrytitle>punct.honorific</refentrytitle>
16374 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
16377 <refname>punct.honorific</refname>
16378 <refpurpose>Punctuation after an honorific in a personal name.</refpurpose>
16382 <programlisting id="punct.honorific.frag">
16383 <xsl:param name="punct.honorific">.</xsl:param>
16387 <refsection><info><title>Description</title></info>
16389 <para>This parameter specifies the punctuation that should be added after an
16390 honorific in a personal name.</para>
16395 <refentry version="5.0" id="segmentedlist.as.table">
16397 <refentrytitle>segmentedlist.as.table</refentrytitle>
16398 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
16401 <refname>segmentedlist.as.table</refname>
16402 <refpurpose>Format segmented lists as tables?</refpurpose>
16406 <programlisting id="segmentedlist.as.table.frag">
16407 <xsl:param name="segmentedlist.as.table" select="0"></xsl:param>
16411 <refsection><info><title>Description</title></info>
16413 <para>If non-zero, <tag>segmentedlist</tag>s will be formatted as
16419 <refentry version="5.0" id="variablelist.as.blocks">
16421 <refentrytitle>variablelist.as.blocks</refentrytitle>
16422 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
16425 <refname>variablelist.as.blocks</refname>
16426 <refpurpose>Format <tag>variablelist</tag>s lists as blocks?</refpurpose>
16430 <programlisting id="variablelist.as.blocks.frag">
16431 <xsl:param name="variablelist.as.blocks" select="0"></xsl:param>
16435 <refsection><info><title>Description</title></info>
16437 <para>If non-zero, <tag>variablelist</tag>s will be formatted as
16440 <para>If you have long terms, proper list markup in the FO case may produce
16441 unattractive lists. By setting this parameter, you can force the stylesheets
16442 to produce block markup instead of proper lists.</para>
16444 <para>You can override this setting with a processing instruction as the
16445 child of <tag>variablelist</tag>: <tag class="xmlpi">dbfo
16446 list-presentation="blocks"</tag> or <tag class="xmlpi">dbfo
16447 list-presentation="list"</tag>.</para>
16449 <para>When using <literal>list-presentation="list"</literal>,
16450 you can also control the amount of space used for the <tag>term</tag>s with
16451 the <tag class="xmlpi">dbfo term-width=".25in"</tag> processing instruction,
16452 the <tag class="attribute">termlength</tag> attribute on <tag>variablelist</tag>,
16453 or allow the stylesheets to attempt to calculate the amount of space to leave based on the
16454 number of letters in the longest term.
16457 <programlisting> <variablelist>
16458 <?dbfo list-presentation="list"?>
16459 <?dbfo term-width="1.5in"?>
16460 <?dbhtml list-presentation="table"?>
16461 <?dbhtml term-width="1.5in"?>
16462 <varlistentry>
16463 <term>list</term>
16466 Formatted as a list even if variablelist.as.blocks is set to 1.
16469 </varlistentry>
16470 </variablelist></programlisting>
16477 <refentry version="5.0" id="blockquote.properties">
16479 <refentrytitle>blockquote.properties</refentrytitle>
16480 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
16483 <refname>blockquote.properties</refname>
16484 <refpurpose>To set the style for block quotations.</refpurpose>
16488 <programlisting id="blockquote.properties.frag">
16489 <xsl:attribute-set name="blockquote.properties">
16490 <xsl:attribute name="margin-{$direction.align.start}">0.5in</xsl:attribute>
16491 <xsl:attribute name="margin-{$direction.align.end}">0.5in</xsl:attribute>
16492 <xsl:attribute name="space-after.minimum">0.5em</xsl:attribute>
16493 <xsl:attribute name="space-after.optimum">1em</xsl:attribute>
16494 <xsl:attribute name="space-after.maximum">2em</xsl:attribute>
16495 </xsl:attribute-set>
16499 <refsection><info><title>Description</title></info>
16501 <para>The <parameter>blockquote.properties</parameter> attribute set specifies
16502 the formating properties of block quotations.</para>
16507 <refentry version="5.0" id="ulink.show">
16509 <refentrytitle>ulink.show</refentrytitle>
16510 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
16513 <refname>ulink.show</refname>
16514 <refpurpose>Display URLs after <tag>ulink</tag>s?</refpurpose>
16518 <programlisting id="ulink.show.frag">
16519 <xsl:param name="ulink.show" select="1"></xsl:param>
16523 <refsection><info><title>Description</title></info>
16525 <para>If non-zero, the URL of each <tag>ulink</tag> will
16526 appear after the text of the link. If the text of the link and the URL
16527 are identical, the URL is suppressed. </para>
16529 <para>See also <parameter>ulink.footnotes</parameter>.</para>
16531 <note><para>DocBook 5 does not have an <tag>ulink</tag> element. When processing
16532 DocBoook 5 documents, <parameter>ulink.show</parameter> applies to all inline
16533 elements that are marked up with <tag class="attribute">xlink:href</tag> attributes
16534 that point to external resources.</para>
16540 <refentry version="5.0" id="ulink.footnotes">
16542 <refentrytitle>ulink.footnotes</refentrytitle>
16543 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
16546 <refname>ulink.footnotes</refname>
16547 <refpurpose>Generate footnotes for <tag>ulink</tag>s?</refpurpose>
16551 <programlisting id="ulink.footnotes.frag">
16552 <xsl:param name="ulink.footnotes" select="0"></xsl:param>
16556 <refsection><info><title>Description</title></info>
16558 <para>If non-zero, and if <parameter>ulink.show</parameter> also is non-zero,
16559 the URL of each <tag>ulink</tag> will appear as a footnote.</para>
16561 <note><para>DocBook 5 does not have an <tag>ulink</tag> element. When processing
16562 DocBoook 5 documents, <parameter>ulink.footnotes</parameter> applies to all inline
16563 elements that are marked up with <tag class="attribute">xlink:href</tag> attributes
16564 that point to external resources.</para>
16570 <refentry version="5.0" id="ulink.hyphenate">
16572 <refentrytitle>ulink.hyphenate</refentrytitle>
16573 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
16576 <refname>ulink.hyphenate</refname>
16577 <refpurpose>Allow URLs to be automatically hyphenated</refpurpose>
16581 <programlisting id="ulink.hyphenate.frag">
16582 <xsl:param name="ulink.hyphenate"></xsl:param>
16586 <refsection><info><title>Description</title></info>
16588 <para>If not empty, the specified character (or more generally, content) is
16589 added to URLs after every character included in the string
16590 in the <parameter>ulink.hyphenate.chars</parameter> parameter (default
16591 is <quote>/</quote>). If the character in this parameter is a
16592 Unicode soft hyphen (0x00AD) or Unicode zero-width space (0x200B), some FO
16593 processors will be able to reasonably hyphenate long URLs.</para>
16595 <para>As of 28 Jan 2002, discretionary hyphens are more widely and correctly
16596 supported than zero-width spaces for this purpose.</para>
16601 <refentry version="5.0" id="ulink.hyphenate.chars">
16603 <refentrytitle>ulink.hyphenate.chars</refentrytitle>
16604 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
16607 <refname>ulink.hyphenate.chars</refname>
16608 <refpurpose>List of characters to allow ulink URLs to be automatically hyphenated on</refpurpose>
16612 <programlisting id="ulink.hyphenate.chars.frag">
16613 <xsl:param name="ulink.hyphenate.chars">/</xsl:param>
16617 <refsection><info><title>Description</title></info>
16619 <para>If the <parameter>ulink.hyphenate</parameter> is not empty, then
16620 hyphenation of ulinks is turned on, and any
16621 character contained in this parameter is treated as an allowable
16622 hyphenation point.</para>
16624 <para>The default value is <quote>/</quote>, but the parameter
16625 could be customized
16626 to contain other URL characters, as for example:</para>
16628 <xsl:param name="ulink.hyphenate.chars">:/@&?.#</xsl:param>
16634 <refentry version="5.0" id="shade.verbatim">
16636 <refentrytitle>shade.verbatim</refentrytitle>
16637 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
16640 <refname>shade.verbatim</refname>
16641 <refpurpose>Should verbatim environments be shaded?</refpurpose>
16645 <programlisting id="shade.verbatim.frag"><xsl:param name="shade.verbatim" select="0"></xsl:param></programlisting>
16648 <refsection><info><title>Description</title></info>
16650 <para>In the FO stylesheet, if this parameter is non-zero then the
16651 <property>shade.verbatim.style</property> properties will be applied
16652 to verbatim environments.</para>
16654 <para>In the HTML stylesheet, this parameter is now deprecated. Use
16655 CSS instead.</para>
16660 <refentry version="5.0" id="shade.verbatim.style">
16662 <refentrytitle>shade.verbatim.style</refentrytitle>
16663 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
16666 <refname>shade.verbatim.style</refname>
16667 <refpurpose>Properties that specify the style of shaded verbatim listings</refpurpose>
16671 <programlisting id="shade.verbatim.style.frag">
16673 <xsl:attribute-set name="shade.verbatim.style">
16674 <xsl:attribute name="background-color">#E0E0E0</xsl:attribute>
16675 </xsl:attribute-set>
16679 <refsection><info><title>Description</title></info>
16681 <para>Properties that specify the style of shaded verbatim listings. The
16682 parameters specified (the border and background color) are added to
16683 the styling of the xsl-fo output. A border might be specified as "thin
16684 black solid" for example. See <link xlink:href="http://www.w3.org/TR/2004/WD-xsl11-20041216/#border">xsl-fo</link></para>
16689 <refentry version="5.0" id="hyphenate.verbatim">
16691 <refentrytitle>hyphenate.verbatim</refentrytitle>
16692 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
16695 <refname>hyphenate.verbatim</refname>
16696 <refpurpose>Should verbatim environments be hyphenated on space characters?</refpurpose>
16700 <programlisting id="hyphenate.verbatim.frag"><xsl:param name="hyphenate.verbatim" select="0"></xsl:param></programlisting>
16703 <refsection><info><title>Description</title></info>
16705 <para>If the lines of program listing are too long to fit into one
16706 line it is quite common to split them at space and indicite by hook
16707 arrow that code continues on the next line. You can turn on this
16708 behaviour for <tag>programlisting</tag>,
16709 <tag>screen</tag> and <tag>synopsis</tag> elements by
16710 using this parameter.</para>
16712 <para>Note that you must also enable line wrapping for verbatim environments and
16713 select appropriate hyphenation character (e.g. hook arrow). This can
16714 be done using <parameter>monospace.verbatim.properties</parameter>
16715 attribute set:</para>
16717 <programlisting><xsl:attribute-set name="monospace.verbatim.properties"
16718 use-attribute-sets="verbatim.properties monospace.properties">
16719 <xsl:attribute name="wrap-option">wrap</xsl:attribute>
16720 <xsl:attribute name="hyphenation-character">&#x25BA;</xsl:attribute>
16721 </xsl:attribute-set></programlisting>
16723 <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
16724 selected character is available in the font you are using for verbatim
16725 environments.</para>
16730 <refentry version="5.0" id="hyphenate.verbatim.characters">
16732 <refentrytitle>hyphenate.verbatim.characters</refentrytitle>
16733 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
16736 <refname>hyphenate.verbatim.characters</refname>
16737 <refpurpose>List of characters after which a line break can occur in listings</refpurpose>
16741 <programlisting id="hyphenate.verbatim.characters.frag">
16742 <xsl:param name="hyphenate.verbatim.characters"></xsl:param>
16746 <refsection><info><title>Description</title></info>
16748 <para>If you enable <parameter>hyphenate.verbatim</parameter> line
16749 breaks are allowed only on space characters. If this is not enough for
16750 your document, you can specify list of additional characters after
16751 which line break is allowed in this parameter.</para>
16756 <refentry version="5.0" id="use.svg">
16758 <refentrytitle>use.svg</refentrytitle>
16759 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
16762 <refname>use.svg</refname>
16763 <refpurpose>Allow SVG in the result tree?</refpurpose>
16767 <programlisting id="use.svg.frag">
16768 <xsl:param name="use.svg" select="1"></xsl:param>
16772 <refsection><info><title>Description</title></info>
16774 <para>If non-zero, SVG will be considered an acceptable image format. SVG
16775 is passed through to the result tree, so correct rendering of the resulting
16776 diagram depends on the formatter (FO processor or web browser) that is used
16777 to process the output from the stylesheet.</para>
16782 <refentry version="5.0" id="use.role.as.xrefstyle">
16784 <refentrytitle>use.role.as.xrefstyle</refentrytitle>
16785 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
16788 <refname>use.role.as.xrefstyle</refname>
16789 <refpurpose>Use <tag class="attribute">role</tag> attribute for
16790 <tag class="attribute">xrefstyle</tag> on <tag>xref</tag>?</refpurpose>
16794 <programlisting id="use.role.as.xrefstyle.frag">
16795 <xsl:param name="use.role.as.xrefstyle" select="1"></xsl:param>
16799 <refsection><info><title>Description</title></info>
16801 <para>In DocBook documents that conform to a schema older than V4.3, this parameter allows
16802 <tag class="attribute">role</tag> to serve the purpose of specifying the cross reference style.</para>
16804 <para>If non-zero, the <tag class="attribute">role</tag> attribute on
16805 <tag>xref</tag> will be used to select the cross reference style.
16806 In DocBook V4.3, the <tag class="attribute">xrefstyle</tag> attribute was added for this purpose.
16807 If the <tag class="attribute">xrefstyle</tag> attribute is present,
16808 <tag class="attribute">role</tag> will be ignored, regardless of the setting
16809 of this parameter.</para>
16813 <refsection><info><title>Example</title></info>
16815 <para>The following small stylesheet shows how to configure the
16816 stylesheets to make use of the cross reference style:</para>
16818 <programlisting><?xml version="1.0"?>
16819 <xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
16822 <xsl:import href="../xsl/html/docbook.xsl"/>
16824 <xsl:output method="html"/>
16826 <xsl:param name="local.l10n.xml" select="document('')"/>
16827 <l:i18n xmlns:l="http://docbook.sourceforge.net/xmlns/l10n/1.0">
16828 <l:l10n xmlns:l="http://docbook.sourceforge.net/xmlns/l10n/1.0" language="en">
16829 <l:context name="xref">
16830 <l:template name="chapter" style="title" text="Chapter %n, %t"/>
16831 <l:template name="chapter" text="Chapter %n"/>
16836 </xsl:stylesheet></programlisting>
16838 <para>With this stylesheet, the cross references in the following document:</para>
16840 <programlisting><?xml version="1.0" encoding="utf-8"?>
16841 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
16842 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
16843 <book id="book"><title>Book</title>
16846 <title>Preface</title>
16848 <para>Normal: <xref linkend="ch1"/>.</para>
16849 <para>Title: <xref xrefstyle="title" linkend="ch1"/>.</para>
16853 <chapter id="ch1">
16854 <title>First Chapter</title>
16856 <para>Irrelevant.</para>
16859 </book></programlisting>
16861 <para>will appear as:</para>
16864 <para>Normal: Chapter 1.</para>
16865 <para>Title: Chapter 1, <emphasis>First Chapter</emphasis>.</para>
16871 <refentry version="5.0" id="menuchoice.separator">
16873 <refentrytitle>menuchoice.separator</refentrytitle>
16874 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
16877 <refname>menuchoice.separator</refname>
16878 <refpurpose>Separator between items of a <tag>menuchoice</tag>
16879 other than <tag>guimenuitem</tag> and
16880 <tag>guisubmenu</tag></refpurpose>
16884 <programlisting id="menuchoice.separator.frag">
16885 <xsl:param name="menuchoice.separator">+</xsl:param>
16889 <refsection><info><title>Description</title></info>
16891 <para>Separator used to connect items of a <tag>menuchoice</tag> other
16892 than <tag>guimenuitem</tag> and <tag>guisubmenu</tag>. The latter
16893 elements are linked with <parameter>menuchoice.menu.separator</parameter>.
16899 <refentry version="5.0" id="menuchoice.menu.separator">
16901 <refentrytitle>menuchoice.menu.separator</refentrytitle>
16902 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
16905 <refname>menuchoice.menu.separator</refname>
16906 <refpurpose>Separator between items of a <tag>menuchoice</tag>
16907 with <tag>guimenuitem</tag> or
16908 <tag>guisubmenu</tag></refpurpose>
16912 <programlisting id="menuchoice.menu.separator.frag">
16913 <xsl:param name="menuchoice.menu.separator"> → </xsl:param>
16917 <refsection><info><title>Description</title></info>
16919 <para>Separator used to connect items of a <tag>menuchoice</tag> with
16920 <tag>guimenuitem</tag> or <tag>guisubmenu</tag>. Other elements
16921 are linked with <parameter>menuchoice.separator</parameter>.
16923 <para>The default value is &#x2192;, which is the
16924 &rarr; (right arrow) character entity.
16925 The current FOP (0.20.5) requires setting the font-family
16928 <para>The default value also includes spaces around the arrow,
16929 which will allow a line to break. Replace the spaces with
16930 &#xA0; (nonbreaking space) if you don't want those
16937 <refentry version="5.0" id="default.float.class">
16939 <refentrytitle>default.float.class</refentrytitle>
16940 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
16943 <refname>default.float.class</refname>
16944 <refpurpose>Specifies the default float class</refpurpose>
16948 <programlisting id="default.float.class.frag">
16949 <xsl:param name="default.float.class">
16951 <xsl:when test="contains($stylesheet.result.type,'html')">left</xsl:when>
16952 <xsl:otherwise>before</xsl:otherwise>
16953 </xsl:choose>
16958 <refsection><info><title>Description</title></info>
16960 <para>Selects the direction in which a float should be placed. for
16961 xsl-fo this is before, for html it is left. For Western texts, the
16962 before direction is the top of the page.</para>
16967 <refentry version="5.0" id="footnote.number.format">
16969 <refentrytitle>footnote.number.format</refentrytitle>
16970 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
16971 <refmiscinfo class="other" otherclass="value">1<alt>1,2,3...</alt></refmiscinfo>
16972 <refmiscinfo class="other" otherclass="value">A<alt>A,B,C...</alt></refmiscinfo>
16973 <refmiscinfo class="other" otherclass="value">a<alt>a,b,c...</alt></refmiscinfo>
16974 <refmiscinfo class="other" otherclass="value">i<alt>i,ii,iii...</alt></refmiscinfo>
16975 <refmiscinfo class="other" otherclass="value">I<alt>I,II,III...</alt></refmiscinfo>
16978 <refname>footnote.number.format</refname>
16979 <refpurpose>Identifies the format used for footnote numbers</refpurpose>
16983 <programlisting id="footnote.number.format.frag">
16984 <xsl:param name="footnote.number.format">1</xsl:param>
16988 <refsection><info><title>Description</title></info>
16990 <para>The <parameter>footnote.number.format</parameter> specifies the format
16991 to use for footnote numeration (1, i, I, a, or A).</para>
16996 <refentry version="5.0" id="table.footnote.number.format">
16998 <refentrytitle>table.footnote.number.format</refentrytitle>
16999 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
17000 <refmiscinfo class="other" otherclass="value">1<alt>1,2,3...</alt></refmiscinfo>
17001 <refmiscinfo class="other" otherclass="value">A<alt>A,B,C...</alt></refmiscinfo>
17002 <refmiscinfo class="other" otherclass="value">a<alt>a,b,c...</alt></refmiscinfo>
17003 <refmiscinfo class="other" otherclass="value">i<alt>i,ii,iii...</alt></refmiscinfo>
17004 <refmiscinfo class="other" otherclass="value">I<alt>I,II,III...</alt></refmiscinfo>
17007 <refname>table.footnote.number.format</refname>
17008 <refpurpose>Identifies the format used for footnote numbers in tables</refpurpose>
17012 <programlisting id="table.footnote.number.format.frag">
17013 <xsl:param name="table.footnote.number.format">a</xsl:param>
17017 <refsection><info><title>Description</title></info>
17019 <para>The <parameter>table.footnote.number.format</parameter> specifies the format
17020 to use for footnote numeration (1, i, I, a, or A) in tables.</para>
17025 <refentry version="5.0" id="footnote.number.symbols">
17027 <refentrytitle>footnote.number.symbols</refentrytitle>
17028 <refmiscinfo class="other" otherclass="datatype"/>
17031 <refname>footnote.number.symbols</refname>
17032 <refpurpose>Special characters to use as footnote markers</refpurpose>
17036 <programlisting id="footnote.number.symbols.frag">
17037 <xsl:param name="footnote.number.symbols"></xsl:param>
17041 <refsection><info><title>Description</title></info>
17043 <para>If <parameter>footnote.number.symbols</parameter> is not the empty string,
17044 footnotes will use the characters it contains as footnote symbols. For example,
17045 <quote>*&#x2020;&#x2021;&#x25CA;&#x2720;</quote> will identify
17046 footnotes with <quote>*</quote>, <quote>†</quote>, <quote>‡</quote>,
17047 <quote>◊</quote>, and <quote>✠</quote>. If there are more footnotes
17048 than symbols, the stylesheets will fall back to numbered footnotes using
17049 <parameter>footnote.number.format</parameter>.</para>
17051 <para>The use of symbols for footnotes depends on the ability of your
17052 processor (or browser) to render the symbols you select. Not all systems are
17053 capable of displaying the full range of Unicode characters. If the quoted characters
17054 in the preceding paragraph are not displayed properly, that's a good indicator
17055 that you may have trouble using those symbols for footnotes.</para>
17060 <refentry version="5.0" id="table.footnote.number.symbols">
17062 <refentrytitle>table.footnote.number.symbols</refentrytitle>
17063 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
17066 <refname>table.footnote.number.symbols</refname>
17067 <refpurpose>Special characters to use a footnote markers in tables</refpurpose>
17071 <programlisting id="table.footnote.number.symbols.frag">
17072 <xsl:param name="table.footnote.number.symbols"></xsl:param>
17076 <refsection><info><title>Description</title></info>
17078 <para>If <parameter>table.footnote.number.symbols</parameter> is not the empty string,
17079 table footnotes will use the characters it contains as footnote symbols. For example,
17080 <quote>*&#x2020;&#x2021;&#x25CA;&#x2720;</quote> will identify
17081 footnotes with <quote>*</quote>, <quote>†</quote>, <quote>‡</quote>,
17082 <quote>◊</quote>, and <quote>✠</quote>. If there are more footnotes
17083 than symbols, the stylesheets will fall back to numbered footnotes using
17084 <parameter>table.footnote.number.format</parameter>.</para>
17086 <para>The use of symbols for footnotes depends on the ability of your
17087 processor (or browser) to render the symbols you select. Not all systems are
17088 capable of displaying the full range of Unicode characters. If the quoted characters
17089 in the preceding paragraph are not displayed properly, that's a good indicator
17090 that you may have trouble using those symbols for footnotes.</para>
17095 <refentry version="5.0" id="footnote.properties">
17097 <refentrytitle>footnote.properties</refentrytitle>
17098 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
17101 <refname>footnote.properties</refname>
17102 <refpurpose>Properties applied to each footnote body
17107 <programlisting id="footnote.properties.frag">
17108 <xsl:attribute-set name="footnote.properties">
17109 <xsl:attribute name="font-family"><xsl:value-of select="$body.fontset"></xsl:value-of></xsl:attribute>
17110 <xsl:attribute name="font-size"><xsl:value-of select="$footnote.font.size"></xsl:value-of></xsl:attribute>
17111 <xsl:attribute name="font-weight">normal</xsl:attribute>
17112 <xsl:attribute name="font-style">normal</xsl:attribute>
17113 <xsl:attribute name="text-align"><xsl:value-of select="$alignment"></xsl:value-of></xsl:attribute>
17114 <xsl:attribute name="start-indent">0pt</xsl:attribute>
17115 <xsl:attribute name="text-indent">0pt</xsl:attribute>
17116 <xsl:attribute name="hyphenate"><xsl:value-of select="$hyphenate"></xsl:value-of></xsl:attribute>
17117 <xsl:attribute name="wrap-option">wrap</xsl:attribute>
17118 <xsl:attribute name="linefeed-treatment">treat-as-space</xsl:attribute>
17119 </xsl:attribute-set>
17123 <refsection><info><title>Description</title></info>
17125 <para>This attribute set is applied to the footnote-block
17127 It can be used to set the
17128 font-size, font-family, and other inheritable properties that will be
17129 applied to all footnotes.</para>
17134 <refentry version="5.0" id="table.footnote.properties">
17136 <refentrytitle>table.footnote.properties</refentrytitle>
17137 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
17140 <refname>table.footnote.properties</refname>
17141 <refpurpose>Properties applied to each table footnote body
17146 <programlisting id="table.footnote.properties.frag">
17147 <xsl:attribute-set name="table.footnote.properties">
17148 <xsl:attribute name="font-family"><xsl:value-of select="$body.fontset"></xsl:value-of></xsl:attribute>
17149 <xsl:attribute name="font-size"><xsl:value-of select="$footnote.font.size"></xsl:value-of></xsl:attribute>
17150 <xsl:attribute name="font-weight">normal</xsl:attribute>
17151 <xsl:attribute name="font-style">normal</xsl:attribute>
17152 <xsl:attribute name="space-before">2pt</xsl:attribute>
17153 <xsl:attribute name="text-align"><xsl:value-of select="$alignment"></xsl:value-of></xsl:attribute>
17154 </xsl:attribute-set>
17158 <refsection><info><title>Description</title></info>
17160 <para>This attribute set is applied to the footnote-block
17161 for each table footnote.
17162 It can be used to set the
17163 font-size, font-family, and other inheritable properties that will be
17164 applied to all table footnotes.</para>
17169 <refentry version="5.0" id="footnote.mark.properties">
17171 <refentrytitle>footnote.mark.properties</refentrytitle>
17172 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
17175 <refname>footnote.mark.properties</refname>
17176 <refpurpose>Properties applied to each footnote mark
17181 <programlisting id="footnote.mark.properties.frag">
17182 <xsl:attribute-set name="footnote.mark.properties">
17183 <xsl:attribute name="font-family"><xsl:value-of select="$body.fontset"></xsl:value-of></xsl:attribute>
17184 <xsl:attribute name="font-size">75%</xsl:attribute>
17185 <xsl:attribute name="font-weight">normal</xsl:attribute>
17186 <xsl:attribute name="font-style">normal</xsl:attribute>
17187 </xsl:attribute-set>
17191 <refsection><info><title>Description</title></info>
17193 <para>This attribute set is applied to the footnote mark used
17195 It should contain only inline properties.
17198 <para>The property to make the mark a superscript is contained in the
17199 footnote template itself, because the current version of FOP reports
17200 an error if baseline-shift is used.
17206 <refentry version="5.0" id="footnote.sep.leader.properties">
17208 <refentrytitle>footnote.sep.leader.properties</refentrytitle>
17209 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
17212 <refname>footnote.sep.leader.properties</refname>
17213 <refpurpose>Properties associated with footnote separators</refpurpose>
17217 <programlisting id="footnote.sep.leader.properties.frag">
17218 <xsl:attribute-set name="footnote.sep.leader.properties">
17219 <xsl:attribute name="color">black</xsl:attribute>
17220 <xsl:attribute name="leader-pattern">rule</xsl:attribute>
17221 <xsl:attribute name="leader-length">1in</xsl:attribute>
17222 </xsl:attribute-set>
17226 <refsection><info><title>Description</title></info>
17228 <para>The styling for the rule line that separates the
17229 footnotes from the body text.
17230 These are properties applied to the fo:leader used as
17233 <para>If you want to do more than just set properties on
17234 the leader element, then you can customize the template
17235 named <literal>footnote.separator</literal> in
17236 <filename>fo/pagesetup.xsl</filename>.</para>
17241 <refentry version="5.0" id="xref.with.number.and.title">
17243 <refentrytitle>xref.with.number.and.title</refentrytitle>
17244 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
17247 <refname>xref.with.number.and.title</refname>
17248 <refpurpose>Use number and title in cross references</refpurpose>
17252 <programlisting id="xref.with.number.and.title.frag">
17253 <xsl:param name="xref.with.number.and.title" select="1"></xsl:param>
17257 <refsection><info><title>Description</title></info>
17259 <para>A cross reference may include the number (for example, the number of
17260 an example or figure) and the <tag>title</tag> which is a required child of some
17261 targets. This parameter inserts both the relevant number as well as
17262 the title into the link. </para>
17267 <refentry version="5.0" id="superscript.properties">
17269 <refentrytitle>superscript.properties</refentrytitle>
17270 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
17273 <refname>superscript.properties</refname>
17274 <refpurpose>Properties associated with superscripts</refpurpose>
17278 <programlisting id="superscript.properties.frag">
17279 <xsl:attribute-set name="superscript.properties">
17280 <xsl:attribute name="font-size">75%</xsl:attribute>
17281 </xsl:attribute-set>
17285 <refsection><info><title>Description</title></info>
17287 <para>Specifies styling properties for superscripts.</para>
17292 <refentry version="5.0" id="subscript.properties">
17294 <refentrytitle>subscript.properties</refentrytitle>
17295 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
17298 <refname>subscript.properties</refname>
17299 <refpurpose>Properties associated with subscripts</refpurpose>
17303 <programlisting id="subscript.properties.frag">
17304 <xsl:attribute-set name="subscript.properties">
17305 <xsl:attribute name="font-size">75%</xsl:attribute>
17306 </xsl:attribute-set>
17310 <refsection><info><title>Description</title></info>
17312 <para>Specifies styling properties for subscripts.</para>
17317 <refentry version="5.0" id="pgwide.properties">
17319 <refentrytitle>pgwide.properties</refentrytitle>
17320 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
17323 <refname>pgwide.properties</refname>
17324 <refpurpose>Properties to make a figure or table page wide.
17329 <programlisting id="pgwide.properties.frag">
17330 <xsl:attribute-set name="pgwide.properties">
17331 <xsl:attribute name="start-indent">0pt</xsl:attribute>
17332 </xsl:attribute-set>
17336 <refsection><info><title>Description</title></info>
17338 <para>This attribute set is used to set the properties
17339 that make a figure or table "page wide" in fo output.
17340 It comes into effect when an attribute <literal>pgwide="1"</literal>
17345 By default, it sets <parameter>start-indent</parameter>
17346 to <literal>0pt</literal>.
17347 In a stylesheet that sets the parameter
17348 <parameter>body.start.indent</parameter>
17349 to a non-zero value in order to indent body text,
17350 this attribute set can be used to outdent pgwide
17351 figures to the start margin.
17354 <para>If a document uses a multi-column page layout,
17355 then this attribute set could try setting <parameter>span</parameter>
17356 to a value of <literal>all</literal>. However, this may
17357 not work with some processors because a span property must be on an
17358 fo:block that is a direct child of fo:flow. It may work in
17359 some processors anyway.
17365 <refentry version="5.0" id="highlight.source">
17367 <refentrytitle>highlight.source</refentrytitle>
17368 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
17371 <refname>highlight.source</refname>
17372 <refpurpose>Should the content of <tag>programlisting</tag>
17373 be syntactically highlighted?</refpurpose>
17377 <programlisting id="highlight.source.frag">
17378 <xsl:param name="highlight.source" select="0"></xsl:param>
17382 <refsection><info><title>Description</title></info>
17384 <para>When this parameter is non-zero, the stylesheets will try to do syntax highlighting of the
17385 content of <tag>programlisting</tag> elements. You specify the language for each programlisting
17386 by using the <tag class="attribute">language</tag> attribute. The <parameter>highlight.default.language</parameter>
17387 parameter can be used to specify the language for programlistings without a <tag class="attribute">language</tag>
17388 attribute. Syntax highlighting also works for <tag>screen</tag> and <tag>synopsis</tag> elements.</para>
17390 <para>The actual highlighting work is done by the XSLTHL extension module. This is an external Java library that has to be
17391 downloaded separately (see below).</para>
17394 <para>In order to use this extension, you must</para>
17396 <listitem><para>add <filename>xslthl-2.x.x.jar</filename> to your Java classpath. The latest version is available
17397 from <link xlink:href="http://sourceforge.net/projects/xslthl">the XSLT syntax highlighting project</link>
17398 at SourceForge.</para>
17401 <para>use a customization layer in which you import one of the following stylesheet modules:
17404 <para><filename>html/highlight.xsl</filename>
17408 <para><filename>xhtml/highlight.xsl</filename>
17412 <para><filename>xhtml-1_1/highlight.xsl</filename>
17416 <para><filename>fo/highlight.xsl</filename>
17422 <listitem><para>let either the <literal>xslthl.config</literal> Java system property or the
17423 <parameter>highlight.xslthl.config</parameter> parameter point to the configuration file for syntax
17424 highlighting (using URL syntax). DocBook XSL comes with a ready-to-use configuration file,
17425 <filename>highlighting/xslthl-config.xml</filename>.</para>
17429 <para>The extension works with Saxon 6.5.x and Xalan-J. (Saxon 8.5 or later is also supported, but since it is
17430 an XSLT 2.0 processor it is not guaranteed to work with DocBook XSL in all circumstances.)</para>
17432 <para>The following is an example of a Saxon 6 command adapted for syntax highlighting, to be used on Windows:</para>
17435 <para><command>java -cp c:/Java/saxon.jar;c:/Java/xslthl-2.0.1.jar
17436 -Dxslthl.config=file:///c:/docbook-xsl/highlighting/xslthl-config.xml com.icl.saxon.StyleSheet
17437 -o test.html test.xml myhtml.xsl</command></para>
17443 <refentry version="5.0" id="highlight.xslthl.config">
17445 <refentrytitle>highlight.xslthl.config</refentrytitle>
17446 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
17449 <refname>highlight.xslthl.config</refname>
17450 <refpurpose>Location of XSLTHL configuration file</refpurpose>
17454 <programlisting id="highlight.xslthl.config.frag">
17455 <xsl:param name="highlight.xslthl.config"></xsl:param>
17459 <refsection><info><title>Description</title></info>
17461 <para>This location has precedence over the corresponding Java property.</para>
17463 <para>Please note that usually you have to specify location as URL not
17464 just as a simple path on the local
17465 filesystem. E.g. <filename>file:///home/user/xslthl/my-xslthl-config.xml</filename>.</para>
17472 <refentry version="5.0" id="highlight.default.language">
17474 <refentrytitle>highlight.default.language</refentrytitle>
17475 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
17478 <refname>highlight.default.language</refname>
17479 <refpurpose>Default language of programlisting</refpurpose>
17483 <programlisting id="highlight.default.language.frag">
17484 <xsl:param name="highlight.default.language"></xsl:param>
17488 <refsection><info><title>Description</title></info>
17490 <para>This language is used when there is no language attribute on programlisting.</para>
17495 <refentry version="5.0" id="email.delimiters.enabled">
17497 <refentrytitle>email.delimiters.enabled</refentrytitle>
17498 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
17501 <refname>email.delimiters.enabled</refname>
17502 <refpurpose>Generate delimiters around email addresses?</refpurpose>
17506 <programlisting id="email.delimiters.enabled.frag">
17507 <xsl:param name="email.delimiters.enabled" select="1"></xsl:param>
17511 <refsection><info><title>Description</title></info>
17513 <para>If non-zero, delimiters
17515 <footnote><para>For delimiters, the
17516 stylesheets are currently hard-coded to output angle
17517 brackets.</para></footnote>
17519 are generated around e-mail addresses
17520 (the output of the <tag>email</tag> element).</para>
17525 <refentry version="5.0" id="email.mailto.enabled">
17527 <refentrytitle>email.mailto.enabled</refentrytitle>
17528 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
17531 <refname>email.mailto.enabled</refname>
17532 <refpurpose>Generate mailto: links for email addresses?</refpurpose>
17536 <programlisting id="email.mailto.enabled.frag">
17537 <xsl:param name="email.mailto.enabled" select="0"></xsl:param>
17541 <refsection><info><title>Description</title></info>
17543 <para>If non-zero the generated output for the <tag>email</tag> element
17544 will be a clickable mailto: link that brings up the default mail client
17545 on the system.</para>
17550 <refentry version="5.0" id="section.container.element">
17552 <refentrytitle>section.container.element</refentrytitle>
17553 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
17554 <refmiscinfo class="other" otherclass="value">block</refmiscinfo>
17555 <refmiscinfo class="other" otherclass="value">wrapper</refmiscinfo>
17558 <refname>section.container.element</refname>
17559 <refpurpose>Select XSL-FO element name to contain sections</refpurpose>
17563 <programlisting id="section.container.element.frag">
17564 <xsl:param name="section.container.element">block</xsl:param>
17568 <refsection><info><title>Description</title></info>
17570 <para>Selects the element name for outer container of
17571 each section. The choices are <literal>block</literal> (default)
17572 or <literal>wrapper</literal>.
17573 The <literal>fo:</literal> namespace prefix is added
17574 by the stylesheet to form the full element name.
17577 <para>This element receives the section <literal>id</literal>
17578 attribute and the appropriate section level attribute-set.
17581 <para>Changing this parameter to <literal>wrapper</literal>
17582 is only necessary when producing multi-column output
17583 that contains page-wide spans. Using <literal>fo:wrapper</literal>
17584 avoids the nesting of <literal>fo:block</literal>
17585 elements that prevents spans from working (the standard says
17586 a span must be on a block that is a direct child of
17587 <literal>fo:flow</literal>).
17590 <para>If set to <literal>wrapper</literal>, the
17591 section attribute-sets only support properties
17592 that are inheritable. That's because there is no
17593 block to apply them to. Properties such as
17594 font-family are inheritable, but properties such as
17598 <para>Only some XSL-FO processors need to use this parameter.
17599 The Antenna House processor, for example, will handle
17600 spans in nested blocks without changing the element name.
17601 The RenderX XEP product and FOP follow the XSL-FO standard
17602 and need to use <literal>wrapper</literal>.
17608 <refentry version="5.0" id="monospace.verbatim.font.width">
17610 <refentrytitle>monospace.verbatim.font.width</refentrytitle>
17611 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
17614 <refname>monospace.verbatim.font.width</refname>
17615 <refpurpose>Width of a single monospace font character</refpurpose>
17619 <programlisting id="monospace.verbatim.font.width.frag">
17620 <xsl:param name="monospace.verbatim.font.width">0.60em</xsl:param>
17624 <refsection><info><title>Description</title></info>
17626 <para>Specifies with em units the width of a single character
17627 of the monospace font. The default value is <literal>0.6em</literal>.</para>
17629 <para>This parameter is only used when a <tag>screen</tag>
17630 or <tag>programlisting</tag> element has a
17631 <tag class="attribute">width</tag> attribute, which is
17632 expressed as a plain integer to indicate the maximum character count
17634 To convert this character count to an actual maximum width
17635 measurement, the width of the font characters must be provided.
17636 Different monospace fonts have different character width,
17637 so this parameter should be adjusted to fit the
17638 monospace font being used.
17644 <refentry version="5.0" id="exsl.node.set.available">
17646 <refentrytitle>exsl.node.set.available</refentrytitle>
17647 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
17650 <refname>exsl.node.set.available</refname>
17651 <refpurpose>Is the test function-available('exsl:node-set') true?</refpurpose>
17655 <programlisting id="exsl.node.set.available.frag"><xsl:param name="exsl.node.set.available">
17657 <xsl:when exsl:foo="" test="function-available('exsl:node-set') or contains(system-property('xsl:vendor'), 'Apache Software Foundation')">1</xsl:when>
17658 <xsl:otherwise>0</xsl:otherwise>
17659 </xsl:choose>
17664 <refsection><info><title>Description</title></info>
17667 then the exsl:node-set() function is available to be used in
17669 If zero, then the function is not available.
17670 This param automatically detects the presence of
17671 the function and does not normally need to be set manually.</para>
17673 <para>This param was created to handle a long-standing
17674 bug in the Xalan processor that fails to detect the
17675 function even though it is available.</para>
17680 <refentry version="5.0" id="bookmarks.collapse">
17682 <refentrytitle>bookmarks.collapse</refentrytitle>
17683 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
17686 <refname>bookmarks.collapse</refname>
17687 <refpurpose>Specifies the initial state of bookmarks</refpurpose>
17691 <programlisting id="bookmarks.collapse.frag">
17692 <xsl:param name="bookmarks.collapse" select="1"></xsl:param>
17696 <refsection><info><title>Description</title></info>
17698 <para>If non-zero, the bookmark tree is collapsed so that only the
17699 top-level bookmarks are displayed initially. Otherwise, the whole tree
17700 of bookmarks is displayed.</para>
17702 <para>This parameter currently works with FOP 0.93 or later.</para>
17707 </reference><reference id="graphics" xml:base="../fo/param.xml"><title>Graphics</title>
17708 <refentry version="5.0" id="graphic.default.extension">
17710 <refentrytitle>graphic.default.extension</refentrytitle>
17711 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
17714 <refname>graphic.default.extension</refname>
17715 <refpurpose>Default extension for graphic filenames</refpurpose>
17719 <programlisting id="graphic.default.extension.frag"><xsl:param name="graphic.default.extension"></xsl:param></programlisting>
17722 <refsection><info><title>Description</title></info>
17724 <para>If a <tag>graphic</tag> or <tag>mediaobject</tag>
17725 includes a reference to a filename that does not include an extension,
17726 and the <tag class="attribute">format</tag> attribute is
17727 <emphasis>unspecified</emphasis>, the default extension will be used.
17733 <refentry version="5.0" id="default.image.width">
17735 <refentrytitle>default.image.width</refentrytitle>
17736 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
17739 <refname>default.image.width</refname>
17740 <refpurpose>The default width of images</refpurpose>
17744 <programlisting id="default.image.width.frag">
17745 <xsl:param name="default.image.width"></xsl:param>
17749 <refsection><info><title>Description</title></info>
17751 <para>If specified, this value will be used for the
17752 <tag class="attribute">width</tag> attribute on images that do not specify any
17753 <emphasis xlink:title="DocBook 5: The Definitive Guide" xlink:href="http://docbook.org/tdg5/en/html/imagedata.html#viewport.area">viewport dimensions</emphasis>.</para>
17758 <refentry version="5.0" id="preferred.mediaobject.role">
17760 <refentrytitle>preferred.mediaobject.role</refentrytitle>
17761 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
17764 <refname>preferred.mediaobject.role</refname>
17765 <refpurpose>Select which mediaobject to use based on
17766 this value of an object's <tag class="attribute">role</tag> attribute.
17771 <programlisting id="preferred.mediaobject.role.frag">
17772 <xsl:param name="preferred.mediaobject.role"></xsl:param>
17776 <refsection><info><title>Description</title></info>
17778 <para>A mediaobject may contain several objects such as imageobjects.
17779 If the parameter <parameter>use.role.for.mediaobject</parameter> is
17780 non-zero, then the <literal>role</literal> attribute on
17781 <tag>imageobject</tag>s and other objects within a
17782 <tag>mediaobject</tag> container will be used to select which object
17783 will be used. If one of the objects has a role value that matches the
17784 <parameter>preferred.mediaobject.role</parameter> parameter, then it
17785 has first priority for selection. If more than one has such a role
17786 value, the first one is used.
17789 See the <parameter>use.role.for.mediaobject</parameter> parameter
17790 for the sequence of selection.</para>
17794 <refentry version="5.0" id="use.role.for.mediaobject">
17796 <refentrytitle>use.role.for.mediaobject</refentrytitle>
17797 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
17800 <refname>use.role.for.mediaobject</refname>
17801 <refpurpose>Use <tag class="attribute">role</tag> attribute
17802 value for selecting which of several objects within a mediaobject to use.
17807 <programlisting id="use.role.for.mediaobject.frag">
17808 <xsl:param name="use.role.for.mediaobject" select="1"></xsl:param>
17812 <refsection><info><title>Description</title></info>
17814 <para>If non-zero, the <tag class="attribute">role</tag> attribute on
17815 <tag>imageobject</tag>s or other objects within a <tag>mediaobject</tag> container will be used to select which object will be
17819 The order of selection when then parameter is non-zero is:
17823 <para>If the stylesheet parameter <parameter>preferred.mediaobject.role</parameter> has a value, then the object whose role equals that value is selected.</para>
17826 <para>Else if an object's role attribute has a value of
17827 <literal>html</literal> for HTML processing or
17828 <literal>fo</literal> for FO output, then the first
17829 of such objects is selected.
17833 <para>Else the first suitable object is selected.</para>
17838 <parameter>use.role.for.mediaobject</parameter>
17839 is zero, then role attributes are not considered
17840 and the first suitable object
17841 with or without a role value is used.
17846 <refentry version="5.0" id="ignore.image.scaling">
17848 <refentrytitle>ignore.image.scaling</refentrytitle>
17849 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
17852 <refname>ignore.image.scaling</refname>
17853 <refpurpose>Tell the stylesheets to ignore the author's image scaling attributes</refpurpose>
17857 <programlisting id="ignore.image.scaling.frag">
17858 <xsl:param name="ignore.image.scaling" select="0"></xsl:param>
17862 <refsection><info><title>Description</title></info>
17864 <para>If non-zero, the scaling attributes on graphics and media objects are
17870 <refentry version="5.0" id="img.src.path">
17872 <refentrytitle>img.src.path</refentrytitle>
17873 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
17876 <refname>img.src.path</refname>
17877 <refpurpose>Path to HTML/FO image files</refpurpose>
17881 <programlisting id="img.src.path.frag"><xsl:param name="img.src.path"></xsl:param></programlisting>
17884 <refsection><info><title>Description</title></info>
17886 <para>Add a path prefix to the value of the <tag class="attribute">fileref</tag>
17887 attribute of <tag>graphic</tag>, <tag>inlinegraphic</tag>, and <tag>imagedata</tag> elements. The resulting
17888 compound path is used in the output as the value of the <tag class="attribute">src</tag>
17889 attribute of <tag class="element">img</tag> (HTML) or <tag class="element">external-graphic</tag> (FO).
17893 The path given by <literal>img.src.path</literal> could be relative to the directory where the HTML/FO
17894 files are created, or it could be an absolute URI.
17895 The default value is empty.
17896 Be sure to include a trailing slash if needed.
17899 <para>This prefix is not applied to any filerefs that start
17900 with "/" or contain "//:".
17906 <refentry version="5.0" id="keep.relative.image.uris">
17908 <refentrytitle>keep.relative.image.uris</refentrytitle>
17909 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
17912 <refname>keep.relative.image.uris</refname>
17913 <refpurpose>Should image URIs be resolved against xml:base?</refpurpose>
17917 <programlisting id="keep.relative.image.uris.frag">
17919 <xsl:param name="keep.relative.image.uris" select="0"></xsl:param>
17923 <refsection><info><title>Description</title></info>
17925 <para>If non-zero, relative URIs (in, for example
17926 <literal>fileref</literal> attributes) will be used in the generated
17927 output. Otherwise, the URIs will be made absolute with respect to the
17930 <para>Note that the stylesheets calculate (and use) the absolute form
17931 for some purposes, this only applies to the resulting output.</para>
17936 </reference><reference id="general" xml:base="../fo/param.xml"><title>Pagination and General Styles</title>
17937 <partintro id="margins_partintro">
17938 <section id="margins_intro"><title>Understanding XSL FO Margins</title>
17940 <para>To make sense of the parameters in this section, it's useful to
17941 consider <xref linkend="fig.pagemodel"/>.</para>
17943 <figure id="fig.pagemodel">
17944 <title>Page Model</title>
17945 <mediaobject id="fo-pageregions-image">
17946 <imageobject role="html">
17947 <imagedata fileref="page.png"/>
17949 <imageobject role="fo">
17950 <imagedata fileref="fo/page.png"/>
17952 <textobject><phrase>Figure showing page margins</phrase></textobject>
17954 <para>This figure shows the physical page with the various FO page regions
17960 <para>First, let's consider the regions on the page.</para>
17962 <para>The white region is the physical page. Its dimensions are determined by
17963 the <parameter>page.height</parameter> and <parameter>page.width</parameter>
17966 <para>The yellow region is the region-body. The size and placement of
17967 the region body is constrained by the dimensions labelled in the
17970 <para>The pink region at the top of the page is the region-before. The
17971 darker area inside the region-before is the header text. In XSL, the default
17972 display alignment for a region is <literal>before</literal>, but the
17973 DocBook stylesheets still explicitly make it <literal>before</literal>. That's
17974 why the darker area is at the top.</para>
17976 <para>The pink region at the bottom of the page is the region-after.
17977 The darker area is the footer text. In XSL, the default display
17978 alignment for a region is <literal>before</literal>,
17979 but the DocBook stylesheets explicitly make it
17980 <literal>after</literal>. That's why the darker area is at the bottom.</para>
17982 <para>The dimensions in the figure are:</para>
17984 <orderedlist numeration="upperalpha">
17985 <listitem><para>The page-master margin-top.
17987 <listitem><para>The region-before extent.
17989 <listitem><para>The region-body margin-top.
17991 <listitem><para>The region-after extent.
17993 <listitem><para>The page-master margin-bottom.
17995 <listitem><para>The region-body margin-bottom.
17997 <listitem><para>The sum of the page-master margin-left and the
17998 region-body margin-left. In DocBook, the region-body margin-left is
17999 zero by default, so this is simply the page-master margin-left.
18001 <listitem><para>The sum of the page-master margin-right and the
18002 region-body margin-right. In DocBook, the region-body margin-right is
18003 zero by default, so this is simply the page-master margin-right.
18010 <refentry version="5.0" id="page.height">
18012 <refentrytitle>page.height</refentrytitle>
18013 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
18016 <refname>page.height</refname>
18017 <refpurpose>The height of the physical page</refpurpose>
18021 <programlisting id="page.height.frag"><xsl:param name="page.height">
18023 <xsl:when test="$page.orientation = 'portrait'">
18024 <xsl:value-of select="$page.height.portrait"></xsl:value-of>
18026 <xsl:otherwise>
18027 <xsl:value-of select="$page.width.portrait"></xsl:value-of>
18028 </xsl:otherwise>
18029 </xsl:choose>
18030 </xsl:param></programlisting>
18033 <refsection><info><title>Description</title></info>
18035 <para>The page height is generally calculated from the
18036 <parameter>paper.type</parameter> and
18037 <parameter>page.orientation</parameter> parameters.
18043 <refentry version="5.0" id="page.height.portrait">
18045 <refentrytitle>page.height.portrait</refentrytitle>
18046 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
18049 <refname>page.height.portrait</refname>
18050 <refpurpose>Specify the physical size of the long edge of the page</refpurpose>
18054 <programlisting id="page.height.portrait.frag"><xsl:param name="page.height.portrait">
18056 <xsl:when test="$paper.type = 'A4landscape'">210mm</xsl:when>
18057 <xsl:when test="$paper.type = 'USletter'">11in</xsl:when>
18058 <xsl:when test="$paper.type = 'USlandscape'">8.5in</xsl:when>
18059 <xsl:when test="$paper.type = '4A0'">2378mm</xsl:when>
18060 <xsl:when test="$paper.type = '2A0'">1682mm</xsl:when>
18061 <xsl:when test="$paper.type = 'A0'">1189mm</xsl:when>
18062 <xsl:when test="$paper.type = 'A1'">841mm</xsl:when>
18063 <xsl:when test="$paper.type = 'A2'">594mm</xsl:when>
18064 <xsl:when test="$paper.type = 'A3'">420mm</xsl:when>
18065 <xsl:when test="$paper.type = 'A4'">297mm</xsl:when>
18066 <xsl:when test="$paper.type = 'A5'">210mm</xsl:when>
18067 <xsl:when test="$paper.type = 'A6'">148mm</xsl:when>
18068 <xsl:when test="$paper.type = 'A7'">105mm</xsl:when>
18069 <xsl:when test="$paper.type = 'A8'">74mm</xsl:when>
18070 <xsl:when test="$paper.type = 'A9'">52mm</xsl:when>
18071 <xsl:when test="$paper.type = 'A10'">37mm</xsl:when>
18072 <xsl:when test="$paper.type = 'B0'">1414mm</xsl:when>
18073 <xsl:when test="$paper.type = 'B1'">1000mm</xsl:when>
18074 <xsl:when test="$paper.type = 'B2'">707mm</xsl:when>
18075 <xsl:when test="$paper.type = 'B3'">500mm</xsl:when>
18076 <xsl:when test="$paper.type = 'B4'">353mm</xsl:when>
18077 <xsl:when test="$paper.type = 'B5'">250mm</xsl:when>
18078 <xsl:when test="$paper.type = 'B6'">176mm</xsl:when>
18079 <xsl:when test="$paper.type = 'B7'">125mm</xsl:when>
18080 <xsl:when test="$paper.type = 'B8'">88mm</xsl:when>
18081 <xsl:when test="$paper.type = 'B9'">62mm</xsl:when>
18082 <xsl:when test="$paper.type = 'B10'">44mm</xsl:when>
18083 <xsl:when test="$paper.type = 'C0'">1297mm</xsl:when>
18084 <xsl:when test="$paper.type = 'C1'">917mm</xsl:when>
18085 <xsl:when test="$paper.type = 'C2'">648mm</xsl:when>
18086 <xsl:when test="$paper.type = 'C3'">458mm</xsl:when>
18087 <xsl:when test="$paper.type = 'C4'">324mm</xsl:when>
18088 <xsl:when test="$paper.type = 'C5'">229mm</xsl:when>
18089 <xsl:when test="$paper.type = 'C6'">162mm</xsl:when>
18090 <xsl:when test="$paper.type = 'C7'">114mm</xsl:when>
18091 <xsl:when test="$paper.type = 'C8'">81mm</xsl:when>
18092 <xsl:when test="$paper.type = 'C9'">57mm</xsl:when>
18093 <xsl:when test="$paper.type = 'C10'">40mm</xsl:when>
18094 <xsl:otherwise>11in</xsl:otherwise>
18095 </xsl:choose>
18096 </xsl:param></programlisting>
18099 <refsection><info><title>Description</title></info>
18101 <para>The portrait page height is the length of the long
18102 edge of the physical page.
18108 <refentry version="5.0" id="page.margin.bottom">
18110 <refentrytitle>page.margin.bottom</refentrytitle>
18111 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
18114 <refname>page.margin.bottom</refname>
18115 <refpurpose>The bottom margin of the page</refpurpose>
18119 <programlisting id="page.margin.bottom.frag">
18120 <xsl:param name="page.margin.bottom">0.5in</xsl:param>
18124 <refsection><info><title>Description</title></info>
18126 <para>The bottom page margin is the distance from the bottom of the region-after
18127 to the physical bottom of the page.
18133 <refentry version="5.0" id="page.margin.inner">
18135 <refentrytitle>page.margin.inner</refentrytitle>
18136 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
18139 <refname>page.margin.inner</refname>
18140 <refpurpose>The inner page margin</refpurpose>
18144 <programlisting id="page.margin.inner.frag"><xsl:param name="page.margin.inner">
18146 <xsl:when test="$double.sided != 0">1.25in</xsl:when>
18147 <xsl:otherwise>1in</xsl:otherwise>
18148 </xsl:choose>
18149 </xsl:param></programlisting>
18152 <refsection><info><title>Description</title></info>
18154 <para>The inner page margin is the distance from bound edge of the
18155 page to the first column of text. </para>
18157 <para>The inner page margin is the distance from bound edge of the
18158 page to the outer edge of the first column of text.</para>
18160 <para>In left-to-right text direction,
18161 this is the left margin of recto (front side) pages.
18162 For single-sided output, it is the left margin
18163 of all pages.</para>
18165 <para>In right-to-left text direction,
18166 this is the right margin of recto pages.
18167 For single-sided output, this is the
18168 right margin of all pages.</para>
18171 <para>Current versions (at least as of version 4.13)
18172 of the XEP XSL-FO processor do not
18173 correctly handle these margin settings for documents
18174 with right-to-left text direction.
18175 The workaround in that situation is to reverse
18176 the values for <parameter>page.margin.inner</parameter>
18177 and <parameter>page.margin.outer</parameter>, until
18178 this bug is fixed by RenderX. It does not affect documents
18179 with left-to-right text direction.</para>
18185 <refentry version="5.0" id="page.margin.outer">
18187 <refentrytitle>page.margin.outer</refentrytitle>
18188 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
18191 <refname>page.margin.outer</refname>
18192 <refpurpose>The outer page margin</refpurpose>
18196 <programlisting id="page.margin.outer.frag"><xsl:param name="page.margin.outer">
18198 <xsl:when test="$double.sided != 0">0.75in</xsl:when>
18199 <xsl:otherwise>1in</xsl:otherwise>
18200 </xsl:choose>
18201 </xsl:param></programlisting>
18204 <refsection><info><title>Description</title></info>
18206 <para>The outer page margin is the distance from non-bound edge of the
18207 page to the outer edge of the last column of text.</para>
18209 <para>In left-to-right text direction,
18210 this is the right margin of recto (front side) pages.
18211 For single-sided output, it is the right margin
18212 of all pages.</para>
18214 <para>In right-to-left text direction,
18215 this is the left margin of recto pages.
18216 For single-sided output, this is the
18217 left margin of all pages.</para>
18220 <para>Current versions (at least as of version 4.13)
18221 of the XEP XSL-FO processor do not
18222 correctly handle these margin settings for documents
18223 with right-to-left text direction.
18224 The workaround in that situation is to reverse
18225 the values for <parameter>page.margin.inner</parameter>
18226 and <parameter>page.margin.outer</parameter>, until
18227 this bug is fixed by RenderX. It does not affect documents
18228 with left-to-right text direction.</para>
18234 <refentry version="5.0" id="page.margin.top">
18236 <refentrytitle>page.margin.top</refentrytitle>
18237 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
18240 <refname>page.margin.top</refname>
18241 <refpurpose>The top margin of the page</refpurpose>
18245 <programlisting id="page.margin.top.frag">
18246 <xsl:param name="page.margin.top">0.5in</xsl:param>
18250 <refsection><info><title>Description</title></info>
18252 <para>The top page margin is the distance from the physical top of the
18253 page to the top of the region-before.</para>
18258 <refentry version="5.0" id="page.orientation">
18260 <refentrytitle>page.orientation</refentrytitle>
18261 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
18262 <refmiscinfo class="other" otherclass="value">portrait</refmiscinfo>
18263 <refmiscinfo class="other" otherclass="value">landscape</refmiscinfo>
18266 <refname>page.orientation</refname>
18267 <refpurpose>Select the page orientation</refpurpose>
18271 <programlisting id="page.orientation.frag">
18272 <xsl:param name="page.orientation">portrait</xsl:param>
18276 <refsection><info><title>Description</title></info>
18278 <para> Select one from portrait or landscape.
18279 In portrait orientation, the short edge is horizontal; in
18280 landscape orientation, it is vertical.
18286 <refentry version="5.0" id="page.width">
18288 <refentrytitle>page.width</refentrytitle>
18289 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
18292 <refname>page.width</refname>
18293 <refpurpose>The width of the physical page</refpurpose>
18297 <programlisting id="page.width.frag"><xsl:param name="page.width">
18299 <xsl:when test="$page.orientation = 'portrait'">
18300 <xsl:value-of select="$page.width.portrait"></xsl:value-of>
18302 <xsl:otherwise>
18303 <xsl:value-of select="$page.height.portrait"></xsl:value-of>
18304 </xsl:otherwise>
18305 </xsl:choose>
18306 </xsl:param></programlisting>
18309 <refsection><info><title>Description</title></info>
18311 <para>The page width is generally calculated from the
18312 <parameter>paper.type</parameter> and
18313 <parameter>page.orientation</parameter> parameters.</para>
18318 <refentry version="5.0" id="page.width.portrait">
18320 <refentrytitle>page.width.portrait</refentrytitle>
18321 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
18324 <refname>page.width.portrait</refname>
18325 <refpurpose>Specify the physical size of the short edge of the page</refpurpose>
18329 <programlisting id="page.width.portrait.frag"><xsl:param name="page.width.portrait">
18331 <xsl:when test="$paper.type = 'USletter'">8.5in</xsl:when>
18332 <xsl:when test="$paper.type = '4A0'">1682mm</xsl:when>
18333 <xsl:when test="$paper.type = '2A0'">1189mm</xsl:when>
18334 <xsl:when test="$paper.type = 'A0'">841mm</xsl:when>
18335 <xsl:when test="$paper.type = 'A1'">594mm</xsl:when>
18336 <xsl:when test="$paper.type = 'A2'">420mm</xsl:when>
18337 <xsl:when test="$paper.type = 'A3'">297mm</xsl:when>
18338 <xsl:when test="$paper.type = 'A4'">210mm</xsl:when>
18339 <xsl:when test="$paper.type = 'A5'">148mm</xsl:when>
18340 <xsl:when test="$paper.type = 'A6'">105mm</xsl:when>
18341 <xsl:when test="$paper.type = 'A7'">74mm</xsl:when>
18342 <xsl:when test="$paper.type = 'A8'">52mm</xsl:when>
18343 <xsl:when test="$paper.type = 'A9'">37mm</xsl:when>
18344 <xsl:when test="$paper.type = 'A10'">26mm</xsl:when>
18345 <xsl:when test="$paper.type = 'B0'">1000mm</xsl:when>
18346 <xsl:when test="$paper.type = 'B1'">707mm</xsl:when>
18347 <xsl:when test="$paper.type = 'B2'">500mm</xsl:when>
18348 <xsl:when test="$paper.type = 'B3'">353mm</xsl:when>
18349 <xsl:when test="$paper.type = 'B4'">250mm</xsl:when>
18350 <xsl:when test="$paper.type = 'B5'">176mm</xsl:when>
18351 <xsl:when test="$paper.type = 'B6'">125mm</xsl:when>
18352 <xsl:when test="$paper.type = 'B7'">88mm</xsl:when>
18353 <xsl:when test="$paper.type = 'B8'">62mm</xsl:when>
18354 <xsl:when test="$paper.type = 'B9'">44mm</xsl:when>
18355 <xsl:when test="$paper.type = 'B10'">31mm</xsl:when>
18356 <xsl:when test="$paper.type = 'C0'">917mm</xsl:when>
18357 <xsl:when test="$paper.type = 'C1'">648mm</xsl:when>
18358 <xsl:when test="$paper.type = 'C2'">458mm</xsl:when>
18359 <xsl:when test="$paper.type = 'C3'">324mm</xsl:when>
18360 <xsl:when test="$paper.type = 'C4'">229mm</xsl:when>
18361 <xsl:when test="$paper.type = 'C5'">162mm</xsl:when>
18362 <xsl:when test="$paper.type = 'C6'">114mm</xsl:when>
18363 <xsl:when test="$paper.type = 'C7'">81mm</xsl:when>
18364 <xsl:when test="$paper.type = 'C8'">57mm</xsl:when>
18365 <xsl:when test="$paper.type = 'C9'">40mm</xsl:when>
18366 <xsl:when test="$paper.type = 'C10'">28mm</xsl:when>
18367 <xsl:otherwise>8.5in</xsl:otherwise>
18368 </xsl:choose>
18369 </xsl:param></programlisting>
18372 <refsection><info><title>Description</title></info>
18374 <para>The portrait page width is the length of the short
18375 edge of the physical page.
18381 <refentry version="5.0" id="paper.type">
18383 <refentrytitle>paper.type</refentrytitle>
18384 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
18385 <refmiscinfo class="other" otherclass="list-type">open</refmiscinfo>
18386 <refmiscinfo class="other" otherclass="list-type">open</refmiscinfo>
18387 <refmiscinfo class="other" otherclass="value">USletter<alt>8.5x11in</alt></refmiscinfo>
18388 <refmiscinfo class="other" otherclass="value">USlandscape<alt>11x8.5in</alt></refmiscinfo>
18389 <refmiscinfo class="other" otherclass="value">USlegal<alt>8.5inx14in</alt></refmiscinfo>
18390 <refmiscinfo class="other" otherclass="value">USlegallandscape<alt>14inx8.5in</alt></refmiscinfo>
18391 <refmiscinfo class="other" otherclass="value">4A0<alt>2378x1682mm</alt></refmiscinfo>
18392 <refmiscinfo class="other" otherclass="value">2A0<alt>1682x1189mm</alt></refmiscinfo>
18393 <refmiscinfo class="other" otherclass="value">A0<alt>1189x841mm</alt></refmiscinfo>
18394 <refmiscinfo class="other" otherclass="value">A1<alt>841x594mm</alt></refmiscinfo>
18395 <refmiscinfo class="other" otherclass="value">A2<alt>594x420mm</alt></refmiscinfo>
18396 <refmiscinfo class="other" otherclass="value">A3<alt>420x297mm</alt></refmiscinfo>
18397 <refmiscinfo class="other" otherclass="value">A4<alt>297x210mm</alt></refmiscinfo>
18398 <refmiscinfo class="other" otherclass="value">A5<alt>210x148mm</alt></refmiscinfo>
18399 <refmiscinfo class="other" otherclass="value">A6<alt>148x105mm</alt></refmiscinfo>
18400 <refmiscinfo class="other" otherclass="value">A7<alt>105x74mm</alt></refmiscinfo>
18401 <refmiscinfo class="other" otherclass="value">A8<alt>74x52mm</alt></refmiscinfo>
18402 <refmiscinfo class="other" otherclass="value">A9<alt>52x37mm</alt></refmiscinfo>
18403 <refmiscinfo class="other" otherclass="value">A10<alt>37x26mm</alt></refmiscinfo>
18404 <refmiscinfo class="other" otherclass="value">B0<alt>1414x1000mm</alt></refmiscinfo>
18405 <refmiscinfo class="other" otherclass="value">B1<alt>1000x707mm</alt></refmiscinfo>
18406 <refmiscinfo class="other" otherclass="value">B2<alt>707x500mm</alt></refmiscinfo>
18407 <refmiscinfo class="other" otherclass="value">B3<alt>500x353mm</alt></refmiscinfo>
18408 <refmiscinfo class="other" otherclass="value">B4<alt>353x250mm</alt></refmiscinfo>
18409 <refmiscinfo class="other" otherclass="value">B5<alt>250x176mm</alt></refmiscinfo>
18410 <refmiscinfo class="other" otherclass="value">B6<alt>176x125mm</alt></refmiscinfo>
18411 <refmiscinfo class="other" otherclass="value">B7<alt>125x88mm</alt></refmiscinfo>
18412 <refmiscinfo class="other" otherclass="value">B8<alt>88x62mm</alt></refmiscinfo>
18413 <refmiscinfo class="other" otherclass="value">B9<alt>62x44mm</alt></refmiscinfo>
18414 <refmiscinfo class="other" otherclass="value">B10<alt>44x31mm</alt></refmiscinfo>
18415 <refmiscinfo class="other" otherclass="value">C0<alt>1297x917mm</alt></refmiscinfo>
18416 <refmiscinfo class="other" otherclass="value">C1<alt>917x648mm</alt></refmiscinfo>
18417 <refmiscinfo class="other" otherclass="value">C2<alt>648x458mm</alt></refmiscinfo>
18418 <refmiscinfo class="other" otherclass="value">C3<alt>458x324mm</alt></refmiscinfo>
18419 <refmiscinfo class="other" otherclass="value">C4<alt>324x229mm</alt></refmiscinfo>
18420 <refmiscinfo class="other" otherclass="value">C5<alt>229x162mm</alt></refmiscinfo>
18421 <refmiscinfo class="other" otherclass="value">C6<alt>162x114mm</alt></refmiscinfo>
18422 <refmiscinfo class="other" otherclass="value">C7<alt>114x81mm</alt></refmiscinfo>
18423 <refmiscinfo class="other" otherclass="value">C8<alt>81x57mm</alt></refmiscinfo>
18424 <refmiscinfo class="other" otherclass="value">C9<alt>57x40mm</alt></refmiscinfo>
18425 <refmiscinfo class="other" otherclass="value">C10<alt>40x28mm</alt></refmiscinfo>
18428 <refname>paper.type</refname>
18429 <refpurpose>Select the paper type</refpurpose>
18433 <programlisting id="paper.type.frag">
18434 <xsl:param name="paper.type">USletter</xsl:param>
18438 <refsection><info><title>Description</title></info>
18440 <para>The paper type is a convenient way to specify the paper size.
18441 The list of known paper sizes includes USletter and most of the A,
18442 B, and C sizes. See <parameter>page.width.portrait</parameter>, for example.
18450 <refentry version="5.0" id="double.sided">
18452 <refentrytitle>double.sided</refentrytitle>
18453 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
18456 <refname>double.sided</refname>
18457 <refpurpose>Is the document to be printed double sided?</refpurpose>
18461 <programlisting id="double.sided.frag">
18462 <xsl:param name="double.sided" select="0"></xsl:param>
18466 <refsection><info><title>Description</title></info>
18468 <para>Double-sided documents are printed with a slightly wider margin
18469 on the binding edge of the page.
18471 <para>FIXME: The current set of parameters does not take writing direction
18472 into account.</para>
18477 <refentry version="5.0" id="body.margin.bottom">
18479 <refentrytitle>body.margin.bottom</refentrytitle>
18480 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
18483 <refname>body.margin.bottom</refname>
18484 <refpurpose>The bottom margin of the body text</refpurpose>
18488 <programlisting id="body.margin.bottom.frag">
18489 <xsl:param name="body.margin.bottom">0.5in</xsl:param>
18493 <refsection><info><title>Description</title></info>
18495 <para>The body bottom margin is the distance from the last line of text
18496 in the page body to the bottom of the region-after.
18502 <refentry version="5.0" id="body.margin.top">
18504 <refentrytitle>body.margin.top</refentrytitle>
18505 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
18508 <refname>body.margin.top</refname>
18509 <refpurpose>To specify the size of the top margin of a page</refpurpose>
18513 <programlisting id="body.margin.top.frag">
18514 <xsl:param name="body.margin.top">0.5in</xsl:param>
18518 <refsection><info><title>Description</title></info>
18520 <para>The body top margin is the distance from the top of the
18521 region-before to the first line of text in the page body.</para>
18526 <refentry version="5.0" id="body.start.indent">
18528 <refentrytitle>body.start.indent</refentrytitle>
18529 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
18532 <refname>body.start.indent</refname>
18533 <refpurpose>The start-indent for the body text</refpurpose>
18537 <programlisting id="body.start.indent.frag">
18538 <xsl:param name="body.start.indent">
18540 <xsl:when test="$fop.extensions != 0">0pt</xsl:when>
18541 <xsl:when test="$passivetex.extensions != 0">0pt</xsl:when>
18542 <xsl:otherwise>4pc</xsl:otherwise>
18543 </xsl:choose>
18548 <refsection><info><title>Description</title></info>
18550 <para>This parameter provides
18551 the means of indenting the body text relative to
18553 For left-to-right text direction, it indents the left side.
18554 For right-to-left text direction, it indents the right side.
18555 It is used in place of the
18556 <parameter>title.margin.left</parameter> for
18557 all XSL-FO processors except FOP 0.25.
18558 It enables support for side floats to appear
18559 in the indented margin area.
18561 <para>This start-indent property is added to the fo:flow
18562 for certain page sequences. Which page-sequences it is
18563 applied to is determined by the template named
18564 <literal>set.flow.properties</literal>.
18565 By default, that template adds it to the flow
18566 for page-sequences using the <quote>body</quote>
18567 master-reference, as well as appendixes and prefaces.
18569 <para>If this parameter is used, section titles should have
18570 a start-indent value of 0pt if they are to be
18571 outdented relative to the body text.
18574 <para>If you are using FOP, then set this parameter to a zero
18575 width value and set the <parameter>title.margin.left</parameter>
18576 parameter to the negative value of the desired indent.
18579 <para>See also <parameter>body.end.indent</parameter> and
18580 <parameter>title.margin.left</parameter>.
18586 <refentry version="5.0" id="body.end.indent">
18588 <refentrytitle>body.end.indent</refentrytitle>
18589 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
18592 <refname>body.end.indent</refname>
18593 <refpurpose>The end-indent for the body text</refpurpose>
18597 <programlisting id="body.end.indent.frag">
18598 <xsl:param name="body.end.indent">0pt</xsl:param>
18602 <refsection><info><title>Description</title></info>
18604 <para>This end-indent property is added to the fo:flow
18605 for certain page sequences. Which page-sequences it is
18606 applied to is determined by the template named
18607 <literal>set.flow.properties</literal>.
18608 By default, that template adds it to the flow
18609 for page-sequences using the <quote>body</quote>
18610 master-reference, as well as appendixes and prefaces.
18613 <para>See also <parameter>body.start.indent</parameter>.
18619 <refentry version="5.0" id="alignment">
18621 <refentrytitle>alignment</refentrytitle>
18622 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
18623 <refmiscinfo class="other" otherclass="list-type">open</refmiscinfo>
18624 <refmiscinfo class="other" otherclass="value">left</refmiscinfo>
18625 <refmiscinfo class="other" otherclass="value">start</refmiscinfo>
18626 <refmiscinfo class="other" otherclass="value">right</refmiscinfo>
18627 <refmiscinfo class="other" otherclass="value">end</refmiscinfo>
18628 <refmiscinfo class="other" otherclass="value">center</refmiscinfo>
18629 <refmiscinfo class="other" otherclass="value">justify</refmiscinfo>
18632 <refname>alignment</refname>
18633 <refpurpose>Specify the default text alignment</refpurpose>
18637 <programlisting id="alignment.frag"><xsl:param name="alignment">justify</xsl:param></programlisting>
18640 <refsection><info><title>Description</title></info>
18642 <para>The default text alignment is used for most body text.
18644 <literal>left</literal>,
18645 <literal>right</literal>,
18646 <literal>start</literal>,
18647 <literal>end</literal>,
18648 <literal>center</literal>,
18649 <literal>justify</literal>.
18650 The default value is <literal>justify</literal>.
18656 <refentry version="5.0" id="hyphenate">
18658 <refentrytitle>hyphenate</refentrytitle>
18659 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
18660 <refmiscinfo class="other" otherclass="list-type">closed</refmiscinfo>
18661 <refmiscinfo class="other" otherclass="value">true</refmiscinfo>
18662 <refmiscinfo class="other" otherclass="value">false</refmiscinfo>
18665 <refname>hyphenate</refname>
18666 <refpurpose>Specify hyphenation behavior</refpurpose>
18670 <programlisting id="hyphenate.frag"><xsl:param name="hyphenate">true</xsl:param></programlisting>
18673 <refsection><info><title>Description</title></info>
18675 <para>If true, words may be hyphenated. Otherwise, they may not.
18681 <refentry version="5.0" id="line-height">
18683 <refentrytitle>line-height</refentrytitle>
18684 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
18687 <refname>line-height</refname>
18688 <refpurpose>Specify the line-height property</refpurpose>
18692 <programlisting id="line-height.frag">
18693 <xsl:param name="line-height">normal</xsl:param>
18697 <refsection><info><title>Description</title></info>
18699 <para>Sets the line-height property.</para>
18704 <refentry version="5.0" id="column.count.back">
18706 <refentrytitle>column.count.back</refentrytitle>
18707 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
18710 <refname>column.count.back</refname>
18711 <refpurpose>Number of columns on back matter pages</refpurpose>
18715 <programlisting id="column.count.back.frag">
18716 <xsl:param name="column.count.back" select="1"></xsl:param>
18720 <refsection><info><title>Description</title></info>
18722 <para>Number of columns on back matter (appendix, glossary, etc.) pages.</para>
18727 <refentry version="5.0" id="column.count.body">
18729 <refentrytitle>column.count.body</refentrytitle>
18730 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
18733 <refname>column.count.body</refname>
18734 <refpurpose>Number of columns on body pages</refpurpose>
18738 <programlisting id="column.count.body.frag">
18739 <xsl:param name="column.count.body" select="1"></xsl:param>
18743 <refsection><info><title>Description</title></info>
18745 <para>Number of columns on body pages.</para>
18750 <refentry version="5.0" id="column.count.front">
18752 <refentrytitle>column.count.front</refentrytitle>
18753 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
18756 <refname>column.count.front</refname>
18757 <refpurpose>Number of columns on front matter pages</refpurpose>
18761 <programlisting id="column.count.front.frag">
18762 <xsl:param name="column.count.front" select="1"></xsl:param>
18766 <refsection><info><title>Description</title></info>
18768 <para>Number of columns on front matter (dedication, preface, etc.) pages.</para>
18773 <refentry version="5.0" id="column.count.index">
18775 <refentrytitle>column.count.index</refentrytitle>
18776 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
18779 <refname>column.count.index</refname>
18780 <refpurpose>Number of columns on index pages</refpurpose>
18784 <programlisting id="column.count.index.frag">
18785 <xsl:param name="column.count.index">2</xsl:param>
18789 <refsection><info><title>Description</title></info>
18791 <para>Number of columns on index pages.</para>
18796 <refentry version="5.0" id="column.count.lot">
18798 <refentrytitle>column.count.lot</refentrytitle>
18799 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
18802 <refname>column.count.lot</refname>
18803 <refpurpose>Number of columns on a 'List-of-Titles' page</refpurpose>
18807 <programlisting id="column.count.lot.frag">
18808 <xsl:param name="column.count.lot" select="1"></xsl:param>
18812 <refsection><info><title>Description</title></info>
18814 <para>Number of columns on a page sequence containing the Table of Contents,
18815 List of Figures, etc.</para>
18820 <refentry version="5.0" id="column.count.titlepage">
18822 <refentrytitle>column.count.titlepage</refentrytitle>
18823 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
18826 <refname>column.count.titlepage</refname>
18827 <refpurpose>Number of columns on a title page</refpurpose>
18831 <programlisting id="column.count.titlepage.frag">
18832 <xsl:param name="column.count.titlepage" select="1"></xsl:param>
18836 <refsection><info><title>Description</title></info>
18838 <para>Number of columns on a title page</para>
18843 <refentry version="5.0" id="column.gap.back">
18845 <refentrytitle>column.gap.back</refentrytitle>
18846 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
18849 <refname>column.gap.back</refname>
18850 <refpurpose>Gap between columns in back matter</refpurpose>
18854 <programlisting id="column.gap.back.frag">
18855 <xsl:param name="column.gap.back">12pt</xsl:param>
18859 <refsection><info><title>Description</title></info>
18861 <para>Specifies the gap between columns in back matter (if
18862 <parameter>column.count.back</parameter> is greater than one).</para>
18867 <refentry version="5.0" id="column.gap.body">
18869 <refentrytitle>column.gap.body</refentrytitle>
18870 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
18873 <refname>column.gap.body</refname>
18874 <refpurpose>Gap between columns in the body</refpurpose>
18878 <programlisting id="column.gap.body.frag">
18879 <xsl:param name="column.gap.body">12pt</xsl:param>
18883 <refsection><info><title>Description</title></info>
18885 <para>Specifies the gap between columns in body matter (if
18886 <parameter>column.count.body</parameter> is greater than one).</para>
18891 <refentry version="5.0" id="column.gap.front">
18893 <refentrytitle>column.gap.front</refentrytitle>
18894 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
18897 <refname>column.gap.front</refname>
18898 <refpurpose>Gap between columns in the front matter</refpurpose>
18902 <programlisting id="column.gap.front.frag">
18903 <xsl:param name="column.gap.front">12pt</xsl:param>
18907 <refsection><info><title>Description</title></info>
18909 <para>Specifies the gap between columns in front matter (if
18910 <parameter>column.count.front</parameter> is greater than one).</para>
18915 <refentry version="5.0" id="column.gap.index">
18917 <refentrytitle>column.gap.index</refentrytitle>
18918 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
18921 <refname>column.gap.index</refname>
18922 <refpurpose>Gap between columns in the index</refpurpose>
18926 <programlisting id="column.gap.index.frag">
18927 <xsl:param name="column.gap.index">12pt</xsl:param>
18931 <refsection><info><title>Description</title></info>
18933 <para>Specifies the gap between columns in indexes (if
18934 <parameter>column.count.index</parameter> is greater than one).</para>
18939 <refentry version="5.0" id="column.gap.lot">
18941 <refentrytitle>column.gap.lot</refentrytitle>
18942 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
18945 <refname>column.gap.lot</refname>
18946 <refpurpose>Gap between columns on a 'List-of-Titles' page</refpurpose>
18950 <programlisting id="column.gap.lot.frag">
18951 <xsl:param name="column.gap.lot">12pt</xsl:param>
18955 <refsection><info><title>Description</title></info>
18957 <para>Specifies the gap between columns on 'List-of-Titles' pages (if
18958 <parameter>column.count.lot</parameter> is greater than one).</para>
18963 <refentry version="5.0" id="column.gap.titlepage">
18965 <refentrytitle>column.gap.titlepage</refentrytitle>
18966 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
18969 <refname>column.gap.titlepage</refname>
18970 <refpurpose>Gap between columns on title pages</refpurpose>
18974 <programlisting id="column.gap.titlepage.frag">
18975 <xsl:param name="column.gap.titlepage">12pt</xsl:param>
18979 <refsection><info><title>Description</title></info>
18981 <para>Specifies the gap between columns on title pages (if
18982 <parameter>column.count.titlepage</parameter> is greater than one).</para>
18988 <refentry version="5.0" id="region.after.extent">
18990 <refentrytitle>region.after.extent</refentrytitle>
18991 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
18994 <refname>region.after.extent</refname>
18995 <refpurpose>Specifies the height of the footer.</refpurpose>
18999 <programlisting id="region.after.extent.frag">
19000 <xsl:param name="region.after.extent">0.4in</xsl:param>
19004 <refsection><info><title>Description</title></info>
19006 <para>The region after extent is the height of the area where footers
19013 <refentry version="5.0" id="region.before.extent">
19015 <refentrytitle>region.before.extent</refentrytitle>
19016 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
19019 <refname>region.before.extent</refname>
19020 <refpurpose>Specifies the height of the header</refpurpose>
19024 <programlisting id="region.before.extent.frag">
19025 <xsl:param name="region.before.extent">0.4in</xsl:param>
19029 <refsection><info><title>Description</title></info>
19031 <para>The region before extent is the height of the area where headers
19038 <refentry version="5.0" id="default.units">
19040 <refentrytitle>default.units</refentrytitle>
19041 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
19042 <refmiscinfo class="other" otherclass="value">cm</refmiscinfo>
19043 <refmiscinfo class="other" otherclass="value">mm</refmiscinfo>
19044 <refmiscinfo class="other" otherclass="value">in</refmiscinfo>
19045 <refmiscinfo class="other" otherclass="value">pt</refmiscinfo>
19046 <refmiscinfo class="other" otherclass="value">pc</refmiscinfo>
19047 <refmiscinfo class="other" otherclass="value">px</refmiscinfo>
19048 <refmiscinfo class="other" otherclass="value">em</refmiscinfo>
19051 <refname>default.units</refname>
19052 <refpurpose>Default units for an unqualified dimension</refpurpose>
19056 <programlisting id="default.units.frag">
19057 <xsl:param name="default.units">pt</xsl:param>
19061 <refsection><info><title>Description</title></info>
19063 <para>If an unqualified dimension is encountered (for example, in a
19064 graphic width), the <parameter>default.units</parameter> will be used for the
19065 units. Unqualified dimensions are not allowed in XSL Formatting Objects.
19071 <refentry version="5.0" id="normal.para.spacing">
19073 <refentrytitle>normal.para.spacing</refentrytitle>
19074 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
19077 <refname>normal.para.spacing</refname>
19078 <refpurpose>What space do you want between normal paragraphs</refpurpose>
19082 <programlisting id="normal.para.spacing.frag"><xsl:attribute-set name="normal.para.spacing">
19083 <xsl:attribute name="space-before.optimum">1em</xsl:attribute>
19084 <xsl:attribute name="space-before.minimum">0.8em</xsl:attribute>
19085 <xsl:attribute name="space-before.maximum">1.2em</xsl:attribute>
19086 </xsl:attribute-set></programlisting>
19088 <refsection><info><title>Description</title></info>
19089 <para>Specify the spacing required between normal paragraphs</para>
19093 <refentry version="5.0" id="body.font.master">
19095 <refentrytitle>body.font.master</refentrytitle>
19096 <refmiscinfo class="other" otherclass="datatype">number</refmiscinfo>
19099 <refname>body.font.master</refname>
19100 <refpurpose>Specifies the default point size for body text</refpurpose>
19104 <programlisting id="body.font.master.frag">
19105 <xsl:param name="body.font.master">10</xsl:param>
19109 <refsection><info><title>Description</title></info>
19111 <para>The body font size is specified in two parameters
19112 (<parameter>body.font.master</parameter> and <parameter>body.font.size</parameter>)
19113 so that math can be performed on the font size by XSLT.
19119 <refentry version="5.0" id="body.font.size">
19121 <refentrytitle>body.font.size</refentrytitle>
19122 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
19125 <refname>body.font.size</refname>
19126 <refpurpose>Specifies the default font size for body text</refpurpose>
19130 <programlisting id="body.font.size.frag">
19131 <xsl:param name="body.font.size">
19132 <xsl:value-of select="$body.font.master"></xsl:value-of><xsl:text>pt</xsl:text>
19133 </xsl:param></programlisting>
19136 <refsection><info><title>Description</title></info>
19138 <para>The body font size is specified in two parameters
19139 (<parameter>body.font.master</parameter> and <parameter>body.font.size</parameter>)
19140 so that math can be performed on the font size by XSLT.
19146 <refentry version="5.0" id="footnote.font.size">
19148 <refentrytitle>footnote.font.size</refentrytitle>
19149 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
19152 <refname>footnote.font.size</refname>
19153 <refpurpose>The font size for footnotes</refpurpose>
19157 <programlisting id="footnote.font.size.frag"><xsl:param name="footnote.font.size">
19158 <xsl:value-of select="$body.font.master * 0.8"></xsl:value-of><xsl:text>pt</xsl:text>
19159 </xsl:param></programlisting>
19162 <refsection><info><title>Description</title></info>
19164 <para>The footnote font size is used for...footnotes!
19170 <refentry version="5.0" id="title.margin.left">
19172 <refentrytitle>title.margin.left</refentrytitle>
19173 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
19176 <refname>title.margin.left</refname>
19177 <refpurpose>Adjust the left margin for titles</refpurpose>
19181 <programlisting id="title.margin.left.frag">
19182 <xsl:param name="title.margin.left">
19184 <xsl:when test="$fop.extensions != 0">-4pc</xsl:when>
19185 <xsl:when test="$passivetex.extensions != 0">0pt</xsl:when>
19186 <xsl:otherwise>0pt</xsl:otherwise>
19187 </xsl:choose>
19192 <refsection><info><title>Description</title></info>
19194 <para>This parameter provides
19195 the means of adjusting the left margin for titles
19196 when the XSL-FO processor being used is
19197 an old version of FOP (0.25 and earlier).
19198 It is only useful when the <parameter>fop.extensions</parameter>
19201 <para>The left margin of the body region
19202 is calculated to include this space,
19203 and titles are outdented to the left outside
19204 the body region by this amount,
19205 effectively leaving titles at the intended left margin
19206 and the body text indented.
19207 Currently this method is only used for old FOP because
19208 it cannot properly use the <parameter>body.start.indent</parameter>
19212 The default value when the <parameter>fop.extensions</parameter>
19213 parameter is nonzero is -4pc, which means the
19214 body text is indented 4 picas relative to
19216 The default value when the <parameter>fop.extensions</parameter>
19217 parameter equals zero is 0pt, and
19218 the body indent should instead be specified
19219 using the <parameter>body.start.indent</parameter>
19223 If you set the value to zero, be sure to still include
19224 a unit indicator such as <literal>0pt</literal>, or
19225 the FO processor will report errors.
19231 <refentry version="5.0" id="draft.mode">
19233 <refentrytitle>draft.mode</refentrytitle>
19234 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
19235 <refmiscinfo class="other" otherclass="value">no</refmiscinfo>
19236 <refmiscinfo class="other" otherclass="value">yes</refmiscinfo>
19237 <refmiscinfo class="other" otherclass="value">maybe</refmiscinfo>
19240 <refname>draft.mode</refname>
19241 <refpurpose>Select draft mode</refpurpose>
19245 <programlisting id="draft.mode.frag">
19246 <xsl:param name="draft.mode">no</xsl:param>
19250 <refsection><info><title>Description</title></info>
19252 <para>Selects draft mode. If <parameter>draft.mode</parameter> is
19253 <quote><literal>yes</literal></quote>, the entire document will be treated
19254 as a draft. If it is <quote><literal>no</literal></quote>, the entire document
19255 will be treated as a final copy. If it is <quote><literal>maybe</literal></quote>,
19256 individual sections will be treated as draft or final independently, depending
19257 on how their <literal>status</literal> attribute is set.
19263 <refentry version="5.0" id="draft.watermark.image">
19265 <refentrytitle>draft.watermark.image</refentrytitle>
19266 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
19269 <refname>draft.watermark.image</refname>
19270 <refpurpose>The URI of the image to be used for draft watermarks</refpurpose>
19274 <programlisting id="draft.watermark.image.frag">
19275 <xsl:param name="draft.watermark.image">images/draft.png</xsl:param>
19279 <refsection><info><title>Description</title></info>
19281 <para>The image to be used for draft watermarks.</para>
19286 <refentry version="5.0" id="headers.on.blank.pages">
19288 <refentrytitle>headers.on.blank.pages</refentrytitle>
19289 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
19292 <refname>headers.on.blank.pages</refname>
19293 <refpurpose>Put headers on blank pages?</refpurpose>
19297 <programlisting id="headers.on.blank.pages.frag">
19298 <xsl:param name="headers.on.blank.pages" select="1"></xsl:param>
19302 <refsection><info><title>Description</title></info>
19304 <para>If non-zero, headers will be placed on blank pages.</para>
19309 <refentry version="5.0" id="footers.on.blank.pages">
19311 <refentrytitle>footers.on.blank.pages</refentrytitle>
19312 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
19315 <refname>footers.on.blank.pages</refname>
19316 <refpurpose>Put footers on blank pages?</refpurpose>
19320 <programlisting id="footers.on.blank.pages.frag">
19321 <xsl:param name="footers.on.blank.pages" select="1"></xsl:param>
19325 <refsection><info><title>Description</title></info>
19327 <para>If non-zero, footers will be placed on blank pages.</para>
19332 <refentry version="5.0" id="header.rule">
19334 <refentrytitle>header.rule</refentrytitle>
19335 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
19338 <refname>header.rule</refname>
19339 <refpurpose>Rule under headers?</refpurpose>
19343 <programlisting id="header.rule.frag">
19344 <xsl:param name="header.rule" select="1"></xsl:param>
19348 <refsection><info><title>Description</title></info>
19350 <para>If non-zero, a rule will be drawn below the page headers.</para>
19355 <refentry version="5.0" id="footer.rule">
19357 <refentrytitle>footer.rule</refentrytitle>
19358 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
19361 <refname>footer.rule</refname>
19362 <refpurpose>Rule over footers?</refpurpose>
19366 <programlisting id="footer.rule.frag">
19367 <xsl:param name="footer.rule" select="1"></xsl:param>
19371 <refsection><info><title>Description</title></info>
19373 <para>If non-zero, a rule will be drawn above the page footers.</para>
19378 <refentry version="5.0" id="header.column.widths">
19380 <refentrytitle>header.column.widths</refentrytitle>
19381 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
19384 <refname>header.column.widths</refname>
19385 <refpurpose>Specify relative widths of header areas</refpurpose>
19388 <refsynopsisdiv><programlisting id="header.column.widths.frag">
19389 <xsl:param name="header.column.widths">1 1 1</xsl:param>
19390 </programlisting></refsynopsisdiv>
19392 <refsection><info><title>Description</title></info>
19394 <para>Page headers in print output use a three column table
19395 to position text at the left, center, and right side of
19396 the header on the page.
19397 This parameter lets you specify the relative sizes of the
19398 three columns. The default value is
19401 <para>The parameter value must be three numbers, separated
19402 by white space. The first number represents the relative
19403 width of the inside header for
19404 double-sided output. The second number is the relative
19405 width of the center header. The third number is the
19406 relative width of the outside header for
19407 double-sided output.
19409 <para>For single-sided output, the first number is the
19410 relative width of left header for left-to-right
19411 text direction, or the right header for right-to-left
19413 The third number is the
19414 relative width of right header for left-to-right
19415 text direction, or the left header for right-to-left
19416 text direction.</para>
19418 <para>The numbers are used to specify the column widths
19419 for the table that makes up the header area.
19420 In the FO output, this looks like:
19424 <fo:table-column column-number="1"
19425 column-width="proportional-column-width(1)"/>
19429 The <literal>proportional-column-width()</literal>
19430 function computes a column width by dividing its
19431 argument by the total of the arguments for all the columns, and
19432 then multiplying the result by the width of the whole table
19433 (assuming all the column specs use the function).
19434 Its argument can be any positive integer or floating point number.
19435 Zero is an acceptable value, although some FO processors
19436 may warn about it, in which case using a very small number might
19437 be more satisfactory.
19440 <para>For example, the value "1 2 1" means the center
19441 header should have twice the width of the other areas.
19442 A value of "0 0 1" means the entire header area
19443 is reserved for the right (or outside) header text.
19444 Note that to keep the center area centered on
19445 the page, the left and right values must be
19446 the same. A specification like "1 2 3" means the
19447 center area is no longer centered on the page
19448 since the right area is three times the width of the left area.
19454 <refentry version="5.0" id="footer.column.widths">
19456 <refentrytitle>footer.column.widths</refentrytitle>
19457 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
19460 <refname>footer.column.widths</refname>
19461 <refpurpose>Specify relative widths of footer areas</refpurpose>
19464 <refsynopsisdiv><programlisting id="footer.column.widths.frag">
19465 <xsl:param name="footer.column.widths">1 1 1</xsl:param>
19466 </programlisting></refsynopsisdiv>
19468 <refsection><info><title>Description</title></info>
19470 <para>Page footers in print output use a three column table
19471 to position text at the left, center, and right side of
19472 the footer on the page.
19473 This parameter lets you specify the relative sizes of the
19474 three columns. The default value is
19477 <para>The parameter value must be three numbers, separated
19478 by white space. The first number represents the relative
19479 width of the inside footer for
19480 double-sided output. The second number is the relative
19481 width of the center footer. The third number is the
19482 relative width of the outside footer for
19483 double-sided output.
19485 <para>For single-sided output, the first number is the
19486 relative width of left footer for left-to-right
19487 text direction, or the right footer for right-to-left
19489 The third number is the
19490 relative width of right footer for left-to-right
19491 text direction, or the left footer for right-to-left
19492 text direction.</para>
19494 <para>The numbers are used to specify the column widths
19495 for the table that makes up the footer area.
19496 In the FO output, this looks like:
19500 <fo:table-column column-number="1"
19501 column-width="proportional-column-width(1)"/>
19505 The <literal>proportional-column-width()</literal>
19506 function computes a column width by dividing its
19507 argument by the total of the arguments for all the columns, and
19508 then multiplying the result by the width of the whole table
19509 (assuming all the column specs use the function).
19510 Its argument can be any positive integer or floating point number.
19511 Zero is an acceptable value, although some FO processors
19512 may warn about it, in which case using a very small number might
19513 be more satisfactory.
19516 <para>For example, the value "1 2 1" means the center
19517 footer should have twice the width of the other areas.
19518 A value of "0 0 1" means the entire footer area
19519 is reserved for the right (or outside) footer text.
19520 Note that to keep the center area centered on
19521 the page, the left and right values must be
19522 the same. A specification like "1 2 3" means the
19523 center area is no longer centered on the page
19524 since the right area is three times the width of the left area.
19530 <refentry version="5.0" id="header.table.properties">
19532 <refentrytitle>header.table.properties</refentrytitle>
19533 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
19536 <refname>header.table.properties</refname>
19537 <refpurpose>Apply properties to the header layout table</refpurpose>
19541 <programlisting id="header.table.properties.frag">
19542 <xsl:attribute-set name="header.table.properties">
19543 <xsl:attribute name="table-layout">fixed</xsl:attribute>
19544 <xsl:attribute name="width">100%</xsl:attribute>
19545 </xsl:attribute-set>
19549 <refsection><info><title>Description</title></info>
19551 <para>Properties applied to the table that lays out the page header.</para>
19556 <refentry version="5.0" id="header.table.height">
19558 <refentrytitle>header.table.height</refentrytitle>
19559 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
19562 <refname>header.table.height</refname>
19563 <refpurpose>Specify the minimum height of the table containing the running page headers</refpurpose>
19566 <refsynopsisdiv><programlisting id="header.table.height.frag">
19567 <xsl:param name="header.table.height">14pt</xsl:param>
19568 </programlisting></refsynopsisdiv>
19570 <refsection><info><title>Description</title></info>
19572 <para>Page headers in print output use a three column table
19573 to position text at the left, center, and right side of
19574 the header on the page.
19575 This parameter lets you specify the minimum height
19576 of the single row in the table.
19577 Since this specifies only the minimum height,
19578 the table should automatically grow to fit taller content.
19579 The default value is "14pt".</para>
19584 <refentry version="5.0" id="footer.table.properties">
19586 <refentrytitle>footer.table.properties</refentrytitle>
19587 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
19590 <refname>footer.table.properties</refname>
19591 <refpurpose>Apply properties to the footer layout table</refpurpose>
19595 <programlisting id="footer.table.properties.frag">
19596 <xsl:attribute-set name="footer.table.properties">
19597 <xsl:attribute name="table-layout">fixed</xsl:attribute>
19598 <xsl:attribute name="width">100%</xsl:attribute>
19599 </xsl:attribute-set>
19603 <refsection><info><title>Description</title></info>
19605 <para>Properties applied to the table that lays out the page footer.</para>
19610 <refentry version="5.0" id="footer.table.height">
19612 <refentrytitle>footer.table.height</refentrytitle>
19613 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
19616 <refname>footer.table.height</refname>
19617 <refpurpose>Specify the minimum height of the table containing the running page footers</refpurpose>
19620 <refsynopsisdiv><programlisting id="footer.table.height.frag">
19621 <xsl:param name="footer.table.height">14pt</xsl:param>
19622 </programlisting></refsynopsisdiv>
19624 <refsection><info><title>Description</title></info>
19626 <para>Page footers in print output use a three column table
19627 to position text at the left, center, and right side of
19628 the footer on the page.
19629 This parameter lets you specify the minimum height
19630 of the single row in the table.
19631 Since this specifies only the minimum height,
19632 the table should automatically grow to fit taller content.
19633 The default value is "14pt".</para>
19638 <refentry version="5.0" id="header.content.properties">
19640 <refentrytitle>header.content.properties</refentrytitle>
19641 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
19644 <refname>header.content.properties</refname>
19645 <refpurpose>Properties of page header content</refpurpose>
19649 <programlisting id="header.content.properties.frag">
19650 <xsl:attribute-set name="header.content.properties">
19651 <xsl:attribute name="font-family">
19652 <xsl:value-of select="$body.fontset"></xsl:value-of>
19653 </xsl:attribute>
19654 <xsl:attribute name="margin-left">
19655 <xsl:value-of select="$title.margin.left"></xsl:value-of>
19656 </xsl:attribute>
19657 </xsl:attribute-set>
19661 <refsection><info><title>Description</title></info>
19663 <para>Properties of page header content.</para>
19668 <refentry version="5.0" id="footer.content.properties">
19670 <refentrytitle>footer.content.properties</refentrytitle>
19671 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
19674 <refname>footer.content.properties</refname>
19675 <refpurpose>Properties of page footer content</refpurpose>
19679 <programlisting id="footer.content.properties.frag">
19680 <xsl:attribute-set name="footer.content.properties">
19681 <xsl:attribute name="font-family">
19682 <xsl:value-of select="$body.fontset"></xsl:value-of>
19683 </xsl:attribute>
19684 <xsl:attribute name="margin-left">
19685 <xsl:value-of select="$title.margin.left"></xsl:value-of>
19686 </xsl:attribute>
19687 </xsl:attribute-set>
19691 <refsection><info><title>Description</title></info>
19693 <para>Properties of page footer content.</para>
19698 <refentry version="5.0" id="marker.section.level">
19700 <refentrytitle>marker.section.level</refentrytitle>
19701 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
19704 <refname>marker.section.level</refname>
19705 <refpurpose>Control depth of sections shown in running headers or footers</refpurpose>
19709 <programlisting id="marker.section.level.frag">
19710 <xsl:param name="marker.section.level">2</xsl:param>
19714 <refsection><info><title>Description</title></info>
19716 <para>The <parameter>marker.section.level</parameter> parameter
19717 controls the depth of section levels that may be displayed
19718 in running headers and footers. For example, if the value
19719 is 2 (the default), then titles from <tag>sect1</tag> and
19720 <tag>sect2</tag> or equivalent <tag>section</tag>
19721 elements are candidates for use in running headers and
19724 <para>Each candidate title is marked in the FO output with a
19725 <tag><fo:marker marker-class-name="section.head.marker"></tag>
19728 <para>In order for such titles to appear in headers
19729 or footers, the <literal>header.content</literal>
19730 or <literal>footer.content</literal> template
19731 must be customized to retrieve the marker using
19732 an output element such as:
19735 <fo:retrieve-marker retrieve-class-name="section.head.marker"
19736 retrieve-position="first-including-carryover"
19737 retrieve-boundary="page-sequence"/>
19744 </reference><reference id="fonts" xml:base="../fo/param.xml"><title>Font Families</title>
19745 <refentry version="5.0" id="body.font.family">
19747 <refentrytitle>body.font.family</refentrytitle>
19748 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
19749 <refmiscinfo class="other" otherclass="list-type">open</refmiscinfo>
19750 <refmiscinfo class="other" otherclass="value">serif</refmiscinfo>
19751 <refmiscinfo class="other" otherclass="value">sans-serif</refmiscinfo>
19752 <refmiscinfo class="other" otherclass="value">monospace</refmiscinfo>
19755 <refname>body.font.family</refname>
19756 <refpurpose>The default font family for body text</refpurpose>
19760 <programlisting id="body.font.family.frag">
19761 <xsl:param name="body.font.family">serif</xsl:param>
19765 <refsection><info><title>Description</title></info>
19767 <para>The body font family is the default font used for text in the page body.
19773 <refentry version="5.0" id="dingbat.font.family">
19775 <refentrytitle>dingbat.font.family</refentrytitle>
19776 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
19777 <refmiscinfo class="other" otherclass="list-type">open</refmiscinfo>
19778 <refmiscinfo class="other" otherclass="value">serif</refmiscinfo>
19779 <refmiscinfo class="other" otherclass="value">sans-serif</refmiscinfo>
19780 <refmiscinfo class="other" otherclass="value">monospace</refmiscinfo>
19783 <refname>dingbat.font.family</refname>
19784 <refpurpose>The font family for copyright, quotes, and other symbols</refpurpose>
19788 <programlisting id="dingbat.font.family.frag">
19789 <xsl:param name="dingbat.font.family">serif</xsl:param>
19793 <refsection><info><title>Description</title></info>
19795 <para>The dingbat font family is used for dingbats. If it is defined
19796 as the empty string, no font change is effected around dingbats.
19802 <refentry version="5.0" id="monospace.font.family">
19804 <refentrytitle>monospace.font.family</refentrytitle>
19805 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
19808 <refname>monospace.font.family</refname>
19809 <refpurpose>The default font family for monospace environments</refpurpose>
19813 <programlisting id="monospace.font.family.frag">
19814 <xsl:param name="monospace.font.family">monospace</xsl:param>
19818 <refsection><info><title>Description</title></info>
19820 <para>The monospace font family is used for verbatim environments
19821 (program listings, screens, etc.).
19827 <refentry version="5.0" id="sans.font.family">
19829 <refentrytitle>sans.font.family</refentrytitle>
19830 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
19833 <refname>sans.font.family</refname>
19834 <refpurpose>The default sans-serif font family</refpurpose>
19838 <programlisting id="sans.font.family.frag">
19839 <xsl:param name="sans.font.family">sans-serif</xsl:param>
19843 <refsection><info><title>Description</title></info>
19845 <para>The default sans-serif font family. At the present, this isn't
19846 actually used by the stylesheets.
19852 <refentry version="5.0" id="title.font.family">
19854 <refentrytitle>title.font.family</refentrytitle>
19855 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
19856 <refmiscinfo class="other" otherclass="list-type">open</refmiscinfo>
19857 <refmiscinfo class="other" otherclass="value">serif</refmiscinfo>
19858 <refmiscinfo class="other" otherclass="value">sans-serif</refmiscinfo>
19859 <refmiscinfo class="other" otherclass="value">monospace</refmiscinfo>
19862 <refname>title.font.family</refname>
19863 <refpurpose>The default font family for titles</refpurpose>
19867 <programlisting id="title.font.family.frag">
19868 <xsl:param name="title.font.family">sans-serif</xsl:param>
19872 <refsection><info><title>Description</title></info>
19874 <para>The title font family is used for titles (chapter, section, figure,
19881 <refentry version="5.0" id="symbol.font.family">
19883 <refentrytitle>symbol.font.family</refentrytitle>
19884 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
19885 <refmiscinfo class="other" otherclass="list-type">open</refmiscinfo>
19886 <refmiscinfo class="other" otherclass="value">serif</refmiscinfo>
19887 <refmiscinfo class="other" otherclass="value">sans-serif</refmiscinfo>
19888 <refmiscinfo class="other" otherclass="value">monospace</refmiscinfo>
19891 <refname>symbol.font.family</refname>
19892 <refpurpose>The font families to be searched for symbols outside
19893 of the body font</refpurpose>
19897 <programlisting id="symbol.font.family.frag">
19898 <xsl:param name="symbol.font.family">Symbol,ZapfDingbats</xsl:param>
19902 <refsection><info><title>Description</title></info>
19904 <para>A typical body or title font does not contain all
19905 the character glyphs that DocBook supports. This parameter
19906 specifies additional fonts that should be searched for
19907 special characters not in the normal font.
19908 These symbol font names are automatically appended
19909 to the body or title font family name when fonts
19911 <tag class="attribute">font-family</tag>
19912 property in the FO output.
19914 <para>The symbol font names should be entered as a
19915 comma-separated list. The default value is
19916 <literal>Symbol,ZapfDingbats</literal>.
19922 </reference><reference id="propsets" xml:base="../fo/param.xml"><title>Property Sets</title>
19923 <refentry version="5.0" id="formal.object.properties">
19925 <refentrytitle>formal.object.properties</refentrytitle>
19926 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
19929 <refname>formal.object.properties</refname>
19930 <refpurpose>Properties associated with a formal object such as a figure, or other component that has a title</refpurpose>
19934 <programlisting id="formal.object.properties.frag">
19935 <xsl:attribute-set name="formal.object.properties">
19936 <xsl:attribute name="space-before.minimum">0.5em</xsl:attribute>
19937 <xsl:attribute name="space-before.optimum">1em</xsl:attribute>
19938 <xsl:attribute name="space-before.maximum">2em</xsl:attribute>
19939 <xsl:attribute name="space-after.minimum">0.5em</xsl:attribute>
19940 <xsl:attribute name="space-after.optimum">1em</xsl:attribute>
19941 <xsl:attribute name="space-after.maximum">2em</xsl:attribute>
19942 <xsl:attribute name="keep-together.within-column">always</xsl:attribute>
19943 </xsl:attribute-set>
19947 <refsection><info><title>Description</title></info>
19949 <para>The styling for formal objects in docbook. Specify the spacing
19950 before and after the object.</para>
19955 <refentry version="5.0" id="formal.title.properties">
19957 <refentrytitle>formal.title.properties</refentrytitle>
19958 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
19961 <refname>formal.title.properties</refname>
19962 <refpurpose>Style the title element of formal object such as a figure.</refpurpose>
19966 <programlisting id="formal.title.properties.frag">
19967 <xsl:attribute-set name="formal.title.properties" use-attribute-sets="normal.para.spacing">
19968 <xsl:attribute name="font-weight">bold</xsl:attribute>
19969 <xsl:attribute name="font-size">
19970 <xsl:value-of select="$body.font.master * 1.2"></xsl:value-of>
19971 <xsl:text>pt</xsl:text>
19972 </xsl:attribute>
19973 <xsl:attribute name="hyphenate">false</xsl:attribute>
19974 <xsl:attribute name="space-after.minimum">0.4em</xsl:attribute>
19975 <xsl:attribute name="space-after.optimum">0.6em</xsl:attribute>
19976 <xsl:attribute name="space-after.maximum">0.8em</xsl:attribute>
19977 </xsl:attribute-set>
19980 <refsection><info><title>Description</title></info>
19981 <para>Specify how the title should be styled. Specify the font size and weight of the title of the formal object.</para>
19985 <refentry version="5.0" id="informal.object.properties">
19987 <refentrytitle>informal.object.properties</refentrytitle>
19988 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
19991 <refname>informal.object.properties</refname>
19992 <refpurpose>Properties associated with an informal (untitled) object, such as an informalfigure</refpurpose>
19996 <programlisting id="informal.object.properties.frag"><xsl:attribute-set name="informal.object.properties">
19997 <xsl:attribute name="space-before.minimum">0.5em</xsl:attribute>
19998 <xsl:attribute name="space-before.optimum">1em</xsl:attribute>
19999 <xsl:attribute name="space-before.maximum">2em</xsl:attribute>
20000 <xsl:attribute name="space-after.minimum">0.5em</xsl:attribute>
20001 <xsl:attribute name="space-after.optimum">1em</xsl:attribute>
20002 <xsl:attribute name="space-after.maximum">2em</xsl:attribute>
20003 </xsl:attribute-set></programlisting>
20005 <refsection><info><title>Description</title></info>
20006 <para>The styling for informal objects in docbook. Specify the spacing before and after the object.</para>
20010 <refentry version="5.0" id="monospace.properties">
20012 <refentrytitle>monospace.properties</refentrytitle>
20013 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
20016 <refname>monospace.properties</refname>
20017 <refpurpose>Properties of monospaced content</refpurpose>
20021 <programlisting id="monospace.properties.frag">
20022 <xsl:attribute-set name="monospace.properties">
20023 <xsl:attribute name="font-family">
20024 <xsl:value-of select="$monospace.font.family"></xsl:value-of>
20025 </xsl:attribute>
20026 </xsl:attribute-set>
20030 <refsection><info><title>Description</title></info>
20032 <para>Specifies the font name for monospaced output. This property set
20033 used to set the font-size as well, but that doesn't work very well
20034 when different fonts are used (as they are in titles and paragraphs,
20035 for example).</para>
20037 <para>If you want to set the font-size in a customization layer, it's
20038 probably going to be more appropriate to set font-size-adjust, if your
20039 formatter supports it.</para>
20044 <refentry version="5.0" id="verbatim.properties">
20046 <refentrytitle>verbatim.properties</refentrytitle>
20047 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
20050 <refname>verbatim.properties</refname>
20051 <refpurpose>Properties associated with verbatim text</refpurpose>
20055 <programlisting id="verbatim.properties.frag">
20056 <xsl:attribute-set name="verbatim.properties">
20057 <xsl:attribute name="space-before.minimum">0.8em</xsl:attribute>
20058 <xsl:attribute name="space-before.optimum">1em</xsl:attribute>
20059 <xsl:attribute name="space-before.maximum">1.2em</xsl:attribute>
20060 <xsl:attribute name="space-after.minimum">0.8em</xsl:attribute>
20061 <xsl:attribute name="space-after.optimum">1em</xsl:attribute>
20062 <xsl:attribute name="space-after.maximum">1.2em</xsl:attribute>
20063 <xsl:attribute name="hyphenate">false</xsl:attribute>
20064 <xsl:attribute name="wrap-option">no-wrap</xsl:attribute>
20065 <xsl:attribute name="white-space-collapse">false</xsl:attribute>
20066 <xsl:attribute name="white-space-treatment">preserve</xsl:attribute>
20067 <xsl:attribute name="linefeed-treatment">preserve</xsl:attribute>
20068 <xsl:attribute name="text-align">start</xsl:attribute>
20069 </xsl:attribute-set></programlisting>
20072 <refsection><info><title>Description</title></info>
20073 <para>This attribute set is used on all verbatim environments.</para>
20078 <refentry version="5.0" id="monospace.verbatim.properties">
20080 <refentrytitle>monospace.verbatim.properties</refentrytitle>
20081 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
20084 <refname>monospace.verbatim.properties</refname>
20085 <refpurpose>What font and size do you want for monospaced content?</refpurpose>
20089 <programlisting id="monospace.verbatim.properties.frag">
20090 <xsl:attribute-set name="monospace.verbatim.properties" use-attribute-sets="verbatim.properties monospace.properties">
20091 <xsl:attribute name="text-align">start</xsl:attribute>
20092 <xsl:attribute name="wrap-option">no-wrap</xsl:attribute>
20093 </xsl:attribute-set>
20096 <refsection><info><title>Description</title></info>
20097 <para>Specify the font name and size you want for monospaced output</para>
20101 <refentry version="5.0" id="sidebar.properties">
20103 <refentrytitle>sidebar.properties</refentrytitle>
20104 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
20107 <refname>sidebar.properties</refname>
20108 <refpurpose>Attribute set for sidebar properties</refpurpose>
20112 <programlisting id="sidebar.properties.frag">
20113 <xsl:attribute-set name="sidebar.properties" use-attribute-sets="formal.object.properties">
20114 <xsl:attribute name="border-style">solid</xsl:attribute>
20115 <xsl:attribute name="border-width">1pt</xsl:attribute>
20116 <xsl:attribute name="border-color">black</xsl:attribute>
20117 <xsl:attribute name="background-color">#DDDDDD</xsl:attribute>
20118 <xsl:attribute name="padding-start">12pt</xsl:attribute>
20119 <xsl:attribute name="padding-end">12pt</xsl:attribute>
20120 <xsl:attribute name="padding-top">6pt</xsl:attribute>
20121 <xsl:attribute name="padding-bottom">6pt</xsl:attribute>
20122 <xsl:attribute name="margin-{$direction.align.start}">0pt</xsl:attribute>
20123 <xsl:attribute name="margin-{$direction.align.end}">0pt</xsl:attribute>
20125 <xsl:attribute name="margin-top">6pt</xsl:attribute>
20126 <xsl:attribute name="margin-bottom">6pt</xsl:attribute>
20128 </xsl:attribute-set>
20132 <refsection><info><title>Description</title></info>
20134 <para>The styling for sidebars.</para>
20139 <refentry version="5.0" id="sidebar.title.properties">
20141 <refentrytitle>sidebar.title.properties</refentrytitle>
20142 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
20145 <refname>sidebar.title.properties</refname>
20146 <refpurpose>Attribute set for sidebar titles</refpurpose>
20150 <programlisting id="sidebar.title.properties.frag">
20151 <xsl:attribute-set name="sidebar.title.properties">
20152 <xsl:attribute name="font-weight">bold</xsl:attribute>
20153 <xsl:attribute name="hyphenate">false</xsl:attribute>
20154 <xsl:attribute name="text-align">start</xsl:attribute>
20155 <xsl:attribute name="keep-with-next.within-column">always</xsl:attribute>
20156 </xsl:attribute-set>
20160 <refsection><info><title>Description</title></info>
20162 <para>The styling for sidebars titles.</para>
20167 <refentry version="5.0" id="sidebar.float.type">
20169 <refentrytitle>sidebar.float.type</refentrytitle>
20170 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
20171 <refmiscinfo class="other" otherclass="value">none</refmiscinfo>
20172 <refmiscinfo class="other" otherclass="value">before</refmiscinfo>
20173 <refmiscinfo class="other" otherclass="value">left</refmiscinfo>
20174 <refmiscinfo class="other" otherclass="value">start</refmiscinfo>
20175 <refmiscinfo class="other" otherclass="value">right</refmiscinfo>
20176 <refmiscinfo class="other" otherclass="value">end</refmiscinfo>
20177 <refmiscinfo class="other" otherclass="value">inside</refmiscinfo>
20178 <refmiscinfo class="other" otherclass="value">outside</refmiscinfo>
20181 <refname>sidebar.float.type</refname>
20182 <refpurpose>Select type of float for sidebar elements</refpurpose>
20186 <programlisting id="sidebar.float.type.frag">
20187 <xsl:param name="sidebar.float.type">none</xsl:param>
20191 <refsection><info><title>Description</title></info>
20193 <para>Selects the type of float for sidebar elements.
20197 <para>If <parameter>sidebar.float.type</parameter> is
20198 <quote><literal>none</literal></quote>, then
20203 <para>If <parameter>sidebar.float.type</parameter> is
20204 <quote><literal>before</literal></quote>, then
20205 the float appears at the top of the page. On some processors,
20206 that may be the next page rather than the current page.
20211 <para>If <parameter>sidebar.float.type</parameter> is
20212 <quote><literal>left</literal></quote>,
20213 then a left side float is used.
20218 <para>If <parameter>sidebar.float.type</parameter> is
20219 <quote><literal>start</literal></quote>,
20220 then when the text direction is left-to-right a left side float is used.
20221 When the text direction is right-to-left, a right side float is used.
20226 <para>If <parameter>sidebar.float.type</parameter> is
20227 <quote><literal>right</literal></quote>,
20228 then a right side float is used.
20233 <para>If <parameter>sidebar.float.type</parameter> is
20234 <quote><literal>end</literal></quote>,
20235 then when the text direction is left-to-right a right side float is used.
20236 When the text direction is right-to-left, a left side float is used.
20241 <para>If your XSL-FO processor supports floats positioned on the
20242 <quote><literal>inside</literal></quote> or
20243 <quote><literal>outside</literal></quote>
20244 of double-sided pages, then you have those two
20245 options for side floats as well.
20253 <refentry version="5.0" id="sidebar.float.width">
20255 <refentrytitle>sidebar.float.width</refentrytitle>
20256 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
20259 <refname>sidebar.float.width</refname>
20260 <refpurpose>Set the default width for sidebars</refpurpose>
20264 <programlisting id="sidebar.float.width.frag">
20265 <xsl:param name="sidebar.float.width">1in</xsl:param>
20269 <refsection><info><title>Description</title></info>
20271 <para>Sets the default width for sidebars when used as a side float.
20272 The width determines the degree to which the sidebar block intrudes into
20275 <para>If <parameter>sidebar.float.type</parameter> is
20276 <quote><literal>before</literal></quote> or
20277 <quote><literal>none</literal></quote>, then
20278 this parameter is ignored.
20284 <refentry version="5.0" id="margin.note.properties">
20286 <refentrytitle>margin.note.properties</refentrytitle>
20287 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
20290 <refname>margin.note.properties</refname>
20291 <refpurpose>Attribute set for margin.note properties</refpurpose>
20295 <programlisting id="margin.note.properties.frag">
20296 <xsl:attribute-set name="margin.note.properties">
20297 <xsl:attribute name="font-size">90%</xsl:attribute>
20298 <xsl:attribute name="text-align">start</xsl:attribute>
20299 </xsl:attribute-set>
20303 <refsection><info><title>Description</title></info>
20305 <para>The styling for margin notes.
20306 By default, margin notes are not implemented for any
20307 element. A stylesheet customization is needed to make
20308 use of this attribute-set.</para>
20310 <para>You can use a template named <quote>floater</quote>
20311 to create the customization.
20312 That template can create side floats by specifying the
20313 content and characteristics as template parameters.
20316 <para>For example:</para>
20317 <programlisting><xsl:template match="para[@role='marginnote']">
20318 <xsl:call-template name="floater">
20319 <xsl:with-param name="position">
20320 <xsl:value-of select="$margin.note.float.type"/>
20321 </xsl:with-param>
20322 <xsl:with-param name="width">
20323 <xsl:value-of select="$margin.note.width"/>
20324 </xsl:with-param>
20325 <xsl:with-param name="content">
20326 <xsl:apply-imports/>
20327 </xsl:with-param>
20328 </xsl:call-template>
20329 </xsl:template></programlisting>
20334 <refentry version="5.0" id="margin.note.title.properties">
20336 <refentrytitle>margin.note.title.properties</refentrytitle>
20337 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
20340 <refname>margin.note.title.properties</refname>
20341 <refpurpose>Attribute set for margin note titles</refpurpose>
20345 <programlisting id="margin.note.title.properties.frag">
20346 <xsl:attribute-set name="margin.note.title.properties">
20347 <xsl:attribute name="font-weight">bold</xsl:attribute>
20348 <xsl:attribute name="hyphenate">false</xsl:attribute>
20349 <xsl:attribute name="text-align">start</xsl:attribute>
20350 <xsl:attribute name="keep-with-next.within-column">always</xsl:attribute>
20351 </xsl:attribute-set>
20355 <refsection><info><title>Description</title></info>
20357 <para>The styling for margin note titles.</para>
20362 <refentry version="5.0" id="margin.note.float.type">
20364 <refentrytitle>margin.note.float.type</refentrytitle>
20365 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
20366 <refmiscinfo class="other" otherclass="value">none</refmiscinfo>
20367 <refmiscinfo class="other" otherclass="value">before</refmiscinfo>
20368 <refmiscinfo class="other" otherclass="value">left</refmiscinfo>
20369 <refmiscinfo class="other" otherclass="value">start</refmiscinfo>
20370 <refmiscinfo class="other" otherclass="value">right</refmiscinfo>
20371 <refmiscinfo class="other" otherclass="value">end</refmiscinfo>
20372 <refmiscinfo class="other" otherclass="value">inside</refmiscinfo>
20373 <refmiscinfo class="other" otherclass="value">outside</refmiscinfo>
20376 <refname>margin.note.float.type</refname>
20377 <refpurpose>Select type of float for margin note customizations</refpurpose>
20381 <programlisting id="margin.note.float.type.frag">
20382 <xsl:param name="margin.note.float.type">none</xsl:param>
20386 <refsection><info><title>Description</title></info>
20388 <para>Selects the type of float for margin notes.
20389 DocBook does not define a margin note element, so this
20390 feature must be implemented as a customization of the stylesheet.
20391 See <parameter>margin.note.properties</parameter> for
20396 <para>If <parameter>margin.note.float.type</parameter> is
20397 <quote><literal>none</literal></quote>, then
20402 <para>If <parameter>margin.note.float.type</parameter> is
20403 <quote><literal>before</literal></quote>, then
20404 the float appears at the top of the page. On some processors,
20405 that may be the next page rather than the current page.
20409 <para>If <parameter>margin.note.float.type</parameter> is
20410 <quote><literal>left</literal></quote> or
20411 <quote><literal>start</literal></quote>, then
20412 a left side float is used.
20416 <para>If <parameter>margin.note.float.type</parameter> is
20417 <quote><literal>right</literal></quote> or
20418 <quote><literal>end</literal></quote>, then
20419 a right side float is used.
20423 <para>If your XSL-FO processor supports floats positioned on the
20424 <quote><literal>inside</literal></quote> or
20425 <quote><literal>outside</literal></quote>
20426 of double-sided pages, then you have those two
20427 options for side floats as well.
20435 <refentry version="5.0" id="margin.note.width">
20437 <refentrytitle>margin.note.width</refentrytitle>
20438 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
20441 <refname>margin.note.width</refname>
20442 <refpurpose>Set the default width for margin notes</refpurpose>
20446 <programlisting id="margin.note.width.frag">
20447 <xsl:param name="margin.note.width">1in</xsl:param>
20451 <refsection><info><title>Description</title></info>
20453 <para>Sets the default width for margin notes when used as a side
20454 float. The width determines the degree to which the margin note block
20455 intrudes into the text area.
20457 <para>If <parameter>margin.note.float.type</parameter> is
20458 <quote><literal>before</literal></quote> or
20459 <quote><literal>none</literal></quote>, then
20460 this parameter is ignored.
20466 <refentry version="5.0" id="component.title.properties">
20468 <refentrytitle>component.title.properties</refentrytitle>
20469 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
20472 <refname>component.title.properties</refname>
20473 <refpurpose>Properties for component titles</refpurpose>
20477 <programlisting id="component.title.properties.frag">
20478 <xsl:attribute-set name="component.title.properties">
20479 <xsl:attribute name="keep-with-next.within-column">always</xsl:attribute>
20480 <xsl:attribute name="space-before.optimum"><xsl:value-of select="concat($body.font.master, 'pt')"></xsl:value-of></xsl:attribute>
20481 <xsl:attribute name="space-before.minimum"><xsl:value-of select="concat($body.font.master, 'pt * 0.8')"></xsl:value-of></xsl:attribute>
20482 <xsl:attribute name="space-before.maximum"><xsl:value-of select="concat($body.font.master, 'pt * 1.2')"></xsl:value-of></xsl:attribute>
20483 <xsl:attribute name="hyphenate">false</xsl:attribute>
20484 <xsl:attribute name="text-align">
20486 <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>
20487 <xsl:otherwise>start</xsl:otherwise>
20488 </xsl:choose>
20489 </xsl:attribute>
20490 <xsl:attribute name="start-indent"><xsl:value-of select="$title.margin.left"></xsl:value-of></xsl:attribute>
20491 </xsl:attribute-set>
20495 <refsection><info><title>Description</title></info>
20497 <para>The properties common to all component titles.</para>
20502 <refentry version="5.0" id="component.titlepage.properties">
20504 <refentrytitle>component.titlepage.properties</refentrytitle>
20505 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
20508 <refname>component.titlepage.properties</refname>
20509 <refpurpose>Properties for component titlepages</refpurpose>
20513 <programlisting id="component.titlepage.properties.frag">
20514 <xsl:attribute-set name="component.titlepage.properties">
20515 </xsl:attribute-set>
20519 <refsection><info><title>Description</title></info>
20521 <para>The properties that are applied to the outer block containing
20522 all the component title page information.
20523 Its main use is to set a <literal>span="all"</literal>
20524 property on the block that is a direct child of the flow.</para>
20526 <para>This attribute-set also applies to index titlepages. It is empty by default.</para>
20531 <refentry version="5.0" id="section.title.properties">
20533 <refentrytitle>section.title.properties</refentrytitle>
20534 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
20537 <refname>section.title.properties</refname>
20538 <refpurpose>Properties for section titles</refpurpose>
20542 <programlisting id="section.title.properties.frag">
20543 <xsl:attribute-set name="section.title.properties">
20544 <xsl:attribute name="font-family">
20545 <xsl:value-of select="$title.font.family"></xsl:value-of>
20546 </xsl:attribute>
20547 <xsl:attribute name="font-weight">bold</xsl:attribute>
20548 <!-- font size is calculated dynamically by section.heading template -->
20549 <xsl:attribute name="keep-with-next.within-column">always</xsl:attribute>
20550 <xsl:attribute name="space-before.minimum">0.8em</xsl:attribute>
20551 <xsl:attribute name="space-before.optimum">1.0em</xsl:attribute>
20552 <xsl:attribute name="space-before.maximum">1.2em</xsl:attribute>
20553 <xsl:attribute name="text-align">start</xsl:attribute>
20554 <xsl:attribute name="start-indent"><xsl:value-of select="$title.margin.left"></xsl:value-of></xsl:attribute>
20555 </xsl:attribute-set>
20559 <refsection><info><title>Description</title></info>
20561 <para>The properties common to all section titles.</para>
20566 <refentry version="5.0" id="section.title.level1.properties">
20568 <refentrytitle>section.title.level1.properties</refentrytitle>
20569 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
20572 <refname>section.title.level1.properties</refname>
20573 <refpurpose>Properties for level-1 section titles</refpurpose>
20577 <programlisting id="section.title.level1.properties.frag">
20578 <xsl:attribute-set name="section.title.level1.properties">
20579 <xsl:attribute name="font-size">
20580 <xsl:value-of select="$body.font.master * 2.0736"></xsl:value-of>
20581 <xsl:text>pt</xsl:text>
20582 </xsl:attribute>
20583 </xsl:attribute-set>
20587 <refsection><info><title>Description</title></info>
20589 <para>The properties of level-1 section titles.</para>
20595 <refentry version="5.0" id="section.title.level2.properties">
20597 <refentrytitle>section.title.level2.properties</refentrytitle>
20598 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
20601 <refname>section.title.level2.properties</refname>
20602 <refpurpose>Properties for level-2 section titles</refpurpose>
20606 <programlisting id="section.title.level2.properties.frag">
20607 <xsl:attribute-set name="section.title.level2.properties">
20608 <xsl:attribute name="font-size">
20609 <xsl:value-of select="$body.font.master * 1.728"></xsl:value-of>
20610 <xsl:text>pt</xsl:text>
20611 </xsl:attribute>
20612 </xsl:attribute-set>
20616 <refsection><info><title>Description</title></info>
20618 <para>The properties of level-2 section titles.</para>
20623 <refentry version="5.0" id="section.title.level3.properties">
20625 <refentrytitle>section.title.level3.properties</refentrytitle>
20626 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
20629 <refname>section.title.level3.properties</refname>
20630 <refpurpose>Properties for level-3 section titles</refpurpose>
20634 <programlisting id="section.title.level3.properties.frag">
20635 <xsl:attribute-set name="section.title.level3.properties">
20636 <xsl:attribute name="font-size">
20637 <xsl:value-of select="$body.font.master * 1.44"></xsl:value-of>
20638 <xsl:text>pt</xsl:text>
20639 </xsl:attribute>
20640 </xsl:attribute-set>
20644 <refsection><info><title>Description</title></info>
20646 <para>The properties of level-3 section titles.</para>
20651 <refentry version="5.0" id="section.title.level4.properties">
20653 <refentrytitle>section.title.level4.properties</refentrytitle>
20654 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
20657 <refname>section.title.level4.properties</refname>
20658 <refpurpose>Properties for level-4 section titles</refpurpose>
20662 <programlisting id="section.title.level4.properties.frag">
20663 <xsl:attribute-set name="section.title.level4.properties">
20664 <xsl:attribute name="font-size">
20665 <xsl:value-of select="$body.font.master * 1.2"></xsl:value-of>
20666 <xsl:text>pt</xsl:text>
20667 </xsl:attribute>
20668 </xsl:attribute-set>
20672 <refsection><info><title>Description</title></info>
20674 <para>The properties of level-4 section titles.</para>
20679 <refentry version="5.0" id="section.title.level5.properties">
20681 <refentrytitle>section.title.level5.properties</refentrytitle>
20682 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
20685 <refname>section.title.level5.properties</refname>
20686 <refpurpose>Properties for level-5 section titles</refpurpose>
20690 <programlisting id="section.title.level5.properties.frag">
20691 <xsl:attribute-set name="section.title.level5.properties">
20692 <xsl:attribute name="font-size">
20693 <xsl:value-of select="$body.font.master"></xsl:value-of>
20694 <xsl:text>pt</xsl:text>
20695 </xsl:attribute>
20696 </xsl:attribute-set>
20700 <refsection><info><title>Description</title></info>
20702 <para>The properties of level-5 section titles.</para>
20707 <refentry version="5.0" id="section.title.level6.properties">
20709 <refentrytitle>section.title.level6.properties</refentrytitle>
20710 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
20713 <refname>section.title.level6.properties</refname>
20714 <refpurpose>Properties for level-6 section titles</refpurpose>
20718 <programlisting id="section.title.level6.properties.frag">
20719 <xsl:attribute-set name="section.title.level6.properties">
20720 <xsl:attribute name="font-size">
20721 <xsl:value-of select="$body.font.master"></xsl:value-of>
20722 <xsl:text>pt</xsl:text>
20723 </xsl:attribute>
20724 </xsl:attribute-set>
20728 <refsection><info><title>Description</title></info>
20730 <para>The properties of level-6 section titles. This property set is actually
20731 used for all titles below level 5.</para>
20736 <refentry version="5.0" id="section.properties">
20738 <refentrytitle>section.properties</refentrytitle>
20739 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
20742 <refname>section.properties</refname>
20743 <refpurpose>Properties for all section levels</refpurpose>
20747 <programlisting id="section.properties.frag">
20748 <xsl:attribute-set name="section.properties">
20749 </xsl:attribute-set>
20753 <refsection><info><title>Description</title></info>
20755 <para>The properties that apply to the containing
20756 block of all section levels, and therefore apply to
20758 This attribute set is inherited by the
20759 more specific attribute sets such as
20760 <tag>section.level1.properties</tag>.
20761 The default is empty.
20767 <refentry version="5.0" id="section.level1.properties">
20769 <refentrytitle>section.level1.properties</refentrytitle>
20770 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
20773 <refname>section.level1.properties</refname>
20774 <refpurpose>Properties for level-1 sections</refpurpose>
20778 <programlisting id="section.level1.properties.frag">
20779 <xsl:attribute-set name="section.level1.properties" use-attribute-sets="section.properties">
20780 </xsl:attribute-set>
20784 <refsection><info><title>Description</title></info>
20786 <para>The properties that apply to the containing
20787 block of a level-1 section, and therefore apply to
20788 the whole section. This includes <tag>sect1</tag>
20789 elements and <tag>section</tag> elements at level 1.
20792 <para>For example, you could start each level-1 section on
20793 a new page by using:</para>
20794 <programlisting><xsl:attribute-set name="section.level1.properties">
20795 <xsl:attribute name="break-before">page</xsl:attribute>
20796 </xsl:attribute-set>
20799 <para>This attribute set inherits attributes from the
20800 general <tag>section.properties</tag> attribute set.
20806 <refentry version="5.0" id="section.level2.properties">
20808 <refentrytitle>section.level2.properties</refentrytitle>
20809 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
20812 <refname>section.level2.properties</refname>
20813 <refpurpose>Properties for level-2 sections</refpurpose>
20817 <programlisting id="section.level2.properties.frag">
20818 <xsl:attribute-set name="section.level2.properties" use-attribute-sets="section.properties">
20819 </xsl:attribute-set>
20823 <refsection><info><title>Description</title></info>
20825 <para>The properties that apply to the containing
20826 block of a level-2 section, and therefore apply to
20827 the whole section. This includes <tag>sect2</tag>
20828 elements and <tag>section</tag> elements at level 2.
20831 <para>For example, you could start each level-2 section on
20832 a new page by using:</para>
20833 <programlisting><xsl:attribute-set name="section.level2.properties">
20834 <xsl:attribute name="break-before">page</xsl:attribute>
20835 </xsl:attribute-set>
20838 <para>This attribute set inherits attributes from the
20839 general <tag>section.properties</tag> attribute set.
20845 <refentry version="5.0" id="section.level3.properties">
20847 <refentrytitle>section.level3.properties</refentrytitle>
20848 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
20851 <refname>section.level3.properties</refname>
20852 <refpurpose>Properties for level-3 sections</refpurpose>
20856 <programlisting id="section.level3.properties.frag">
20857 <xsl:attribute-set name="section.level3.properties" use-attribute-sets="section.properties">
20858 </xsl:attribute-set>
20862 <refsection><info><title>Description</title></info>
20864 <para>The properties that apply to the containing
20865 block of a level-3 section, and therefore apply to
20866 the whole section. This includes <tag>sect3</tag>
20867 elements and <tag>section</tag> elements at level 3.
20870 <para>For example, you could start each level-3 section on
20871 a new page by using:</para>
20872 <programlisting><xsl:attribute-set name="section.level3.properties">
20873 <xsl:attribute name="break-before">page</xsl:attribute>
20874 </xsl:attribute-set>
20877 <para>This attribute set inherits attributes from the
20878 general <tag>section.properties</tag> attribute set.
20884 <refentry version="5.0" id="section.level4.properties">
20886 <refentrytitle>section.level4.properties</refentrytitle>
20887 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
20890 <refname>section.level4.properties</refname>
20891 <refpurpose>Properties for level-4 sections</refpurpose>
20895 <programlisting id="section.level4.properties.frag">
20896 <xsl:attribute-set name="section.level4.properties" use-attribute-sets="section.properties">
20897 </xsl:attribute-set>
20901 <refsection><info><title>Description</title></info>
20903 <para>The properties that apply to the containing
20904 block of a level-4 section, and therefore apply to
20905 the whole section. This includes <tag>sect4</tag>
20906 elements and <tag>section</tag> elements at level 4.
20909 <para>For example, you could start each level-4 section on
20910 a new page by using:</para>
20911 <programlisting><xsl:attribute-set name="section.level4.properties">
20912 <xsl:attribute name="break-before">page</xsl:attribute>
20913 </xsl:attribute-set>
20916 <para>This attribute set inherits attributes from the
20917 general <tag>section.properties</tag> attribute set.
20923 <refentry version="5.0" id="section.level5.properties">
20925 <refentrytitle>section.level5.properties</refentrytitle>
20926 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
20929 <refname>section.level5.properties</refname>
20930 <refpurpose>Properties for level-5 sections</refpurpose>
20934 <programlisting id="section.level5.properties.frag">
20935 <xsl:attribute-set name="section.level5.properties" use-attribute-sets="section.properties">
20936 </xsl:attribute-set>
20940 <refsection><info><title>Description</title></info>
20942 <para>The properties that apply to the containing
20943 block of a level-5 section, and therefore apply to
20944 the whole section. This includes <tag>sect5</tag>
20945 elements and <tag>section</tag> elements at level 5.
20948 <para>For example, you could start each level-5 section on
20949 a new page by using:</para>
20950 <programlisting><xsl:attribute-set name="section.level5.properties">
20951 <xsl:attribute name="break-before">page</xsl:attribute>
20952 </xsl:attribute-set>
20955 <para>This attribute set inherits attributes from the
20956 general <tag>section.properties</tag> attribute set.
20962 <refentry version="5.0" id="section.level6.properties">
20964 <refentrytitle>section.level6.properties</refentrytitle>
20965 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
20968 <refname>section.level6.properties</refname>
20969 <refpurpose>Properties for level-6 sections</refpurpose>
20973 <programlisting id="section.level6.properties.frag">
20974 <xsl:attribute-set name="section.level6.properties" use-attribute-sets="section.properties">
20975 </xsl:attribute-set>
20979 <refsection><info><title>Description</title></info>
20981 <para>The properties that apply to the containing
20982 block of a level 6 or lower section, and therefore apply to
20983 the whole section. This includes
20984 <tag>section</tag> elements at level 6 and lower.
20987 <para>For example, you could start each level-6 section on
20988 a new page by using:</para>
20989 <programlisting><xsl:attribute-set name="section.level6.properties">
20990 <xsl:attribute name="break-before">page</xsl:attribute>
20991 </xsl:attribute-set>
20994 <para>This attribute set inherits attributes from the
20995 general <tag>section.properties</tag> attribute set.
21001 <refentry version="5.0" id="figure.properties">
21003 <refentrytitle>figure.properties</refentrytitle>
21004 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
21007 <refname>figure.properties</refname>
21008 <refpurpose>Properties associated with a figure</refpurpose>
21012 <programlisting id="figure.properties.frag">
21013 <xsl:attribute-set name="figure.properties" use-attribute-sets="formal.object.properties"></xsl:attribute-set>
21017 <refsection><info><title>Description</title></info>
21019 <para>The styling for figures.</para>
21024 <refentry version="5.0" id="example.properties">
21026 <refentrytitle>example.properties</refentrytitle>
21027 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
21030 <refname>example.properties</refname>
21031 <refpurpose>Properties associated with a example</refpurpose>
21035 <programlisting id="example.properties.frag">
21036 <xsl:attribute-set name="example.properties" use-attribute-sets="formal.object.properties"></xsl:attribute-set>
21040 <refsection><info><title>Description</title></info>
21042 <para>The styling for examples.</para>
21047 <refentry version="5.0" id="equation.properties">
21049 <refentrytitle>equation.properties</refentrytitle>
21050 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
21053 <refname>equation.properties</refname>
21054 <refpurpose>Properties associated with a equation</refpurpose>
21058 <programlisting id="equation.properties.frag">
21059 <xsl:attribute-set name="equation.properties" use-attribute-sets="formal.object.properties"></xsl:attribute-set>
21063 <refsection><info><title>Description</title></info>
21065 <para>The styling for equations.</para>
21070 <refentry version="5.0" id="equation.number.properties">
21072 <refentrytitle>equation.number.properties</refentrytitle>
21073 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
21076 <refname>equation.number.properties</refname>
21077 <refpurpose>Properties that apply to the <tag>fo:table-cell</tag> containing the number
21078 of an <tag>equation</tag> that does not have a title.</refpurpose>
21082 <programlisting id="equation.number.properties.frag"><xsl:attribute-set name="equation.number.properties">
21083 <xsl:attribute name="text-align">end</xsl:attribute>
21084 <xsl:attribute name="display-align">center</xsl:attribute>
21085 </xsl:attribute-set></programlisting>
21087 <refsection><info><title>Description</title></info>
21088 <para>Properties that apply to the fo:table-cell containing the number
21089 of an equation when it has no title. The number in an equation with a
21090 title is formatted along with the title, and this attribute-set does not apply.</para>
21094 <refentry version="5.0" id="table.properties">
21096 <refentrytitle>table.properties</refentrytitle>
21097 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
21100 <refname>table.properties</refname>
21101 <refpurpose>Properties associated with the block surrounding a table</refpurpose>
21105 <programlisting id="table.properties.frag">
21106 <xsl:attribute-set name="table.properties" use-attribute-sets="formal.object.properties">
21107 <xsl:attribute name="keep-together.within-column">auto</xsl:attribute>
21108 </xsl:attribute-set>
21112 <refsection><info><title>Description</title></info>
21114 <para>Block styling properties for tables. This parameter should really
21115 have been called <literal>table.block.properties</literal> or something
21116 like that, but we’re leaving it to avoid backwards-compatibility
21119 <para>See also <parameter>table.table.properties</parameter>.</para>
21124 <refentry version="5.0" id="informalfigure.properties">
21126 <refentrytitle>informalfigure.properties</refentrytitle>
21127 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
21130 <refname>informalfigure.properties</refname>
21131 <refpurpose>Properties associated with an informalfigure</refpurpose>
21135 <programlisting id="informalfigure.properties.frag">
21136 <xsl:attribute-set name="informalfigure.properties" use-attribute-sets="informal.object.properties"></xsl:attribute-set>
21140 <refsection><info><title>Description</title></info>
21142 <para>The styling for informalfigures.</para>
21147 <refentry version="5.0" id="informalexample.properties">
21149 <refentrytitle>informalexample.properties</refentrytitle>
21150 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
21153 <refname>informalexample.properties</refname>
21154 <refpurpose>Properties associated with an informalexample</refpurpose>
21158 <programlisting id="informalexample.properties.frag">
21159 <xsl:attribute-set name="informalexample.properties" use-attribute-sets="informal.object.properties"></xsl:attribute-set>
21163 <refsection><info><title>Description</title></info>
21165 <para>The styling for informalexamples.</para>
21170 <refentry version="5.0" id="informalequation.properties">
21172 <refentrytitle>informalequation.properties</refentrytitle>
21173 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
21176 <refname>informalequation.properties</refname>
21177 <refpurpose>Properties associated with an informalequation</refpurpose>
21181 <programlisting id="informalequation.properties.frag">
21182 <xsl:attribute-set name="informalequation.properties" use-attribute-sets="informal.object.properties"></xsl:attribute-set>
21186 <refsection><info><title>Description</title></info>
21188 <para>The styling for informalequations.</para>
21193 <refentry version="5.0" id="informaltable.properties">
21195 <refentrytitle>informaltable.properties</refentrytitle>
21196 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
21199 <refname>informaltable.properties</refname>
21200 <refpurpose>Properties associated with the block surrounding an informaltable</refpurpose>
21204 <programlisting id="informaltable.properties.frag">
21205 <xsl:attribute-set name="informaltable.properties" use-attribute-sets="informal.object.properties"></xsl:attribute-set>
21209 <refsection><info><title>Description</title></info>
21211 <para>Block styling properties for informaltables. This parameter should really
21212 have been called <literal>informaltable.block.properties</literal> or something
21213 like that, but we’re leaving it to avoid backwards-compatibility
21216 <para>See also <parameter>table.table.properties</parameter>.</para>
21221 <refentry version="5.0" id="procedure.properties">
21223 <refentrytitle>procedure.properties</refentrytitle>
21224 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
21227 <refname>procedure.properties</refname>
21228 <refpurpose>Properties associated with a procedure</refpurpose>
21232 <programlisting id="procedure.properties.frag">
21233 <xsl:attribute-set name="procedure.properties" use-attribute-sets="formal.object.properties">
21234 <xsl:attribute name="keep-together.within-column">auto</xsl:attribute>
21235 </xsl:attribute-set>
21239 <refsection><info><title>Description</title></info>
21241 <para>The styling for procedures.</para>
21246 <refentry version="5.0" id="root.properties">
21248 <refentrytitle>root.properties</refentrytitle>
21249 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
21252 <refname>root.properties</refname>
21253 <refpurpose>The properties of the fo:root element</refpurpose>
21257 <programlisting id="root.properties.frag">
21258 <xsl:attribute-set name="root.properties">
21259 <xsl:attribute name="font-family">
21260 <xsl:value-of select="$body.fontset"></xsl:value-of>
21261 </xsl:attribute>
21262 <xsl:attribute name="font-size">
21263 <xsl:value-of select="$body.font.size"></xsl:value-of>
21264 </xsl:attribute>
21265 <xsl:attribute name="text-align">
21266 <xsl:value-of select="$alignment"></xsl:value-of>
21267 </xsl:attribute>
21268 <xsl:attribute name="line-height">
21269 <xsl:value-of select="$line-height"></xsl:value-of>
21270 </xsl:attribute>
21271 <xsl:attribute name="font-selection-strategy">character-by-character</xsl:attribute>
21272 <xsl:attribute name="line-height-shift-adjustment">disregard-shifts</xsl:attribute>
21273 <xsl:attribute name="writing-mode">
21274 <xsl:value-of select="$direction.mode"></xsl:value-of>
21275 </xsl:attribute>
21276 </xsl:attribute-set>
21280 <refsection><info><title>Description</title></info>
21282 <para>This property set is used on the <tag>fo:root</tag> element of
21283 an FO file. It defines a set of default, global parameters.</para>
21288 <refentry version="5.0" id="qanda.title.properties">
21290 <refentrytitle>qanda.title.properties</refentrytitle>
21291 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
21294 <refname>qanda.title.properties</refname>
21295 <refpurpose>Properties for qanda set titles</refpurpose>
21299 <programlisting id="qanda.title.properties.frag">
21300 <xsl:attribute-set name="qanda.title.properties">
21301 <xsl:attribute name="font-family">
21302 <xsl:value-of select="$title.font.family"></xsl:value-of>
21303 </xsl:attribute>
21304 <xsl:attribute name="font-weight">bold</xsl:attribute>
21305 <!-- font size is calculated dynamically by qanda.heading template -->
21306 <xsl:attribute name="keep-with-next.within-column">always</xsl:attribute>
21307 <xsl:attribute name="space-before.minimum">0.8em</xsl:attribute>
21308 <xsl:attribute name="space-before.optimum">1.0em</xsl:attribute>
21309 <xsl:attribute name="space-before.maximum">1.2em</xsl:attribute>
21310 </xsl:attribute-set>
21314 <refsection><info><title>Description</title></info>
21316 <para>The properties common to all qanda set titles.</para>
21321 <refentry version="5.0" id="qanda.title.level1.properties">
21323 <refentrytitle>qanda.title.level1.properties</refentrytitle>
21324 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
21327 <refname>qanda.title.level1.properties</refname>
21328 <refpurpose>Properties for level-1 qanda set titles</refpurpose>
21332 <programlisting id="qanda.title.level1.properties.frag">
21333 <xsl:attribute-set name="qanda.title.level1.properties">
21334 <xsl:attribute name="font-size">
21335 <xsl:value-of select="$body.font.master * 2.0736"></xsl:value-of>
21336 <xsl:text>pt</xsl:text>
21337 </xsl:attribute>
21338 </xsl:attribute-set>
21342 <refsection><info><title>Description</title></info>
21344 <para>The properties of level-1 qanda set titles.</para>
21349 <refentry version="5.0" id="qanda.title.level2.properties">
21351 <refentrytitle>qanda.title.level2.properties</refentrytitle>
21352 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
21355 <refname>qanda.title.level2.properties</refname>
21356 <refpurpose>Properties for level-2 qanda set titles</refpurpose>
21360 <programlisting id="qanda.title.level2.properties.frag">
21361 <xsl:attribute-set name="qanda.title.level2.properties">
21362 <xsl:attribute name="font-size">
21363 <xsl:value-of select="$body.font.master * 1.728"></xsl:value-of>
21364 <xsl:text>pt</xsl:text>
21365 </xsl:attribute>
21366 </xsl:attribute-set>
21370 <refsection><info><title>Description</title></info>
21372 <para>The properties of level-2 qanda set titles.</para>
21377 <refentry version="5.0" id="qanda.title.level3.properties">
21379 <refentrytitle>qanda.title.level3.properties</refentrytitle>
21380 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
21383 <refname>qanda.title.level3.properties</refname>
21384 <refpurpose>Properties for level-3 qanda set titles</refpurpose>
21388 <programlisting id="qanda.title.level3.properties.frag">
21389 <xsl:attribute-set name="qanda.title.level3.properties">
21390 <xsl:attribute name="font-size">
21391 <xsl:value-of select="$body.font.master * 1.44"></xsl:value-of>
21392 <xsl:text>pt</xsl:text>
21393 </xsl:attribute>
21394 </xsl:attribute-set>
21398 <refsection><info><title>Description</title></info>
21400 <para>The properties of level-3 qanda set titles.</para>
21405 <refentry version="5.0" id="qanda.title.level4.properties">
21407 <refentrytitle>qanda.title.level4.properties</refentrytitle>
21408 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
21411 <refname>qanda.title.level4.properties</refname>
21412 <refpurpose>Properties for level-4 qanda set titles</refpurpose>
21416 <programlisting id="qanda.title.level4.properties.frag">
21417 <xsl:attribute-set name="qanda.title.level4.properties">
21418 <xsl:attribute name="font-size">
21419 <xsl:value-of select="$body.font.master * 1.2"></xsl:value-of>
21420 <xsl:text>pt</xsl:text>
21421 </xsl:attribute>
21422 </xsl:attribute-set>
21426 <refsection><info><title>Description</title></info>
21428 <para>The properties of level-4 qanda set titles.</para>
21433 <refentry version="5.0" id="qanda.title.level5.properties">
21435 <refentrytitle>qanda.title.level5.properties</refentrytitle>
21436 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
21439 <refname>qanda.title.level5.properties</refname>
21440 <refpurpose>Properties for level-5 qanda set titles</refpurpose>
21444 <programlisting id="qanda.title.level5.properties.frag">
21445 <xsl:attribute-set name="qanda.title.level5.properties">
21446 <xsl:attribute name="font-size">
21447 <xsl:value-of select="$body.font.master"></xsl:value-of>
21448 <xsl:text>pt</xsl:text>
21449 </xsl:attribute>
21450 </xsl:attribute-set>
21454 <refsection><info><title>Description</title></info>
21456 <para>The properties of level-5 qanda set titles.</para>
21461 <refentry version="5.0" id="qanda.title.level6.properties">
21463 <refentrytitle>qanda.title.level6.properties</refentrytitle>
21464 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
21467 <refname>qanda.title.level6.properties</refname>
21468 <refpurpose>Properties for level-6 qanda set titles</refpurpose>
21472 <programlisting id="qanda.title.level6.properties.frag">
21473 <xsl:attribute-set name="qanda.title.level6.properties">
21474 <xsl:attribute name="font-size">
21475 <xsl:value-of select="$body.font.master"></xsl:value-of>
21476 <xsl:text>pt</xsl:text>
21477 </xsl:attribute>
21478 </xsl:attribute-set>
21482 <refsection><info><title>Description</title></info>
21484 <para>The properties of level-6 qanda set titles.
21485 This property set is actually
21486 used for all titles below level 5.</para>
21491 <refentry version="5.0" id="article.appendix.title.properties">
21493 <refentrytitle>article.appendix.title.properties</refentrytitle>
21494 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
21497 <refname>article.appendix.title.properties</refname>
21498 <refpurpose>Properties for appendix titles that appear in an article</refpurpose>
21502 <programlisting id="article.appendix.title.properties.frag">
21503 <xsl:attribute-set name="article.appendix.title.properties" use-attribute-sets="section.title.properties section.title.level1.properties">
21504 <xsl:attribute name="margin-{$direction.align.start}">
21505 <xsl:value-of select="$title.margin.left"></xsl:value-of>
21506 </xsl:attribute>
21507 </xsl:attribute-set>
21511 <refsection><info><title>Description</title></info>
21513 <para>The properties for the title of an appendix that
21514 appears inside an article. The default is to use
21515 the properties of sect1 titles.</para>
21520 <refentry version="5.0" id="abstract.properties">
21522 <refentrytitle>abstract.properties</refentrytitle>
21523 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
21526 <refname>abstract.properties</refname>
21527 <refpurpose>Properties associated with the block surrounding an abstract</refpurpose>
21531 <programlisting id="abstract.properties.frag">
21532 <xsl:attribute-set name="abstract.properties">
21533 <xsl:attribute name="start-indent">0.0in</xsl:attribute>
21534 <xsl:attribute name="end-indent">0.0in</xsl:attribute>
21535 </xsl:attribute-set>
21539 <refsection><info><title>Description</title></info>
21541 <para>Block styling properties for abstract.</para>
21543 <para>See also <parameter>abstract.title.properties</parameter>.</para>
21548 <refentry version="5.0" id="abstract.title.properties">
21550 <refentrytitle>abstract.title.properties</refentrytitle>
21551 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
21554 <refname>abstract.title.properties</refname>
21555 <refpurpose>Properties for abstract titles</refpurpose>
21559 <programlisting id="abstract.title.properties.frag">
21560 <xsl:attribute-set name="abstract.title.properties">
21561 <xsl:attribute name="font-family"><xsl:value-of select="$title.fontset"></xsl:value-of></xsl:attribute>
21562 <xsl:attribute name="font-weight">bold</xsl:attribute>
21563 <xsl:attribute name="keep-with-next.within-column">always</xsl:attribute>
21564 <xsl:attribute name="keep-with-next.within-column">always</xsl:attribute>
21565 <xsl:attribute name="space-before.optimum"><xsl:value-of select="concat($body.font.master, 'pt')"></xsl:value-of></xsl:attribute>
21566 <xsl:attribute name="space-before.minimum"><xsl:value-of select="concat($body.font.master, 'pt * 0.8')"></xsl:value-of></xsl:attribute>
21567 <xsl:attribute name="space-before.maximum"><xsl:value-of select="concat($body.font.master, 'pt * 1.2')"></xsl:value-of></xsl:attribute>
21568 <xsl:attribute name="hyphenate">false</xsl:attribute>
21569 <xsl:attribute name="text-align">center</xsl:attribute>
21570 </xsl:attribute-set>
21574 <refsection><info><title>Description</title></info>
21576 <para>The properties for abstract titles.</para>
21578 <para>See also <parameter>abstract.properties</parameter>.</para>
21583 <refentry version="5.0" id="index.page.number.properties">
21585 <refentrytitle>index.page.number.properties</refentrytitle>
21586 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
21589 <refname>index.page.number.properties</refname>
21590 <refpurpose>Properties associated with index page numbers</refpurpose>
21594 <programlisting id="index.page.number.properties.frag">
21595 <xsl:attribute-set name="index.page.number.properties">
21596 </xsl:attribute-set>
21600 <refsection><info><title>Description</title></info>
21602 <para>Properties associated with page numbers in indexes.
21603 Changing color to indicate the page number is a link is
21610 <refentry version="5.0" id="revhistory.table.properties">
21612 <refentrytitle>revhistory.table.properties</refentrytitle>
21613 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
21616 <refname>revhistory.table.properties</refname>
21617 <refpurpose>The properties of table used for formatting revhistory</refpurpose>
21621 <programlisting id="revhistory.table.properties.frag">
21622 <xsl:attribute-set name="revhistory.table.properties">
21623 </xsl:attribute-set>
21627 <refsection><info><title>Description</title></info>
21629 <para>This property set defines appearance of revhistory table.</para>
21634 <refentry version="5.0" id="revhistory.table.cell.properties">
21636 <refentrytitle>revhistory.table.cell.properties</refentrytitle>
21637 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
21640 <refname>revhistory.table.cell.properties</refname>
21641 <refpurpose>The properties of table cells used for formatting revhistory</refpurpose>
21645 <programlisting id="revhistory.table.cell.properties.frag">
21646 <xsl:attribute-set name="revhistory.table.cell.properties">
21647 </xsl:attribute-set>
21651 <refsection><info><title>Description</title></info>
21653 <para>This property set defines appearance of individual cells in revhistory table.</para>
21658 <refentry version="5.0" id="revhistory.title.properties">
21660 <refentrytitle>revhistory.title.properties</refentrytitle>
21661 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
21664 <refname>revhistory.title.properties</refname>
21665 <refpurpose>The properties of revhistory title</refpurpose>
21669 <programlisting id="revhistory.title.properties.frag">
21670 <xsl:attribute-set name="revhistory.title.properties">
21671 </xsl:attribute-set>
21675 <refsection><info><title>Description</title></info>
21677 <para>This property set defines appearance of revhistory title.</para>
21682 </reference><reference id="profiling" xml:base="../fo/param.xml"><title>Profiling</title>
21683 <partintro id="profiling_partintro">
21684 <para>The following parameters can be used for attribute-based
21685 profiling of your document. For more information about profiling, see
21686 <link role="tcg" xlink:href="Profiling.html">Profiling (conditional text)</link>.</para>
21688 <refentry version="5.0" id="profile.arch">
21690 <refentrytitle>profile.arch</refentrytitle>
21691 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
21694 <refname>profile.arch</refname>
21695 <refpurpose>Target profile for <tag class="attribute">arch</tag>
21696 attribute</refpurpose>
21700 <programlisting id="profile.arch.frag">
21701 <xsl:param name="profile.arch"></xsl:param>
21706 <refsection><info><title>Description</title></info>
21708 <para>The value of this parameter specifies profiles which should be
21709 included in the output. You can specify multiple profiles by
21710 separating them by semicolon. You can change separator character by
21711 <parameter>profile.separator</parameter>
21714 <para>This parameter has effect only when you are using profiling
21715 stylesheets (<filename>profile-docbook.xsl</filename>,
21716 <filename>profile-chunk.xsl</filename>, …) instead of normal
21717 ones (<filename>docbook.xsl</filename>,
21718 <filename>chunk.xsl</filename>, …).</para>
21723 <refentry version="5.0" id="profile.audience">
21725 <refentrytitle>profile.audience</refentrytitle>
21726 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
21729 <refname>profile.audience</refname>
21730 <refpurpose>Target profile for <tag class="attribute">audience</tag>
21731 attribute</refpurpose>
21735 <programlisting id="profile.audience.frag">
21736 <xsl:param name="profile.audience"></xsl:param>
21740 <refsection><info><title>Description</title></info>
21742 <para>Value of this parameter specifies profiles which should be
21743 included in the output. You can specify multiple profiles by
21744 separating them by semicolon. You can change separator character by
21745 <parameter>profile.separator</parameter>
21748 <para>This parameter has effect only when you are using profiling
21749 stylesheets (<filename>profile-docbook.xsl</filename>,
21750 <filename>profile-chunk.xsl</filename>, …) instead of normal
21751 ones (<filename>docbook.xsl</filename>,
21752 <filename>chunk.xsl</filename>, …).</para>
21757 <refentry version="5.0" id="profile.condition">
21759 <refentrytitle>profile.condition</refentrytitle>
21760 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
21763 <refname>profile.condition</refname>
21764 <refpurpose>Target profile for <tag class="attribute">condition</tag>
21765 attribute</refpurpose>
21769 <programlisting id="profile.condition.frag">
21770 <xsl:param name="profile.condition"></xsl:param>
21774 <refsection><info><title>Description</title></info>
21776 <para>The value of this parameter specifies profiles which should be
21777 included in the output. You can specify multiple profiles by
21778 separating them by semicolon. You can change separator character by
21779 <parameter>profile.separator</parameter>
21782 <para>This parameter has effect only when you are using profiling
21783 stylesheets (<filename>profile-docbook.xsl</filename>,
21784 <filename>profile-chunk.xsl</filename>, …) instead of normal
21785 ones (<filename>docbook.xsl</filename>,
21786 <filename>chunk.xsl</filename>, …).</para>
21791 <refentry version="5.0" id="profile.conformance">
21793 <refentrytitle>profile.conformance</refentrytitle>
21794 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
21797 <refname>profile.conformance</refname>
21798 <refpurpose>Target profile for <tag class="attribute">conformance</tag>
21799 attribute</refpurpose>
21803 <programlisting id="profile.conformance.frag">
21804 <xsl:param name="profile.conformance"></xsl:param>
21808 <refsection><info><title>Description</title></info>
21810 <para>The value of this parameter specifies profiles which should be
21811 included in the output. You can specify multiple profiles by
21812 separating them by semicolon. You can change separator character by
21813 <parameter>profile.separator</parameter>
21816 <para>This parameter has effect only when you are using profiling
21817 stylesheets (<filename>profile-docbook.xsl</filename>,
21818 <filename>profile-chunk.xsl</filename>, …) instead of normal
21819 ones (<filename>docbook.xsl</filename>,
21820 <filename>chunk.xsl</filename>, …).</para>
21825 <refentry version="5.0" id="profile.lang">
21827 <refentrytitle>profile.lang</refentrytitle>
21828 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
21831 <refname>profile.lang</refname>
21832 <refpurpose>Target profile for <tag class="attribute">lang</tag>
21833 attribute</refpurpose>
21837 <programlisting id="profile.lang.frag">
21838 <xsl:param name="profile.lang"></xsl:param>
21842 <refsection><info><title>Description</title></info>
21844 <para>The value of this parameter specifies profiles which should be
21845 included in the output. You can specify multiple profiles by
21846 separating them by semicolon. You can change separator character by
21847 <parameter>profile.separator</parameter>
21850 <para>This parameter has effect only when you are using profiling
21851 stylesheets (<filename>profile-docbook.xsl</filename>,
21852 <filename>profile-chunk.xsl</filename>, …) instead of normal
21853 ones (<filename>docbook.xsl</filename>,
21854 <filename>chunk.xsl</filename>, …).</para>
21859 <refentry version="5.0" id="profile.os">
21861 <refentrytitle>profile.os</refentrytitle>
21862 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
21865 <refname>profile.os</refname>
21866 <refpurpose>Target profile for <tag class="attribute">os</tag>
21867 attribute</refpurpose>
21871 <programlisting id="profile.os.frag">
21872 <xsl:param name="profile.os"></xsl:param>
21876 <refsection><info><title>Description</title></info>
21878 <para>The value of this parameter specifies profiles which should be
21879 included in the output. You can specify multiple profiles by
21880 separating them by semicolon. You can change separator character by
21881 <parameter>profile.separator</parameter>
21884 <para>This parameter has effect only when you are using profiling
21885 stylesheets (<filename>profile-docbook.xsl</filename>,
21886 <filename>profile-chunk.xsl</filename>, …) instead of normal
21887 ones (<filename>docbook.xsl</filename>,
21888 <filename>chunk.xsl</filename>, …).</para>
21893 <refentry version="5.0" id="profile.revision">
21895 <refentrytitle>profile.revision</refentrytitle>
21896 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
21899 <refname>profile.revision</refname>
21900 <refpurpose>Target profile for <tag class="attribute">revision</tag>
21901 attribute</refpurpose>
21905 <programlisting id="profile.revision.frag">
21906 <xsl:param name="profile.revision"></xsl:param>
21910 <refsection><info><title>Description</title></info>
21912 <para>The value of this parameter specifies profiles which should be
21913 included in the output. You can specify multiple profiles by
21914 separating them by semicolon. You can change separator character by
21915 <parameter>profile.separator</parameter>
21918 <para>This parameter has effect only when you are using profiling
21919 stylesheets (<filename>profile-docbook.xsl</filename>,
21920 <filename>profile-chunk.xsl</filename>, …) instead of normal
21921 ones (<filename>docbook.xsl</filename>,
21922 <filename>chunk.xsl</filename>, …).</para>
21927 <refentry version="5.0" id="profile.revisionflag">
21929 <refentrytitle>profile.revisionflag</refentrytitle>
21930 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
21933 <refname>profile.revisionflag</refname>
21934 <refpurpose>Target profile for <tag class="attribute">revisionflag</tag>
21935 attribute</refpurpose>
21939 <programlisting id="profile.revisionflag.frag">
21940 <xsl:param name="profile.revisionflag"></xsl:param>
21944 <refsection><info><title>Description</title></info>
21946 <para>The value of this parameter specifies profiles which should be
21947 included in the output. You can specify multiple profiles by
21948 separating them by semicolon. You can change separator character by
21949 <parameter>profile.separator</parameter>
21952 <para>This parameter has effect only when you are using profiling
21953 stylesheets (<filename>profile-docbook.xsl</filename>,
21954 <filename>profile-chunk.xsl</filename>, …) instead of normal
21955 ones (<filename>docbook.xsl</filename>,
21956 <filename>chunk.xsl</filename>, …).</para>
21961 <refentry version="5.0" id="profile.role">
21963 <refentrytitle>profile.role</refentrytitle>
21964 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
21967 <refname>profile.role</refname>
21968 <refpurpose>Target profile for <tag class="attribute">role</tag>
21969 attribute</refpurpose>
21973 <programlisting id="profile.role.frag">
21974 <xsl:param name="profile.role"></xsl:param>
21978 <refsection><info><title>Description</title></info>
21980 <para>The value of this parameter specifies profiles which should be
21981 included in the output. You can specify multiple profiles by
21982 separating them by semicolon. You can change separator character by
21983 <parameter>profile.separator</parameter>
21986 <para>This parameter has effect only when you are using profiling
21987 stylesheets (<filename>profile-docbook.xsl</filename>,
21988 <filename>profile-chunk.xsl</filename>, …) instead of normal
21989 ones (<filename>docbook.xsl</filename>,
21990 <filename>chunk.xsl</filename>, …).</para>
21993 <para>Note that <tag class="attribute">role</tag> is often
21994 used for other purposes than profiling. For example it is commonly
21995 used to get emphasize in bold font:</para>
21997 <programlisting><emphasis role="bold">very important</emphasis></programlisting>
21999 <para>If you are using <tag class="attribute">role</tag> for
22000 these purposes do not forget to add values like <literal>bold</literal> to
22001 value of this parameter. If you forgot you will get document with
22002 small pieces missing which are very hard to track.</para>
22004 <para>For this reason it is not recommended to use <tag class="attribute">role</tag> attribute for profiling. You should
22005 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>
22011 <refentry version="5.0" id="profile.security">
22013 <refentrytitle>profile.security</refentrytitle>
22014 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
22017 <refname>profile.security</refname>
22018 <refpurpose>Target profile for <tag class="attribute">security</tag>
22019 attribute</refpurpose>
22023 <programlisting id="profile.security.frag">
22024 <xsl:param name="profile.security"></xsl:param>
22028 <refsection><info><title>Description</title></info>
22030 <para>The value of this parameter specifies profiles which should be
22031 included in the output. You can specify multiple profiles by
22032 separating them by semicolon. You can change separator character by
22033 <parameter>profile.separator</parameter>
22036 <para>This parameter has effect only when you are using profiling
22037 stylesheets (<filename>profile-docbook.xsl</filename>,
22038 <filename>profile-chunk.xsl</filename>, …) instead of normal
22039 ones (<filename>docbook.xsl</filename>,
22040 <filename>chunk.xsl</filename>, …).</para>
22045 <refentry version="5.0" id="profile.status">
22047 <refentrytitle>profile.status</refentrytitle>
22048 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
22051 <refname>profile.status</refname>
22052 <refpurpose>Target profile for <tag class="attribute">status</tag>
22053 attribute</refpurpose>
22057 <programlisting id="profile.status.frag">
22058 <xsl:param name="profile.status"></xsl:param>
22062 <refsection><info><title>Description</title></info>
22064 <para>The value of this parameter specifies profiles which should be
22065 included in the output. You can specify multiple profiles by
22066 separating them by semicolon. You can change separator character by
22067 <parameter>profile.separator</parameter>
22070 <para>This parameter has effect only when you are using profiling
22071 stylesheets (<filename>profile-docbook.xsl</filename>,
22072 <filename>profile-chunk.xsl</filename>, …) instead of normal
22073 ones (<filename>docbook.xsl</filename>,
22074 <filename>chunk.xsl</filename>, …).</para>
22079 <refentry version="5.0" id="profile.userlevel">
22081 <refentrytitle>profile.userlevel</refentrytitle>
22082 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
22085 <refname>profile.userlevel</refname>
22086 <refpurpose>Target profile for <tag class="attribute">userlevel</tag>
22087 attribute</refpurpose>
22091 <programlisting id="profile.userlevel.frag">
22092 <xsl:param name="profile.userlevel"></xsl:param>
22096 <refsection><info><title>Description</title></info>
22098 <para>The value of this parameter specifies profiles which should be
22099 included in the output. You can specify multiple profiles by
22100 separating them by semicolon. You can change separator character by
22101 <parameter>profile.separator</parameter>
22104 <para>This parameter has effect only when you are using profiling
22105 stylesheets (<filename>profile-docbook.xsl</filename>,
22106 <filename>profile-chunk.xsl</filename>, …) instead of normal
22107 ones (<filename>docbook.xsl</filename>,
22108 <filename>chunk.xsl</filename>, …).</para>
22113 <refentry version="5.0" id="profile.vendor">
22115 <refentrytitle>profile.vendor</refentrytitle>
22116 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
22119 <refname>profile.vendor</refname>
22120 <refpurpose>Target profile for <tag class="attribute">vendor</tag>
22121 attribute</refpurpose>
22125 <programlisting id="profile.vendor.frag">
22126 <xsl:param name="profile.vendor"></xsl:param>
22130 <refsection><info><title>Description</title></info>
22132 <para>The value of this parameter specifies profiles which should be
22133 included in the output. You can specify multiple profiles by
22134 separating them by semicolon. You can change separator character by
22135 <parameter>profile.separator</parameter>
22138 <para>This parameter has effect only when you are using profiling
22139 stylesheets (<filename>profile-docbook.xsl</filename>,
22140 <filename>profile-chunk.xsl</filename>, …) instead of normal
22141 ones (<filename>docbook.xsl</filename>,
22142 <filename>chunk.xsl</filename>, …).</para>
22147 <refentry version="5.0" id="profile.wordsize">
22149 <refentrytitle>profile.wordsize</refentrytitle>
22150 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
22153 <refname>profile.wordsize</refname>
22154 <refpurpose>Target profile for <tag class="attribute">wordsize</tag>
22155 attribute</refpurpose>
22159 <programlisting id="profile.wordsize.frag">
22160 <xsl:param name="profile.wordsize"></xsl:param>
22164 <refsection><info><title>Description</title></info>
22166 <para>The value of this parameter specifies profiles which should be
22167 included in the output. You can specify multiple profiles by
22168 separating them by semicolon. You can change separator character by
22169 <parameter>profile.separator</parameter>
22172 <para>This parameter has effect only when you are using profiling
22173 stylesheets (<filename>profile-docbook.xsl</filename>,
22174 <filename>profile-chunk.xsl</filename>, …) instead of normal
22175 ones (<filename>docbook.xsl</filename>,
22176 <filename>chunk.xsl</filename>, …).</para>
22181 <refentry version="5.0" id="profile.attribute">
22183 <refentrytitle>profile.attribute</refentrytitle>
22184 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
22187 <refname>profile.attribute</refname>
22188 <refpurpose>Name of user-specified profiling attribute</refpurpose>
22192 <programlisting id="profile.attribute.frag">
22193 <xsl:param name="profile.attribute"></xsl:param>
22197 <refsection><info><title>Description</title></info>
22199 <para>This parameter is used in conjuction with
22200 <parameter>profile.value</parameter>.</para>
22202 <para>This parameter has effect only when you are using profiling
22203 stylesheets (<filename>profile-docbook.xsl</filename>,
22204 <filename>profile-chunk.xsl</filename>, …) instead of normal
22205 ones (<filename>docbook.xsl</filename>,
22206 <filename>chunk.xsl</filename>, …).</para>
22211 <refentry version="5.0" id="profile.value">
22213 <refentrytitle>profile.value</refentrytitle>
22214 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
22217 <refname>profile.value</refname>
22218 <refpurpose>Target profile for user-specified attribute</refpurpose>
22222 <programlisting id="profile.value.frag">
22223 <xsl:param name="profile.value"></xsl:param>
22227 <refsection><info><title>Description</title></info>
22229 <para>When you are using this parameter you must also specify name of
22230 profiling attribute with parameter
22231 <parameter>profile.attribute</parameter>.</para>
22233 <para>The value of this parameter specifies profiles which should be
22234 included in the output. You can specify multiple profiles by
22235 separating them by semicolon. You can change separator character by
22236 <parameter>profile.separator</parameter>
22239 <para>This parameter has effect only when you are using profiling
22240 stylesheets (<filename>profile-docbook.xsl</filename>,
22241 <filename>profile-chunk.xsl</filename>, …) instead of normal
22242 ones (<filename>docbook.xsl</filename>,
22243 <filename>chunk.xsl</filename>, …).</para>
22248 <refentry version="5.0" id="profile.separator">
22250 <refentrytitle>profile.separator</refentrytitle>
22251 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
22254 <refname>profile.separator</refname>
22255 <refpurpose>Separator character for compound profile values</refpurpose>
22259 <programlisting id="profile.separator.frag">
22260 <xsl:param name="profile.separator">;</xsl:param>
22264 <refsection><info><title>Description</title></info>
22266 <para>Separator character used for compound profile values. See <parameter>profile.arch</parameter></para>
22271 </reference><reference id="l10n" xml:base="../fo/param.xml"><title>Localization</title>
22272 <refentry version="5.0" id="l10n.gentext.language">
22274 <refentrytitle>l10n.gentext.language</refentrytitle>
22275 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
22278 <refname>l10n.gentext.language</refname>
22279 <refpurpose>Sets the gentext language</refpurpose>
22283 <programlisting id="l10n.gentext.language.frag">
22284 <xsl:param name="l10n.gentext.language"></xsl:param>
22288 <refsection><info><title>Description</title></info>
22290 <para>If this parameter is set to any value other than the empty string, its
22291 value will be used as the value for the language when generating text. Setting
22292 <parameter>l10n.gentext.language</parameter> overrides any settings within the
22293 document being formatted.</para>
22295 <para>It's much more likely that you might want to set the
22296 <parameter>l10n.gentext.default.language</parameter> parameter.</para>
22301 <refentry version="5.0" id="l10n.gentext.default.language">
22303 <refentrytitle>l10n.gentext.default.language</refentrytitle>
22304 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
22307 <refname>l10n.gentext.default.language</refname>
22308 <refpurpose>Sets the default language for generated text</refpurpose>
22312 <programlisting id="l10n.gentext.default.language.frag">
22313 <xsl:param name="l10n.gentext.default.language">en</xsl:param>
22317 <refsection><info><title>Description</title></info>
22319 <para>The value of the <parameter>l10n.gentext.default.language</parameter>
22320 parameter is used as the language for generated text if no setting is provided
22321 in the source document.</para>
22326 <refentry version="5.0" id="l10n.gentext.use.xref.language">
22328 <refentrytitle>l10n.gentext.use.xref.language</refentrytitle>
22329 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
22332 <refname>l10n.gentext.use.xref.language</refname>
22333 <refpurpose>Use the language of target when generating cross-reference text?</refpurpose>
22337 <programlisting id="l10n.gentext.use.xref.language.frag">
22338 <xsl:param name="l10n.gentext.use.xref.language" select="0"></xsl:param>
22342 <refsection><info><title>Description</title></info>
22344 <para>If non-zero, the language of the target will be used when
22345 generating cross reference text. Usually, the <quote>current</quote>
22346 language is used when generating text (that is, the language of the
22347 element that contains the cross-reference element). But setting this parameter
22348 allows the language of the element <emphasis>pointed to</emphasis> to control
22349 the generated text.</para>
22351 <para>Consider the following example:</para>
22354 <programlisting><para lang="en">See also <xref linkend="chap3"/>.</para>
22358 <para>Suppose that Chapter 3 happens to be written in German.
22359 If <parameter>l10n.gentext.use.xref.language</parameter> is non-zero, the
22360 resulting text will be something like this:</para>
22363 <para>See also Kapital 3.</para>
22366 <para>Where the more traditional rendering would be:</para>
22369 <para>See also Chapter 3.</para>
22375 <refentry version="5.0" id="l10n.lang.value.rfc.compliant">
22377 <refentrytitle>l10n.lang.value.rfc.compliant</refentrytitle>
22378 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
22381 <refname>l10n.lang.value.rfc.compliant</refname>
22382 <refpurpose>Make value of lang attribute RFC compliant?</refpurpose>
22386 <programlisting id="l10n.lang.value.rfc.compliant.frag">
22387 <xsl:param name="l10n.lang.value.rfc.compliant" select="1"></xsl:param>
22391 <refsection><info><title>Description</title></info>
22393 <para>If non-zero, ensure that the values for all <tag class="attribute">lang</tag> attributes in HTML output are RFC
22394 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:
22396 <blockquote><para>[RFC1766] defines and explains the language codes
22397 that must be used in HTML documents.</para>
22398 <para>Briefly, language codes consist of a primary code and a possibly
22399 empty series of subcodes:
22401 <literallayout class="monospaced">language-code = primary-code ( "-" subcode )*</literallayout>
22403 <para>And in RFC 1766, <link xlink:href="http://www.ietf.org/rfc/rfc1766.txt">Tags for the Identification
22404 of Languages</link>, the EBNF for "language tag" is given as:
22406 <literallayout class="monospaced">Language-Tag = Primary-tag *( "-" Subtag )
22407 Primary-tag = 1*8ALPHA
22408 Subtag = 1*8ALPHA</literallayout>
22411 </para></footnote>.
22413 by taking any underscore characters in any <tag class="attribute">lang</tag> values found in source documents, and
22414 replacing them with hyphen characters in output HTML files. For
22415 example, <literal>zh_CN</literal> in a source document becomes
22416 <literal>zh-CN</literal> in the HTML output form that source.
22419 <para>This parameter does not cause any case change in <tag class="attribute">lang</tag> values, because RFC 1766
22420 explicitly states that all "language tags" (as it calls them) "are
22421 to be treated as case insensitive".</para>
22428 <refentry version="5.0" id="writing.mode">
22430 <refentrytitle>writing.mode</refentrytitle>
22431 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
22434 <refname>writing.mode</refname>
22435 <refpurpose>Direction of text flow based on locale</refpurpose>
22439 <programlisting id="writing.mode.frag">
22440 <xsl:param name="writing.mode">
22441 <xsl:call-template name="gentext">
22442 <xsl:with-param name="key">writing-mode</xsl:with-param>
22443 <xsl:with-param name="lang">
22444 <xsl:call-template name="l10n.language">
22445 <xsl:with-param name="target" select="/*[1]"></xsl:with-param>
22446 </xsl:call-template>
22447 </xsl:with-param>
22448 </xsl:call-template>
22453 <refsection><info><title>Description</title></info>
22455 <para>Sets direction of text flow and text alignment based on locale.
22456 The value is normally taken from the gentext file for the
22457 lang attribute of the document's root element, using the
22458 key name 'writing-mode' to look it up in the gentext file.
22459 But the param can also be
22460 set on the command line to override that gentext value.
22462 <para>Accepted values are:
22467 <para>Left-to-right text flow in each line, lines stack top to bottom.</para>
22473 <para>Right-to-left text flow in each line, lines stack top to bottom.</para>
22479 <para>Top-to-bottom text flow in each vertical line, lines stack right to left.
22480 Supported by only a few XSL-FO processors. Not supported in HTML output.</para>
22486 <para>Shorthand for lr-tb.</para>
22492 <para>Shorthand for rl-tb.</para>
22498 <para>Shorthand for tb-rl.</para>
22507 </reference><reference id="ebnf" xml:base="../fo/param.xml"><title>EBNF</title>
22508 <refentry version="5.0" id="ebnf.assignment">
22510 <refentrytitle>ebnf.assignment</refentrytitle>
22511 <refmiscinfo class="other" otherclass="datatype">rtf</refmiscinfo>
22514 <refname>ebnf.assignment</refname>
22515 <refpurpose>The EBNF production assignment operator</refpurpose>
22519 <programlisting id="ebnf.assignment.frag">
22521 <xsl:param name="ebnf.assignment">
22522 <fo:inline font-family="{$monospace.font.family}">
22523 <xsl:text>::=</xsl:text>
22529 <refsection><info><title>Description</title></info>
22531 <para>The <parameter>ebnf.assignment</parameter> parameter determines what
22532 text is used to show <quote>assignment</quote> in <tag>production</tag>s
22533 in <tag>productionset</tag>s.</para>
22535 <para>While <quote><literal>::=</literal></quote> is common, so are several
22536 other operators.</para>
22541 <refentry version="5.0" id="ebnf.statement.terminator">
22543 <refentrytitle>ebnf.statement.terminator</refentrytitle>
22544 <refmiscinfo class="other" otherclass="datatype">rtf</refmiscinfo>
22547 <refname>ebnf.statement.terminator</refname>
22548 <refpurpose>Punctuation that ends an EBNF statement.</refpurpose>
22552 <programlisting id="ebnf.statement.terminator.frag">
22554 <xsl:param name="ebnf.statement.terminator"></xsl:param>
22558 <refsection><info><title>Description</title></info>
22560 <para>The <parameter>ebnf.statement.terminator</parameter> parameter determines what
22561 text is used to terminate each <tag>production</tag>
22562 in <tag>productionset</tag>.</para>
22564 <para>Some notations end each statement with a period.</para>
22569 </reference><reference id="prepress" xml:base="../fo/param.xml"><title>Prepress</title>
22570 <refentry version="5.0" id="crop.marks">
22572 <refentrytitle>crop.marks</refentrytitle>
22573 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
22576 <refname>crop.marks</refname>
22577 <refpurpose>Output crop marks?</refpurpose>
22581 <programlisting id="crop.marks.frag">
22582 <xsl:param name="crop.marks" select="0"></xsl:param>
22586 <refsection><info><title>Description</title></info>
22588 <para>If non-zero, crop marks will be added to each page. Currently this
22589 works only with XEP if you have <parameter>xep.extensions</parameter> set.</para>
22594 <refentry version="5.0" id="crop.mark.width">
22596 <refentrytitle>crop.mark.width</refentrytitle>
22597 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
22600 <refname>crop.mark.width</refname>
22601 <refpurpose>Width of crop marks.</refpurpose>
22605 <programlisting id="crop.mark.width.frag">
22606 <xsl:param name="crop.mark.width">0.5pt</xsl:param>
22610 <refsection><info><title>Description</title></info>
22612 <para>Width of crop marks. Crop marks are controlled by
22613 <parameter>crop.marks</parameter> parameter.</para>
22618 <refentry version="5.0" id="crop.mark.offset">
22620 <refentrytitle>crop.mark.offset</refentrytitle>
22621 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
22624 <refname>crop.mark.offset</refname>
22625 <refpurpose>Length of crop marks.</refpurpose>
22629 <programlisting id="crop.mark.offset.frag">
22630 <xsl:param name="crop.mark.offset">24pt</xsl:param>
22634 <refsection><info><title>Description</title></info>
22636 <para>Length of crop marks. Crop marks are controlled by
22637 <parameter>crop.marks</parameter> parameter.</para>
22642 <refentry version="5.0" id="crop.mark.bleed">
22644 <refentrytitle>crop.mark.bleed</refentrytitle>
22645 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
22648 <refname>crop.mark.bleed</refname>
22649 <refpurpose>Length of invisible part of crop marks.</refpurpose>
22653 <programlisting id="crop.mark.bleed.frag">
22654 <xsl:param name="crop.mark.bleed">6pt</xsl:param>
22658 <refsection><info><title>Description</title></info>
22660 <para>Length of invisible part of crop marks. Crop marks are controlled by
22661 <parameter>crop.marks</parameter> parameter.</para>
22668 <part id="manpages">
22669 <?dbhtml dir="manpages"?>
22670 <?dbhtml filename="index.html"?>
22671 <title xml:base="../manpages/param.xml">Manpages Parameter Reference</title>
22672 <partintro id="manintro">
22674 <para xml:base="../manpages/param.xml">This is reference documentation for all user-configurable
22675 parameters in the DocBook XSL "manpages" stylesheet (for
22676 generating groff/nroff output). Note that the manpages
22677 stylesheet is a customization layer of the DocBook XSL HTML
22678 stylesheet. Therefore, you can also use a number of <link xlink:href="../html/">HTML stylesheet parameters</link>
22679 to control manpages output (in addition to the
22680 manpages-specific parameters listed in this section).</para>
22683 <reference id="general" xml:base="../manpages/param.xml">
22684 <title>Hyphenation, justification, and breaking</title>
22685 <refentry version="5.0" id="man.hyphenate">
22687 <refentrytitle>man.hyphenate</refentrytitle>
22688 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
22691 <refname>man.hyphenate</refname>
22692 <refpurpose>Enable hyphenation?</refpurpose>
22696 <programlisting id="man.hyphenate.frag">
22697 <xsl:param name="man.hyphenate">0</xsl:param></programlisting>
22700 <refsection><info><title>Description</title></info>
22702 <para>If non-zero, hyphenation is enabled.</para>
22705 <para>The default value for this parameter is zero because groff is
22706 not particularly smart about how it does hyphenation; it can end up
22707 hyphenating a lot of things that you don't want hyphenated. To
22708 mitigate that, the default behavior of the stylesheets is to suppress
22709 hyphenation of computer inlines, filenames, and URLs. (You can
22710 override the default behavior by setting non-zero values for the
22711 <parameter>man.hyphenate.urls</parameter>,
22712 <parameter>man.hyphenate.filenames</parameter>, and
22713 <parameter>man.hyphenate.computer.inlines</parameter> parameters.) But
22714 the best way is still to just globally disable hyphenation, as the
22715 stylesheets do by default.</para>
22717 <para>The only good reason to enabled hyphenation is if you have also
22718 enabled justification (which is disabled by default). The reason is
22719 that justified text can look very bad unless you also hyphenate it; to
22720 quote the <quote>Hypenation</quote> node from the groff info page:
22723 <para><emphasis>Since the odds are not great for finding a set of
22724 words, for every output line, which fit nicely on a line without
22725 inserting excessive amounts of space between words, 'gtroff'
22726 hyphenates words so that it can justify lines without inserting too
22727 much space between words.</emphasis></para>
22730 So, if you set a non-zero value for the
22731 <parameter>man.justify</parameter> parameter (to enable
22732 justification), then you should probably also set a non-zero value for
22733 <parameter>man.hyphenate</parameter> (to enable hyphenation).</para>
22740 <refentry version="5.0" id="man.hyphenate.urls">
22742 <refentrytitle>man.hyphenate.urls</refentrytitle>
22743 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
22746 <refname>man.hyphenate.urls</refname>
22747 <refpurpose>Hyphenate URLs?</refpurpose>
22751 <programlisting id="man.hyphenate.urls.frag">
22752 <xsl:param name="man.hyphenate.urls">0</xsl:param></programlisting>
22755 <refsection><info><title>Description</title></info>
22757 <para>If zero (the default), hyphenation is suppressed for output of
22758 the <tag>ulink</tag> <tag class="attribute">url</tag> attribute.</para>
22761 <para>If hyphenation is already turned off globally (that is, if
22762 <parameter>man.hyphenate</parameter> is zero, setting
22763 <parameter>man.hyphenate.urls</parameter> is not necessary.</para>
22766 <para>If <parameter>man.hyphenate.urls</parameter> is non-zero, URLs
22767 will not be treated specially and are subject to hyphenation just like
22768 other words.</para>
22771 <para>If you are thinking about setting a non-zero value for
22772 <parameter>man.hyphenate.urls</parameter> in order to make long
22773 URLs break across lines, you'd probably be better off
22774 experimenting with setting the
22775 <parameter>man.break.after.slash</parameter> parameter first. That
22776 will cause long URLs to be broken after slashes.</para>
22782 <refentry version="5.0" id="man.hyphenate.filenames">
22784 <refentrytitle>man.hyphenate.filenames</refentrytitle>
22785 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
22788 <refname>man.hyphenate.filenames</refname>
22789 <refpurpose>Hyphenate filenames?</refpurpose>
22793 <programlisting id="man.hyphenate.filenames.frag">
22794 <xsl:param name="man.hyphenate.filenames">0</xsl:param></programlisting>
22797 <refsection><info><title>Description</title></info>
22799 <para>If zero (the default), hyphenation is suppressed for
22800 <tag>filename</tag> output.</para>
22803 <para>If hyphenation is already turned off globally (that is, if
22804 <parameter>man.hyphenate</parameter> is zero, setting
22805 <parameter>man.hyphenate.filenames</parameter> is not
22809 <para>If <parameter>man.hyphenate.filenames</parameter> is non-zero,
22810 filenames will not be treated specially and are subject to hyphenation
22811 just like other words.</para>
22814 <para>If you are thinking about setting a non-zero value for
22815 <parameter>man.hyphenate.filenames</parameter> in order to make long
22816 filenames/pathnames break across lines, you'd probably be better off
22817 experimenting with setting the
22818 <parameter>man.break.after.slash</parameter> parameter first. That
22819 will cause long pathnames to be broken after slashes.</para>
22825 <refentry version="5.0" id="man.hyphenate.computer.inlines">
22827 <refentrytitle>man.hyphenate.computer.inlines</refentrytitle>
22828 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
22831 <refname>man.hyphenate.computer.inlines</refname>
22832 <refpurpose>Hyphenate computer inlines?</refpurpose>
22836 <programlisting id="man.hyphenate.computer.inlines.frag">
22837 <xsl:param name="man.hyphenate.computer.inlines">0</xsl:param></programlisting>
22840 <refsection><info><title>Description</title></info>
22842 <para>If zero (the default), hyphenation is suppressed for
22843 <quote>computer inlines</quote> such as environment variables,
22844 constants, etc. This parameter current affects output of the following
22846 <simplelist type="inline">
22848 <member><tag>classname</tag></member>
22849 <member><tag>constant</tag></member>
22850 <member><tag>envar</tag></member>
22851 <member><tag>errorcode</tag></member>
22852 <member><tag>option</tag></member>
22853 <member><tag>replaceable</tag></member>
22854 <member><tag>userinput</tag></member>
22855 <member><tag>type</tag></member>
22856 <member><tag>varname</tag></member>
22861 <para>If hyphenation is already turned off globally (that is, if
22862 <parameter>man.hyphenate</parameter> is zero, setting the
22863 <parameter>man.hyphenate.computer.inlines</parameter> is not
22867 <para>If <parameter>man.hyphenate.computer.inlines</parameter> is
22868 non-zero, computer inlines will not be treated specially and will be
22869 hyphenated like other words when needed.</para>
22874 <refentry version="5.0" id="man.justify">
22876 <refentrytitle>man.justify</refentrytitle>
22877 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
22880 <refname>man.justify</refname>
22881 <refpurpose>Justify text to both right and left margins?</refpurpose>
22885 <programlisting id="man.justify.frag">
22886 <xsl:param name="man.justify">0</xsl:param></programlisting>
22889 <refsection><info><title>Description</title></info>
22891 <para>If non-zero, text is justified to both the right and left
22892 margins (or, in roff terminology, "adjusted and filled" to both the
22893 right and left margins). If zero (the default), text is adjusted to
22894 the left margin only -- producing what is traditionally called
22895 "ragged-right" text.</para>
22898 <para>The default value for this parameter is zero because justified
22899 text looks good only when it is also hyphenated. Without hyphenation,
22900 excessive amounts of space often end up getting between words, in
22901 order to "pad" lines out to align on the right margin.</para>
22903 <para>The problem is that groff is not particularly smart about how it
22904 does hyphenation; it can end up hyphenating a lot of things that you
22905 don't want hyphenated. So, disabling both justification and
22906 hyphenation ensures that hyphens won't get inserted where you don't
22907 want to them, and you don't end up with lines containing excessive
22908 amounts of space between words.</para>
22910 <para>However, if do you decide to set a non-zero value for the
22911 <parameter>man.justify</parameter> parameter (to enable
22912 justification), then you should probably also set a non-zero value for
22913 <parameter>man.hyphenate</parameter> (to enable hyphenation).</para>
22915 <para>Yes, these default settings run counter to how most existing man
22916 pages are formatted. But there are some notable exceptions, such as
22917 the <literal>perl</literal> man pages.</para>
22922 <refentry version="5.0" id="man.break.after.slash">
22924 <refentrytitle>man.break.after.slash</refentrytitle>
22925 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
22928 <refname>man.break.after.slash</refname>
22929 <refpurpose>Enable line-breaking after slashes?</refpurpose>
22933 <programlisting id="man.break.after.slash.frag">
22934 <xsl:param name="man.break.after.slash">0</xsl:param></programlisting>
22937 <refsection><info><title>Description</title></info>
22939 <para>If non-zero, line-breaking after slashes is enabled. This is
22940 mainly useful for causing long URLs or pathnames/filenames to be
22941 broken up or "wrapped" across lines (though it also has the side
22942 effect of sometimes causing relatively short URLs and pathnames to be
22943 broken up across lines too).</para>
22945 <para>If zero (the default), line-breaking after slashes is
22946 disabled. In that case, strings containing slashes (for example, URLs
22947 or filenames) are not broken across lines, even if they exceed the
22948 maximum column widith.</para>
22951 <para>If you set a non-zero value for this parameter, check your
22952 man-page output carefuly afterwards, in order to make sure that the
22953 setting has not introduced an excessive amount of breaking-up of URLs
22954 or pathnames. If your content contains mostly short URLs or
22955 pathnames, setting a non-zero value for
22956 <parameter>man.break.after.slash</parameter> will probably result in
22957 in a significant number of relatively short URLs and pathnames being
22958 broken across lines, which is probably not what you want.</para>
22964 </reference><reference id="indent" xml:base="../manpages/param.xml">
22965 <title>Indentation</title>
22966 <refentry version="5.0" id="man.indent.width">
22968 <refentrytitle>man.indent.width</refentrytitle>
22969 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
22972 <refname>man.indent.width</refname>
22973 <refpurpose>Specifies width used for adjusted indents</refpurpose>
22977 <programlisting id="man.indent.width.frag">
22978 <xsl:param name="man.indent.width">4</xsl:param>
22982 <refsection><info><title>Description</title></info>
22983 <para>The <parameter>man.indent.width</parameter> parameter specifies
22984 the width used for adjusted indents. The value of
22985 <parameter>man.indent.width</parameter> is used for indenting of
22986 lists, verbatims, headings, and elsewhere, depending on whether the
22987 values of certain <literal>man.indent.*</literal> boolean parameters
22988 are non-zero.</para>
22990 <para>The value of <parameter>man.indent.width</parameter> should
22991 include a valid roff measurement unit (for example,
22992 <literal>n</literal> or <literal>u</literal>). The default value of
22993 <literal>4n</literal> specifies a 4-en width; when viewed on a
22994 console, that amounts to the width of four characters. For details
22995 about roff measurment units, see the <literal>Measurements</literal>
22996 node in the groff info page.</para>
23001 <refentry version="5.0" id="man.indent.refsect">
23003 <refentrytitle>man.indent.refsect</refentrytitle>
23004 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
23007 <refname>man.indent.refsect</refname>
23008 <refpurpose>Adjust indentation of refsect* and refsection?</refpurpose>
23012 <programlisting id="man.indent.refsect.frag">
23013 <xsl:param name="man.indent.refsect" select="0"></xsl:param></programlisting>
23016 <refsection><info><title>Description</title></info>
23018 <para>If the value of <parameter>man.indent.refsect</parameter> is
23019 non-zero, the width of the left margin for
23020 <tag>refsect1</tag>, <tag>refsect2</tag> and
23021 <tag>refsect3</tag> contents and titles (and first-level,
23022 second-level, and third-level nested
23023 <tag>refsection</tag>instances) is adjusted by the value of
23024 the <parameter>man.indent.width</parameter> parameter. With
23025 <parameter>man.indent.width</parameter> set to its default value of
23026 <literal>3n</literal>, the main results are that:
23030 <para>contents of <tag>refsect1</tag> are output with a
23031 left margin of three characters instead the roff default of seven
23032 or eight characters</para>
23035 <para>contents of <tag>refsect2</tag> are displayed in
23036 console output with a left margin of six characters instead the of
23037 the roff default of seven characters</para>
23040 <para> the contents of <tag>refsect3</tag> and nested
23041 <tag>refsection</tag> instances are adjusted
23042 accordingly.</para>
23046 If instead the value of <parameter>man.indent.refsect</parameter> is
23047 zero, no margin adjustment is done for <literal>refsect*</literal>
23051 <para>If your content is primarly comprised of
23052 <tag>refsect1</tag> and <tag>refsect2</tag> content
23053 (or the <tag>refsection</tag> equivalent) – with few or
23054 no <tag>refsect3</tag> or lower nested sections , you may be
23055 able to “conserve” space in your output by setting
23056 <parameter>man.indent.refsect</parameter> to a non-zero value. Doing
23057 so will “squeeze” the left margin in such as way as to provide an
23058 additional four characters of “room” per line in
23059 <tag>refsect1</tag> output. That extra room may be useful
23060 if, for example, you have many verbatim sections with long lines in
23067 <refentry version="5.0" id="man.indent.blurbs">
23069 <refentrytitle>man.indent.blurbs</refentrytitle>
23070 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
23073 <refname>man.indent.blurbs</refname>
23074 <refpurpose>Adjust indentation of blurbs?</refpurpose>
23078 <programlisting id="man.indent.blurbs.frag">
23079 <xsl:param name="man.indent.blurbs" select="1"></xsl:param></programlisting>
23082 <refsection><info><title>Description</title></info>
23084 <para>If the value of <parameter>man.indent.blurbs</parameter> is
23085 non-zero, the width of the left margin for
23086 <tag>authorblurb</tag>, <tag>personblurb</tag>, and
23087 <tag>contrib</tag> output is set to the value of the
23088 <parameter>man.indent.width</parameter> parameter
23089 (<literal>3n</literal> by default). If instead the value of
23090 <parameter>man.indent.blurbs</parameter> is zero, the built-in roff
23091 default width (<literal>7.2n</literal>) is used.</para>
23096 <refentry version="5.0" id="man.indent.lists">
23098 <refentrytitle>man.indent.lists</refentrytitle>
23099 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
23102 <refname>man.indent.lists</refname>
23103 <refpurpose>Adjust indentation of lists?</refpurpose>
23107 <programlisting id="man.indent.lists.frag">
23108 <xsl:param name="man.indent.lists" select="1"></xsl:param></programlisting>
23111 <refsection><info><title>Description</title></info>
23113 <para>If the value of <parameter>man.indent.lists</parameter> is
23114 non-zero, the width of the left margin for list items in
23115 <tag>itemizedlist</tag>,
23116 <tag>orderedlist</tag>,
23117 <tag>variablelist</tag> output (and output of some other
23118 lists) is set to the value of the
23119 <parameter>man.indent.width</parameter> parameter
23120 (<literal>4n</literal> by default). If instead the value of
23121 <parameter>man.indent.lists</parameter> is zero, the built-in roff
23122 default width (<literal>7.2n</literal>) is used.</para>
23127 <refentry version="5.0" id="man.indent.verbatims">
23129 <refentrytitle>man.indent.verbatims</refentrytitle>
23130 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
23133 <refname>man.indent.verbatims</refname>
23134 <refpurpose>Adjust indentation of verbatims?</refpurpose>
23138 <programlisting id="man.indent.verbatims.frag">
23139 <xsl:param name="man.indent.verbatims" select="1"></xsl:param></programlisting>
23142 <refsection><info><title>Description</title></info>
23144 <para>If the value of <parameter>man.indent.verbatims</parameter> is
23145 non-zero, the width of the left margin for output of verbatim
23146 environments (<tag>programlisting</tag>,
23147 <tag>screen</tag>, and so on) is set to the value of the
23148 <parameter>man.indent.width</parameter> parameter
23149 (<literal>3n</literal> by default). If instead the value of
23150 <parameter>man.indent.verbatims</parameter> is zero, the built-in roff
23151 default width (<literal>7.2n</literal>) is used.</para>
23156 </reference><reference id="fonts" xml:base="../manpages/param.xml">
23157 <title>Fonts</title>
23158 <refentry version="5.0" id="man.font.funcprototype">
23160 <refentrytitle>man.font.funcprototype</refentrytitle>
23161 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
23164 <refname>man.font.funcprototype</refname>
23165 <refpurpose>Specifies font for funcprototype output</refpurpose>
23169 <programlisting id="man.font.funcprototype.frag">
23170 <xsl:param name="man.font.funcprototype">BI</xsl:param>
23174 <refsection><info><title>Description</title></info>
23176 <para>The <parameter>man.font.funcprototype</parameter> parameter
23177 specifies the font for <tag>funcprototype</tag> output. It
23178 should be a valid roff font name, such as <literal>BI</literal> or
23179 <literal>B</literal>.</para>
23184 <refentry version="5.0" id="man.font.funcsynopsisinfo">
23186 <refentrytitle>man.font.funcsynopsisinfo</refentrytitle>
23187 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
23190 <refname>man.font.funcsynopsisinfo</refname>
23191 <refpurpose>Specifies font for funcsynopsisinfo output</refpurpose>
23195 <programlisting id="man.font.funcsynopsisinfo.frag">
23196 <xsl:param name="man.font.funcsynopsisinfo">B</xsl:param>
23200 <refsection><info><title>Description</title></info>
23202 <para>The <parameter>man.font.funcsynopsisinfo</parameter> parameter
23203 specifies the font for <tag>funcsynopsisinfo</tag> output. It
23204 should be a valid roff font name, such as <literal>B</literal> or
23205 <literal>I</literal>.</para>
23210 <refentry version="5.0" id="man.font.links">
23212 <refentrytitle>man.font.links</refentrytitle>
23213 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
23216 <refname>man.font.links</refname>
23217 <refpurpose>Specifies font for links</refpurpose>
23221 <programlisting id="man.font.links.frag">
23222 <xsl:param name="man.font.links">B</xsl:param>
23226 <refsection><info><title>Description</title></info>
23228 <para>The <parameter>man.font.links</parameter> parameter
23229 specifies the font for output of links (<tag>ulink</tag> instances
23230 and any instances of any element with an <tag class="attribute">xlink:href</tag> attribute).</para>
23232 <para>The value of <parameter>man.font.links</parameter> must be
23233 either <literal>B</literal> or <literal>I</literal>, or empty. If
23234 the value is empty, no font formatting is applied to links.</para>
23236 <para>If you set <parameter>man.endnotes.are.numbered</parameter> and/or
23237 <parameter>man.endnotes.list.enabled</parameter> to zero (disabled), then
23238 you should probably also set an empty value for
23239 <parameter>man.font.links</parameter>. But if
23240 <parameter>man.endnotes.are.numbered</parameter> is non-zero (enabled),
23241 you should probably keep
23242 <parameter>man.font.links</parameter> set to
23243 <literal>B</literal> or <literal>I</literal><footnote><para>The
23244 main purpose of applying a font format to links in most output
23245 formats it to indicate that the formatted text is
23246 “clickable”; given that links rendered in man pages are
23247 not “real” hyperlinks that users can click on, it might
23248 seem like there is never a good reason to have font formatting for
23249 link contents in man output.</para>
23250 <para>In fact, if you suppress the
23251 display of inline link references (by setting
23252 <parameter>man.endnotes.are.numbered</parameter> to zero), there is no
23253 good reason to apply font formatting to links. However, if
23254 <parameter>man.endnotes.are.numbered</parameter> is non-zero, having
23255 font formatting for links (arguably) serves a purpose: It provides
23256 “context” information about exactly what part of the text
23257 is being “annotated” by the link. Depending on how you
23258 mark up your content, that context information may or may not
23259 have value.</para></footnote>.</para>
23262 <refsection><info><title>Related Parameters</title></info>
23263 <para><parameter>man.endnotes.list.enabled</parameter>,
23264 <parameter>man.endnotes.are.numbered</parameter></para>
23269 <refentry version="5.0" id="man.font.table.headings">
23271 <refentrytitle>man.font.table.headings</refentrytitle>
23272 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
23275 <refname>man.font.table.headings</refname>
23276 <refpurpose>Specifies font for table headings</refpurpose>
23280 <programlisting id="man.font.table.headings.frag">
23281 <xsl:param name="man.font.table.headings">B</xsl:param>
23285 <refsection><info><title>Description</title></info>
23287 <para>The <parameter>man.font.table.headings</parameter> parameter
23288 specifies the font for <tag>table</tag> headings. It should be
23289 a valid roff font, such as <literal>B</literal> or
23290 <literal>I</literal>.</para>
23295 <refentry version="5.0" id="man.font.table.title">
23297 <refentrytitle>man.font.table.title</refentrytitle>
23298 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
23301 <refname>man.font.table.title</refname>
23302 <refpurpose>Specifies font for table headings</refpurpose>
23306 <programlisting id="man.font.table.title.frag">
23307 <xsl:param name="man.font.table.title">B</xsl:param>
23311 <refsection><info><title>Description</title></info>
23313 <para>The <parameter>man.font.table.title</parameter> parameter
23314 specifies the font for <tag>table</tag> titles. It should be
23315 a valid roff font, such as <literal>B</literal> or
23316 <literal>I</literal>.</para>
23321 </reference><reference id="synopsis" xml:base="../manpages/param.xml">
23322 <title>SYNOPSIS section</title>
23323 <refentry version="5.0" id="man.funcsynopsis.style">
23325 <refentrytitle>man.funcsynopsis.style</refentrytitle>
23326 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
23327 <refmiscinfo class="other" otherclass="value">ansi</refmiscinfo>
23328 <refmiscinfo class="other" otherclass="value">kr</refmiscinfo>
23331 <refname>man.funcsynopsis.style</refname>
23332 <refpurpose>What style of <tag>funcsynopsis</tag> should be generated?</refpurpose>
23335 <programlisting id="man.funcsynopsis.style.frag"><xsl:param name="man.funcsynopsis.style">ansi</xsl:param></programlisting>
23337 <refsection><info><title>Description</title></info>
23338 <para>If <parameter>man.funcsynopsis.style</parameter> is
23339 <literal>ansi</literal>, ANSI-style function synopses are
23340 generated for a <tag>funcsynopsis</tag>, otherwise K&R-style
23341 function synopses are generated.</para>
23345 </reference><reference id="authors" xml:base="../manpages/param.xml">
23346 <title>AUTHORS and COPYRIGHT sections</title>
23347 <refentry version="5.0" id="man.authors.section.enabled">
23349 <refentrytitle>man.authors.section.enabled</refentrytitle>
23350 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
23353 <refname>man.authors.section.enabled</refname>
23354 <refpurpose>Display auto-generated AUTHORS section?</refpurpose>
23357 <programlisting id="man.authors.section.enabled.frag">
23358 <xsl:param name="man.authors.section.enabled">1</xsl:param>
23361 <refsection><info><title>Description</title></info>
23363 <para>If the value of
23364 <parameter>man.authors.section.enabled</parameter> is non-zero
23365 (the default), then an <literal>AUTHORS</literal> section is
23366 generated near the end of each man page. The output of the
23367 <literal>AUTHORS</literal> section is assembled from any
23368 <tag>author</tag>, <tag>editor</tag>, and <tag>othercredit</tag>
23369 metadata found in the contents of the child <tag>info</tag> or
23370 <tag>refentryinfo</tag> (if any) of the <tag>refentry</tag>
23371 itself, or from any <tag>author</tag>, <tag>editor</tag>, and
23372 <tag>othercredit</tag> metadata that may appear in <tag>info</tag>
23373 contents of any ancestors of the <tag>refentry</tag>.</para>
23375 <para>If the value of
23376 <parameter>man.authors.section.enabled</parameter> is zero, the
23377 the auto-generated <literal>AUTHORS</literal> section is
23380 <para>Set the value of
23381 <parameter>man.authors.section.enabled</parameter> to zero if
23382 you want to have a manually created <literal>AUTHORS</literal>
23383 section in your source, and you want it to appear in output
23384 instead of the auto-generated <literal>AUTHORS</literal>
23389 <refentry version="5.0" id="man.copyright.section.enabled">
23391 <refentrytitle>man.copyright.section.enabled</refentrytitle>
23392 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
23395 <refname>man.copyright.section.enabled</refname>
23396 <refpurpose>Display auto-generated COPYRIGHT section?</refpurpose>
23399 <programlisting id="man.copyright.section.enabled.frag">
23400 <xsl:param name="man.copyright.section.enabled">1</xsl:param>
23403 <refsection><info><title>Description</title></info>
23405 <para>If the value of
23406 <parameter>man.copyright.section.enabled</parameter> is non-zero
23407 (the default), then a <literal>COPYRIGHT</literal> section is
23408 generated near the end of each man page. The output of the
23409 <literal>COPYRIGHT</literal> section is assembled from any
23410 <tag>copyright</tag> and <tag>legalnotice</tag> metadata found in
23411 the contents of the child <tag>info</tag> or
23412 <tag>refentryinfo</tag> (if any) of the <tag>refentry</tag>
23413 itself, or from any <tag>copyright</tag> and
23414 <tag>legalnotice</tag> metadata that may appear in <tag>info</tag>
23415 contents of any ancestors of the <tag>refentry</tag>.</para>
23417 <para>If the value of
23418 <parameter>man.copyright.section.enabled</parameter> is zero, the
23419 the auto-generated <literal>COPYRIGHT</literal> section is
23422 <para>Set the value of
23423 <parameter>man.copyright.section.enabled</parameter> to zero if
23424 you want to have a manually created <literal>COPYRIGHT</literal>
23425 section in your source, and you want it to appear in output
23426 instead of the auto-generated <literal>COPYRIGHT</literal>
23431 </reference><reference id="endnotes" xml:base="../manpages/param.xml">
23432 <title>Endnotes and link handling</title>
23433 <refentry version="5.0" id="man.endnotes.list.enabled">
23435 <refentrytitle>man.endnotes.list.enabled</refentrytitle>
23436 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
23439 <refname>man.endnotes.list.enabled</refname>
23440 <refpurpose>Display endnotes list at end of man page?</refpurpose>
23444 <programlisting id="man.endnotes.list.enabled.frag">
23445 <xsl:param name="man.endnotes.list.enabled">1</xsl:param>
23449 <refsection><info><title>Description</title></info>
23451 <para>If the value of <parameter>man.endnotes.list.enabled</parameter> is
23452 non-zero (the default), then an endnotes list is added to the end of
23453 the output man page.</para>
23455 <para>If the value of <parameter>man.endnotes.list.enabled</parameter> is
23456 zero, the list is suppressed — unless link numbering is enabled (that
23457 is, if <parameter>man.endnotes.are.numbered</parameter> is non-zero), in
23458 which case, that setting overrides the
23459 <parameter>man.endnotes.list.enabled</parameter> setting, and the
23460 endnotes list is still displayed. The reason is that inline
23461 numbering of notesources associated with endnotes only makes sense
23462 if a (numbered) list of endnotes is also generated.</para>
23466 <parameter>man.endnotes.list.enabled</parameter> at its default
23467 (non-zero) value ensures that no “out of line” information (such
23468 as the URLs for hyperlinks and images) gets lost in your
23469 man-page output. It just gets “rearranged”.</para>
23470 <para>So if you’re thinking about disabling endnotes listing by
23471 setting the value of
23472 <parameter>man.endnotes.list.enabled</parameter> to zero:
23473 Before you do so, first take some time to carefully consider
23474 the information needs and experiences of your users. The “out
23475 of line” information has value even if the presentation of it
23476 in text output is not as interactive as it may be in other
23477 output formats.</para>
23478 <para>As far as the specific case of URLs: Even though the URLs
23479 displayed in text output may not be “real” (clickable)
23480 hyperlinks, many X terminals have convenience features for
23481 recognizing URLs and can, for example, present users with
23482 an options to open a URL in a browser with the user clicks on
23483 the URL is a terminal window. And short of those, users with X
23484 terminals can always manually cut and paste the URLs into a web
23486 <para>Also, note that various “man to html” tools, such as the
23487 widely used <command><link xlink:href="http://users.actrix.gen.nz/michael/vhman2html.html">man2html</link></command> (<literal>VH-Man2html</literal>)
23488 application, automatically mark up URLs with <literal>a@href</literal> markup
23489 during conversion — resulting in “real” hyperlinks in HTML
23490 output from those tools.</para>
23493 <para>To “turn off” numbering of endnotes in the
23494 endnotes list, set <parameter>man.endnotes.are.numbered</parameter>
23495 to zero. The endnotes list will
23496 still be displayed; it will just be displayed without the
23497 numbers<footnote><para>It can still make sense to have
23498 the list of endnotes displayed even if you have endnotes numbering turned
23499 off. In that case, your endnotes list basically becomes a “list
23500 of references” without any association with specific text in
23501 your document. This is probably the best option if you find the inline
23502 endnotes numbering obtrusive. Your users will still have access to all the “out of line”
23503 such as URLs for hyperlinks.</para></footnote>
23506 <para>The default heading for the endnotes list is
23507 <literal>NOTES</literal>. To change that, set a non-empty
23508 value for the <parameter>man.endnotes.list.heading</parameter>
23511 <para>In the case of notesources that are links: Along with the
23512 URL for each link, the endnotes list includes the contents of the
23513 link. The list thus includes only non-empty<footnote>
23515 <para>A “non-empty” link is one that looks like
23516 this:<literallayout class="monospaced"> <ulink url="http://docbook.sf.net/snapshot/xsl/doc/manpages/">manpages</ulink></literallayout>
23517 an “empty link” is on that looks like this:<literallayout class="monospaced"> <ulink url="http://docbook.sf.net/snapshot/xsl/doc/manpages/"/></literallayout>
23518 </para></footnote> links.
23520 Empty links are never included, and never numbered. They are simply
23521 displayed inline, without any numbering.</para>
23523 <para>In addition, if there are multiple instances of links in a
23524 <tag>refentry</tag> that have the same URL, the URL is listed only
23525 once. The contents listed for that link in the endnotes list are
23526 the contents of the first link which has that URL.</para>
23528 <para>If you disable endnotes listing, you should probably also set
23529 <parameter>man.links.are.underlined</parameter> to zero (to disable
23530 link underlining).</para>
23534 <refentry version="5.0" id="man.endnotes.list.heading">
23536 <refentrytitle>man.endnotes.list.heading</refentrytitle>
23537 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
23540 <refname>man.endnotes.list.heading</refname>
23541 <refpurpose>Specifies an alternate name for endnotes list</refpurpose>
23545 <programlisting id="man.endnotes.list.heading.frag">
23546 <xsl:param name="man.endnotes.list.heading"></xsl:param>
23550 <refsection><info><title>Description</title></info>
23552 <para>If the value of the
23553 <parameter>man.endnotes.are.numbered</parameter> parameter
23554 and/or the <parameter>man.endnotes.list.enabled</parameter>
23555 parameter is non-zero (the defaults for both are non-zero), a
23556 numbered list of endnotes is generated near the end of each man
23557 page. The default heading for the list of endnotes is the
23558 equivalent of the English word <literal>NOTES</literal> in
23559 the current locale. To cause an alternate heading to be displayed,
23560 set a non-empty value for the
23561 <parameter>man.endnotes.list.heading</parameter> parameter —
23562 for example, <literal>REFERENCES</literal>.</para>
23566 <refentry version="5.0" id="man.endnotes.are.numbered">
23568 <refentrytitle>man.endnotes.are.numbered</refentrytitle>
23569 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
23572 <refname>man.endnotes.are.numbered</refname>
23573 <refpurpose>Number endnotes?</refpurpose>
23577 <programlisting id="man.endnotes.are.numbered.frag">
23578 <xsl:param name="man.endnotes.are.numbered">1</xsl:param>
23582 <refsection><info><title>Description</title></info>
23584 <para>If the value of <parameter>man.endnotes.are.numbered</parameter> is
23585 non-zero (the default), then for each non-empty<footnote>
23586 <para>A “non-empty” notesource is one that looks like
23587 this:<literallayout class="monospaced"> <ulink url="http://docbook.sf.net/snapshot/xsl/doc/manpages/">manpages</ulink></literallayout>
23588 an “empty” notesource is on that looks like this:<literallayout class="monospaced"> <ulink url="http://docbook.sf.net/snapshot/xsl/doc/manpages/"/></literallayout>
23589 </para></footnote> “notesource”:
23593 <para>a number (in square brackets) is displayed inline after the
23594 rendered inline contents (if any) of the notesource</para>
23597 <para>the contents of the notesource are included in a
23598 numbered list of endnotes that is generated at the end of
23599 each man page; the number for each endnote corresponds to
23600 the inline number for the notesource with which it is
23604 The default heading for the list of endnotes is
23605 <literal>NOTES</literal>. To output a different heading, set a value
23606 for the <parameter>man.endnotes.section.heading</parameter>
23610 <para>The endnotes list is also displayed (but without
23611 numbers) if the value of
23612 <parameter>man.endnotes.list.enabled</parameter> is
23617 <para>If the value of <parameter>man.endnotes.are.numbered</parameter> is
23618 zero, numbering of endnotess is suppressed; only inline
23619 contents (if any) of the notesource are displayed inline.
23621 <para>If you are thinking about disabling endnote numbering by setting
23622 the value of <parameter>man.endnotes.are.numbered</parameter> to zero,
23623 before you do so, first take some time to carefully
23624 consider the information needs and experiences of your users. The
23625 square-bracketed numbers displayed inline after notesources may seem
23626 obstrusive and aesthetically unpleasing<footnote><para>As far as notesources that are links, ytou might
23627 think it would be better to just display URLs for non-empty
23628 links inline, after their content, rather than displaying
23629 square-bracketed numbers all over the place. But it's not better. In
23630 fact, it's not even practical, because many (most) URLs for links
23631 are too long to be displayed inline. They end up overflowing the
23632 right margin. You can set a non-zero value for
23633 <parameter>man.break.after.slash</parameter> parameter to deal with
23634 that, but it could be argued that what you end up with is at least
23635 as ugly, and definitely more obstrusive, then having short
23636 square-bracketed numbers displayed inline.</para></footnote>,
23638 but in a text-only output format, the
23639 numbered-notesources/endnotes-listing mechanism is the only
23640 practical way to handle this kind of content.</para>
23642 <para>Also, users of “text based” browsers such as
23643 <command>lynx</command> will already be accustomed to seeing inline
23644 numbers for links. And various "man to html" applications, such as
23645 the widely used <command><link xlink:href="http://users.actrix.gen.nz/michael/vhman2html.html">man2html</link></command> (<literal>VH-Man2html</literal>)
23646 application, can automatically turn URLs into "real" HTML hyperlinks
23647 in output. So leaving <parameter>man.endnotes.are.numbered</parameter>
23648 at its default (non-zero) value ensures that no information is
23649 lost in your man-page output. It just gets
23650 “rearranged”.</para>
23653 <para>The handling of empty links is not affected by this
23654 parameter. Empty links are handled simply by displaying their URLs
23655 inline. Empty links are never auto-numbered.</para>
23657 <para>If you disable endnotes numbering, you should probably also set
23658 <parameter>man.font.links</parameter> to an empty value (to
23659 disable font formatting for links.</para>
23662 <refsection><info><title>Related Parameters</title></info>
23663 <para><parameter>man.endnotes.list.enabled</parameter>,
23664 <parameter>man.font.links</parameter></para>
23668 <refentry version="5.0" id="man.base.url.for.relative.links">
23670 <refentrytitle>man.base.url.for.relative.links</refentrytitle>
23671 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
23674 <refname>man.base.url.for.relative.links</refname>
23675 <refpurpose>Specifies a base URL for relative links</refpurpose>
23679 <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>
23682 <refsection><info><title>Description</title></info>
23684 <para>For any “notesource” listed in the auto-generated
23685 “NOTES” section of output man pages (which is generated when
23687 <parameter>man.endnotes.list.enabled</parameter> parameter
23688 is non-zero), if the notesource is a link source with a
23689 relative URI, the URI is displayed in output with the value
23691 <parameter>man.base.url.for.relative.links</parameter>
23692 parameter prepended to the value of the link URI.</para>
23695 <para>A link source is an notesource that references an
23699 <para>a <tag>ulink</tag> element with a <tag class="attribute">url</tag> attribute</para>
23702 <para>any element with an <tag class="attribute">xlink:href</tag> attribute</para>
23705 <para>an <tag>imagedata</tag>, <tag>audiodata</tag>, or
23706 <tag>videodata</tag> element</para>
23712 <para>If you use relative URIs in link sources in your DocBook
23713 <tag>refentry</tag> source, and you leave
23714 <parameter>man.base.url.for.relative.links</parameter>
23715 unset, the relative links will appear “as is” in the “Notes”
23716 section of any man-page output generated from your source.
23717 That’s probably not what you want, because such relative
23718 links are only usable in the context of HTML output. So, to
23719 make the links meaningful and usable in the context of
23720 man-page output, set a value for
23721 <parameter>man.base.url.for.relative.links</parameter> that
23722 points to the online version of HTML output generated from
23723 your DocBook <tag>refentry</tag> source. For
23725 <programlisting><xsl:param name="man.base.url.for.relative.links"
23726 >http://www.kernel.org/pub/software/scm/git/docs/</xsl:param></programlisting>
23731 <refsection><info><title>Related Parameters</title></info>
23732 <para><parameter>man.endnotes.list.enabled</parameter></para>
23737 </reference><reference id="lists" xml:base="../manpages/param.xml">
23738 <title>Lists</title>
23739 <refentry version="5.0" id="man.segtitle.suppress">
23741 <refentrytitle>man.segtitle.suppress</refentrytitle>
23742 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
23745 <refname>man.segtitle.suppress</refname>
23746 <refpurpose>Suppress display of segtitle contents?</refpurpose>
23750 <programlisting id="man.segtitle.suppress.frag">
23751 <xsl:param name="man.segtitle.suppress" select="0"></xsl:param></programlisting>
23754 <refsection><info><title>Description</title></info>
23756 <para>If the value of <parameter>man.segtitle.suppress</parameter> is
23757 non-zero, then display of <tag>segtitle</tag> contents is
23758 suppressed in output.</para>
23763 </reference><reference id="charmap" xml:base="../manpages/param.xml">
23764 <title>Character/string substitution</title>
23765 <refentry version="5.0" id="man.charmap.enabled">
23767 <refentrytitle>man.charmap.enabled</refentrytitle>
23768 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
23771 <refname>man.charmap.enabled</refname>
23772 <refpurpose>Apply character map before final output?</refpurpose>
23776 <programlisting id="man.charmap.enabled.frag">
23777 <xsl:param name="man.charmap.enabled" select="1"></xsl:param>
23781 <refsection><info><title>Description</title></info>
23783 <para>If the value of the <parameter>man.charmap.enabled</parameter>
23784 parameter is non-zero, a "character map" is used to substitute certain
23785 Unicode symbols and special characters with appropriate roff/groff
23786 equivalents, just before writing each man-page file to the
23787 filesystem. If instead the value of
23788 <parameter>man.charmap.enabled</parameter> is zero, Unicode characters
23789 are passed through "as is".</para>
23791 <refsection><info><title>Details</title></info>
23793 <para>For converting certain Unicode symbols and special characters in
23794 UTF-8 or UTF-16 encoded XML source to appropriate groff/roff
23795 equivalents in man-page output, the DocBook XSL Stylesheets
23796 distribution includes a <link xlink:href="http://docbook.sourceforge.net/snapshot/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
23797 map</link> format as detailed in the XSLT 2.0 specification. The map
23798 contains more than 800 character mappings and can be considered the
23799 standard roff character map for the distribution.</para>
23801 <para>You can use the <parameter>man.charmap.uri</parameter>
23802 parameter to specify a URI for the location for an alternate roff
23803 character map to use in place of the standard roff character map
23804 provided in the distribution.</para>
23806 <para>You can also use a subset of a character map. For details,
23807 see the <parameter>man.charmap.use.subset</parameter>,
23808 <parameter>man.charmap.subset.profile</parameter>, and
23809 <parameter>man.charmap.subset.profile.english</parameter>
23816 <refentry version="5.0" id="man.charmap.uri">
23818 <refentrytitle>man.charmap.uri</refentrytitle>
23819 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
23822 <refname>man.charmap.uri</refname>
23823 <refpurpose>URI for custom roff character map</refpurpose>
23827 <programlisting id="man.charmap.uri.frag">
23828 <xsl:param name="man.charmap.uri"></xsl:param>
23832 <refsection><info><title>Description</title></info>
23834 <para>For converting certain Unicode symbols and special characters in
23835 UTF-8 or UTF-16 encoded XML source to appropriate groff/roff
23836 equivalents in man-page output, the DocBook XSL Stylesheets
23837 distribution includes an <link xlink:href="http://www.w3.org/TR/xslt20/#character-maps">XSLT character
23838 map</link>. That character map can be considered the standard roff
23839 character map for the distribution.</para>
23841 <para>If the value of the <parameter>man.charmap.uri</parameter>
23842 parameter is non-empty, that value is used as the URI for the location
23843 for an alternate roff character map to use in place of the standard
23844 roff character map provided in the distribution.</para>
23847 <para>Do not set a value for <parameter>man.charmap.uri</parameter>
23848 unless you have a custom roff character map that differs from the
23849 standard one provided in the distribution.</para>
23854 <refentry version="5.0" id="man.charmap.use.subset">
23856 <refentrytitle>man.charmap.use.subset</refentrytitle>
23857 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
23860 <refname>man.charmap.use.subset</refname>
23861 <refpurpose>Use subset of character map instead of full map?</refpurpose>
23865 <programlisting id="man.charmap.use.subset.frag">
23866 <xsl:param name="man.charmap.use.subset" select="1"></xsl:param>
23870 <refsection><info><title>Description</title></info>
23872 <para>If the value of the
23873 <parameter>man.charmap.use.subset</parameter> parameter is non-zero,
23874 a subset of the roff character map is used instead of the full roff
23875 character map. The profile of the subset used is determined either
23876 by the value of the
23877 <parameter>man.charmap.subset.profile</parameter>
23878 parameter (if the source is not in English) or the
23879 <parameter>man.charmap.subset.profile.english</parameter>
23880 parameter (if the source is in English).</para>
23883 <para>You may want to experiment with setting a non-zero value of
23884 <parameter>man.charmap.use.subset</parameter>, so that the full
23885 character map is used. Depending on which XSLT engine you run,
23886 setting a non-zero value for
23887 <parameter>man.charmap.use.subset</parameter> may significantly
23888 increase the time needed to process your documents. Or it may
23889 not. For example, if you set it and run it with xsltproc, it seems
23890 to dramatically increase processing time; on the other hand, if you
23891 set it and run it with Saxon, it does not seem to increase
23892 processing time nearly as much.</para>
23894 <para>If processing time is not a important concern and/or you can
23895 tolerate the increase in processing time imposed by using the full
23896 character map, set <parameter>man.charmap.use.subset</parameter> to
23900 <refsection><info><title>Details</title></info>
23902 <para>For converting certain Unicode symbols and special characters in
23903 UTF-8 or UTF-16 encoded XML source to appropriate groff/roff
23904 equivalents in man-page output, the DocBook XSL Stylesheets
23905 distribution includes a <link xlink:href="http://docbook.sourceforge.net/snapshot/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
23906 map</link> format as detailed in the XSLT 2.0 specification. The map
23907 contains more than 800 character mappings and can be considered the
23908 standard roff character map for the distribution.</para>
23911 <para>You can use the <parameter>man.charmap.uri</parameter>
23912 parameter to specify a URI for the location for an alternate roff
23913 character map to use in place of the standard roff character map
23914 provided in the distribution.</para>
23917 <para>Because it is not terrifically efficient to use the standard
23918 800-character character map in full -- and for most (or all) users,
23919 never necessary to use it in full -- the DocBook XSL Stylesheets
23920 support a mechanism for using, within any given character map, a
23921 subset of character mappings instead of the full set. You can use the
23922 <parameter>man.charmap.subset.profile</parameter> or
23923 <parameter>man.charmap.subset.profile.english</parameter>
23924 parameter to tune the profile of that subset to use.</para>
23930 <refentry version="5.0" id="man.charmap.subset.profile">
23932 <refentrytitle>man.charmap.subset.profile</refentrytitle>
23933 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
23936 <refname>man.charmap.subset.profile</refname>
23937 <refpurpose>Profile of character map subset</refpurpose>
23941 <programlisting id="man.charmap.subset.profile.frag">
23942 <xsl:param name="man.charmap.subset.profile">
23943 @*[local-name() = 'block'] = 'Miscellaneous Technical' or
23944 (@*[local-name() = 'block'] = 'C1 Controls And Latin-1 Supplement (Latin-1 Supplement)' and
23945 (@*[local-name() = 'class'] = 'symbols' or
23946 @*[local-name() = 'class'] = 'letters')
23948 @*[local-name() = 'block'] = 'Latin Extended-A'
23950 (@*[local-name() = 'block'] = 'General Punctuation' and
23951 (@*[local-name() = 'class'] = 'spaces' or
23952 @*[local-name() = 'class'] = 'dashes' or
23953 @*[local-name() = 'class'] = 'quotes' or
23954 @*[local-name() = 'class'] = 'bullets'
23957 @*[local-name() = 'name'] = 'HORIZONTAL ELLIPSIS' or
23958 @*[local-name() = 'name'] = 'WORD JOINER' or
23959 @*[local-name() = 'name'] = 'SERVICE MARK' or
23960 @*[local-name() = 'name'] = 'TRADE MARK SIGN' or
23961 @*[local-name() = 'name'] = 'ZERO WIDTH NO-BREAK SPACE'
23966 <refsection><info><title>Description</title></info>
23968 <para>If the value of the
23969 <parameter>man.charmap.use.subset</parameter> parameter is non-zero,
23970 and your DocBook source is not written in English (that
23971 is, if the <tag class="attribute">lang</tag> or <tag class="attribute">xml:lang</tag> attribute on the root element
23972 in your DocBook source or on the first <tag>refentry</tag>
23973 element in your source has a value other than
23974 <literal>en</literal>), then the character-map subset specified
23975 by the <parameter>man.charmap.subset.profile</parameter>
23976 parameter is used instead of the full roff character map.</para>
23978 <para>Otherwise, if the <tag class="attribute">lang</tag> or <tag class="attribute">xml:lang</tag> attribute on the root
23979 element in your DocBook
23980 source or on the first <tag>refentry</tag> element in your source
23981 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
23982 subset specified by the
23983 <parameter>man.charmap.subset.profile.english</parameter>
23984 parameter is used instead of
23985 <parameter>man.charmap.subset.profile</parameter>.</para>
23987 <para>The difference between the two subsets is that
23988 <parameter>man.charmap.subset.profile</parameter> provides
23989 mappings for characters in Western European languages that are
23990 not part of the Roman (English) alphabet (ASCII character set).</para>
23992 <para>The value of <parameter>man.charmap.subset.profile</parameter>
23993 is a string representing an XPath expression that matches attribute
23994 names and values for <tag namespace="http://docbook.sf.net/xmlns/unichar/1.0">output-character</tag>
23995 elements in the character map.</para>
23997 <para>The attributes supported in the <link xlink:href="http://docbook.sourceforge.net/snapshot/xsl/manpages/charmap.groff.xsl">standard roff character map included in the distribution</link> are:
24000 <term>character</term>
24002 <simpara>a raw Unicode character or numeric Unicode
24003 character-entity value (either in decimal or hex); all
24004 characters have this attribute</simpara>
24010 <simpara>a standard full/long ISO/Unicode character name (e.g.,
24011 "OHM SIGN"); all characters have this attribute</simpara>
24017 <simpara>a standard Unicode "block" name (e.g., "General
24018 Punctuation"); all characters have this attribute. For the full
24019 list of Unicode block names supported in the standard roff
24020 character map, see <xref linkend="BlocksAndClasses"/>.</simpara>
24026 <simpara>a class of characters (e.g., "spaces"). Not all
24027 characters have this attribute; currently, it is used only with
24028 certain characters within the "C1 Controls And Latin-1
24029 Supplement" and "General Punctuation" blocks. For details, see
24030 <xref linkend="BlocksAndClasses"/>.</simpara>
24034 <term>entity</term>
24036 <simpara>an ISO entity name (e.g., "ohm"); not all characters
24037 have this attribute, because not all characters have ISO entity
24038 names; for example, of the 800 or so characters in the standard
24039 roff character map included in the distribution, only around 300
24040 have ISO entity names.
24045 <term>string</term>
24047 <simpara>a string representing an roff/groff escape-code (with
24048 "@esc@" used in place of the backslash), or a simple ASCII
24049 string; all characters in the roff character map have this
24050 attribute</simpara>
24055 <para>The value of <parameter>man.charmap.subset.profile</parameter>
24056 is evaluated as an XPath expression at run-time to select a portion of
24057 the roff character map to use. You can tune the subset used by adding
24058 or removing parts. For example, if you need to use a wide range of
24059 mathematical operators in a document, and you want to have them
24060 converted into roff markup properly, you might add the following:
24062 <literallayout class="monospaced"> @*[local-name() = 'block'] ='MathematicalOperators' </literallayout>
24064 That will cause a additional set of around 67 additional "math"
24065 characters to be converted into roff markup. </para>
24068 <para>Depending on which XSLT engine you use, either the EXSLT
24069 <function>dyn:evaluate</function> extension function (for xsltproc or
24070 Xalan) or <function>saxon:evaluate</function> extension function (for
24071 Saxon) are used to dynamically evaluate the value of
24072 <parameter>man.charmap.subset.profile</parameter> at run-time. If you
24073 don't use xsltproc, Saxon, Xalan -- or some other XSLT engine that
24074 supports <function>dyn:evaluate</function> -- you must either set the
24075 value of the <parameter>man.charmap.use.subset</parameter> parameter
24076 to zero and process your documents using the full character map
24077 instead, or set the value of the
24078 <parameter>man.charmap.enabled</parameter> parameter to zero instead
24079 (so that character-map processing is disabled completely.</para>
24082 <para>An alternative to using
24083 <parameter>man.charmap.subset.profile</parameter> is to create your
24084 own custom character map, and set the value of
24085 <parameter>man.charmap.uri</parameter> to the URI/filename for
24086 that. If you use a custom character map, you will probably want to
24087 include in it just the characters you want to use, and so you will
24088 most likely also want to set the value of
24089 <parameter>man.charmap.use.subset</parameter> to zero.</para>
24090 <para>You can create a
24091 custom character map by making a copy of the <link xlink:href="http://docbook.sourceforge.net/snapshot/xsl/manpages/charmap.groff.xsl">standard roff character map</link> provided in the distribution, and
24092 then adding to, changing, and/or deleting from that.</para>
24095 <para>If you author your DocBook XML source in UTF-8 or UTF-16
24096 encoding and aren't sure what OSes or environments your man-page
24097 output might end up being viewed on, and not sure what version of
24098 nroff/groff those environments might have, you should be careful about
24099 what Unicode symbols and special characters you use in your source and
24100 what parts you add to the value of
24101 <parameter>man.charmap.subset.profile</parameter>.</para>
24102 <para>Many of the escape codes used are specific to groff and using
24103 them may not provide the expected output on an OS or environment that
24104 uses nroff instead of groff.</para>
24105 <para>On the other hand, if you intend for your man-page output to be
24106 viewed only on modern systems (for example, GNU/Linux systems, FreeBSD
24107 systems, or Cygwin environments) that have a good, up-to-date groff,
24108 then you can safely include a wide range of Unicode symbols and
24109 special characters in your UTF-8 or UTF-16 encoded DocBook XML source
24110 and add any of the supported Unicode block names to the value of
24111 <parameter>man.charmap.subset.profile</parameter>.</para>
24115 <para>For other details, see the documentation for the
24116 <parameter>man.charmap.use.subset</parameter> parameter.</para>
24118 <refsection id="BlocksAndClasses"><info><title>Supported Unicode block names and "class" values</title></info>
24121 <para>Below is the full list of Unicode block names and "class"
24122 values supported in the standard roff stylesheet provided in the
24123 distribution, along with a description of which codepoints from the
24124 Unicode range corresponding to that block name or block/class
24125 combination are supported.</para>
24129 <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)
24130 <itemizedlist><info><title>class values</title></info>
24133 <para>symbols</para>
24136 <para>letters</para>
24138 </itemizedlist></para>
24141 <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>
24144 <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>
24147 <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>
24150 <para><link xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&id=General%20Punctuation">General Punctuation</link> (x2000 to x206f, partial)
24151 <itemizedlist><info><title>class values</title></info>
24154 <para><link xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&start=8192&end=8203">spaces</link></para>
24157 <para><link xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&start=8208&end=8213">dashes</link></para>
24160 <para>quotes</para>
24163 <para>daggers</para>
24166 <para>bullets</para>
24169 <para>leaders</para>
24172 <para>primes</para>
24178 <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>
24181 <para><link xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&id=Currency%20Symbols">Currency Symbols</link> (x20a0 to x20b1)</para>
24184 <para><link xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&id=Letterlike%20Symbols">Letterlike Symbols</link> (x2100 to x214b)</para>
24187 <para><link xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&id=Number%20Forms">Number Forms</link> (x2150 to x218f)</para>
24190 <para><link xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&id=Arrows">Arrows</link> (x2190 to x21ff, partial)</para>
24193 <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>
24196 <para><link xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&id=Control%20Pictures">Control Pictures</link> (x2400 to x243f)</para>
24199 <para><link xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&id=Enclosed%20Alphanumerics">Enclosed Alphanumerics</link> (x2460 to x24ff)</para>
24202 <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>
24205 <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>
24208 <para><link xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&id=Dingbats">Dingbats</link> (x2700 to x27be, partial)</para>
24211 <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>
24218 <refentry version="5.0" id="man.charmap.subset.profile.english">
24220 <refentrytitle>man.charmap.subset.profile.english</refentrytitle>
24221 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
24224 <refname>man.charmap.subset.profile.english</refname>
24225 <refpurpose>Profile of character map subset</refpurpose>
24229 <programlisting id="man.charmap.subset.profile.english.frag">
24230 <xsl:param name="man.charmap.subset.profile.english">
24231 @*[local-name() = 'block'] = 'Miscellaneous Technical' or
24232 (@*[local-name() = 'block'] = 'C1 Controls And Latin-1 Supplement (Latin-1 Supplement)' and
24233 @*[local-name() = 'class'] = 'symbols')
24235 (@*[local-name() = 'block'] = 'General Punctuation' and
24236 (@*[local-name() = 'class'] = 'spaces' or
24237 @*[local-name() = 'class'] = 'dashes' or
24238 @*[local-name() = 'class'] = 'quotes' or
24239 @*[local-name() = 'class'] = 'bullets'
24242 @*[local-name() = 'name'] = 'HORIZONTAL ELLIPSIS' or
24243 @*[local-name() = 'name'] = 'WORD JOINER' or
24244 @*[local-name() = 'name'] = 'SERVICE MARK' or
24245 @*[local-name() = 'name'] = 'TRADE MARK SIGN' or
24246 @*[local-name() = 'name'] = 'ZERO WIDTH NO-BREAK SPACE'
24251 <refsection><info><title>Description</title></info>
24253 <para>If the value of the
24254 <parameter>man.charmap.use.subset</parameter> parameter is
24255 non-zero, and your DocBook source is written in English (that
24256 is, if its <tag class="attribute">lang</tag> or <tag class="attribute">xml:lang</tag> attribute on the root element
24257 in your DocBook source or on the first <tag>refentry</tag>
24258 element in your source has the value <literal>en</literal> or if
24259 it has no <tag class="attribute">lang</tag> or <tag class="attribute">xml:lang</tag> attribute), then the
24260 character-map subset specified by the
24261 <parameter>man.charmap.subset.profile.english</parameter>
24262 parameter is used instead of the full roff character map.</para>
24264 <para>Otherwise, if the <tag class="attribute">lang</tag> or <tag class="attribute">xml:lang</tag> attribute
24265 on the root element in your DocBook source or on the first
24266 <tag>refentry</tag> element in your source has a value other
24267 than <literal>en</literal>, then the character-map subset
24269 <parameter>man.charmap.subset.profile</parameter> parameter is
24271 <parameter>man.charmap.subset.profile.english</parameter>.</para>
24273 <para>The difference between the two subsets is that
24274 <parameter>man.charmap.subset.profile</parameter> provides
24275 mappings for characters in Western European languages that are
24276 not part of the Roman (English) alphabet (ASCII character set).</para>
24278 <para>The value of <parameter>man.charmap.subset.profile.english</parameter>
24279 is a string representing an XPath expression that matches attribute
24280 names and values for <tag namespace="http://docbook.sf.net/xmlns/unichar/1.0">output-character</tag> elements in the character map.</para>
24282 <para>For other details, see the documentation for the
24283 <parameter>man.charmap.subset.profile.english</parameter> and
24284 <parameter>man.charmap.use.subset</parameter> parameters.</para>
24289 <refentry version="5.0" id="man.string.subst.map.local.pre">
24291 <refentrytitle>man.string.subst.map.local.pre</refentrytitle>
24292 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
24295 <refname>man.string.subst.map.local.pre</refname>
24296 <refpurpose>Specifies “local” string substitutions</refpurpose>
24300 <programlisting id="man.string.subst.map.local.pre.frag">
24301 <xsl:param name="man.string.subst.map.local.pre"></xsl:param>
24305 <refsection><info><title>Description</title></info>
24307 <para>Use the <parameter>man.string.subst.map.local.pre</parameter>
24308 parameter to specify any “local” string substitutions to perform over
24309 the entire roff source for each man page <emphasis>before</emphasis>
24310 performing the string substitutions specified by the <parameter>man.string.subst.map</parameter> parameter.</para>
24312 <para>For details about the format of this parameter, see the
24313 documentation for the <parameter>man.string.subst.map</parameter>
24319 <refentry version="5.0" id="man.string.subst.map">
24321 <refentrytitle>man.string.subst.map</refentrytitle>
24322 <refmiscinfo class="other" otherclass="datatype">rtf</refmiscinfo>
24325 <refname>man.string.subst.map</refname>
24326 <refpurpose>Specifies a set of string substitutions</refpurpose>
24330 <programlisting id="man.string.subst.map.frag">
24331 <xsl:param name="man.string.subst.map">
24333 <!-- * remove no-break marker at beginning of line (stylesheet artifact) -->
24334 <ss:substitution oldstring="▒▀" newstring="▒"></ss:substitution>
24335 <!-- * replace U+2580 no-break marker (stylesheet-added) w/ no-break space -->
24336 <ss:substitution oldstring="▀" newstring="\ "></ss:substitution>
24338 <!-- ==================================================================== -->
24340 <!-- * squeeze multiple newlines before a roff request -->
24341 <ss:substitution oldstring="
24344 ."></ss:substitution>
24345 <!-- * remove any .sp instances that directly precede a .PP -->
24346 <ss:substitution oldstring=".sp
24347 .PP" newstring=".PP"></ss:substitution>
24348 <!-- * remove any .sp instances that directly follow a .PP -->
24349 <ss:substitution oldstring=".sp
24350 .sp" newstring=".sp"></ss:substitution>
24351 <!-- * squeeze multiple .sp instances into a single .sp-->
24352 <ss:substitution oldstring=".PP
24353 .sp" newstring=".PP"></ss:substitution>
24354 <!-- * squeeze multiple newlines after start of no-fill (verbatim) env. -->
24355 <ss:substitution oldstring=".nf
24358 "></ss:substitution>
24359 <!-- * squeeze multiple newlines after REstoring margin -->
24360 <ss:substitution oldstring=".RE
24363 "></ss:substitution>
24364 <!-- * U+2591 is a marker we add before and after every Parameter in -->
24365 <!-- * Funcprototype output -->
24366 <ss:substitution oldstring="░" newstring=" "></ss:substitution>
24367 <!-- * U+2592 is a marker we add for the newline before output of <sbr>; -->
24368 <ss:substitution oldstring="▒" newstring="
24369 "></ss:substitution>
24371 <!-- * Now deal with some other characters that are added by the -->
24372 <!-- * stylesheets during processing. -->
24374 <!-- * bullet -->
24375 <ss:substitution oldstring="•" newstring="\(bu"></ss:substitution>
24376 <!-- * left double quote -->
24377 <ss:substitution oldstring="“" newstring="\(lq"></ss:substitution>
24378 <!-- * right double quote -->
24379 <ss:substitution oldstring="”" newstring="\(rq"></ss:substitution>
24380 <!-- * left single quote -->
24381 <ss:substitution oldstring="‘" newstring="\(oq"></ss:substitution>
24382 <!-- * right single quote -->
24383 <ss:substitution oldstring="’" newstring="\(cq"></ss:substitution>
24384 <!-- * copyright sign -->
24385 <ss:substitution oldstring="©" newstring="\(co"></ss:substitution>
24386 <!-- * registered sign -->
24387 <ss:substitution oldstring="®" newstring="\(rg"></ss:substitution>
24388 <!-- * ...servicemark... -->
24389 <!-- * There is no groff equivalent for it. -->
24390 <ss:substitution oldstring="℠" newstring="(SM)"></ss:substitution>
24391 <!-- * ...trademark... -->
24392 <!-- * We don't do "\(tm" because for console output, -->
24393 <!-- * groff just renders that as "tm"; that is: -->
24395 <!-- * Product&#x2122; -> Producttm -->
24397 <!-- * So we just make it to "(TM)" instead; thus: -->
24399 <!-- * Product&#x2122; -> Product(TM) -->
24400 <ss:substitution oldstring="™" newstring="(TM)"></ss:substitution>
24406 <refsection><info><title>Description</title></info>
24408 <para>The <parameter>man.string.subst.map</parameter> parameter
24409 contains <link linkend="map">a map</link> that specifies a set of
24410 string substitutions to perform over the entire roff source for each
24411 man page, either just before generating final man-page output (that
24412 is, before writing man-page files to disk) or, if the value of the
24413 <parameter>man.charmap.enabled</parameter> parameter is non-zero,
24414 before applying the roff character map.</para>
24416 <para>You can use <parameter>man.string.subst.map</parameter> as a
24417 “lightweight” character map to perform “essential” substitutions --
24418 that is, substitutions that are <emphasis>always</emphasis> performed,
24419 even if the value of the <parameter>man.charmap.enabled</parameter>
24420 parameter is zero. For example, you can use it to replace quotation
24421 marks or other special characters that are generated by the DocBook
24422 XSL stylesheets for a particular locale setting (as opposed to those
24423 characters that are actually in source XML documents), or to replace
24424 any special characters that may be automatically generated by a
24425 particular customization of the DocBook XSL stylesheets.</para>
24428 <para>Do you not change value of the
24429 <parameter>man.string.subst.map</parameter> parameter unless you are
24430 sure what you are doing. First consider adding your
24431 string-substitution mappings to either or both of the following
24435 <term><parameter>man.string.subst.map.local.pre</parameter></term>
24436 <listitem><para>applied before
24437 <parameter>man.string.subst.map</parameter></para></listitem>
24440 <term><parameter>man.string.subst.map.local.post</parameter></term>
24441 <listitem><para>applied after
24442 <parameter>man.string.subst.map</parameter></para></listitem>
24445 By default, both of those parameters contain no
24446 string substitutions. They are intended as a means for you to
24447 specify your own local string-substitution mappings.</para>
24449 <para>If you remove any of default mappings from the value of the
24450 <parameter>man.string.subst.map</parameter> parameter, you are
24451 likely to end up with broken output. And be very careful about adding
24452 anything to it; it’s used for doing string substitution over the
24453 entire roff source of each man page – it causes target strings to be
24454 replaced in roff requests and escapes, not just in the visible
24455 contents of the page.</para>
24459 <refsection id="map">
24461 <title>Contents of the substitution map</title>
24463 <para>The string-substitution map contains one or more
24464 <tag>ss:substitution</tag> elements, each of which has two
24468 <term>oldstring</term>
24470 <simpara>string to replace</simpara>
24474 <term>newstring</term>
24476 <simpara>string with which to replace <tag class="attribute">oldstring</tag></simpara>
24480 It may also include XML comments (that is, delimited with
24481 "<literal><!--</literal>" and "<literal>--></literal>").
24488 <refentry version="5.0" id="man.string.subst.map.local.post">
24490 <refentrytitle>man.string.subst.map.local.post</refentrytitle>
24491 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
24494 <refname>man.string.subst.map.local.post</refname>
24495 <refpurpose>Specifies “local” string substitutions</refpurpose>
24499 <programlisting id="man.string.subst.map.local.post.frag">
24500 <xsl:param name="man.string.subst.map.local.post"></xsl:param>
24504 <refsection><info><title>Description</title></info>
24506 <para>Use the <parameter>man.string.subst.map.local.post</parameter>
24507 parameter to specify any “local” string substitutions to perform over
24508 the entire roff source for each man page <emphasis>after</emphasis>
24509 performing the string substitutions specified by the <parameter>man.string.subst.map</parameter> parameter.</para>
24511 <para>For details about the format of this parameter, see the
24512 documentation for the <parameter>man.string.subst.map</parameter>
24518 </reference><reference id="refmeta" xml:base="../manpages/param.xml">
24519 <title>Refentry metadata gathering</title>
24520 <refentry version="5.0" id="refentry.meta.get.quietly">
24522 <refentrytitle>refentry.meta.get.quietly</refentrytitle>
24523 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
24526 <refname>refentry.meta.get.quietly</refname>
24527 <refpurpose>Suppress notes and warnings when gathering refentry metadata?</refpurpose>
24531 <programlisting id="refentry.meta.get.quietly.frag">
24532 <xsl:param name="refentry.meta.get.quietly" select="0"></xsl:param>
24536 <refsection><info><title>Description</title></info>
24538 <para>If zero (the default), notes and warnings about “missing” markup
24539 are generated during gathering of refentry metadata. If non-zero, the
24540 metadata is gathered “quietly” -- that is, the notes and warnings are
24544 <para>If you are processing a large amount of <tag>refentry</tag>
24545 content, you may be able to speed up processing significantly by
24546 setting a non-zero value for
24547 <parameter>refentry.meta.get.quietly</parameter>.</para>
24553 <refentry version="5.0" id="refentry.date.profile">
24555 <refentrytitle>refentry.date.profile</refentrytitle>
24556 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
24559 <refname>refentry.date.profile</refname>
24560 <refpurpose>Specifies profile for refentry "date" data</refpurpose>
24564 <programlisting id="refentry.date.profile.frag">
24565 <xsl:param name="refentry.date.profile">
24566 (($info[//date])[last()]/date)[1]|
24567 (($info[//pubdate])[last()]/pubdate)[1]
24572 <refsection><info><title>Description</title></info>
24574 <para>The value of <parameter>refentry.date.profile</parameter> is a
24575 string representing an XPath expression. It is evaluated at run-time
24576 and used only if <parameter>refentry.date.profile.enabled</parameter>
24577 is non-zero. Otherwise, the <tag>refentry</tag> metadata-gathering
24578 logic "hard coded" into the stylesheets is used.</para>
24580 <para> The <literal>man(7)</literal> man page describes this content
24581 as "the date of the last revision". In man pages, it is the content
24582 that is usually displayed in the center footer.</para>
24587 <refentry version="5.0" id="refentry.date.profile.enabled">
24589 <refentrytitle>refentry.date.profile.enabled</refentrytitle>
24590 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
24593 <refname>refentry.date.profile.enabled</refname>
24594 <refpurpose>Enable refentry "date" profiling?</refpurpose>
24598 <programlisting id="refentry.date.profile.enabled.frag">
24599 <xsl:param name="refentry.date.profile.enabled">0</xsl:param></programlisting>
24602 <refsection><info><title>Description</title></info>
24604 <para>If the value of
24605 <parameter>refentry.date.profile.enabled</parameter> is non-zero, then
24606 during <tag>refentry</tag> metadata gathering, the info profile
24607 specified by the customizable
24608 <parameter>refentry.date.profile</parameter> parameter is used.</para>
24610 <para>If instead the value of
24611 <parameter>refentry.date.profile.enabled</parameter> is zero (the
24612 default), then "hard coded" logic within the DocBook XSL stylesheets
24613 is used for gathering <tag>refentry</tag> "date" data.</para>
24615 <para>If you find that the default <tag>refentry</tag>
24616 metadata-gathering behavior is causing incorrect "date" data to show
24617 up in your output, then consider setting a non-zero value for
24618 <parameter>refentry.date.profile.enabled</parameter> and adjusting the
24619 value of <parameter>refentry.date.profile</parameter> to cause correct
24620 data to be gathered. </para>
24622 <para>Note that the terms "source" and "date" have special meanings in
24623 this context. For details, see the documentation for the
24624 <parameter>refentry.date.profile</parameter> parameter.</para>
24629 <refentry version="5.0" id="refentry.manual.profile">
24631 <refentrytitle>refentry.manual.profile</refentrytitle>
24632 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
24635 <refname>refentry.manual.profile</refname>
24636 <refpurpose>Specifies profile for refentry "manual" data</refpurpose>
24640 <programlisting id="refentry.manual.profile.frag">
24641 <xsl:param name="refentry.manual.profile">
24642 (($info[//title])[last()]/title)[1]|
24648 <refsection><info><title>Description</title></info>
24650 <para>The value of <parameter>refentry.manual.profile</parameter> is
24651 a string representing an XPath expression. It is evaluated at
24652 run-time and used only if
24653 <parameter>refentry.manual.profile.enabled</parameter> is
24654 non-zero. Otherwise, the <tag>refentry</tag> metadata-gathering logic
24655 "hard coded" into the stylesheets is used.</para>
24657 <para>In man pages, this content is usually displayed in the middle of
24658 the header of the page. The <literal>man(7)</literal> man page
24659 describes this as "the title of the manual (e.g., <citetitle>Linux
24660 Programmer's Manual</citetitle>)". Here are some examples from
24661 existing man pages:
24664 <para><citetitle>dpkg utilities</citetitle>
24665 (<command>dpkg-name</command>)</para>
24668 <para><citetitle>User Contributed Perl Documentation</citetitle>
24669 (<command>GET</command>)</para>
24672 <para><citetitle>GNU Development Tools</citetitle>
24673 (<command>ld</command>)</para>
24676 <para><citetitle>Emperor Norton Utilities</citetitle>
24677 (<command>ddate</command>)</para>
24680 <para><citetitle>Debian GNU/Linux manual</citetitle>
24681 (<command>faked</command>)</para>
24684 <para><citetitle>GIMP Manual Pages</citetitle>
24685 (<command>gimp</command>)</para>
24688 <para><citetitle>KDOC Documentation System</citetitle>
24689 (<command>qt2kdoc</command>)</para>
24697 <refentry version="5.0" id="refentry.manual.profile.enabled">
24699 <refentrytitle>refentry.manual.profile.enabled</refentrytitle>
24700 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
24703 <refname>refentry.manual.profile.enabled</refname>
24704 <refpurpose>Enable refentry "manual" profiling?</refpurpose>
24708 <programlisting id="refentry.manual.profile.enabled.frag">
24709 <xsl:param name="refentry.manual.profile.enabled">0</xsl:param></programlisting>
24712 <refsection><info><title>Description</title></info>
24714 <para>If the value of
24715 <parameter>refentry.manual.profile.enabled</parameter> is
24716 non-zero, then during <tag>refentry</tag> metadata gathering, the info
24717 profile specified by the customizable
24718 <parameter>refentry.manual.profile</parameter> parameter is
24721 <para>If instead the value of
24722 <parameter>refentry.manual.profile.enabled</parameter> is zero (the
24723 default), then "hard coded" logic within the DocBook XSL stylesheets
24724 is used for gathering <tag>refentry</tag> "manual" data.</para>
24726 <para>If you find that the default <tag>refentry</tag>
24727 metadata-gathering behavior is causing incorrect "manual" data to show
24728 up in your output, then consider setting a non-zero value for
24729 <parameter>refentry.manual.profile.enabled</parameter> and adjusting
24730 the value of <parameter>refentry.manual.profile</parameter> to cause
24731 correct data to be gathered. </para>
24733 <para>Note that the term "manual" has a special meanings in this
24734 context. For details, see the documentation for the
24735 <parameter>refentry.manual.profile</parameter> parameter.</para>
24740 <refentry version="5.0" id="refentry.source.name.suppress">
24742 <refentrytitle>refentry.source.name.suppress</refentrytitle>
24743 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
24746 <refname>refentry.source.name.suppress</refname>
24747 <refpurpose>Suppress "name" part of refentry "source" contents?</refpurpose>
24751 <programlisting id="refentry.source.name.suppress.frag">
24752 <xsl:param name="refentry.source.name.suppress">0</xsl:param></programlisting>
24755 <refsection><info><title>Description</title></info>
24757 <para>If the value of
24758 <parameter>refentry.source.name.suppress</parameter> is non-zero, then
24759 during <tag>refentry</tag> metadata gathering, no "source name" data
24760 is added to the <tag>refentry</tag> "source" contents. Instead (unless
24761 <parameter>refentry.version.suppress</parameter> is also non-zero),
24762 only "version" data is added to the "source" contents.</para>
24764 <para>If you find that the <tag>refentry</tag> metadata gathering
24765 mechanism is causing unwanted "source name" data to show up in your
24766 output -- for example, in the footer (or possibly header) of a man
24767 page -- then you might consider setting a non-zero value for
24768 <parameter>refentry.source.name.suppress</parameter>.</para>
24770 <para>Note that the terms "source", "source name", and "version" have
24771 special meanings in this context. For details, see the documentation
24772 for the <parameter>refentry.source.name.profile</parameter>
24778 <refentry version="5.0" id="refentry.source.name.profile">
24780 <refentrytitle>refentry.source.name.profile</refentrytitle>
24781 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
24784 <refname>refentry.source.name.profile</refname>
24785 <refpurpose>Specifies profile for refentry "source name" data</refpurpose>
24789 <programlisting id="refentry.source.name.profile.frag">
24790 <xsl:param name="refentry.source.name.profile">
24791 (($info[//productname])[last()]/productname)[1]|
24792 (($info[//corpname])[last()]/corpname)[1]|
24793 (($info[//corpcredit])[last()]/corpcredit)[1]|
24794 (($info[//corpauthor])[last()]/corpauthor)[1]|
24795 (($info[//orgname])[last()]/orgname)[1]|
24796 (($info[//publishername])[last()]/publishername)[1]
24801 <refsection><info><title>Description</title></info>
24803 <para>The value of <parameter>refentry.source.name.profile</parameter>
24804 is a string representing an XPath expression. It is evaluated at
24805 run-time and used only if
24806 <parameter>refentry.source.name.profile.enabled</parameter> is
24807 non-zero. Otherwise, the <tag>refentry</tag> metadata-gathering logic
24808 "hard coded" into the stylesheets is used.</para>
24810 <para>A "source name" is one part of a (potentially) two-part
24811 <replaceable>Name</replaceable> <replaceable>Version</replaceable>
24812 "source" field. In man pages, it is usually displayed in the left
24813 footer of the page. It typically indicates the software system or
24814 product that the item documented in the man page belongs to. The
24815 <literal>man(7)</literal> man page describes it as "the source of
24816 the command", and provides the following examples:
24819 <para>For binaries, use something like: GNU, NET-2, SLS
24820 Distribution, MCC Distribution.</para>
24823 <para>For system calls, use the version of the kernel that you
24824 are currently looking at: Linux 0.99.11.</para>
24827 <para>For library calls, use the source of the function: GNU, BSD
24828 4.3, Linux DLL 4.4.1.</para>
24833 <para>In practice, there are many pages that simply have a Version
24834 number in the "source" field. So, it looks like what we have is a
24836 <replaceable>Name</replaceable> <replaceable>Version</replaceable>,
24842 <para>product name (e.g., BSD) or org. name (e.g., GNU)</para>
24846 <term>Version</term>
24848 <para>version number</para>
24852 Each part is optional. If the <replaceable>Name</replaceable> is a
24853 product name, then the <replaceable>Version</replaceable> is probably
24854 the version of the product. Or there may be no
24855 <replaceable>Name</replaceable>, in which case, if there is a
24856 <replaceable>Version</replaceable>, it is probably the version
24857 of the item itself, not the product it is part of. Or, if the
24858 <replaceable>Name</replaceable> is an organization name, then there
24859 probably will be no <replaceable>Version</replaceable>.</para>
24863 <refentry version="5.0" id="refentry.source.name.profile.enabled">
24865 <refentrytitle>refentry.source.name.profile.enabled</refentrytitle>
24866 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
24869 <refname>refentry.source.name.profile.enabled</refname>
24870 <refpurpose>Enable refentry "source name" profiling?</refpurpose>
24874 <programlisting id="refentry.source.name.profile.enabled.frag">
24875 <xsl:param name="refentry.source.name.profile.enabled">0</xsl:param></programlisting>
24878 <refsection><info><title>Description</title></info>
24880 <para>If the value of
24881 <parameter>refentry.source.name.profile.enabled</parameter> is
24882 non-zero, then during <tag>refentry</tag> metadata gathering, the info
24883 profile specified by the customizable
24884 <parameter>refentry.source.name.profile</parameter> parameter is
24887 <para>If instead the value of
24888 <parameter>refentry.source.name.profile.enabled</parameter> is zero (the
24889 default), then "hard coded" logic within the DocBook XSL stylesheets
24890 is used for gathering <tag>refentry</tag> "source name" data.</para>
24892 <para>If you find that the default <tag>refentry</tag>
24893 metadata-gathering behavior is causing incorrect "source name" data to
24894 show up in your output, then consider setting a non-zero value for
24895 <parameter>refentry.source.name.profile.enabled</parameter> and
24896 adjusting the value of
24897 <parameter>refentry.source.name.profile</parameter> to cause correct
24898 data to be gathered. </para>
24900 <para>Note that the terms "source" and "source name" have special
24901 meanings in this context. For details, see the documentation for the
24902 <parameter>refentry.source.name.profile</parameter> parameter.</para>
24907 <refentry version="5.0" id="refentry.version.suppress">
24909 <refentrytitle>refentry.version.suppress</refentrytitle>
24910 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
24913 <refname>refentry.version.suppress</refname>
24914 <refpurpose>Suppress "version" part of refentry "source" contents?</refpurpose>
24918 <programlisting id="refentry.version.suppress.frag">
24919 <xsl:param name="refentry.version.suppress">0</xsl:param></programlisting>
24922 <refsection><info><title>Description</title></info>
24924 <para>If the value of <parameter>refentry.version.suppress</parameter>
24925 is non-zero, then during <tag>refentry</tag> metadata gathering, no
24926 "version" data is added to the <tag>refentry</tag> "source"
24927 contents. Instead (unless
24928 <parameter>refentry.source.name.suppress</parameter> is also
24929 non-zero), only "source name" data is added to the "source"
24932 <para>If you find that the <tag>refentry</tag> metadata gathering
24933 mechanism is causing unwanted "version" data to show up in your output
24934 -- for example, in the footer (or possibly header) of a man page --
24935 then you might consider setting a non-zero value for
24936 <parameter>refentry.version.suppress</parameter>.</para>
24938 <para>Note that the terms "source", "source name", and "version" have
24939 special meanings in this context. For details, see the documentation
24940 for the <parameter>refentry.source.name.profile</parameter>
24946 <refentry version="5.0" id="refentry.version.profile">
24948 <refentrytitle>refentry.version.profile</refentrytitle>
24949 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
24952 <refname>refentry.version.profile</refname>
24953 <refpurpose>Specifies profile for refentry "version" data</refpurpose>
24957 <programlisting id="refentry.version.profile.frag">
24958 <xsl:param name="refentry.version.profile">
24959 (($info[//productnumber])[last()]/productnumber)[1]|
24960 (($info[//edition])[last()]/edition)[1]|
24961 (($info[//releaseinfo])[last()]/releaseinfo)[1]
24966 <refsection><info><title>Description</title></info>
24968 <para>The value of <parameter>refentry.version.profile</parameter> is
24969 a string representing an XPath expression. It is evaluated at
24970 run-time and used only if
24971 <parameter>refentry.version.profile.enabled</parameter> is
24972 non-zero. Otherwise, the <tag>refentry</tag> metadata-gathering logic
24973 "hard coded" into the stylesheets is used.</para>
24975 <para>A "source.name" is one part of a (potentially) two-part
24976 <replaceable>Name</replaceable> <replaceable>Version</replaceable>
24977 "source" field. For more details, see the documentation for the
24978 <parameter>refentry.source.name.profile</parameter> parameter.</para>
24983 <refentry version="5.0" id="refentry.version.profile.enabled">
24985 <refentrytitle>refentry.version.profile.enabled</refentrytitle>
24986 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
24989 <refname>refentry.version.profile.enabled</refname>
24990 <refpurpose>Enable refentry "version" profiling?</refpurpose>
24994 <programlisting id="refentry.version.profile.enabled.frag">
24995 <xsl:param name="refentry.version.profile.enabled">0</xsl:param></programlisting>
24998 <refsection><info><title>Description</title></info>
25000 <para>If the value of
25001 <parameter>refentry.version.profile.enabled</parameter> is
25002 non-zero, then during <tag>refentry</tag> metadata gathering, the info
25003 profile specified by the customizable
25004 <parameter>refentry.version.profile</parameter> parameter is
25007 <para>If instead the value of
25008 <parameter>refentry.version.profile.enabled</parameter> is zero (the
25009 default), then "hard coded" logic within the DocBook XSL stylesheets
25010 is used for gathering <tag>refentry</tag> "version" data.</para>
25012 <para>If you find that the default <tag>refentry</tag>
25013 metadata-gathering behavior is causing incorrect "version" data to show
25014 up in your output, then consider setting a non-zero value for
25015 <parameter>refentry.version.profile.enabled</parameter> and adjusting
25016 the value of <parameter>refentry.version.profile</parameter> to cause
25017 correct data to be gathered. </para>
25019 <para>Note that the terms "source" and "version" have special
25020 meanings in this context. For details, see the documentation for the
25021 <parameter>refentry.version.profile</parameter> parameter.</para>
25026 <refentry version="5.0" id="refentry.manual.fallback.profile">
25028 <refentrytitle>refentry.manual.fallback.profile</refentrytitle>
25029 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
25032 <refname>refentry.manual.fallback.profile</refname>
25033 <refpurpose>Specifies profile of "fallback" for refentry "manual" data</refpurpose>
25037 <programlisting id="refentry.manual.fallback.profile.frag">
25038 <xsl:param name="refentry.manual.fallback.profile">
25039 refmeta/refmiscinfo[not(@class = 'date')][1]/node()</xsl:param>
25043 <refsection><info><title>Description</title></info>
25046 <parameter>refentry.manual.fallback.profile</parameter> is a string
25047 representing an XPath expression. It is evaluated at run-time and
25048 used only if no "manual" data can be found by other means (that is,
25049 either using the <tag>refentry</tag> metadata-gathering logic "hard
25050 coded" in the stylesheets, or the value of
25051 <parameter>refentry.manual.profile</parameter>, if it is
25055 <para>Depending on which XSLT engine you run, either the EXSLT
25056 <function>dyn:evaluate</function> extension function (for xsltproc or
25057 Xalan) or <function>saxon:evaluate</function> extension function (for
25058 Saxon) are used to dynamically evaluate the value of
25059 <parameter>refentry.manual.fallback.profile</parameter> at
25060 run-time. If you don't use xsltproc, Saxon, Xalan -- or some other
25061 XSLT engine that supports <function>dyn:evaluate</function> -- you
25062 must manually disable fallback processing by setting an empty value
25063 for the <parameter>refentry.manual.fallback.profile</parameter>
25070 <refentry version="5.0" id="refentry.source.fallback.profile">
25072 <refentrytitle>refentry.source.fallback.profile</refentrytitle>
25073 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
25076 <refname>refentry.source.fallback.profile</refname>
25077 <refpurpose>Specifies profile of "fallback" for refentry "source" data</refpurpose>
25081 <programlisting id="refentry.source.fallback.profile.frag">
25082 <xsl:param name="refentry.source.fallback.profile">
25083 refmeta/refmiscinfo[not(@class = 'date')][1]/node()</xsl:param>
25087 <refsection><info><title>Description</title></info>
25090 <parameter>refentry.source.fallback.profile</parameter> is a string
25091 representing an XPath expression. It is evaluated at run-time and used
25092 only if no "source" data can be found by other means (that is, either
25093 using the <tag>refentry</tag> metadata-gathering logic "hard coded" in
25094 the stylesheets, or the value of the
25095 <parameter>refentry.source.name.profile</parameter> and
25096 <parameter>refentry.version.profile</parameter> parameters, if those
25097 are enabled).</para>
25100 <para>Depending on which XSLT engine you run, either the EXSLT
25101 <function>dyn:evaluate</function> extension function (for xsltproc or
25102 Xalan) or <function>saxon:evaluate</function> extension function (for
25103 Saxon) are used to dynamically evaluate the value of
25104 <parameter>refentry.source.fallback.profile</parameter> at
25105 run-time. If you don't use xsltproc, Saxon, Xalan -- or some other
25106 XSLT engine that supports <function>dyn:evaluate</function> -- you
25107 must manually disable fallback processing by setting an empty value
25108 for the <parameter>refentry.source.fallback.profile</parameter>
25115 </reference><reference id="th" xml:base="../manpages/param.xml">
25116 <title>Page header/footer</title>
25117 <refentry version="5.0" id="man.th.extra1.suppress">
25119 <refentrytitle>man.th.extra1.suppress</refentrytitle>
25120 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
25123 <refname>man.th.extra1.suppress</refname>
25124 <refpurpose>Suppress extra1 part of header/footer?</refpurpose>
25128 <programlisting id="man.th.extra1.suppress.frag">
25129 <xsl:param name="man.th.extra1.suppress">0</xsl:param></programlisting>
25132 <refsection><info><title>Description</title></info>
25134 <para>If the value of <parameter>man.th.extra1.suppress</parameter> is
25135 non-zero, then the <literal>extra1</literal> part of the
25136 <literal>.TH</literal> title line header/footer is suppressed.</para>
25138 <para>The content of the <literal>extra1</literal> field is almost
25139 always displayed in the center footer of the page and is, universally,
25145 <refentry version="5.0" id="man.th.extra2.suppress">
25147 <refentrytitle>man.th.extra2.suppress</refentrytitle>
25148 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
25151 <refname>man.th.extra2.suppress</refname>
25152 <refpurpose>Suppress extra2 part of header/footer?</refpurpose>
25156 <programlisting id="man.th.extra2.suppress.frag">
25157 <xsl:param name="man.th.extra2.suppress">0</xsl:param></programlisting>
25160 <refsection><info><title>Description</title></info>
25162 <para>If the value of <parameter>man.th.extra2.suppress</parameter> is
25163 non-zero, then the <literal>extra2</literal> part of the
25164 <literal>.TH</literal> title line header/footer is suppressed.</para>
25166 <para>The content of the <literal>extra2</literal> field is usually
25167 displayed in the left footer of the page and is typically "source"
25168 data, often in the form
25169 <replaceable>Name</replaceable> <replaceable>Version</replaceable>;
25170 for example, "GTK+ 1.2" (from the <literal>gtk-options(7)</literal>
25174 <para>You can use the
25175 <parameter>refentry.source.name.suppress</parameter> and
25176 <parameter>refentry.version.suppress</parameter> parameters to
25177 independently suppress the <replaceable>Name</replaceable> and
25178 <replaceable>Version</replaceable> parts of the
25179 <literal>extra2</literal> field.</para>
25185 <refentry version="5.0" id="man.th.extra3.suppress">
25187 <refentrytitle>man.th.extra3.suppress</refentrytitle>
25188 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
25191 <refname>man.th.extra3.suppress</refname>
25192 <refpurpose>Suppress extra3 part of header/footer?</refpurpose>
25196 <programlisting id="man.th.extra3.suppress.frag">
25197 <xsl:param name="man.th.extra3.suppress">0</xsl:param></programlisting>
25200 <refsection><info><title>Description</title></info>
25202 <para>If the value of <parameter>man.th.extra3.suppress</parameter> is
25203 non-zero, then the <literal>extra3</literal> part of the
25204 <literal>.TH</literal> title line header/footer is
25207 <para>The content of the <literal>extra3</literal> field is usually
25208 displayed in the middle header of the page and is typically a "manual
25209 name"; for example, "GTK+ User's Manual" (from the
25210 <literal>gtk-options(7)</literal> man page).</para>
25215 <refentry version="5.0" id="man.th.title.max.length">
25217 <refentrytitle>man.th.title.max.length</refentrytitle>
25218 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
25221 <refname>man.th.title.max.length</refname>
25222 <refpurpose>Maximum length of title in header/footer</refpurpose>
25226 <programlisting id="man.th.title.max.length.frag">
25227 <xsl:param name="man.th.title.max.length">20</xsl:param>
25231 <refsection><info><title>Description</title></info>
25233 <para>Specifies the maximum permitted length of the title part of the
25234 man-page <literal>.TH</literal> title line header/footer. If the title
25235 exceeds the maxiumum specified, it is truncated down to the maximum
25236 permitted length.</para>
25238 <refsection><info><title>Details</title></info>
25241 <para>Every man page generated using the DocBook stylesheets has a
25242 title line, specified using the <literal>TH</literal> roff
25243 macro. Within that title line, there is always, at a minimum, a title,
25244 followed by a section value (representing a man "section" -- usually
25245 just a number).</para>
25247 <para>The title and section are displayed, together, in the visible
25248 header of each page. Where in the header they are displayed depends on
25249 OS the man page is viewed on, and on what version of nroff/groff/man
25250 is used for viewing the page. But, at a minimum and across all
25251 systems, the title and section are displayed on the right-hand column
25252 of the header. On many systems -- those with a modern groff, including
25253 Linux systems -- they are displayed twice: both in the left and right
25254 columns of the header.</para>
25256 <para>So if the length of the title exceeds a certain percentage of
25257 the column width in which the page is viewed, the left and right
25258 titles can end up overlapping, making them unreadable, or breaking to
25259 another line, which doesn't look particularly good.</para>
25261 <para>So the stylesheets provide the
25262 <parameter>man.th.title.max.length</parameter> parameter as a means
25263 for truncating titles that exceed the maximum length that can be
25264 viewing properly in a page header.</para>
25266 <para>The default value is reasonable but somewhat arbitrary. If you
25267 have pages with long titles, you may want to experiment with changing
25268 the value in order to achieve the correct aesthetic results.</para>
25274 <refentry version="5.0" id="man.th.extra2.max.length">
25276 <refentrytitle>man.th.extra2.max.length</refentrytitle>
25277 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
25280 <refname>man.th.extra2.max.length</refname>
25281 <refpurpose>Maximum length of extra2 in header/footer</refpurpose>
25285 <programlisting id="man.th.extra2.max.length.frag">
25286 <xsl:param name="man.th.extra2.max.length">30</xsl:param>
25290 <refsection><info><title>Description</title></info>
25292 <para>Specifies the maximum permitted length of the
25293 <literal>extra2</literal> part of the man-page part of the
25294 <literal>.TH</literal> title line header/footer. If the
25295 <literal>extra2</literal> content exceeds the maxiumum specified, it
25296 is truncated down to the maximum permitted length.</para>
25298 <para>The content of the <literal>extra2</literal> field is usually
25299 displayed in the left footer of the page and is typically "source"
25300 data indicating the software system or product that the item
25301 documented in the man page belongs to, often in the form
25302 <replaceable>Name</replaceable> <replaceable>Version</replaceable>;
25303 for example, "GTK+ 1.2" (from the <literal>gtk-options(7)</literal>
25306 <para>The default value for this parameter is reasonable but somewhat
25307 arbitrary. If you are processing pages with long "source" information,
25308 you may want to experiment with changing the value in order to achieve
25309 the correct aesthetic results.</para>
25313 <refentry version="5.0" id="man.th.extra3.max.length">
25315 <refentrytitle>man.th.extra3.max.length</refentrytitle>
25316 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
25319 <refname>man.th.extra3.max.length</refname>
25320 <refpurpose>Maximum length of extra3 in header/footer</refpurpose>
25324 <programlisting id="man.th.extra3.max.length.frag">
25325 <xsl:param name="man.th.extra3.max.length">30</xsl:param>
25329 <refsection><info><title>Description</title></info>
25331 <para>Specifies the maximum permitted length of the
25332 <literal>extra3</literal> part of the man-page <literal>.TH</literal>
25333 title line header/footer. If the <literal>extra3</literal> content
25334 exceeds the maxiumum specified, it is truncated down to the maximum
25335 permitted length.</para>
25337 <para>The content of the <literal>extra3</literal> field is usually
25338 displayed in the middle header of the page and is typically a "manual
25339 name"; for example, "GTK+ User's Manual" (from the
25340 <literal>gtk-options(7)</literal> man page).</para>
25342 <para>The default value for this parameter is reasonable but somewhat
25343 arbitrary. If you are processing pages with long "manual names" -- or
25344 especially if you are processing pages that have both long "title"
25345 parts (command/function, etc. names) <emphasis>and</emphasis> long
25346 manual names -- you may want to experiment with changing the value in
25347 order to achieve the correct aesthetic results.</para>
25351 </reference><reference id="output" xml:base="../manpages/param.xml">
25352 <title>Output</title>
25353 <refentry version="5.0" id="man.output.manifest.enabled">
25355 <refentrytitle>man.output.manifest.enabled</refentrytitle>
25356 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
25359 <refname>man.output.manifest.enabled</refname>
25360 <refpurpose>Generate a manifest file?</refpurpose>
25364 <programlisting id="man.output.manifest.enabled.frag"><xsl:param name="man.output.manifest.enabled" select="0"></xsl:param></programlisting>
25367 <refsection><info><title>Description</title></info>
25369 <para>If non-zero, a list of filenames for man pages generated by
25370 the stylesheet transformation is written to the file named by the
25371 <parameter>man.output.manifest.filename</parameter> parameter.</para>
25376 <refentry version="5.0" id="man.output.manifest.filename">
25378 <refentrytitle>man.output.manifest.filename</refentrytitle>
25379 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
25382 <refname>man.output.manifest.filename</refname>
25383 <refpurpose>Name of manifest file</refpurpose>
25387 <programlisting id="man.output.manifest.filename.frag"><xsl:param name="man.output.manifest.filename">MAN.MANIFEST</xsl:param></programlisting>
25390 <refsection><info><title>Description</title></info>
25392 <para>The <parameter>man.output.manifest.filename</parameter> parameter
25393 specifies the name of the file to which the manpages manifest file
25394 is written (if the value of the
25395 <parameter>man.output.manifest.enabled</parameter> parameter is
25401 <refentry version="5.0" id="man.output.in.separate.dir">
25403 <refentrytitle>man.output.in.separate.dir</refentrytitle>
25404 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
25407 <refname>man.output.in.separate.dir</refname>
25408 <refpurpose>Output man-page files in separate output directory?</refpurpose>
25412 <programlisting id="man.output.in.separate.dir.frag">
25413 <xsl:param name="man.output.in.separate.dir" select="0"></xsl:param>
25417 <refsection><info><title>Description</title></info>
25419 <para>If the value of <literal>man.output.in.separate.dir</literal>
25420 parameter is non-zero, man-page files are output in a separate
25421 directory, specified by the <parameter>man.output.base.dir</parameter>
25422 parameter; otherwise, if the value of
25423 <literal>man.output.in.separate.dir</literal> is zero, man-page files
25424 are not output in a separate directory.</para>
25429 <refentry version="5.0" id="man.output.lang.in.name.enabled">
25431 <refentrytitle>man.output.lang.in.name.enabled</refentrytitle>
25432 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
25435 <refname>man.output.lang.in.name.enabled</refname>
25436 <refpurpose>Include $LANG value in man-page filename/pathname?</refpurpose>
25440 <programlisting id="man.output.lang.in.name.enabled.frag">
25441 <xsl:param name="man.output.lang.in.name.enabled" select="0"></xsl:param>
25445 <refsection><info><title>Description</title></info>
25447 <para>The <parameter>man.output.lang.in.name.enabled</parameter>
25448 parameter specifies whether a <literal>$lang</literal> value is
25449 included in man-page filenames and pathnames.</para>
25451 <para>If the value of
25452 <parameter>man.output.lang.in.name.enabled</parameter> is non-zero,
25453 man-page files are output with the <literal>$lang</literal> value
25454 included in their filenames or pathnames as follows;
25458 <para>if <parameter>man.output.subdirs.enabled</parameter> is
25459 non-zero, each file is output to, e.g., a
25460 <filename>man/<replaceable>$lang</replaceable>/man8/foo.8</filename>
25464 <para>if <parameter>man.output.subdirs.enabled</parameter> is
25465 zero, each file is output with a
25466 <literal>foo.<replaceable>$lang</replaceable>.8</literal>
25475 <refentry version="5.0" id="man.output.base.dir">
25477 <refentrytitle>man.output.base.dir</refentrytitle>
25478 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
25481 <refname>man.output.base.dir</refname>
25482 <refpurpose>Specifies separate output directory</refpurpose>
25486 <programlisting id="man.output.base.dir.frag"><xsl:param name="man.output.base.dir">man/</xsl:param></programlisting>
25489 <refsection><info><title>Description</title></info>
25491 <para>The <parameter>man.output.base.dir</parameter> parameter
25492 specifies the base directory into which man-page files are output. The
25493 <parameter>man.output.subdirs.enabled</parameter> parameter controls
25494 whether the files are output in subdirectories within the base
25498 <para>The values of the <parameter>man.output.base.dir</parameter>
25499 and <parameter>man.output.subdirs.enabled</parameter> parameters are
25500 used only if the value of
25501 <parameter>man.output.in.separate.dir</parameter> parameter is
25502 non-zero. If the value of the
25503 <parameter>man.output.in.separate.dir</parameter> is zero, man-page
25504 files are not output in a separate directory.</para>
25510 <refentry version="5.0" id="man.output.subdirs.enabled">
25512 <refentrytitle>man.output.subdirs.enabled</refentrytitle>
25513 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
25516 <refname>man.output.subdirs.enabled</refname>
25517 <refpurpose>Output man-page files in subdirectories within base output directory?</refpurpose>
25521 <programlisting id="man.output.subdirs.enabled.frag">
25522 <xsl:param name="man.output.subdirs.enabled" select="1"></xsl:param>
25526 <refsection><info><title>Description</title></info>
25528 <para>The <parameter>man.output.subdirs.enabled</parameter> parameter
25529 controls whether man-pages files are output in subdirectories within
25530 the base directory specified by the directory specified by the
25531 <parameter>man.output.base.dir</parameter> parameter.</para>
25534 <para>The values of the <parameter>man.output.base.dir</parameter>
25535 and <parameter>man.output.subdirs.enabled</parameter> parameters are
25536 used only if the value of
25537 <parameter>man.output.in.separate.dir</parameter> parameter is
25538 non-zero. If the value of the
25539 <parameter>man.output.in.separate.dir</parameter> is zero, man-page
25540 files are not output in a separate directory.</para>
25546 <refentry version="5.0" id="man.output.quietly">
25548 <refentrytitle>man.output.quietly</refentrytitle>
25549 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
25552 <refname>man.output.quietly</refname>
25553 <refpurpose>Suppress filename messages emitted when generating output?</refpurpose>
25557 <programlisting id="man.output.quietly.frag">
25558 <xsl:param name="man.output.quietly" select="0"></xsl:param>
25562 <refsection><info><title>Description</title></info>
25564 <para>If zero (the default), for each man-page file created, a message
25565 with the name of the file is emitted. If non-zero, the files are
25566 output "quietly" -- that is, the filename messages are
25570 <para>If you are processing a large amount of <tag>refentry</tag>
25571 content, you may be able to speed up processing significantly by
25572 setting a non-zero value for
25573 <parameter>man.output.quietly</parameter>.</para>
25579 <refentry version="5.0" id="man.output.encoding">
25581 <refentrytitle>man.output.encoding</refentrytitle>
25582 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
25585 <refname>man.output.encoding</refname>
25586 <refpurpose>Encoding used for man-page output</refpurpose>
25590 <programlisting id="man.output.encoding.frag">
25591 <xsl:param name="man.output.encoding">UTF-8</xsl:param>
25595 <refsection><info><title>Description</title></info>
25597 <para>This parameter specifies the encoding to use for files generated
25598 by the manpages stylesheet. Not all processors support specification
25599 of this parameter.</para>
25602 <para>If the value of the <parameter>man.charmap.enabled</parameter>
25603 parameter is non-zero (the default), keeping the
25604 <parameter>man.output.encoding</parameter> parameter at its default
25605 value (<literal>UTF-8</literal>) or setting it to
25606 <literal>UTF-16</literal> <emphasis role="bold">does not cause your
25607 man pages to be output in raw UTF-8 or UTF-16</emphasis> -- because
25608 any Unicode characters for which matches are found in the enabled
25609 character map will be replaced with roff escape sequences before the
25610 final man-page files are generated.</para>
25612 <para>So if you want to generate "real" UTF-8 man pages, without any
25613 character substitution being performed on your content, you need to
25614 set <parameter>man.charmap.enabled</parameter> to zero (which will
25615 completely disable character-map processing). </para>
25617 <para>You may also need to set
25618 <parameter>man.charmap.enabled</parameter> to zero if you want to
25619 output man pages in an encoding other than <literal>UTF-8</literal>
25620 or <literal>UTF-16</literal>. Character-map processing is based on
25621 Unicode character values and may not work with other output
25628 <refentry version="5.0" id="man.output.better.ps.enabled">
25630 <refentrytitle>man.output.better.ps.enabled</refentrytitle>
25631 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
25634 <refname>man.output.better.ps.enabled</refname>
25635 <refpurpose>Enable enhanced print/PostScript output?</refpurpose>
25638 <programlisting id="man.output.better.ps.enabled.frag">
25639 <xsl:param name="man.output.better.ps.enabled">0</xsl:param>
25642 <refsection><info><title>Description</title></info>
25644 <para>If the value of the
25645 <parameter>man.output.better.ps.enabled</parameter> parameter is
25646 non-zero, certain markup is embedded in each generated man page
25647 such that PostScript output from the <command>man -Tps</command>
25648 command for that page will include a number of enhancements
25649 designed to improve the quality of that output.</para>
25651 <para>If <parameter>man.output.better.ps.enabled</parameter> is
25652 zero (the default), no such markup is embedded in generated man
25653 pages, and no enhancements are included in the PostScript
25654 output generated from those man pages by the <command>man
25655 -Tps</command> command.</para>
25658 <para>The enhancements provided by this parameter rely on
25659 features that are specific to groff (GNU troff) and that are
25660 not part of “classic” AT&T troff or any of its
25661 derivatives. Therefore, any man pages you generate with this
25662 parameter enabled will be readable only on systems on which
25663 the groff (GNU troff) program is installed, such as GNU/Linux
25664 systems. The pages <emphasis role="bold">will not not be
25665 readable on systems on with the classic troff (AT&T
25666 troff) command is installed</emphasis>.</para>
25669 <para>The value of this parameter only affects PostScript output
25670 generated from the <command>man</command> command. It has no
25671 effect on output generated using the FO backend.</para>
25674 <para>You can generate PostScript output for any man page by
25675 running the following command:</para>
25676 <programlisting> man <replaceable>FOO</replaceable> -Tps > <replaceable>FOO</replaceable>.ps</programlisting>
25677 <para>You can then generate PDF output by running the following
25679 <programlisting> ps2pdf <replaceable>FOO</replaceable>.ps</programlisting>
25685 </reference><reference id="other" xml:base="../manpages/param.xml">
25686 <title>Other</title>
25687 <refentry version="5.0" id="man.table.footnotes.divider">
25689 <refentrytitle>man.table.footnotes.divider</refentrytitle>
25690 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
25693 <refname>man.table.footnotes.divider</refname>
25694 <refpurpose>Specifies divider string that appears before table footnotes</refpurpose>
25698 <programlisting id="man.table.footnotes.divider.frag">
25699 <xsl:param name="man.table.footnotes.divider">----</xsl:param>
25703 <refsection><info><title>Description</title></info>
25705 <para>In each table that contains footenotes, the string specified by
25706 the <parameter>man.table.footnotes.divider</parameter> parameter is
25707 output before the list of footnotes for the table.</para>
25712 <refentry version="5.0" id="man.subheading.divider.enabled">
25714 <refentrytitle>man.subheading.divider.enabled</refentrytitle>
25715 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
25718 <refname>man.subheading.divider.enabled</refname>
25719 <refpurpose>Add divider comment to roff source before/after subheadings?</refpurpose>
25723 <programlisting id="man.subheading.divider.enabled.frag">
25724 <xsl:param name="man.subheading.divider.enabled">0</xsl:param>
25728 <refsection><info><title>Description</title></info>
25730 <para>If the value of the
25731 <parameter>man.subheading.divider.enabled</parameter> parameter is
25732 non-zero, the contents of the
25733 <parameter>man.subheading.divider</parameter> parameter are used to
25734 add a "divider" before and after subheadings in the roff
25735 output. <emphasis role="bold">The divider is not visisble in the
25736 rendered man page</emphasis>; it is added as a comment, in the source,
25737 simply for the purpose of increasing reability of the source.</para>
25739 <para>If <parameter>man.subheading.divider.enabled</parameter> is zero
25740 (the default), the subheading divider is suppressed.</para>
25745 <refentry version="5.0" id="man.subheading.divider">
25747 <refentrytitle>man.subheading.divider</refentrytitle>
25748 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
25751 <refname>man.subheading.divider</refname>
25752 <refpurpose>Specifies string to use as divider comment before/after subheadings</refpurpose>
25756 <programlisting id="man.subheading.divider.frag">
25757 <xsl:param name="man.subheading.divider">========================================================================</xsl:param>
25761 <refsection><info><title>Description</title></info>
25763 <para>If the value of the
25764 <parameter>man.subheading.divider.enabled</parameter> parameter is
25765 non-zero, the contents of the
25766 <parameter>man.subheading.divider</parameter> parameter are used to
25767 add a "divider" before and after subheadings in the roff
25768 output. <emphasis role="bold">The divider is not visisble in the
25769 rendered man page</emphasis>; it is added as a comment, in the source,
25770 simply for the purpose of increasing reability of the source.</para>
25772 <para>If <parameter>man.subheading.divider.enabled</parameter> is zero
25773 (the default), the subheading divider is suppressed.</para>
25780 <part id="roundtrip">
25781 <?dbhtml dir="roundtrip"?>
25782 <?dbhtml filename="index.html"?>
25783 <title xml:base="../roundtrip/param.xml">Roundtrip Parameter Reference</title>
25784 <partintro id="roundtripintro">
25786 <para xml:base="../roundtrip/param.xml">This is reference documentation for all user-configurable
25787 parameters in the DocBook “Roundtrip” Stylesheets (for
25788 transforming DocBook to WordML, OpenDocument, and Apple Pages,
25789 and for converting from those formats back to DocBook).</para>
25794 <refentry version="5.0" id="wordml.template" xml:base="../roundtrip/param.xml">
25796 <refentrytitle>wordml.template</refentrytitle>
25797 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
25800 <refname>wordml.template</refname>
25801 <refpurpose>Specify the template WordML document</refpurpose>
25805 <programlisting id="wordml.template.frag">
25806 <xsl:param name="wordml.template"></xsl:param>
25810 <refsection><info><title>Description</title></info>
25812 <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>
25814 <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>
25819 <refentry version="5.0" id="pages.template" xml:base="../roundtrip/param.xml">
25821 <refentrytitle>pages.template</refentrytitle>
25822 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
25825 <refname>pages.template</refname>
25826 <refpurpose>Specify the template Pages document</refpurpose>
25830 <programlisting id="pages.template.frag">
25831 <xsl:param name="pages.template"></xsl:param>
25835 <refsection><info><title>Description</title></info>
25837 <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>
25839 <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>
25846 <part id="slides"><title>Slides Parameter Reference</title>
25847 <?dbhtml dir="slides"?>
25848 <?dbhtml filename="index.html"?>
25849 <partintro id="slidesintro">
25850 <para>This is reference documentation for all
25851 user-configurable parameters in the DocBook XSL Slides
25852 stylesheets (for generating HTML and PDF slide
25853 presentations).</para>
25855 <para>The Slides stylesheet for HTML output is a
25856 customization layer of the DocBook XSL HTML
25857 stylesheet; the Slides stylesheet for FO output is a
25858 customization layer of the DocBook XSL FO stylesheet.
25859 Therefore, in addition to the slides-specific
25860 parameters listed in this section, you can also use a
25861 number of <link xlink:href="../html">HTML stylesheet
25862 parameters</link> and <link xlink:href="../fo">FO
25863 stylesheet parameters</link> to control Slides
25867 <reference id="html" xml:base="../slides/html/param.xml">
25868 <title>HTML: General Parameters</title>
25869 <refentry version="5.0" id="keyboard.nav">
25871 <refentrytitle>keyboard.nav</refentrytitle>
25872 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
25875 <refname>keyboard.nav</refname>
25876 <refpurpose>Enable keyboard navigation?</refpurpose>
25880 <programlisting id="keyboard.nav.frag">
25881 <xsl:param name="keyboard.nav" select="1"></xsl:param>
25885 <refsection><info><title>Description</title></info>
25887 <para>If non-zero, JavaScript is added to the slides to enable keyboard
25888 navigation. Pressing 'n', space, or return moves forward; pressing 'p' moves
25894 <refentry version="5.0" id="css.stylesheet">
25896 <refentrytitle>css.stylesheet</refentrytitle>
25897 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
25900 <refname>css.stylesheet</refname>
25901 <refpurpose>CSS stylesheet for slides</refpurpose>
25905 <programlisting id="css.stylesheet.frag">
25906 <xsl:param name="css.stylesheet">slides.css</xsl:param>
25910 <refsection><info><title>Description</title></info>
25912 <para>Identifies the CSS stylesheet used by all the slides. This parameter
25913 can be set in the source document with the <?dbhtml?> pseudo-attribute
25914 <literal>css-stylesheet</literal>.</para>
25919 <refentry version="5.0" id="css.stylesheet.dir">
25921 <refentrytitle>css.stylesheet.dir</refentrytitle>
25922 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
25925 <refname>css.stylesheet.dir</refname>
25926 <refpurpose>Default directory for CSS stylesheets</refpurpose>
25930 <programlisting id="css.stylesheet.dir.frag">
25931 <xsl:param name="css.stylesheet.dir"></xsl:param>
25935 <refsection><info><title>Description</title></info>
25937 <para>Identifies the default directory for the CSS stylesheet
25938 generated on all the slides. This parameter can be set in the source
25939 document with the <?dbhtml?> pseudo-attribute
25940 <literal>css-stylesheet-dir</literal>.</para>
25942 <para>If non-empty, this value is prepended to each of the stylesheets.
25948 <refentry version="5.0" id="titlefoil.html">
25950 <refentrytitle>titlefoil.html</refentrytitle>
25951 <refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo>
25954 <refname>titlefoil.html</refname>
25955 <refpurpose>Name of title foil HTML file</refpurpose>
25959 <programlisting id="titlefoil.html.frag">
25960 <xsl:param name="titlefoil.html" select="concat('index', $html.ext)"></xsl:param>
25964 <refsection><info><title>Description</title></info>
25966 <para>Sets the filename used for the slides titlepage.</para>
25971 <refentry version="5.0" id="toc.html">
25973 <refentrytitle>toc.html</refentrytitle>
25974 <refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo>
25977 <refname>toc.html</refname>
25978 <refpurpose>Name of ToC HTML file</refpurpose>
25982 <programlisting id="toc.html.frag">
25983 <xsl:param name="toc.html" select="concat('toc', $html.ext)"></xsl:param>
25987 <refsection><info><title>Description</title></info>
25989 <para>Sets the filename used for the table of contents page.</para>
25994 <refentry version="5.0" id="foilgroup.toc">
25996 <refentrytitle>foilgroup.toc</refentrytitle>
25997 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
26000 <refname>foilgroup.toc</refname>
26001 <refpurpose>Put ToC on foilgroup pages?</refpurpose>
26005 <programlisting id="foilgroup.toc.frag">
26006 <xsl:param name="foilgroup.toc" select="1"></xsl:param>
26010 <refsection><info><title>Description</title></info>
26012 <para>If non-zero, a ToC will be placed on foilgroup pages (after any
26019 <refentry version="5.0" id="output.indent">
26021 <refentrytitle>output.indent</refentrytitle>
26022 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
26023 <refmiscinfo class="other" otherclass="value">no</refmiscinfo>
26024 <refmiscinfo class="other" otherclass="value">yes</refmiscinfo>
26027 <refname>output.indent</refname>
26028 <refpurpose>Indent output?</refpurpose>
26032 <programlisting id="output.indent.frag">
26033 <xsl:param name="output.indent">no</xsl:param>
26037 <refsection><info><title>Description</title></info>
26039 <para>Specifies the setting of the <parameter>indent</parameter>
26040 parameter on the HTML slides. For more information, see the discussion
26041 of the <tag>xsl:output</tag> element in the XSLT specification.</para>
26042 <para>Select from <literal>yes</literal> or <literal>no</literal>.</para>
26047 <refentry version="5.0" id="overlay">
26049 <refentrytitle>overlay</refentrytitle>
26050 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
26053 <refname>overlay</refname>
26054 <refpurpose>Overlay footer navigation?</refpurpose>
26058 <programlisting id="overlay.frag">
26059 <xsl:param name="overlay" select="0"></xsl:param>
26063 <refsection><info><title>Description</title></info>
26065 <para>If non-zero, JavaScript is added to the slides to make the
26066 bottom navigation appear at the bottom of each page. This option and
26067 <link linkend="multiframe">multiframe</link> are mutually exclusive.</para>
26069 <para>If this parameter is zero, the bottom navigation simply appears
26070 below the content of each slide.</para>
26075 <refentry version="5.0" id="show.foil.number">
26077 <refentrytitle>show.foil.number</refentrytitle>
26078 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
26081 <refname>show.foil.number</refname>
26082 <refpurpose>Show foil number on each foil?</refpurpose>
26086 <programlisting id="show.foil.number.frag">
26087 <xsl:param name="show.foil.number" select="0"></xsl:param>
26091 <refsection><info><title>Description</title></info>
26093 <para>If non-zero, on each slide there will be its number. Currently
26094 not supported in all output formats.</para>
26099 </reference><reference id="frames" xml:base="../slides/html/param.xml">
26100 <title>HTML: Frames Parameters</title>
26101 <refentry version="5.0" id="nav.separator">
26103 <refentrytitle>nav.separator</refentrytitle>
26104 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
26107 <refname>nav.separator</refname>
26108 <refpurpose>Output separator between navigation and body?</refpurpose>
26112 <programlisting id="nav.separator.frag">
26113 <xsl:param name="nav.separator" select="1"></xsl:param>
26117 <refsection><info><title>Description</title></info>
26119 <para>If non-zero, a separator (<literal><HR></literal>) is
26120 added between the navigation links and the content of each slide.</para>
26125 <refentry version="5.0" id="toc.row.height">
26127 <refentrytitle>toc.row.height</refentrytitle>
26128 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
26131 <refname>toc.row.height</refname>
26132 <refpurpose>Height of ToC rows in dynamic ToCs</refpurpose>
26136 <programlisting id="toc.row.height.frag">
26137 <xsl:param name="toc.row.height">22</xsl:param>
26141 <refsection><info><title>Description</title></info>
26143 <para>This parameter specifies the height of each row in the table of
26144 contents. This is only applicable if a <link linkend="dynamic.toc">dynamic ToC</link> is used. You may want to
26145 adjust this parameter for optimal appearance with the font and image
26146 sizes selected by your <link linkend="css.stylesheet">CSS
26153 <refentry version="5.0" id="toc.bg.color">
26155 <refentrytitle>toc.bg.color</refentrytitle>
26156 <refmiscinfo class="other" otherclass="datatype">color</refmiscinfo>
26159 <refname>toc.bg.color</refname>
26160 <refpurpose>Background color for ToC frame</refpurpose>
26164 <programlisting id="toc.bg.color.frag">
26165 <xsl:param name="toc.bg.color">#FFFFFF</xsl:param>
26169 <refsection><info><title>Description</title></info>
26171 <para>Specifies the background color used in the ToC frame.</para>
26176 <refentry version="5.0" id="body.bg.color">
26178 <refentrytitle>body.bg.color</refentrytitle>
26179 <refmiscinfo class="other" otherclass="datatype">color</refmiscinfo>
26182 <refname>body.bg.color</refname>
26183 <refpurpose>Background color for body frame</refpurpose>
26187 <programlisting id="body.bg.color.frag">
26188 <xsl:param name="body.bg.color">#FFFFFF</xsl:param>
26192 <refsection><info><title>Description</title></info>
26194 <para>Specifies the background color used in the body column of
26195 tabular slides.</para>
26200 <refentry version="5.0" id="toc.width">
26202 <refentrytitle>toc.width</refentrytitle>
26203 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
26206 <refname>toc.width</refname>
26207 <refpurpose>Width of ToC frame</refpurpose>
26211 <programlisting id="toc.width.frag">
26212 <xsl:param name="toc.width">250</xsl:param>
26213 <!-- Presumably in pixels? -->
26217 <refsection><info><title>Description</title></info>
26219 <para>Specifies the width of the ToC frame in pixels.</para>
26224 <refentry version="5.0" id="toc.hide.show">
26226 <refentrytitle>toc.hide.show</refentrytitle>
26227 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
26230 <refname>toc.hide.show</refname>
26231 <refpurpose>Enable hide/show button for ToC frame</refpurpose>
26235 <programlisting id="toc.hide.show.frag">
26236 <xsl:param name="toc.hide.show" select="0"></xsl:param>
26240 <refsection><info><title>Description</title></info>
26242 <para>If non-zero, JavaScript (and an additional icon, see
26243 <link linkend="hidetoc.image">hidetoc.image</link> and
26244 <link linkend="hidetoc.image">showtoc.image</link>) is added to each slide
26245 to allow the ToC panel to be <quote>toggled</quote> on each panel.</para>
26247 <note><para>There is a bug in Mozilla 1.0 (at least as of CR3) that causes
26248 the browser to reload the titlepage when this feature is used.</para></note>
26253 <refentry version="5.0" id="dynamic.toc">
26255 <refentrytitle>dynamic.toc</refentrytitle>
26256 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
26259 <refname>dynamic.toc</refname>
26260 <refpurpose>Dynamic ToCs?</refpurpose>
26264 <programlisting id="dynamic.toc.frag">
26265 <xsl:param name="dynamic.toc" select="0"></xsl:param>
26269 <refsection><info><title>Description</title></info>
26271 <para>If non-zero, JavaScript is used to make the ToC panel <quote>dynamic</quote>.
26272 In a dynamic ToC, each section in the ToC can be expanded and collapsed by
26273 clicking on the appropriate image.</para>
26278 <refentry version="5.0" id="active.toc">
26280 <refentrytitle>active.toc</refentrytitle>
26281 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
26284 <refname>active.toc</refname>
26285 <refpurpose>Active ToCs?</refpurpose>
26289 <programlisting id="active.toc.frag">
26290 <xsl:param name="active.toc" select="0"></xsl:param>
26294 <refsection><info><title>Description</title></info>
26296 <para>If non-zero, JavaScript is used to keep the ToC and the current slide
26297 <quote>in sync</quote>. That is, each time the slide changes, the corresponding
26298 ToC entry will be underlined.</para>
26303 <refentry version="5.0" id="overlay.logo">
26305 <refentrytitle>overlay.logo</refentrytitle>
26306 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
26309 <refname>overlay.logo</refname>
26310 <refpurpose>Logo to overlay on ToC frame</refpurpose>
26314 <programlisting id="overlay.logo.frag">
26315 <xsl:param name="overlay.logo">http://docbook.sourceforge.net/release/buttons/slides-1.png</xsl:param>
26319 <refsection><info><title>Description</title></info>
26321 <para>If this URI is non-empty, JavaScript is used to overlay the
26322 specified image on the ToC frame.</para>
26327 <refentry version="5.0" id="multiframe">
26329 <refentrytitle>multiframe</refentrytitle>
26330 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
26333 <refname>multiframe</refname>
26334 <refpurpose>Use multiple frames for slide bodies?</refpurpose>
26338 <programlisting id="multiframe.frag">
26339 <xsl:param name="multiframe" select="0"></xsl:param>
26343 <refsection><info><title>Description</title></info>
26345 <para>If non-zero, multiple frames are used for the body of each
26346 slide. This is one way of forcing the slide navigation elements to
26347 appear in constant locations. The other way is with <link linkend="overlay">overlays</link>. The <link linkend="overlay"><parameter>overlay</parameter></link> and
26348 <parameter>multiframe</parameter> parameters are mutually
26354 <refentry version="5.0" id="multiframe.top.bgcolor">
26356 <refentrytitle>multiframe.top.bgcolor</refentrytitle>
26357 <refmiscinfo class="other" otherclass="datatype">color</refmiscinfo>
26360 <refname>multiframe.top.bgcolor</refname>
26361 <refpurpose>Background color for top navigation frame</refpurpose>
26365 <programlisting id="multiframe.top.bgcolor.frag">
26366 <xsl:param name="multiframe.top.bgcolor">white</xsl:param>
26370 <refsection><info><title>Description</title></info>
26372 <para>Specifies the background color of the top navigation frame when
26373 <link linkend="multiframe">multiframe</link> is enabled.</para>
26378 <refentry version="5.0" id="multiframe.bottom.bgcolor">
26380 <refentrytitle>multiframe.bottom.bgcolor</refentrytitle>
26381 <refmiscinfo class="other" otherclass="datatype">color</refmiscinfo>
26384 <refname>multiframe.bottom.bgcolor</refname>
26385 <refpurpose>Background color for bottom navigation frame</refpurpose>
26389 <programlisting id="multiframe.bottom.bgcolor.frag">
26390 <xsl:param name="multiframe.bottom.bgcolor">white</xsl:param>
26394 <refsection><info><title>Description</title></info>
26396 <para>Specifies the background color of the bottom navigation frame when
26397 <link linkend="multiframe">multiframe</link> is enabled.</para>
26402 <refentry version="5.0" id="multiframe.navigation.height">
26404 <refentrytitle>multiframe.navigation.height</refentrytitle>
26405 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
26408 <refname>multiframe.navigation.height</refname>
26409 <refpurpose>Height of navigation frames</refpurpose>
26413 <programlisting id="multiframe.navigation.height.frag">
26414 <xsl:param name="multiframe.navigation.height">40</xsl:param>
26418 <refsection><info><title>Description</title></info>
26420 <para>Specifies the height of the navigation frames in pixels when
26421 <link linkend="multiframe">multiframe</link> is enabled.</para>
26426 </reference><reference id="graphics" xml:base="../slides/html/param.xml">
26427 <title>HTML: Graphics Parameters</title>
26428 <refentry version="5.0" id="graphics.dir">
26430 <refentrytitle>graphics.dir</refentrytitle>
26431 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
26434 <refname>graphics.dir</refname>
26435 <refpurpose>Graphics directory</refpurpose>
26439 <programlisting id="graphics.dir.frag">
26440 <xsl:param name="graphics.dir"></xsl:param>
26444 <refsection><info><title>Description</title></info>
26446 <para>Identifies the graphics directory for the navigation components
26447 generated on all the slides. This parameter can be set in the source
26448 document with the <?dbhtml?> pseudo-attribute
26449 <literal>graphics-dir</literal>.</para>
26451 <para>If non-empty, this value is prepended to each of the graphic
26452 image paths.</para>
26457 <refentry version="5.0" id="bullet.image">
26459 <refentrytitle>bullet.image</refentrytitle>
26460 <refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo>
26463 <refname>bullet.image</refname>
26464 <refpurpose>Bullet image</refpurpose>
26468 <programlisting id="bullet.image.frag">
26469 <xsl:param name="bullet.image">toc/bullet.png</xsl:param>
26473 <refsection><info><title>Description</title></info>
26475 <para>Specifies the filename of the bullet image used for foils in the
26481 <refentry version="5.0" id="next.image">
26483 <refentrytitle>next.image</refentrytitle>
26484 <refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo>
26487 <refname>next.image</refname>
26488 <refpurpose>Right-arrow image</refpurpose>
26492 <programlisting id="next.image.frag">
26493 <xsl:param name="next.image">active/nav-next.png</xsl:param>
26497 <refsection><info><title>Description</title></info>
26499 <para>Specifies the filename of the right-pointing navigation arrow.</para>
26504 <refentry version="5.0" id="prev.image">
26506 <refentrytitle>prev.image</refentrytitle>
26507 <refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo>
26510 <refname>prev.image</refname>
26511 <refpurpose>Left-arrow image</refpurpose>
26515 <programlisting id="prev.image.frag">
26516 <xsl:param name="prev.image">active/nav-prev.png</xsl:param>
26520 <refsection><info><title>Description</title></info>
26522 <para>Specifies the filename of the left-pointing navigation arrow.</para>
26527 <refentry version="5.0" id="up.image">
26529 <refentrytitle>up.image</refentrytitle>
26530 <refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo>
26533 <refname>up.image</refname>
26534 <refpurpose>Up-arrow image</refpurpose>
26538 <programlisting id="up.image.frag">
26539 <xsl:param name="up.image">active/nav-up.png</xsl:param>
26543 <refsection><info><title>Description</title></info>
26545 <para>Specifies the filename of the upward-pointing navigation arrow.</para>
26550 <refentry version="5.0" id="home.image">
26552 <refentrytitle>home.image</refentrytitle>
26553 <refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo>
26556 <refname>home.image</refname>
26557 <refpurpose>Home image</refpurpose>
26561 <programlisting id="home.image.frag">
26562 <xsl:param name="home.image">active/nav-home.png</xsl:param>
26566 <refsection><info><title>Description</title></info>
26568 <para>Specifies the filename of the home navigation icon.</para>
26573 <refentry version="5.0" id="toc.image">
26575 <refentrytitle>toc.image</refentrytitle>
26576 <refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo>
26579 <refname>toc.image</refname>
26580 <refpurpose>ToC image</refpurpose>
26584 <programlisting id="toc.image.frag">
26585 <xsl:param name="toc.image">active/nav-toc.png</xsl:param>
26589 <refsection><info><title>Description</title></info>
26591 <para>Specifies the filename of the ToC navigation icon.</para>
26597 <refentry version="5.0" id="no.next.image">
26599 <refentrytitle>no.next.image</refentrytitle>
26600 <refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo>
26603 <refname>no.next.image</refname>
26604 <refpurpose>Inactive right-arrow image</refpurpose>
26608 <programlisting id="no.next.image.frag">
26609 <xsl:param name="no.next.image">inactive/nav-next.png</xsl:param>
26613 <refsection><info><title>Description</title></info>
26615 <para>Specifies the filename of the inactive right-pointing navigation arrow.</para>
26620 <refentry version="5.0" id="no.prev.image">
26622 <refentrytitle>no.prev.image</refentrytitle>
26623 <refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo>
26626 <refname>no.prev.image</refname>
26627 <refpurpose>Inactive left-arrow image</refpurpose>
26631 <programlisting id="no.prev.image.frag">
26632 <xsl:param name="no.prev.image">inactive/nav-prev.png</xsl:param>
26636 <refsection><info><title>Description</title></info>
26638 <para>Specifies the filename of the inactive left-pointing navigation arrow.</para>
26643 <refentry version="5.0" id="no.up.image">
26645 <refentrytitle>no.up.image</refentrytitle>
26646 <refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo>
26649 <refname>no.up.image</refname>
26650 <refpurpose>Inactive up-arrow image</refpurpose>
26654 <programlisting id="no.up.image.frag">
26655 <xsl:param name="no.up.image">inactive/nav-up.png</xsl:param>
26659 <refsection><info><title>Description</title></info>
26661 <para>Specifies the filename of the inactive upward-pointing navigation arrow.</para>
26666 <refentry version="5.0" id="no.home.image">
26668 <refentrytitle>no.home.image</refentrytitle>
26669 <refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo>
26672 <refname>no.home.image</refname>
26673 <refpurpose>Inactive home image</refpurpose>
26677 <programlisting id="no.home.image.frag">
26678 <xsl:param name="no.home.image">inactive/nav-home.png</xsl:param>
26682 <refsection><info><title>Description</title></info>
26684 <para>Specifies the filename of the inactive home navigation icon.</para>
26689 <refentry version="5.0" id="no.toc.image">
26691 <refentrytitle>no.toc.image</refentrytitle>
26692 <refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo>
26695 <refname>no.toc.image</refname>
26696 <refpurpose>Inactive ToC image</refpurpose>
26700 <programlisting id="no.toc.image.frag">
26701 <xsl:param name="no.toc.image">inactive/nav-toc.png</xsl:param>
26705 <refsection><info><title>Description</title></info>
26707 <para>Specifies the filename of the inactive ToC navigation icon.</para>
26713 <refentry version="5.0" id="plus.image">
26715 <refentrytitle>plus.image</refentrytitle>
26716 <refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo>
26719 <refname>plus.image</refname>
26720 <refpurpose>Plus image</refpurpose>
26724 <programlisting id="plus.image.frag">
26725 <xsl:param name="plus.image">toc/closed.png</xsl:param>
26729 <refsection><info><title>Description</title></info>
26731 <para>Specifies the filename of the <quote>plus</quote> image; the image used in a
26732 <link linkend="dynamic.toc">dynamic ToC</link> to indicate that a section
26733 can be expanded.</para>
26738 <refentry version="5.0" id="minus.image">
26740 <refentrytitle>minus.image</refentrytitle>
26741 <refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo>
26744 <refname>minus.image</refname>
26745 <refpurpose>Minus image</refpurpose>
26749 <programlisting id="minus.image.frag">
26750 <xsl:param name="minus.image">toc/open.png</xsl:param>
26754 <refsection><info><title>Description</title></info>
26756 <para>Specifies the filename of the <quote>minus</quote> image; the image used in a
26757 <link linkend="dynamic.toc">dynamic ToC</link> to indicate that a section
26758 can be collapsed.</para>
26763 <refentry version="5.0" id="hidetoc.image">
26765 <refentrytitle>hidetoc.image</refentrytitle>
26766 <refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo>
26769 <refname>hidetoc.image</refname>
26770 <refpurpose>Hide ToC image</refpurpose>
26774 <programlisting id="hidetoc.image.frag">
26775 <xsl:param name="hidetoc.image">hidetoc.gif</xsl:param>
26779 <refsection><info><title>Description</title></info>
26781 <para>Specifies the filename of the <quote>hide ToC</quote> image. This is used
26782 when the <link linkend="toc.hide.show">ToC hide/show</link> parameter is
26788 <refentry version="5.0" id="showtoc.image">
26790 <refentrytitle>showtoc.image</refentrytitle>
26791 <refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo>
26794 <refname>showtoc.image</refname>
26795 <refpurpose>Show ToC image</refpurpose>
26799 <programlisting id="showtoc.image.frag">
26800 <xsl:param name="showtoc.image">showtoc.gif</xsl:param>
26804 <refsection><info><title>Description</title></info>
26806 <para>Specifies the filename of the <quote>show ToC</quote> image. This is used
26807 when the <link linkend="toc.hide.show">ToC hide/show</link> parameter is
26813 </reference><reference id="javascript" xml:base="../slides/html/param.xml">
26814 <title>HTML: JavaScript Parameters</title>
26815 <refentry version="5.0" id="script.dir">
26817 <refentrytitle>script.dir</refentrytitle>
26818 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
26821 <refname>script.dir</refname>
26822 <refpurpose>Script directory</refpurpose>
26826 <programlisting id="script.dir.frag">
26827 <xsl:param name="script.dir"></xsl:param>
26831 <refsection><info><title>Description</title></info>
26833 <para>Identifies the JavaScript source directory for the slides.
26834 This parameter can be set in the source
26835 document with the <?dbhtml?> pseudo-attribute
26836 <literal>script-dir</literal>.</para>
26838 <para>If non-empty, this value is prepended to each of the JavaScript files.
26844 <refentry version="5.0" id="ua.js">
26846 <refentrytitle>ua.js</refentrytitle>
26847 <refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo>
26850 <refname>ua.js</refname>
26851 <refpurpose>UA JavaScript file</refpurpose>
26855 <programlisting id="ua.js.frag">
26856 <xsl:param name="ua.js">ua.js</xsl:param>
26860 <refsection><info><title>Description</title></info>
26862 <para>Specifies the filename of the UA JavaScript file. It's unlikely
26863 that you will ever need to change this parameter.</para>
26868 <refentry version="5.0" id="xbDOM.js">
26870 <refentrytitle>xbDOM.js</refentrytitle>
26871 <refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo>
26874 <refname>xbDOM.js</refname>
26875 <refpurpose>xbDOM JavaScript file</refpurpose>
26879 <programlisting id="xbDOM.js.frag">
26880 <xsl:param name="xbDOM.js">xbDOM.js</xsl:param>
26884 <refsection><info><title>Description</title></info>
26886 <para>Specifies the filename of the xbDOM JavaScript file. It's unlikely
26887 that you will ever need to change this parameter.</para>
26892 <refentry version="5.0" id="xbStyle.js">
26894 <refentrytitle>xbStyle.js</refentrytitle>
26895 <refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo>
26898 <refname>xbStyle.js</refname>
26899 <refpurpose>xbStyle JavaScript file</refpurpose>
26903 <programlisting id="xbStyle.js.frag">
26904 <xsl:param name="xbStyle.js">xbStyle.js</xsl:param>
26908 <refsection><info><title>Description</title></info>
26910 <para>Specifies the filename of the xbStyle JavaScript file. It's unlikely
26911 that you will ever need to change this parameter.</para>
26916 <refentry version="5.0" id="xbLibrary.js">
26918 <refentrytitle>xbLibrary.js</refentrytitle>
26919 <refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo>
26922 <refname>xbLibrary.js</refname>
26923 <refpurpose>xbLibrary JavaScript file</refpurpose>
26927 <programlisting id="xbLibrary.js.frag">
26928 <xsl:param name="xbLibrary.js">xbLibrary.js</xsl:param>
26932 <refsection><info><title>Description</title></info>
26934 <para>Specifies the filename of the xbLibrary JavaScript file. It's unlikely
26935 that you will ever need to change this parameter.</para>
26940 <refentry version="5.0" id="xbCollapsibleLists.js">
26942 <refentrytitle>xbCollapsibleLists.js</refentrytitle>
26943 <refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo>
26946 <refname>xbCollapsibleLists.js</refname>
26947 <refpurpose>xbCollapsibleLists JavaScript file</refpurpose>
26951 <programlisting id="xbCollapsibleLists.js.frag">
26952 <xsl:param name="xbCollapsibleLists.js">xbCollapsibleLists.js</xsl:param>
26956 <refsection><info><title>Description</title></info>
26958 <para>Specifies the filename of the xbCollapsibleLists JavaScript file. It's unlikely
26959 that you will ever need to change this parameter.</para>
26964 <refentry version="5.0" id="overlay.js">
26966 <refentrytitle>overlay.js</refentrytitle>
26967 <refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo>
26970 <refname>overlay.js</refname>
26971 <refpurpose>Overlay JavaScript file</refpurpose>
26975 <programlisting id="overlay.js.frag">
26976 <xsl:param name="overlay.js">overlay.js</xsl:param>
26980 <refsection><info><title>Description</title></info>
26982 <para>Specifies the filename of the overlay JavaScript file. It's unlikely
26983 that you will ever need to change this parameter.</para>
26988 <refentry version="5.0" id="slides.js">
26990 <refentrytitle>slides.js</refentrytitle>
26991 <refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo>
26994 <refname>slides.js</refname>
26995 <refpurpose>Slides overlay file</refpurpose>
26999 <programlisting id="slides.js.frag">
27000 <xsl:param name="slides.js">slides.js</xsl:param>
27004 <refsection><info><title>Description</title></info>
27006 <para>Specifies the filename of the slides JavaScript file. It's unlikely
27007 that you will ever need to change this parameter.</para>
27012 </reference><reference id="l10n" xml:base="../slides/html/param.xml">
27013 <title>HTML: Localization Parameters</title>
27014 <refentry version="5.0" id="text.home">
27016 <refentrytitle>text.home</refentrytitle>
27017 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
27020 <refname>text.home</refname>
27021 <refpurpose>Home</refpurpose>
27025 <programlisting id="text.home.frag">
27026 <xsl:param name="text.home">Home</xsl:param>
27030 <refsection><info><title>Description</title></info>
27032 <para>FIXME:</para>
27037 <refentry version="5.0" id="text.toc">
27039 <refentrytitle>text.toc</refentrytitle>
27040 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
27043 <refname>text.toc</refname>
27044 <refpurpose>FIXME:</refpurpose>
27048 <programlisting id="text.toc.frag">
27049 <xsl:param name="text.toc">ToC</xsl:param>
27053 <refsection><info><title>Description</title></info>
27055 <para>FIXME:</para>
27060 <refentry version="5.0" id="text.prev">
27062 <refentrytitle>text.prev</refentrytitle>
27063 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
27066 <refname>text.prev</refname>
27067 <refpurpose>FIXME:</refpurpose>
27071 <programlisting id="text.prev.frag">
27072 <xsl:param name="text.prev">Prev</xsl:param>
27076 <refsection><info><title>Description</title></info>
27078 <para>FIXME:</para>
27083 <refentry version="5.0" id="text.up">
27085 <refentrytitle>text.up</refentrytitle>
27086 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
27089 <refname>text.up</refname>
27090 <refpurpose>FIXME:</refpurpose>
27094 <programlisting id="text.up.frag">
27095 <xsl:param name="text.up">Up</xsl:param>
27099 <refsection><info><title>Description</title></info>
27101 <para>FIXME:</para>
27106 <refentry version="5.0" id="text.next">
27108 <refentrytitle>text.next</refentrytitle>
27109 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
27112 <refname>text.next</refname>
27113 <refpurpose>FIXME:</refpurpose>
27117 <programlisting id="text.next.frag">
27118 <xsl:param name="text.next">Next</xsl:param>
27122 <refsection><info><title>Description</title></info>
27124 <para>FIXME:</para>
27132 <reference id="fo" xml:base="../slides/fo/param.xml">
27133 <title>FO: General Params</title>
27134 <refentry version="5.0" id="slide.title.font.family">
27136 <refentrytitle>slide.title.font.family</refentrytitle>
27137 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
27138 <refmiscinfo class="other" otherclass="list-type">open</refmiscinfo>
27139 <refmiscinfo class="other" otherclass="value">serif</refmiscinfo>
27140 <refmiscinfo class="other" otherclass="value">sans-serif</refmiscinfo>
27141 <refmiscinfo class="other" otherclass="value">monospace</refmiscinfo>
27144 <refname>slide.title.font.family</refname>
27145 <refpurpose>Specifies font family to use for slide titles</refpurpose>
27149 <programlisting id="slide.title.font.family.frag">
27150 <xsl:param name="slide.title.font.family">Helvetica</xsl:param>
27154 <refsection><info><title>Description</title></info>
27156 <para>Specifies the font family to use for slides titles.</para>
27161 <refentry version="5.0" id="slide.font.family">
27163 <refentrytitle>slide.font.family</refentrytitle>
27164 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
27165 <refmiscinfo class="other" otherclass="list-type">open</refmiscinfo>
27166 <refmiscinfo class="other" otherclass="value">serif</refmiscinfo>
27167 <refmiscinfo class="other" otherclass="value">sans-serif</refmiscinfo>
27168 <refmiscinfo class="other" otherclass="value">monospace</refmiscinfo>
27171 <refname>slide.font.family</refname>
27172 <refpurpose>Specifies font family to use for slide bodies</refpurpose>
27176 <programlisting id="slide.font.family.frag">
27177 <xsl:param name="slide.font.family">Helvetica</xsl:param>
27181 <refsection><info><title>Description</title></info>
27183 <para>Specifies the font family to use for slides bodies.</para>
27188 <refentry version="5.0" id="foil.title.master">
27190 <refentrytitle>foil.title.master</refentrytitle>
27191 <refmiscinfo class="other" otherclass="datatype">number</refmiscinfo>
27194 <refname>foil.title.master</refname>
27195 <refpurpose>Specifies unitless font size to use for foil titles</refpurpose>
27199 <programlisting id="foil.title.master.frag">
27200 <xsl:param name="foil.title.master">36</xsl:param>
27201 <!-- Inconsistant use of point size? -->
27205 <refsection><info><title>Description</title></info>
27207 <para>Specifies a unitless font size to use for foil titles; used in
27208 combination with the <parameter>foil.title.size</parameter>
27213 <refentry version="5.0" id="foil.title.size">
27215 <refentrytitle>foil.title.size</refentrytitle>
27216 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
27219 <refname>foil.title.size</refname>
27220 <refpurpose>Specifies font size to use for foil titles, including units</refpurpose>
27224 <programlisting id="foil.title.size.frag">
27225 <xsl:param name="foil.title.size">
27226 <xsl:value-of select="$foil.title.master"></xsl:value-of><xsl:text>pt</xsl:text>
27231 <refsection><info><title>Description</title></info>
27233 <para>This parameter combines the value of the
27234 <parameter>foil.title.master</parameter> parameter with a unit
27235 specification. The default unit is <literal>pt</literal>
27241 </reference><reference id="propsets" xml:base="../slides/fo/param.xml">
27242 <title>FO: Property Sets</title>
27243 <refentry version="5.0" id="slides.properties">
27245 <refentrytitle>slides.properties</refentrytitle>
27246 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
27249 <refname>slides.properties</refname>
27250 <refpurpose>Specifies properties for all slides</refpurpose>
27254 <programlisting id="slides.properties.frag">
27255 <xsl:attribute-set name="slides.properties">
27256 <xsl:attribute name="font-family">
27257 <xsl:value-of select="$slide.font.family"></xsl:value-of>
27258 </xsl:attribute>
27259 </xsl:attribute-set>
27263 <refsection><info><title>Description</title></info>
27265 <para>This parameter specifies properties that are applied to all slides.</para>
27270 <refentry version="5.0" id="foilgroup.properties">
27272 <refentrytitle>foilgroup.properties</refentrytitle>
27273 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
27276 <refname>foilgroup.properties</refname>
27277 <refpurpose>Specifies properties for all foilgroups</refpurpose>
27281 <programlisting id="foilgroup.properties.frag">
27282 <xsl:attribute-set name="foilgroup.properties">
27283 <xsl:attribute name="font-family">
27284 <xsl:value-of select="$slide.font.family"></xsl:value-of>
27285 </xsl:attribute>
27286 </xsl:attribute-set>
27290 <refsection><info><title>Description</title></info>
27292 <para>This parameter specifies properties that are applied to all foilgroups.</para>
27297 <refentry version="5.0" id="foil.subtitle.properties">
27299 <refentrytitle>foil.subtitle.properties</refentrytitle>
27300 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
27303 <refname>foil.subtitle.properties</refname>
27304 <refpurpose>Specifies properties for all foil subtitles</refpurpose>
27308 <programlisting id="foil.subtitle.properties.frag">
27309 <xsl:attribute-set name="foil.subtitle.properties">
27310 <xsl:attribute name="font-family">
27311 <xsl:value-of select="$slide.title.font.family"></xsl:value-of>
27312 </xsl:attribute>
27313 <xsl:attribute name="text-align">center</xsl:attribute>
27314 <xsl:attribute name="font-size">
27315 <xsl:value-of select="$foil.title.master * 0.8"></xsl:value-of><xsl:text>pt</xsl:text>
27316 </xsl:attribute>
27317 <xsl:attribute name="space-after">12pt</xsl:attribute>
27318 </xsl:attribute-set>
27322 <refsection><info><title>Description</title></info>
27324 <para>This parameter specifies properties that are applied to all foil subtitles.</para>
27329 <refentry version="5.0" id="foil.properties">
27331 <refentrytitle>foil.properties</refentrytitle>
27332 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
27335 <refname>foil.properties</refname>
27336 <refpurpose>Specifies properties for all foils</refpurpose>
27340 <programlisting id="foil.properties.frag">
27341 <xsl:attribute-set name="foil.properties">
27342 <xsl:attribute name="font-family">
27343 <xsl:value-of select="$slide.font.family"></xsl:value-of>
27344 </xsl:attribute>
27345 <xsl:attribute name="margin-{$direction.align.start}">1in</xsl:attribute>
27346 <xsl:attribute name="margin-{$direction.align.end}">1in</xsl:attribute>
27347 <xsl:attribute name="font-size">
27348 <xsl:value-of select="$body.font.size"></xsl:value-of>
27349 </xsl:attribute>
27350 <xsl:attribute name="font-weight">bold</xsl:attribute>
27351 </xsl:attribute-set>
27355 <refsection><info><title>Description</title></info>
27357 <para>This parameter specifies properties that are applied to all foils.</para>
27362 <refentry version="5.0" id="speakernote.properties">
27364 <refentrytitle>speakernote.properties</refentrytitle>
27365 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
27368 <refname>speakernote.properties</refname>
27369 <refpurpose>Specifies properties for all speakernotes</refpurpose>
27373 <programlisting id="speakernote.properties.frag">
27374 <xsl:attribute-set name="speakernote.properties">
27375 <xsl:attribute name="font-family">Times Roman</xsl:attribute>
27376 <xsl:attribute name="font-style">italic</xsl:attribute>
27377 <xsl:attribute name="font-size">12pt</xsl:attribute>
27378 <xsl:attribute name="font-weight">normal</xsl:attribute>
27379 </xsl:attribute-set>
27383 <refsection><info><title>Description</title></info>
27385 <para>This parameter specifies properties that are applied to all speakernotes.</para>
27390 <refentry version="5.0" id="running.foot.properties">
27392 <refentrytitle>running.foot.properties</refentrytitle>
27393 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
27396 <refname>running.foot.properties</refname>
27397 <refpurpose>Specifies properties for running foot on each slide</refpurpose>
27401 <programlisting id="running.foot.properties.frag">
27402 <xsl:attribute-set name="running.foot.properties">
27403 <xsl:attribute name="font-family">
27404 <xsl:value-of select="$slide.font.family"></xsl:value-of>
27405 </xsl:attribute>
27406 <xsl:attribute name="font-size">14pt</xsl:attribute>
27407 <xsl:attribute name="color">#9F9F9F</xsl:attribute>
27408 </xsl:attribute-set>
27412 <refsection><info><title>Description</title></info>
27414 <para>This parameter specifies properties that are applied to the
27415 running foot area of each slide.</para>
27422 <part id="website">
27423 <?dbhtml dir="website"?>
27424 <?dbhtml filename="index.html"?>
27425 <title xml:base="../website/param.xml">Website Parameter Reference</title>
27426 <partintro id="websiteintro">
27428 <para xml:base="../website/param.xml">This is reference documentation for all user-configurable
27429 parameters in the DocBook XSL Website stylesheet (for
27430 generating websites from DocBook XML sources). Note that the
27431 Website stylesheet is a customization layer of the DocBook XSL
27432 HTML stylesheet. Therefore, in addition to the
27433 Website-specific parameters listed in this section, you can
27434 also use a number of <link xlink:href="../html/">HTML
27435 stylesheet parameters</link> to control Website output.</para>
27438 <reference id="general" xml:base="../website/param.xml">
27439 <title>General Parameters</title>
27440 <refentry version="5.0" id="autolayout-file">
27442 <refentrytitle>autolayout-file</refentrytitle>
27443 <refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo>
27446 <refname>autolayout-file</refname>
27447 <refpurpose>Identifies the autolayout.xml file</refpurpose>
27451 <programlisting id="autolayout-file.frag">
27452 <xsl:param name="autolayout-file">autolayout.xml</xsl:param>
27456 <refsection><info><title>Description</title></info>
27457 <para>When the source pages are spread over several directories, this
27458 parameter can be set (for example, from the command line of a batch-mode
27459 XSLT processor) to indicate the location of the autolayout.xml file.</para>
27460 <para>FIXME: for browser-based use, there needs to be a PI for this...
27465 <refentry version="5.0" id="body.attributes">
27467 <refentrytitle>body.attributes</refentrytitle>
27468 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
27471 <refname>body.attributes</refname>
27472 <refpurpose>DEPRECATED</refpurpose>
27476 <programlisting id="body.attributes.frag">
27477 <xsl:attribute-set name="body.attributes">
27478 <xsl:attribute name="bgcolor">white</xsl:attribute>
27479 <xsl:attribute name="text">black</xsl:attribute>
27480 <xsl:attribute name="link">#0000FF</xsl:attribute>
27481 <xsl:attribute name="vlink">#840084</xsl:attribute>
27482 <xsl:attribute name="alink">#0000FF</xsl:attribute>
27483 </xsl:attribute-set>
27487 <refsection><info><title>Description</title></info>
27488 <para>DEPRECATED</para>
27492 <refentry version="5.0" id="currentpage.marker">
27494 <refentrytitle>currentpage.marker</refentrytitle>
27495 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
27498 <refname>currentpage.marker</refname>
27499 <refpurpose>The text symbol used to mark the current page</refpurpose>
27503 <programlisting id="currentpage.marker.frag">
27504 <xsl:param name="currentpage.marker">@</xsl:param>
27508 <refsection><info><title>Description</title></info>
27509 <para>Character to use as identifying the current page in </para>
27513 <refentry version="5.0" id="dry-run">
27515 <refentrytitle>dry-run</refentrytitle>
27516 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
27519 <refname>dry-run</refname>
27520 <refpurpose>Indicates that no files should be produced</refpurpose>
27523 <programlisting id="dry-run.frag">
27524 <xsl:param name="dry-run" select="0"></xsl:param>
27527 <refsection><info><title>Description</title></info>
27528 <para>When using the XSLT processor to manage dependencies and construct
27529 the website, this parameter can be used to suppress the generation of
27530 new and updated files. Effectively, this allows you to see what the
27531 stylesheet would do, without actually making any changes.</para>
27532 <para>Only applies when XSLT-based chunking is being used.</para>
27536 <refentry version="5.0" id="feedback.href">
27538 <refentrytitle>feedback.href</refentrytitle>
27539 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
27542 <refname>feedback.href</refname>
27543 <refpurpose>HREF (URI) for feedback link</refpurpose>
27547 <programlisting id="feedback.href.frag">
27548 <xsl:param name="feedback.href"></xsl:param>
27552 <refsection><info><title>Description</title></info>
27553 <para>The <varname>feedback.href</varname> value is used as the value
27554 for the <tag class="attribute">href</tag> attribute on the feedback
27555 link. If <varname>feedback.href</varname>
27556 is empty, no feedback link is generated.</para>
27560 <refentry version="5.0" id="feedback.link.text">
27562 <refentrytitle>feedback.link.text</refentrytitle>
27563 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
27566 <refname>feedback.link.text</refname>
27567 <refpurpose>The text of the feedback link</refpurpose>
27571 <programlisting id="feedback.link.text.frag">
27572 <xsl:param name="feedback.link.text">Feedback</xsl:param>
27576 <refsection><info><title>Description</title></info>
27577 <para>The contents of this variable is used as the text of the feedback
27578 link if <varname>feedback.href</varname> is not empty. If
27579 <varname>feedback.href</varname> is empty, no feedback link is
27584 <refentry version="5.0" id="feedback.with.ids">
27586 <refentrytitle>feedback.with.ids</refentrytitle>
27587 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
27590 <refname>feedback.with.ids</refname>
27591 <refpurpose>Toggle use of IDs in feedback</refpurpose>
27595 <programlisting id="feedback.with.ids.frag">
27596 <xsl:param name="feedback.with.ids" select="0"></xsl:param>
27600 <refsection><info><title>Description</title></info>
27601 <para>If <varname>feedback.with.ids</varname> is non-zero, the ID of the
27602 current page will be added to the feedback link. This can be used, for
27603 example, if the <varname>feedback.href</varname> is a CGI script.</para>
27607 <refentry version="5.0" id="filename-prefix">
27609 <refentrytitle>filename-prefix</refentrytitle>
27610 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
27613 <refname>filename-prefix</refname>
27614 <refpurpose>Prefix added to all filenames</refpurpose>
27618 <programlisting id="filename-prefix.frag">
27619 <xsl:param name="filename-prefix"></xsl:param>
27623 <refsection><info><title>Description</title></info>
27624 <para>To produce the <quote>text-only</quote> (that is, non-tabular) layout
27625 of a website simultaneously with the tabular layout, the filenames have to
27626 be distinguished. That's accomplished by adding the
27627 <varname>filename-prefix</varname> to the front of each filename.</para>
27631 <refentry version="5.0" id="footer.hr">
27633 <refentrytitle>footer.hr</refentrytitle>
27634 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
27637 <refname>footer.hr</refname>
27638 <refpurpose>Toggle <HR> before footer</refpurpose>
27642 <programlisting id="footer.hr.frag">
27643 <xsl:param name="footer.hr" select="1"></xsl:param>
27647 <refsection><info><title>Description</title></info>
27648 <para>If non-zero, an <HR> is generated at the bottom of each web page,
27649 before the footer.</para>
27653 <refentry version="5.0" id="header.hr">
27655 <refentrytitle>header.hr</refentrytitle>
27656 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
27659 <refname>header.hr</refname>
27660 <refpurpose>Toggle <HR> after header</refpurpose>
27664 <programlisting id="header.hr.frag">
27665 <xsl:param name="header.hr" select="1"></xsl:param>
27669 <refsection><info><title>Description</title></info>
27670 <para>If non-zero, an <HR> is generated at the bottom of each web page,
27671 before the footer.</para>
27675 <refentry version="5.0" id="output-root">
27677 <refentrytitle>output-root</refentrytitle>
27678 <refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo>
27681 <refname>output-root</refname>
27682 <refpurpose>Specifies the root directory of the website</refpurpose>
27686 <programlisting id="output-root.frag">
27687 <xsl:param name="output-root">.</xsl:param>
27691 <refsection><info><title>Description</title></info>
27692 <para>When using the XSLT processor to manage dependencies and construct
27693 the website, this parameter can be used to indicate the root directory
27694 where the resulting pages are placed.</para>
27695 <para>Only applies when XSLT-based chunking is being used.</para>
27699 <refentry version="5.0" id="rebuild-all">
27701 <refentrytitle>rebuild-all</refentrytitle>
27702 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
27705 <refname>rebuild-all</refname>
27706 <refpurpose>Indicates that all files should be produced</refpurpose>
27710 <programlisting id="rebuild-all.frag">
27711 <xsl:param name="rebuild-all" select="0"></xsl:param>
27715 <refsection><info><title>Description</title></info>
27716 <para>When using the XSLT processor to manage dependencies and construct
27717 the website, this parameter can be used to regenerate the whole website,
27718 updating even pages that don't appear to need to be updated.</para>
27719 <para>The dependency extension only looks at the source documents. So
27720 if you change something in the stylesheet, for example, that has a global
27721 effect, you can use this parameter to force the stylesheet to rebuild the
27724 <para>Only applies when XSLT-based chunking is being used.</para>
27728 <refentry version="5.0" id="sequential.links">
27730 <refentrytitle>sequential.links</refentrytitle>
27731 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
27734 <refname>sequential.links</refname>
27735 <refpurpose>Make sequentional links?</refpurpose>
27739 <programlisting id="sequential.links.frag">
27740 <xsl:param name="sequential.links" select="0"></xsl:param>
27744 <refsection><info><title>Description</title></info>
27749 <refentry version="5.0" id="suppress.homepage.title">
27751 <refentrytitle>suppress.homepage.title</refentrytitle>
27752 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
27755 <refname>suppress.homepage.title</refname>
27756 <refpurpose>Suppress title on homepage?</refpurpose>
27760 <programlisting id="suppress.homepage.title.frag">
27761 <xsl:param name="suppress.homepage.title" select="1"></xsl:param>
27765 <refsection><info><title>Description</title></info>
27766 <para>FIXME:If non-zero, the title on the homepage is suppressed?</para>
27770 <refentry version="5.0" id="table.spacer.image">
27772 <refentrytitle>table.spacer.image</refentrytitle>
27773 <refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo>
27776 <refname>table.spacer.image</refname>
27777 <refpurpose>Invisible pixel for tabular accessibility</refpurpose>
27781 <programlisting id="table.spacer.image.frag">
27782 <xsl:param name="table.spacer.image">graphics/spacer.gif</xsl:param>
27786 <refsection><info><title>Description</title></info>
27787 <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
27788 website presentation.</para>
27792 </reference><reference id="nav" xml:base="../website/param.xml">
27793 <title>Navigation Parameters</title>
27794 <refentry version="5.0" id="banner.before.navigation">
27796 <refentrytitle>banner.before.navigation</refentrytitle>
27797 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
27800 <refname>banner.before.navigation</refname>
27801 <refpurpose>Put banner before navigation?</refpurpose>
27805 <programlisting id="banner.before.navigation.frag">
27806 <xsl:param name="banner.before.navigation" select="1"></xsl:param>
27810 <refsection><info><title>Description</title></info>
27815 <refentry version="5.0" id="navbgcolor">
27817 <refentrytitle>navbgcolor</refentrytitle>
27818 <refmiscinfo class="other" otherclass="datatype">color</refmiscinfo>
27821 <refname>navbgcolor</refname>
27822 <refpurpose>The background color of the navigation TOC</refpurpose>
27826 <programlisting id="navbgcolor.frag">
27827 <xsl:param name="navbgcolor">#4080FF</xsl:param>
27831 <refsection><info><title>Description</title></info>
27832 <para>The background color of the navigation TOC.</para>
27833 <para>Only applies with the tabular presentation is being used.</para>
27837 <refentry version="5.0" id="navbodywidth">
27839 <refentrytitle>navbodywidth</refentrytitle>
27840 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
27843 <refname>navbodywidth</refname>
27844 <refpurpose>Specifies the width of the navigation table body</refpurpose>
27848 <programlisting id="navbodywidth.frag">
27849 <xsl:param name="navbodywidth"></xsl:param>
27853 <refsection><info><title>Description</title></info>
27854 <para>The width of the body column.</para>
27855 <para>Only applies with the tabular presentation is being used.</para>
27859 <refentry version="5.0" id="nav.table.summary">
27861 <refentrytitle>nav.table.summary</refentrytitle>
27862 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
27865 <refname>nav.table.summary</refname>
27866 <refpurpose>HTML Table summary attribute value for navigation tables</refpurpose>
27870 <programlisting id="nav.table.summary.frag">
27871 <xsl:param name="nav.table.summary">Navigation</xsl:param>
27875 <refsection><info><title>Description</title></info>
27876 <para>The value of this parameter is used as the value of the table
27877 summary attribute for the navigation table.</para>
27878 <para>Only applies with the tabular presentation is being used.</para>
27882 <refentry version="5.0" id="navtocwidth">
27884 <refentrytitle>navtocwidth</refentrytitle>
27885 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
27888 <refname>navtocwidth</refname>
27889 <refpurpose>Specifies the width of the navigation table TOC</refpurpose>
27893 <programlisting id="navtocwidth.frag">
27894 <xsl:param name="navtocwidth">220</xsl:param>
27898 <refsection><info><title>Description</title></info>
27899 <para>The width, in pixels, of the navigation column.</para>
27900 <para>Only applies with the tabular presentation is being used.</para>
27904 <refentry version="5.0" id="textbgcolor">
27906 <refentrytitle>textbgcolor</refentrytitle>
27907 <refmiscinfo class="other" otherclass="datatype">color</refmiscinfo>
27910 <refname>textbgcolor</refname>
27911 <refpurpose>The background color of the table body</refpurpose>
27915 <programlisting id="textbgcolor.frag">
27916 <xsl:param name="textbgcolor">white</xsl:param>
27920 <refsection><info><title>Description</title></info>
27921 <para>The background color of the table body.</para>
27922 <para>Only applies with the tabular presentation is being used.</para>
27926 </reference><reference id="toc" xml:base="../website/param.xml">
27927 <title>ToC Parameters</title>
27928 <refentry version="5.0" id="toc.blank.graphic">
27930 <refentrytitle>toc.blank.graphic</refentrytitle>
27931 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
27934 <refname>toc.blank.graphic</refname>
27935 <refpurpose>Use graphic for "blanks" in TOC?</refpurpose>
27939 <programlisting id="toc.blank.graphic.frag">
27940 <xsl:param name="toc.blank.graphic" select="1"></xsl:param>
27944 <refsection><info><title>Description</title></info>
27945 <para>If non-zero, "blanks" in the the TOC will be accomplished
27946 with the graphic identified by <varname>toc.spacer.image</varname>.
27948 <para>Only applies with the tabular presentation is being used.</para>
27952 <refentry version="5.0" id="toc.blank.image">
27954 <refentrytitle>toc.blank.image</refentrytitle>
27955 <refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo>
27958 <refname>toc.blank.image</refname>
27959 <refpurpose>The image for "blanks" in the TOC</refpurpose>
27963 <programlisting id="toc.blank.image.frag">
27964 <xsl:param name="toc.blank.image">graphics/blank.gif</xsl:param>
27968 <refsection><info><title>Description</title></info>
27969 <para>If <varname>toc.blank.graphic</varname> is non-zero, this image
27970 will be used to for "blanks" in the TOC.</para>
27971 <para>Only applies with the tabular presentation is being used.</para>
27975 <refentry version="5.0" id="toc.blank.text">
27977 <refentrytitle>toc.blank.text</refentrytitle>
27978 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
27981 <refname>toc.blank.text</refname>
27982 <refpurpose>The text for "blanks" in the TOC</refpurpose>
27986 <programlisting id="toc.blank.text.frag">
27987 <xsl:param name="toc.blank.text">   </xsl:param>
27991 <refsection><info><title>Description</title></info>
27992 <para>If <varname>toc.blank.graphic</varname> is zero, this text string
27993 will be used for "blanks" in the TOC.</para>
27994 <para>Only applies with the tabular presentation is being used.</para>
27998 <refentry version="5.0" id="toc.pointer.graphic">
28000 <refentrytitle>toc.pointer.graphic</refentrytitle>
28001 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
28004 <refname>toc.pointer.graphic</refname>
28005 <refpurpose>Use graphic for TOC pointer?</refpurpose>
28009 <programlisting id="toc.pointer.graphic.frag">
28010 <xsl:param name="toc.pointer.graphic" select="1"></xsl:param>
28014 <refsection><info><title>Description</title></info>
28015 <para>If non-zero, the "pointer" in the TOC will be displayed
28016 with the graphic identified by <varname>toc.pointer.image</varname>.
28018 <para>Only applies with the tabular presentation is being used.</para>
28022 <refentry version="5.0" id="toc.pointer.image">
28024 <refentrytitle>toc.pointer.image</refentrytitle>
28025 <refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo>
28028 <refname>toc.pointer.image</refname>
28029 <refpurpose>The image for the "pointer" in the TOC</refpurpose>
28033 <programlisting id="toc.pointer.image.frag">
28034 <xsl:param name="toc.pointer.image">graphics/arrow.gif</xsl:param>
28038 <refsection><info><title>Description</title></info>
28039 <para>If <varname>toc.pointer.graphic</varname> is non-zero, this image
28040 will be used for the "pointer" in the TOC.</para>
28041 <para>Only applies with the tabular presentation is being used.</para>
28045 <refentry version="5.0" id="toc.pointer.text">
28047 <refentrytitle>toc.pointer.text</refentrytitle>
28048 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
28051 <refname>toc.pointer.text</refname>
28052 <refpurpose>The text for the "pointer" in the TOC</refpurpose>
28056 <programlisting id="toc.pointer.text.frag">
28057 <xsl:param name="toc.pointer.text"> > </xsl:param>
28061 <refsection><info><title>Description</title></info>
28062 <para>If <varname>toc.pointer.graphic</varname> is zero, this text string
28063 will be used to display the "pointer" in the TOC.</para>
28064 <para>Only applies with the tabular presentation is being used.</para>
28068 <refentry version="5.0" id="toc.spacer.graphic">
28070 <refentrytitle>toc.spacer.graphic</refentrytitle>
28071 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
28074 <refname>toc.spacer.graphic</refname>
28075 <refpurpose>Use graphic for TOC spacer?</refpurpose>
28079 <programlisting id="toc.spacer.graphic.frag">
28080 <xsl:param name="toc.spacer.graphic" select="1"></xsl:param>
28084 <refsection><info><title>Description</title></info>
28085 <para>If non-zero, the indentation in the TOC will be accomplished
28086 with the graphic identified by <varname>toc.spacer.image</varname>.
28088 <para>Only applies with the tabular presentation is being used.</para>
28092 <refentry version="5.0" id="toc.spacer.image">
28094 <refentrytitle>toc.spacer.image</refentrytitle>
28095 <refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo>
28098 <refname>toc.spacer.image</refname>
28099 <refpurpose>The image for spacing the TOC</refpurpose>
28103 <programlisting id="toc.spacer.image.frag">
28104 <xsl:param name="toc.spacer.image">graphics/blank.gif</xsl:param>
28108 <refsection><info><title>Description</title></info>
28109 <para>If <varname>toc.spacer.graphic</varname> is non-zero, this image
28110 will be used to indent the TOC.</para>
28111 <para>Only applies with the tabular presentation is being used.</para>
28115 <refentry version="5.0" id="toc.spacer.text">
28117 <refentrytitle>toc.spacer.text</refentrytitle>
28118 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
28121 <refname>toc.spacer.text</refname>
28122 <refpurpose>The text for spacing the TOC</refpurpose>
28126 <programlisting id="toc.spacer.text.frag">
28127 <xsl:param name="toc.spacer.text">   </xsl:param>
28131 <refsection><info><title>Description</title></info>
28132 <para>If <varname>toc.spacer.graphic</varname> is zero, this text string
28133 will be used to indent the TOC.</para>
28134 <para>Only applies with the tabular presentation is being used.</para>
28141 <book id="pi"><title>DocBook XSL Stylesheets User Reference: PIs</title>
28142 <?dbhtml dir="pi"?>
28143 <?dbhtml filename="index.html"?>
28146 <para>This is generated reference documentation for all
28147 user-specifiable processing instructions in the DocBook
28150 <para>You add these PIs at particular points in a document to
28151 cause specific “exceptions” to formatting/output behavior. To
28152 make global changes in formatting/output behavior across an
28153 entire document, it’s better to do it by setting an
28154 appropriate stylesheet parameter (if there is one).</para>
28159 <part id="pi-html">
28160 <info xml:base="../html/pi.xml"><title>HTML Processing Instruction Reference</title>
28161 <releaseinfo role="meta">
28162 $Id: pi.xsl 8394 2009-04-02 20:31:30Z mzjn $
28165 <partintro id="partintro" xml:base="../html/pi.xml">
28166 <title>Introduction</title>
28168 <para>This is generated reference documentation for all
28169 user-specifiable processing instructions (PIs) in the DocBook
28170 XSL stylesheets for HTML output.
28173 <para>You add these PIs at particular points in a document to
28174 cause specific “exceptions” to formatting/output behavior. To
28175 make global changes in formatting/output behavior across an
28176 entire document, it’s better to do it by setting an
28177 appropriate stylesheet parameter (if there is one).</para>
28184 <refentry id="dbhtml_background-color" xml:base="../html/pi.xml">
28186 <refname>dbhtml_background-color</refname>
28187 <refpurpose>Sets background color for an image</refpurpose>
28191 <synopsis><tag class="xmlpi">dbhtml background-color="<replaceable>color</replaceable>"</tag></synopsis>
28194 <refsect1><title>Description</title>
28196 <para>Use the <tag class="xmlpi">dbhtml background-color</tag> PI before or
28197 after an image (<tag>graphic</tag>, <tag>inlinegraphic</tag>,
28198 <tag>imagedata</tag>, or <tag>videodata</tag> element) as a
28199 sibling to the element, to set a background color for the
28202 </refsect1><refsect1><title>Parameters</title>
28205 <varlistentry><term>background-color="<replaceable>color</replaceable>"</term>
28208 <para>An HTML color value</para>
28214 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
28216 <para><link role="tcg" xlink:href="BGcolor.html">Background color</link></para>
28218 </refsect1></refentry>
28220 <refentry id="dbhtml_bgcolor" xml:base="../html/pi.xml">
28222 <refname>dbhtml_bgcolor</refname>
28223 <refpurpose>Sets background color on a CALS table row or table cell</refpurpose>
28227 <synopsis><tag class="xmlpi">dbhtml bgcolor="<replaceable>color</replaceable>"</tag></synopsis>
28230 <refsect1><title>Description</title>
28232 <para>Use the <tag class="xmlpi">dbhtml bgcolor</tag> PI as child of a CALS table row
28233 or cell to set a background color for that table row or cell.</para>
28235 </refsect1><refsect1><title>Parameters</title>
28238 <varlistentry><term>bgcolor="<replaceable>color</replaceable>"</term>
28241 <para>An HTML color value</para>
28247 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
28249 <para><link role="tcg" xlink:href="BGtableColor.html#CellBGColor">Cell background color</link></para>
28251 </refsect1></refentry>
28253 <refentry id="dbhtml_cellpadding" xml:base="../html/pi.xml">
28255 <refname>dbhtml_cellpadding</refname>
28256 <refpurpose>Specifies cellpadding in CALS table or qandaset output</refpurpose>
28260 <synopsis><tag class="xmlpi">dbhtml cellpadding="<replaceable>number</replaceable>"</tag></synopsis>
28263 <refsect1><title>Description</title>
28265 <para>Use the <tag class="xmlpi">dbhtml cellpadding</tag> PI as a child of a
28266 CALS <tag>table</tag> or <tag>qandaset</tag> to specify the value
28267 for the HTML <literal>cellpadding</literal> attribute in the
28268 output HTML table.</para>
28270 </refsect1><refsect1><title>Parameters</title>
28273 <varlistentry><term>cellpadding="<replaceable>number</replaceable>"</term>
28276 <para>Specifies the cellpadding</para>
28282 </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
28284 <para><parameter>html.cellpadding</parameter></para>
28286 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
28288 <para><link role="tcg" xlink:href="CellSpacing.html">Cell spacing and cell padding</link>,
28289 <link role="tcg" xlink:href="QandAformat.html">Q and A formatting</link></para>
28291 </refsect1></refentry>
28293 <refentry id="dbhtml_cellspacing" xml:base="../html/pi.xml">
28295 <refname>dbhtml_cellspacing</refname>
28296 <refpurpose>Specifies cellspacing in CALS table or qandaset output</refpurpose>
28300 <synopsis><tag class="xmlpi">dbhtml cellspacing="<replaceable>number</replaceable>"</tag></synopsis>
28303 <refsect1><title>Description</title>
28305 <para>Use the <tag class="xmlpi">dbhtml cellspacing</tag> PI as a child of a
28306 CALS <tag>table</tag> or <tag>qandaset</tag> to specify the value
28307 for the HTML <literal>cellspacing</literal> attribute in the
28308 output HTML table.</para>
28310 </refsect1><refsect1><title>Parameters</title>
28313 <varlistentry><term>cellspacing="<replaceable>number</replaceable>"</term>
28316 <para>Specifies the cellspacing</para>
28322 </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
28324 <para><parameter>html.cellspacing</parameter></para>
28326 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
28328 <para><link role="tcg" xlink:href="CellSpacing.html">Cell spacing and cell padding</link>,
28329 <link role="tcg" xlink:href="QandAformat.html">Q and A formatting</link></para>
28331 </refsect1></refentry>
28333 <refentry id="dbhtml_class" xml:base="../html/pi.xml">
28335 <refname>dbhtml_class</refname>
28336 <refpurpose>Set value of the class attribute for a CALS table row</refpurpose>
28340 <synopsis><tag class="xmlpi">dbhtml class="<replaceable>name</replaceable>"</tag></synopsis>
28343 <refsect1><title>Description</title>
28345 <para>Use the <tag class="xmlpi">dbhtml class</tag> PI as a child of a
28346 <tag>row</tag> to specify a <literal>class</literal>
28347 attribute and value in the HTML output for that row.</para>
28349 </refsect1><refsect1><title>Parameters</title>
28352 <varlistentry><term>class="<replaceable>name</replaceable>"</term>
28355 <para>Specifies the class name</para>
28361 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
28363 <para><link role="tcg" xlink:href="CSSTableCells.html">Table styles in HTML output</link></para>
28365 </refsect1></refentry>
28367 <refentry id="dbhtml_dir" xml:base="../html/pi.xml">
28369 <refname>dbhtml_dir</refname>
28370 <refpurpose>Specifies a directory name in which to write files</refpurpose>
28374 <synopsis><tag class="xmlpi">dbhtml dir="<replaceable>path</replaceable>"</tag></synopsis>
28377 <refsect1><title>Description</title>
28379 <para>When chunking output, use the <tag class="xmlpi">dbhtml dir</tag> PI
28380 as a child of a chunk source to cause the output of that
28381 chunk to be written to the specified directory; also, use it
28382 as a child of a <tag>mediaobject</tag> to specify a
28383 directory into which any long-description files for that
28384 <tag>mediaobject</tag> will be written.</para>
28386 </refsect1><refsect1><title>Parameters</title>
28389 <varlistentry><term>dir="<replaceable>path</replaceable>"</term>
28392 <para>Specifies the pathname for the directory</para>
28398 </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
28400 <para><parameter>base.dir</parameter></para>
28402 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
28404 <para><link role="tcg" xlink:href="Chunking.html#dbhtmlDirPI">dbhtml dir processing instruction</link></para>
28406 </refsect1></refentry>
28408 <refentry id="dbhtml_filename" xml:base="../html/pi.xml">
28410 <refname>dbhtml_filename</refname>
28411 <refpurpose>Specifies a filename for a chunk</refpurpose>
28415 <synopsis><tag class="xmlpi">dbhtml filename="<replaceable>filename</replaceable>"</tag></synopsis>
28418 <refsect1><title>Description</title>
28420 <para>When chunking output, use the <tag class="xmlpi">dbhtml filename</tag>
28421 PI as a child of a chunk source to specify a filename for
28422 the output file for that chunk.</para>
28424 </refsect1><refsect1><title>Parameters</title>
28427 <varlistentry><term>filename="<replaceable>path</replaceable>"</term>
28430 <para>Specifies the filename for the file</para>
28436 </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
28438 <para><parameter>use.id.as.filename</parameter></para>
28440 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
28442 <para><link role="tcg" xlink:href="Chunking.html#DbhtmlFilenames">dbhtml filenames</link></para>
28444 </refsect1></refentry>
28446 <refentry id="dbhtml_funcsynopsis-style" xml:base="../html/pi.xml">
28448 <refname>dbhtml_funcsynopsis-style</refname>
28449 <refpurpose>Specifies presentation style for a funcsynopsis</refpurpose>
28453 <synopsis><tag class="xmlpi">dbhtml funcsynopsis-style="kr"|"ansi"</tag></synopsis>
28456 <refsect1><title>Description</title>
28458 <para>Use the <tag class="xmlpi">dbhtml funcsynopsis-style</tag> PI as a child of
28459 a <tag>funcsynopsis</tag> or anywhere within a funcsynopsis
28460 to control the presentation style for output of all
28461 <tag>funcprototype</tag> instances within that funcsynopsis.</para>
28463 </refsect1><refsect1><title>Parameters</title>
28466 <varlistentry><term>funcsynopsis-style="kr"</term>
28469 <para>Displays <tag>funcprototype</tag> output in K&R style</para>
28473 <varlistentry><term>funcsynopsis-style="ansi"</term>
28476 <para>Displays <tag>funcprototype</tag> output in ANSI style</para>
28482 </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
28484 <para><parameter>funcsynopsis.style</parameter></para>
28486 </refsect1></refentry>
28488 <refentry id="dbhtml_img.src.path" xml:base="../html/pi.xml">
28490 <refname>dbhtml_img.src.path</refname>
28491 <refpurpose>Specifies a path to the location of an image file</refpurpose>
28495 <synopsis><tag class="xmlpi">dbhtml img.src.path="<replaceable>path</replaceable>"</tag></synopsis>
28498 <refsect1><title>Description</title>
28500 <para>Use the <tag class="xmlpi">dbhtml img.src.path</tag> PI before or
28501 after an image (<tag>graphic</tag>,
28502 <tag>inlinegraphic</tag>, <tag>imagedata</tag>, or
28503 <tag>videodata</tag> element) as a sibling to the element,
28504 to specify a path to the location of the image; in HTML
28505 output, the value specified for the
28506 <code>img.src.path</code> attribute is prepended to the
28509 </refsect1><refsect1><title>Parameters</title>
28512 <varlistentry><term>img.src.path="<replaceable>path</replaceable>"</term>
28515 <para>Specifies the pathname to prepend to the name of the image file</para>
28521 </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
28523 <para><parameter>img.src.path</parameter></para>
28525 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
28527 <para><link role="tcg" xlink:href="GraphicsLocations.html#UsingFileref">Using fileref</link></para>
28529 </refsect1></refentry>
28531 <refentry id="dbhtml_label-width" xml:base="../html/pi.xml">
28533 <refname>dbhtml_label-width</refname>
28534 <refpurpose>Specifies the label width for a qandaset</refpurpose>
28538 <synopsis><tag class="xmlpi">dbhtml label-width="<replaceable>width</replaceable>"</tag></synopsis>
28541 <refsect1><title>Description</title>
28543 <para>Use the <tag class="xmlpi">dbhtml label-width</tag> PI as a child of a
28544 <tag>qandaset</tag> to specify the width of labels.</para>
28546 </refsect1><refsect1><title>Parameters</title>
28549 <varlistentry><term>label-width="<replaceable>width</replaceable>"</term>
28552 <para>Specifies the label width (including units)</para>
28558 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
28560 <para><link role="tcg" xlink:href="QandAformat.html">Q and A formatting</link></para>
28562 </refsect1></refentry>
28564 <refentry id="dbhtml_linenumbering.everyNth" xml:base="../html/pi.xml">
28566 <refname>dbhtml_linenumbering.everyNth</refname>
28567 <refpurpose>Specifies interval for line numbers in verbatims</refpurpose>
28571 <synopsis><tag class="xmlpi">dbhtml linenumbering.everyNth="<replaceable>N</replaceable>"</tag></synopsis>
28574 <refsect1><title>Description</title>
28576 <para>Use the <tag class="xmlpi">dbhtml linenumbering.everyNth</tag> PI as a child
28577 of a “verbatim” element – <tag>programlisting</tag>,
28578 <tag>screen</tag>, <tag>synopsis</tag> — to specify
28579 the interval at which lines are numbered.</para>
28581 </refsect1><refsect1><title>Parameters</title>
28584 <varlistentry><term>linenumbering.everyNth="<replaceable>N</replaceable>"</term>
28587 <para>Specifies numbering interval; a number is output
28588 before every <replaceable>N</replaceable>th line</para>
28594 </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
28596 <para><parameter>linenumbering.everyNth</parameter></para>
28598 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
28600 <para><link role="tcg" xlink:href="AnnotateListing.html#LineNumbering">Line numbering</link></para>
28602 </refsect1></refentry>
28604 <refentry id="dbhtml_linenumbering.separator" xml:base="../html/pi.xml">
28606 <refname>dbhtml_linenumbering.separator</refname>
28607 <refpurpose>Specifies separator text for line numbers in verbatims</refpurpose>
28611 <synopsis><tag class="xmlpi">dbhtml linenumbering.separator="<replaceable>text</replaceable>"</tag></synopsis>
28614 <refsect1><title>Description</title>
28616 <para>Use the <tag class="xmlpi">dbhtml linenumbering.separator</tag> PI as a child
28617 of a “verbatim” element – <tag>programlisting</tag>,
28618 <tag>screen</tag>, <tag>synopsis</tag> — to specify
28619 the separator text output between the line numbers and content.</para>
28621 </refsect1><refsect1><title>Parameters</title>
28624 <varlistentry><term>linenumbering.separator="<replaceable>text</replaceable>"</term>
28627 <para>Specifies the text (zero or more characters)</para>
28633 </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
28635 <para><parameter>linenumbering.separator</parameter></para>
28637 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
28639 <para><link role="tcg" xlink:href="AnnotateListing.html#LineNumbering">Line numbering</link></para>
28641 </refsect1></refentry>
28643 <refentry id="dbhtml_linenumbering.width" xml:base="../html/pi.xml">
28645 <refname>dbhtml_linenumbering.width</refname>
28646 <refpurpose>Specifies width for line numbers in verbatims</refpurpose>
28650 <synopsis><tag class="xmlpi">dbhtml linenumbering.width="<replaceable>width</replaceable>"</tag></synopsis>
28653 <refsect1><title>Description</title>
28655 <para>Use the <tag class="xmlpi">dbhtml linenumbering.width</tag> PI as a child
28656 of a “verbatim” element – <tag>programlisting</tag>,
28657 <tag>screen</tag>, <tag>synopsis</tag> — to specify
28658 the width set aside for line numbers.</para>
28660 </refsect1><refsect1><title>Parameters</title>
28663 <varlistentry><term>linenumbering.width="<replaceable>width</replaceable>"</term>
28666 <para>Specifies the width (inluding units)</para>
28672 </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
28674 <para><parameter>linenumbering.width</parameter></para>
28676 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
28678 <para><link role="tcg" xlink:href="AnnotateListing.html#LineNumbering">Line numbering</link></para>
28680 </refsect1></refentry>
28682 <refentry id="dbhtml_list-presentation" xml:base="../html/pi.xml">
28684 <refname>dbhtml_list-presentation</refname>
28685 <refpurpose>Specifies presentation style for a variablelist or
28686 segmentedlist</refpurpose>
28690 <synopsis><tag class="xmlpi">dbhtml list-presentation="list"|"table"</tag></synopsis>
28693 <refsect1><title>Description</title>
28695 <para>Use the <tag class="xmlpi">dbhtml list-presentation</tag> PI as a child of
28696 a <tag>variablelist</tag> or <tag>segmentedlist</tag> to
28697 control the presentation style for the list (to cause it, for
28698 example, to be displayed as a table).</para>
28700 </refsect1><refsect1><title>Parameters</title>
28703 <varlistentry><term>list-presentation="list"</term>
28706 <para>Displays the list as a list</para>
28710 <varlistentry><term>list-presentation="table"</term>
28713 <para>Displays the list as a table</para>
28719 </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
28724 <para><parameter>variablelist.as.table</parameter></para>
28729 <para><parameter>segmentedlist.as.table</parameter></para>
28734 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
28736 <para><link role="tcg" xlink:href="Variablelists.html#VarListFormatting">Variable list formatting in HTML</link></para>
28738 </refsect1></refentry>
28740 <refentry id="dbhtml_list-width" xml:base="../html/pi.xml">
28742 <refname>dbhtml_list-width</refname>
28743 <refpurpose>Specifies the width of a variablelist or simplelist</refpurpose>
28747 <synopsis><tag class="xmlpi">dbhtml list-width="<replaceable>width</replaceable>"</tag></synopsis>
28750 <refsect1><title>Description</title>
28752 <para>Use the <tag class="xmlpi">dbhtml list-width</tag> PI as a child of a
28753 <tag>variablelist</tag> or a <tag>simplelist</tag> presented
28754 as a table, to specify the output width.</para>
28756 </refsect1><refsect1><title>Parameters</title>
28759 <varlistentry><term>list-width="<replaceable>width</replaceable>"</term>
28762 <para>Specifies the output width (including units)</para>
28768 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
28770 <para><link role="tcg" xlink:href="Variablelists.html#VarListFormatting">Variable list formatting in HTML</link></para>
28772 </refsect1></refentry>
28774 <refentry id="dbhtml_row-height" xml:base="../html/pi.xml">
28776 <refname>dbhtml_row-height</refname>
28777 <refpurpose>Specifies the height for a CALS table row</refpurpose>
28781 <synopsis><tag class="xmlpi">dbhtml row-height="<replaceable>height</replaceable>"</tag></synopsis>
28784 <refsect1><title>Description</title>
28786 <para>Use the <tag class="xmlpi">dbhtml row-height</tag> PI as a child of a
28787 <tag>row</tag> to specify the height of the row.</para>
28789 </refsect1><refsect1><title>Parameters</title>
28792 <varlistentry><term>row-height="<replaceable>height</replaceable>"</term>
28795 <para>Specifies the row height (including units)</para>
28801 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
28803 <para><link role="tcg" xlink:href="RowHeight.html">Row height</link></para>
28805 </refsect1></refentry>
28807 <refentry id="dbhtml_start" xml:base="../html/pi.xml">
28809 <refname>dbhtml_start</refname>
28810 <refpurpose>(obsolete) Sets the starting number on an ordered list</refpurpose>
28814 <synopsis><tag class="xmlpi">dbhtml start="<replaceable>character</replaceable>"</tag></synopsis>
28817 <refsect1><title>Description</title>
28819 <para><emphasis>This PI is obsolete</emphasis>. The intent of
28820 this PI was to provide a means for setting a specific starting
28821 number for an ordered list. Instead of this PI, set a value
28822 for the <literal>override</literal> attribute on the first
28823 <tag>listitem</tag> in the list; that will have the same
28824 effect as what this PI was intended for.</para>
28826 </refsect1><refsect1><title>Parameters</title>
28829 <varlistentry><term>start="<replaceable>character</replaceable>"</term>
28832 <para>Specifies the character to use as the starting
28833 number; use 0-9, a-z, A-Z, or lowercase or uppercase
28834 Roman numerals</para>
28840 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
28842 <para><link role="tcg" xlink:href="Orderedlists.html#ListStartNum">List starting number</link></para>
28844 </refsect1></refentry>
28846 <refentry id="dbhtml_stop-chunking" xml:base="../html/pi.xml">
28848 <refname>dbhtml_stop-chunking</refname>
28849 <refpurpose>Do not chunk any descendants of this element.</refpurpose>
28853 <synopsis><tag class="xmlpi">dbhtml stop-chunking</tag></synopsis>
28856 <refsect1><title>Description</title>
28858 <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:
28859 <programlisting><section>
28860 <title>Configuring pencil</title>
28861 <?dbhtml stop-chunking?>
28865 </section></programlisting>
28868 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
28870 <para><link role="tcg" xlink:href="Chunking.html">Chunking into multiple HTML files</link></para>
28872 </refsect1></refentry>
28874 <refentry id="dbhtml_table-summary" xml:base="../html/pi.xml">
28876 <refname>dbhtml_table-summary</refname>
28877 <refpurpose>Specifies summary for CALS table, variablelist, segmentedlist, or qandaset output</refpurpose>
28881 <synopsis><tag class="xmlpi">dbhtml table-summary="<replaceable>text</replaceable>"</tag></synopsis>
28884 <refsect1><title>Description</title>
28886 <para>Use the <tag class="xmlpi">dbhtml table-summary</tag> PI as a child of
28887 a CALS <tag>table</tag>, <tag>variablelist</tag>,
28888 <tag>segmentedlist</tag>, or <tag>qandaset</tag> to specify
28889 the text for the HTML <literal>summary</literal> attribute
28890 in the output HTML table.</para>
28892 </refsect1><refsect1><title>Parameters</title>
28895 <varlistentry><term>table-summary="<replaceable>text</replaceable>"</term>
28898 <para>Specifies the summary text (zero or more characters)</para>
28904 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
28906 <para><link role="tcg" xlink:href="Variablelists.html#VarListFormatting">Variable list formatting in HTML</link>,
28907 <link role="tcg" xlink:href="TableSummary.html">Table summary text</link></para>
28909 </refsect1></refentry>
28911 <refentry id="dbhtml_table-width" xml:base="../html/pi.xml">
28913 <refname>dbhtml_table-width</refname>
28914 <refpurpose>Specifies the width for a CALS table</refpurpose>
28918 <synopsis><tag class="xmlpi">dbhtml table-width="<replaceable>width</replaceable>"</tag></synopsis>
28921 <refsect1><title>Description</title>
28923 <para>Use the <tag class="xmlpi">dbhtml table-width</tag> PI as a child of a
28924 CALS <tag>table</tag> to specify the width of the table in
28927 </refsect1><refsect1><title>Parameters</title>
28930 <varlistentry><term>table-width="<replaceable>width</replaceable>"</term>
28933 <para>Specifies the table width (including units or as a percentage)</para>
28939 </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
28941 <para><parameter>default.table.width</parameter></para>
28943 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
28945 <para><link role="tcg" xlink:href="Tables.html#TableWidth">Table width</link></para>
28947 </refsect1></refentry>
28949 <refentry id="dbhtml_term-presentation" xml:base="../html/pi.xml">
28951 <refname>dbhtml_term-presentation</refname>
28952 <refpurpose>Sets character formatting for terms in a variablelist</refpurpose>
28956 <synopsis><tag class="xmlpi">dbhtml term-presentation="bold"|"italic"|"bold-italic"</tag></synopsis>
28959 <refsect1><title>Description</title>
28961 <para>Use the <tag class="xmlpi">dbhtml term-presentation</tag> PI as a child
28962 of a <tag>variablelist</tag> to set character formatting for
28963 the <tag>term</tag> output of the list.</para>
28965 </refsect1><refsect1><title>Parameters</title>
28968 <varlistentry><term>term-presentation="<replaceable>bold</replaceable>"</term>
28971 <para>Specifies that terms are displayed in bold</para>
28975 <varlistentry><term>term-presentation="<replaceable>italic</replaceable>"</term>
28978 <para>Specifies that terms are displayed in italic</para>
28982 <varlistentry><term>term-presentation="<replaceable>bold-italic</replaceable>"</term>
28985 <para>Specifies that terms are displayed in bold-italic</para>
28991 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
28993 <para><link role="tcg" xlink:href="Variablelists.html#VarListFormatting">Variable list formatting in HTML</link></para>
28995 </refsect1></refentry>
28997 <refentry id="dbhtml_term-separator" xml:base="../html/pi.xml">
28999 <refname>dbhtml_term-separator</refname>
29000 <refpurpose>Specifies separator text among terms in a varlistentry</refpurpose>
29004 <synopsis><tag class="xmlpi">dbhtml term-separator="<replaceable>text</replaceable>"</tag></synopsis>
29007 <refsect1><title>Description</title>
29009 <para>Use the <tag class="xmlpi">dbhtml term-separator</tag> PI as a child
29010 of a <tag>variablelist</tag> to specify the separator text
29011 among <tag>term</tag> instances.</para>
29013 </refsect1><refsect1><title>Parameters</title>
29016 <varlistentry><term>term-separator="<replaceable>text</replaceable>"</term>
29019 <para>Specifies the text (zero or more characters)</para>
29025 </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
29027 <para><parameter>variablelist.term.separator</parameter></para>
29029 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
29031 <para><link role="tcg" xlink:href="Variablelists.html#VarListFormatting">Variable list formatting in HTML</link></para>
29033 </refsect1></refentry>
29035 <refentry id="dbhtml_term-width" xml:base="../html/pi.xml">
29037 <refname>dbhtml_term-width</refname>
29038 <refpurpose>Specifies the term width for a variablelist</refpurpose>
29042 <synopsis><tag class="xmlpi">dbhtml term-width="<replaceable>width</replaceable>"</tag></synopsis>
29045 <refsect1><title>Description</title>
29047 <para>Use the <tag class="xmlpi">dbhtml term-width</tag> PI as a child of a
29048 <tag>variablelist</tag> to specify the width for
29049 <tag>term</tag> output.</para>
29051 </refsect1><refsect1><title>Parameters</title>
29054 <varlistentry><term>term-width="<replaceable>width</replaceable>"</term>
29057 <para>Specifies the term width (including units)</para>
29063 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
29065 <para><link role="tcg" xlink:href="Variablelists.html#VarListFormatting">Variable list formatting in HTML</link></para>
29067 </refsect1></refentry>
29069 <refentry id="dbhtml_toc" xml:base="../html/pi.xml">
29071 <refname>dbhtml_toc</refname>
29072 <refpurpose>Specifies whether a TOC should be generated for a qandaset</refpurpose>
29076 <synopsis><tag class="xmlpi">dbhtml toc="0"|"1"</tag></synopsis>
29079 <refsect1><title>Description</title>
29081 <para>Use the <tag class="xmlpi">dbhtml toc</tag> PI as a child of a
29082 <tag>qandaset</tag> to specify whether a table of contents
29083 (TOC) is generated for the <tag>qandaset</tag>.</para>
29085 </refsect1><refsect1><title>Parameters</title>
29088 <varlistentry><term>toc="0"</term>
29091 <para>If zero, no TOC is generated</para>
29095 <varlistentry><term>toc="1"</term>
29098 <para>If <code>1</code> (or any non-zero value),
29099 a TOC is generated</para>
29105 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
29107 <para><link role="tcg" xlink:href="QandAtoc.html">Q and A list of questions</link>,
29108 <link role="tcg" xlink:href="QandAformat.html">Q and A formatting</link></para>
29110 </refsect1></refentry>
29112 <refentry id="dbcmdlist" xml:base="../html/pi.xml">
29114 <refname>dbcmdlist</refname>
29115 <refpurpose>Generates a hyperlinked list of commands</refpurpose>
29119 <synopsis><tag class="xmlpi">dbcmdlist</tag></synopsis>
29122 <refsect1><title>Description</title>
29124 <para>Use the <tag class="xmlpi">dbcmdlist</tag> PI as the child of any
29125 element (for example, <tag>refsynopsisdiv</tag>) containing multiple
29126 <tag>cmdsynopsis</tag> instances; a hyperlinked navigational
29127 “command list” will be generated at the top of output for that
29128 element, enabling users to quickly jump
29129 to each command synopsis.</para>
29131 </refsect1><refsect1><title>Parameters</title>
29133 <para>[No parameters]</para>
29135 </refsect1></refentry>
29137 <refentry id="dbfunclist" xml:base="../html/pi.xml">
29139 <refname>dbfunclist</refname>
29140 <refpurpose>Generates a hyperlinked list of functions</refpurpose>
29144 <synopsis><tag class="xmlpi">dbfunclist</tag></synopsis>
29147 <refsect1><title>Description</title>
29149 <para>Use the <tag class="xmlpi">dbfunclist</tag> PI as the child of any
29150 element (for example, <tag>refsynopsisdiv</tag>) containing multiple
29151 <tag>funcsynopsis</tag> instances; a hyperlinked
29152 navigational “function list” will be generated at the top of
29153 output for that element, enabling users to quickly
29154 jump to to each function synopsis.</para>
29156 </refsect1><refsect1><title>Parameters</title>
29158 <para>[No parameters]</para>
29160 </refsect1></refentry>
29162 <refentry id="dbhtml-include_href" xml:base="../html/pi.xml">
29164 <refname>dbhtml-include_href</refname>
29165 <refpurpose>Copies an external well-formed HTML/XML file into current doc</refpurpose>
29169 <synopsis><tag class="xmlpi">dbhtml-include href="<replaceable>URI</replaceable>"</tag></synopsis>
29172 <refsect1><title>Description</title>
29174 <para>Use the <tag class="xmlpi">dbhtml-include href</tag> PI anywhere in a
29175 document to cause the contents of the file referenced by the
29176 <code>href</code> pseudo-attribute to be copied/inserted “as
29177 is” into your HTML output at the point in document order
29178 where the PI occurs in the source.</para>
29182 <para>The referenced file may contain plain text (as long as
29183 it is “wrapped” in an <tag>html</tag> element — see the
29184 note below) or markup in any arbitrary vocabulary,
29185 including HTML — but it must conform to XML
29186 well-formedness constraints (because the feature in XSLT
29187 1.0 for opening external files, the
29188 <function>document()</function> function, can only handle
29189 files that meet XML well-formedness constraints).</para>
29192 <para>Among other things, XML well-formedness constraints
29193 require a document to have <emphasis>a single root
29194 element</emphasis>. So if the content you want to
29195 include is plain text or is markup that does
29196 <emphasis>not</emphasis> have a single root element,
29197 <emphasis role="strong">wrap the content in an
29198 <tag>html</tag> element</emphasis>. The stylesheets will
29199 strip out that surrounding <tag>html</tag> “wrapper” when
29200 they find it, leaving just the content you want to
29204 </refsect1><refsect1><title>Parameters</title>
29207 <varlistentry><term>href="<replaceable>URI</replaceable>"</term>
29210 <para>Specifies the URI for the file to include; the URI
29211 can be, for example, a remote <literal>http:</literal>
29212 URI, or a local filesystem <literal>file:</literal>
29219 </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
29221 <para><parameter>textinsert.extension</parameter></para>
29223 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
29225 <para><link role="tcg" xlink:href="InsertExtHtml.html">Inserting external HTML code</link>,
29226 <link role="tcg" xlink:href="ExternalCode.html">External code files</link></para>
29228 </refsect1></refentry>
29230 <refentry id="dbhh" xml:base="../html/pi.xml">
29232 <refname>dbhh</refname>
29233 <refpurpose>Sets topic name and topic id for context-sensitive HTML Help</refpurpose>
29237 <synopsis><tag class="xmlpi">dbhh topicname="<replaceable>name</replaceable>" topicid="<replaceable>id</replaceable>"</tag></synopsis>
29240 <refsect1><title>Description</title>
29242 <para>Use the <tag class="xmlpi">dbhh</tag> PI as a child of components
29243 that should be used as targets for context-sensitive help requests.</para>
29245 </refsect1><refsect1><title>Parameters</title>
29248 <varlistentry><term>topicname="<replaceable>name</replaceable>"</term>
29251 <para>Specifies a unique string constant that identifies a help topic</para>
29255 <varlistentry><term>topicid="<replaceable>id</replaceable>"</term>
29258 <para>Specifies a unique integer value for the <literal>topicname</literal> string</para>
29264 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
29266 <para><link role="tcg" xlink:href="HtmlHelp.html#HHContextHelp">Context-sensitive help</link></para>
29268 </refsect1></refentry>
29272 <info xml:base="../fo/pi.xml"><title>FO Processing Instruction Reference</title>
29273 <releaseinfo role="meta">
29274 $Id: pi.xsl 8487 2009-07-14 21:43:36Z bobstayton $
29278 <partintro id="partintro" xml:base="../fo/pi.xml">
29279 <title>Introduction</title>
29282 <para>This is generated reference documentation for all
29283 user-specifiable processing instructions (PIs) in the DocBook
29284 XSL stylesheets for FO output.
29287 <para>You add these PIs at particular points in a document to
29288 cause specific “exceptions” to formatting/output behavior. To
29289 make global changes in formatting/output behavior across an
29290 entire document, it’s better to do it by setting an
29291 appropriate stylesheet parameter (if there is one).</para>
29298 <refentry id="dbfo_background-color" xml:base="../fo/pi.xml">
29300 <refname>dbfo_background-color</refname>
29301 <refpurpose>Sets background color for an image</refpurpose>
29305 <synopsis><tag class="xmlpi">dbfo background-color="<replaceable>color</replaceable>"</tag></synopsis>
29308 <refsect1><title>Description</title>
29310 <para>Use the <tag class="xmlpi">dbfo background-color</tag> PI before or
29311 after an image (<tag>graphic</tag>, <tag>inlinegraphic</tag>,
29312 <tag>imagedata</tag>, or <tag>videodata</tag> element) as a
29313 sibling to the element, to set a background color for the
29316 </refsect1><refsect1><title>Parameters</title>
29319 <varlistentry><term>background-color="<replaceable>color</replaceable>"</term>
29322 <para>An HTML color value</para>
29328 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
29330 <para><link role="tcg" xlink:href="BGcolor.html">Background color</link></para>
29332 </refsect1></refentry>
29334 <refentry id="dbfo_bgcolor" xml:base="../fo/pi.xml">
29336 <refname>dbfo_bgcolor</refname>
29337 <refpurpose>Sets background color on a table row or table cell</refpurpose>
29341 <synopsis><tag class="xmlpi">dbfo bgcolor="<replaceable>color</replaceable>"</tag></synopsis>
29344 <refsect1><title>Description</title>
29346 <para>Use the <tag class="xmlpi">dbfo bgcolor</tag> PI as child of a table row
29347 or cell to set a background color for that table row or cell.</para>
29350 <para>This PI works for both CALS and HTML tables.</para>
29352 </refsect1><refsect1><title>Parameters</title>
29355 <varlistentry><term>bgcolor="<replaceable>color</replaceable>"</term>
29358 <para>An HTML color value</para>
29364 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
29366 <para><link role="tcg" xlink:href="BGtableColor.html#CellBGColor">Cell background color</link></para>
29368 </refsect1></refentry>
29370 <refentry id="dbfo_float-type" xml:base="../fo/pi.xml">
29372 <refname>dbfo_float-type</refname>
29373 <refpurpose>Specifies float behavior for a sidebar</refpurpose>
29377 <synopsis><tag class="xmlpi">dbfo float-type="margin.note"</tag></synopsis>
29380 <refsect1><title>Description</title>
29382 <para>Use the <tag class="xmlpi">dbfo float-type</tag> PI to specify the float
29383 behavior for a <tag>sidebar</tag> (to cause the sidebar to be
29384 displayed as a marginal note).</para>
29386 </refsect1><refsect1><title>Parameters</title>
29389 <varlistentry><term>float-type="margin.note"</term>
29392 <para>Specifies that the <tag>sidebar</tag> should be
29393 displayed as a marginal note.</para>
29399 </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
29401 <para><parameter>sidebar.float.type</parameter> (parameter),
29402 <parameter>sidebar.float.width</parameter> (parameter),
29403 <parameter>sidebar.properties</parameter> (attribute-set),
29404 <parameter>sidebar.title.properties</parameter> (attribute-set)
29407 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
29409 <para><link role="tcg" xlink:href="SideFloats.html#SidebarFloats">A sidebar as
29410 side float</link></para>
29412 </refsect1></refentry>
29414 <refentry id="dbfo_funcsynopsis-style" xml:base="../fo/pi.xml">
29416 <refname>dbfo_funcsynopsis-style</refname>
29417 <refpurpose>Specifies presentation style for a funcsynopsis</refpurpose>
29421 <synopsis><tag class="xmlpi">dbfo funcsynopsis-style="kr"|"ansi"</tag></synopsis>
29424 <refsect1><title>Description</title>
29426 <para>Use the <tag class="xmlpi">dbfo funcsynopsis-style</tag> PI as a child of
29427 a <tag>funcsynopsis</tag> or anywhere within a funcsynopsis
29428 to control the presentation style for output of all
29429 <tag>funcprototype</tag> instances within that funcsynopsis.</para>
29431 </refsect1><refsect1><title>Parameters</title>
29434 <varlistentry><term>funcsynopsis-style="kr"</term>
29437 <para>Displays <tag>funcprototype</tag> output in K&R style</para>
29441 <varlistentry><term>funcsynopsis-style="ansi"</term>
29444 <para>Displays <tag>funcprototype</tag> output in ANSI style</para>
29450 </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
29452 <para><parameter>funcsynopsis.style</parameter></para>
29454 </refsect1></refentry>
29456 <refentry id="dbfo_glossary-presentation" xml:base="../fo/pi.xml">
29458 <refname>dbfo_glossary-presentation</refname>
29459 <refpurpose>Specifies presentation style for a glossary</refpurpose>
29463 <synopsis><tag class="xmlpi">dbfo glossary-presentation="list"|"blocks"</tag></synopsis>
29466 <refsect1><title>Description</title>
29468 <para>Use the <tag class="xmlpi">dbfo glossary-presentation</tag> PI as a child of
29469 a <tag>glossary</tag> to control its presentation style.</para>
29471 </refsect1><refsect1><title>Parameters</title>
29474 <varlistentry><term>glossary-presentation="list"</term>
29477 <para>Displays the glossary as a list</para>
29481 <varlistentry><term>glossary-presentation="blocks"</term>
29484 <para>Displays the glossary as blocks</para>
29490 </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
29492 <para><parameter>glossary.as.blocks</parameter></para>
29494 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
29496 <para><link role="tcg" xlink:href="Glossaries.html#GlossaryFormatPrint">Glossary
29497 formatting in print</link></para>
29499 </refsect1></refentry>
29501 <refentry id="dbfo_glosslist-presentation" xml:base="../fo/pi.xml">
29503 <refname>dbfo_glosslist-presentation</refname>
29504 <refpurpose>Specifies presentation style for a glosslist</refpurpose>
29508 <synopsis><tag class="xmlpi">dbfo glosslist-presentation="list"|"blocks"</tag></synopsis>
29511 <refsect1><title>Description</title>
29513 <para>Use the <tag class="xmlpi">dbfo glosslist-presentation</tag> PI as a child of
29514 a <tag>glosslist</tag> to control its presentation style.</para>
29516 </refsect1><refsect1><title>Parameters</title>
29519 <varlistentry><term>glosslist-presentation="list"</term>
29522 <para>Displays the glosslist as a list</para>
29526 <varlistentry><term>glosslist-presentation="blocks"</term>
29529 <para>Displays the glosslist as blocks</para>
29535 </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
29537 <para><parameter>glosslist.as.blocks</parameter> </para>
29539 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
29541 <para><link role="tcg" xlink:href="Glossaries.html#GlossaryFormatPrint">Glossary
29542 formatting in print</link></para>
29544 </refsect1></refentry>
29546 <refentry id="dbfo_glossterm-width" xml:base="../fo/pi.xml">
29548 <refname>dbfo_glossterm-width</refname>
29549 <refpurpose>Specifies the glossterm width for a glossary or
29550 glosslist</refpurpose>
29554 <synopsis><tag class="xmlpi">dbfo glossterm-width="<replaceable>width</replaceable>"</tag></synopsis>
29557 <refsect1><title>Description</title>
29559 <para>Use the <tag class="xmlpi">dbfo glossterm-width</tag> PI as a child of a
29560 <tag>glossary</tag> or <tag>glosslist</tag> to specify the
29561 width for output of <tag>glossterm</tag> instances in the
29564 </refsect1><refsect1><title>Parameters</title>
29567 <varlistentry><term>glossterm-width="<replaceable>width</replaceable>"</term>
29570 <para>Specifies the glossterm width (including units)</para>
29576 </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
29578 <para><parameter>glossterm.width</parameter>,
29579 <parameter>glossterm.separation</parameter>
29582 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
29584 <para><link role="tcg" xlink:href="Glossaries.html#GlossaryFormatPrint">Glossary
29585 formatting in print</link></para>
29587 </refsect1></refentry>
29589 <refentry id="dbfo_keep-together" xml:base="../fo/pi.xml">
29591 <refname>dbfo_keep-together</refname>
29592 <refpurpose>Specifies “keep” behavior for a table, example,
29593 figure, equation, procedure, or task</refpurpose>
29597 <synopsis><tag class="xmlpi">dbfo keep-together="auto"|"always"</tag></synopsis>
29600 <refsect1><title>Description</title>
29602 <para>Use the <tag class="xmlpi">dbfo keep-together</tag> PI as a child of a
29603 formal object (<tag>table</tag>, <tag>example</tag>,
29604 <tag>figure</tag>, <tag>equation</tag>, <tag>procedure</tag>, or
29605 <tag>task</tag>) to specify “keep” behavior (to allow the object to
29606 “break” across a page).</para>
29609 <para>The PI also works with <tag>informaltable</tag>, <tag>informalexample</tag>,
29610 <tag>informalfigure</tag> and <tag>informalequation</tag>.
29614 </refsect1><refsect1><title>Parameters</title>
29617 <varlistentry><term>keep-together="auto"</term>
29620 <para>Enables the object to break across a page</para>
29624 <varlistentry><term>keep-together="always"</term>
29627 <para>Prevents the object from breaking across a page (the
29628 default stylesheet behavior)</para>
29634 </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
29636 <para>formal.object.properties</para>
29638 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
29640 <para><link role="tcg" xlink:href="PageBreaking.html#KeepTogetherPI">Keep-together processing instruction</link></para>
29642 </refsect1></refentry>
29644 <refentry id="dbfo_label-width" xml:base="../fo/pi.xml">
29646 <refname>dbfo_label-width</refname>
29647 <refpurpose>Specifies the label width for a qandaset, itemizedlist, orderedlist
29648 or calloutlist</refpurpose>
29652 <synopsis><tag class="xmlpi">dbfo label-width="<replaceable>width</replaceable>"</tag></synopsis>
29655 <refsect1><title>Description</title>
29657 <para>Use the <tag class="xmlpi">dbfo label-width</tag> PI as a child of a
29658 <tag>qandaset</tag>, <tag>itemizedlist</tag>, <tag>orderedlist</tag>,
29659 or <tag>calloutlist</tag> to specify the width of labels.</para>
29661 </refsect1><refsect1><title>Parameters</title>
29664 <varlistentry><term>label-width="<replaceable>width</replaceable>"</term>
29667 <para>Specifies the label width (including units)</para>
29673 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
29675 <para><link role="tcg" xlink:href="QandAformat.html">Q and A formatting</link></para>
29677 </refsect1></refentry>
29679 <refentry id="dbfo_linenumbering.everyNth" xml:base="../fo/pi.xml">
29681 <refname>dbfo_linenumbering.everyNth</refname>
29682 <refpurpose>Specifies interval for line numbers in verbatims</refpurpose>
29686 <synopsis><tag class="xmlpi">dbfo linenumbering.everyNth="<replaceable>N</replaceable>"</tag></synopsis>
29689 <refsect1><title>Description</title>
29691 <para>Use the <tag class="xmlpi">dbfo linenumbering.everyNth</tag> PI as a child
29692 of a “verbatim” element – <tag>programlisting</tag>,
29693 <tag>screen</tag>, <tag>synopsis</tag> — to specify
29694 the interval at which lines are numbered.</para>
29696 </refsect1><refsect1><title>Parameters</title>
29699 <varlistentry><term>linenumbering.everyNth="<replaceable>N</replaceable>"</term>
29702 <para>Specifies numbering interval; a number is output
29703 before every <replaceable>N</replaceable>th line</para>
29709 </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
29711 <para><parameter>linenumbering.everyNth</parameter></para>
29713 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
29715 <para><link role="tcg" xlink:href="AnnotateListing.html#LineNumbering">Line numbering</link></para>
29717 </refsect1></refentry>
29719 <refentry id="dbfo_linenumbering.separator" xml:base="../fo/pi.xml">
29721 <refname>dbfo_linenumbering.separator</refname>
29722 <refpurpose>Specifies separator text for line numbers in verbatims</refpurpose>
29726 <synopsis><tag class="xmlpi">dbfo linenumbering.separator="<replaceable>text</replaceable>"</tag></synopsis>
29729 <refsect1><title>Description</title>
29731 <para>Use the <tag class="xmlpi">dbfo linenumbering.separator</tag> PI as a child
29732 of a “verbatim” element – <tag>programlisting</tag>,
29733 <tag>screen</tag>, <tag>synopsis</tag> — to specify
29734 the separator text output between the line numbers and content.</para>
29736 </refsect1><refsect1><title>Parameters</title>
29739 <varlistentry><term>linenumbering.separator="<replaceable>text</replaceable>"</term>
29742 <para>Specifies the text (zero or more characters)</para>
29748 </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
29750 <para><parameter>linenumbering.separator</parameter></para>
29752 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
29754 <para><link role="tcg" xlink:href="AnnotateListing.html#LineNumbering">Line numbering</link></para>
29756 </refsect1></refentry>
29758 <refentry id="dbfo_linenumbering.width" xml:base="../fo/pi.xml">
29760 <refname>dbfo_linenumbering.width</refname>
29761 <refpurpose>Specifies width for line numbers in verbatims</refpurpose>
29765 <synopsis><tag class="xmlpi">dbfo linenumbering.width="<replaceable>width</replaceable>"</tag></synopsis>
29768 <refsect1><title>Description</title>
29770 <para>Use the <tag class="xmlpi">dbfo linenumbering.width</tag> PI as a child
29771 of a “verbatim” element – <tag>programlisting</tag>,
29772 <tag>screen</tag>, <tag>synopsis</tag> — to specify
29773 the width set aside for line numbers.</para>
29775 </refsect1><refsect1><title>Parameters</title>
29778 <varlistentry><term>linenumbering.width="<replaceable>width</replaceable>"</term>
29781 <para>Specifies the width (inluding units)</para>
29787 </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
29789 <para><parameter>linenumbering.width</parameter></para>
29791 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
29793 <para><link role="tcg" xlink:href="AnnotateListing.html#LineNumbering">Line numbering</link></para>
29795 </refsect1></refentry>
29797 <refentry id="dbfo_list-presentation" xml:base="../fo/pi.xml">
29799 <refname>dbfo_list-presentation</refname>
29800 <refpurpose>Specifies presentation style for a variablelist or
29801 segmentedlist</refpurpose>
29805 <synopsis><tag class="xmlpi">dbfo list-presentation="list"|"blocks"|"table"</tag></synopsis>
29808 <refsect1><title>Description</title>
29810 <para>Use the <tag class="xmlpi">dbfo list-presentation</tag> PI as a child of
29811 a <tag>variablelist</tag> or <tag>segmentedlist</tag> to
29812 control the presentation style for the list (to cause it, for
29813 example, to be displayed as a table).</para>
29815 </refsect1><refsect1><title>Parameters</title>
29818 <varlistentry><term>list-presentation="list"</term>
29821 <para>Displays the list as a list</para>
29825 <varlistentry><term>list-presentation="blocks"</term>
29828 <para>(<tag>variablelist</tag> only) Displays the list as blocks</para>
29832 <varlistentry><term>list-presentation="table"</term>
29835 <para>(<tag>segmentedlist</tag> only) Displays the list as a table</para>
29841 </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
29846 <para><parameter>variablelist.as.blocks</parameter></para>
29851 <para><parameter>variablelist.as.table</parameter></para>
29856 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
29858 <para><link role="tcg" xlink:href="Variablelists.html#ListIndents">Variable list formatting in print</link></para>
29860 </refsect1></refentry>
29862 <refentry id="dbfo_list-width" xml:base="../fo/pi.xml">
29864 <refname>dbfo_list-width</refname>
29865 <refpurpose>Specifies the width of a horizontal simplelist</refpurpose>
29869 <synopsis><tag class="xmlpi">dbfo list-width="<replaceable>width</replaceable>"</tag></synopsis>
29872 <refsect1><title>Description</title>
29874 <para>Use the <tag class="xmlpi">dbfo list-width</tag> PI as a child of a
29875 <tag>simplelist</tag> whose <tag class="attribute">class</tag>
29876 value is <literal>horizontal</literal>, to specify the width
29877 of the <tag>simplelist</tag>.</para>
29879 </refsect1><refsect1><title>Parameters</title>
29882 <varlistentry><term>list-width="<replaceable>width</replaceable>"</term>
29885 <para>Specifies the <tag>simplelist</tag> width (including units)</para>
29891 </refsect1></refentry>
29893 <refentry id="dbfo_orientation" xml:base="../fo/pi.xml">
29895 <refname>dbfo_orientation</refname>
29896 <refpurpose>Specifies the orientation for a CALS table row or cell</refpurpose>
29900 <synopsis><tag class="xmlpi">dbfo orientation="0"|"90"|"180"|"270"|"-90"|"-180"|"-270"</tag></synopsis>
29903 <refsect1><title>Description</title>
29905 <para>Use the <tag class="xmlpi">dbfo orientation</tag> PI as a child of a CALS
29906 <tag>table</tag> row or cell to specify the orientation
29907 (rotation) for the row or cell.</para>
29909 </refsect1><refsect1><title>Parameters</title>
29912 <varlistentry><term>orientation="0"|"90"|"180"|"270"|"-90"|"-180"|"-270"</term>
29915 <para>Specifies the number of degrees by which the cell or
29916 row is rotated</para>
29922 </refsect1></refentry>
29924 <refentry id="dbfo_pgwide" xml:base="../fo/pi.xml">
29926 <refname>dbfo_pgwide</refname>
29927 <refpurpose>Specifies if an <tag>equation</tag> or <tag>example</tag> goes across full page width</refpurpose>
29931 <synopsis><tag class="xmlpi">dbfo pgwide="0"|"1"</tag></synopsis>
29934 <refsect1><title>Description</title>
29936 <para>Use the <tag class="xmlpi">dbfo pgwide</tag> PI as a child of an
29937 <tag>equation</tag> or <tag>example</tag> to specify that the
29938 content should rendered across the full width of the page.</para>
29940 </refsect1><refsect1><title>Parameters</title>
29943 <varlistentry><term>pgwide="0"</term>
29946 <para>If zero, the content is rendered across the current
29951 <varlistentry><term>pgwide="1"</term>
29954 <para>If <code>1</code> (or any non-zero value), the
29955 content is rendered across the full width of the page</para>
29961 </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
29963 <para><parameter>pgwide.properties</parameter></para>
29965 </refsect1></refentry>
29967 <refentry id="dbfo_rotated-width" xml:base="../fo/pi.xml">
29969 <refname>dbfo_rotated-width</refname>
29970 <refpurpose>Specifies the width for a CALS table <tag>entry</tag> or
29971 <tag>row</tag></refpurpose>
29975 <synopsis><tag class="xmlpi">dbfo rotated-width="<replaceable>width</replaceable>"</tag></synopsis>
29978 <refsect1><title>Description</title>
29980 <para>Use the <tag class="xmlpi">dbfo rotated-width</tag> PI as a child of
29981 <tag>entry</tag> or <tag>row</tag> instance in a CALS table to specify the
29982 width of that the <tag>entry</tag> or <tag>row</tag>; or
29983 use it higher up in table to cause the width to be inherited
29984 recursively down.</para>
29986 </refsect1><refsect1><title>Parameters</title>
29989 <varlistentry><term>rotated-width="<replaceable>width</replaceable>"</term>
29992 <para>Specifies the width of a row or cell (including units)</para>
29998 </refsect1></refentry>
30000 <refentry id="dbfo_sidebar-width" xml:base="../fo/pi.xml">
30002 <refname>dbfo_sidebar-width</refname>
30003 <refpurpose>Specifies the width of a sidebar</refpurpose>
30007 <synopsis><tag class="xmlpi">dbfo sidebar-width="<replaceable>width</replaceable>"</tag></synopsis>
30010 <refsect1><title>Description</title>
30012 <para>Use the <tag class="xmlpi">dbfo sidebar-width</tag> PI as a child of a
30013 <tag>sidebar</tag> to specify the width of the sidebar.</para>
30015 </refsect1><refsect1><title>Parameters</title>
30018 <varlistentry><term>sidebar-width="<replaceable>width</replaceable>"</term>
30021 <para>Specifies the <tag>sidebar</tag> width (including units)</para>
30027 </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
30029 <para><parameter>sidebar.float.type parameter</parameter>,
30030 <parameter>sidebar.float.width parameter</parameter>,
30031 <parameter>sidebar.properties attribute-set</parameter>,
30032 <parameter>sidebar.title.properties</parameter>
30035 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
30037 <para><link role="tcg" xlink:href="SideFloats.html#SidebarFloats">A sidebar as
30038 side float</link></para>
30040 </refsect1></refentry>
30042 <refentry id="dbfo_start" xml:base="../fo/pi.xml">
30044 <refname>dbfo_start</refname>
30045 <refpurpose>(obsolete) Sets the starting number on an ordered list</refpurpose>
30049 <synopsis><tag class="xmlpi">dbfo start="<replaceable>character</replaceable>"</tag></synopsis>
30052 <refsect1><title>Description</title>
30054 <para><emphasis>This PI is obsolete</emphasis>. The intent of
30055 it was to provide a means for setting a specific starting
30056 number for an ordered list. Instead of this PI, set a value
30057 for the <literal>override</literal> attribute on the first
30058 <tag>listitem</tag> in the list; that will have the same
30059 effect as what this PI was intended for.</para>
30061 </refsect1><refsect1><title>Parameters</title>
30064 <varlistentry><term>start="<replaceable>character</replaceable>"</term>
30067 <para>Specifies the character to use as the starting
30068 number; use 0-9, a-z, A-Z, or lowercase or uppercase
30069 Roman numerals</para>
30075 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
30077 <para><link role="tcg" xlink:href="Orderedlists.html#ListStartNum">List starting number</link></para>
30079 </refsect1></refentry>
30081 <refentry id="dbfo_table-width" xml:base="../fo/pi.xml">
30083 <refname>dbfo_table-width</refname>
30084 <refpurpose>Specifies the width for a CALS table or for revhistory
30085 output</refpurpose>
30089 <synopsis><tag class="xmlpi">dbfo table-width="<replaceable>width</replaceable>"</tag></synopsis>
30092 <refsect1><title>Description</title>
30094 <para>Use the <tag class="xmlpi">dbfo table-width</tag> PI as a child or
30095 sibling of a CALS <tag>table</tag>, or as a child of an
30096 <tag>informaltable</tag>, <tag>entrytbl</tag>, or
30097 <tag>revhistory</tag> instance (which is rendered as a table
30098 in output) to specify the width of the table in output.</para>
30100 </refsect1><refsect1><title>Parameters</title>
30103 <varlistentry><term>table-width="<replaceable>width</replaceable>"</term>
30106 <para>Specifies the table width (including units or as a percentage)</para>
30112 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
30114 <para><link role="tcg" xlink:href="Tables.html#TableWidth">Table width</link></para>
30116 </refsect1></refentry>
30118 <refentry id="dbfo_term-width" xml:base="../fo/pi.xml">
30120 <refname>dbfo_term-width</refname>
30121 <refpurpose>Specifies the term width for a variablelist</refpurpose>
30125 <synopsis><tag class="xmlpi">dbfo term-width="<replaceable>width</replaceable>"</tag></synopsis>
30128 <refsect1><title>Description</title>
30130 <para>Use the <tag class="xmlpi">dbfo term-width</tag> PI as a child of a
30131 <tag>variablelist</tag> to specify the width for
30132 <tag>term</tag> output.</para>
30134 </refsect1><refsect1><title>Parameters</title>
30137 <varlistentry><term>term-width="<replaceable>width</replaceable>"</term>
30140 <para>Specifies the term width (including units)</para>
30146 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
30148 <para><link role="tcg" xlink:href="Variablelists.html#ListIndents">Variable list formatting in print</link></para>
30150 </refsect1></refentry>
30152 <refentry id="dbfo_toc" xml:base="../fo/pi.xml">
30154 <refname>dbfo_toc</refname>
30155 <refpurpose>Specifies whether a TOC should be generated for a qandaset</refpurpose>
30159 <synopsis><tag class="xmlpi">dbfo toc="0"|"1"</tag></synopsis>
30162 <refsect1><title>Description</title>
30164 <para>Use the <tag class="xmlpi">dbfo toc</tag> PI as a child of a
30165 <tag>qandaset</tag> to specify whether a table of contents
30166 (TOC) is generated for the <tag>qandaset</tag>.</para>
30168 </refsect1><refsect1><title>Parameters</title>
30171 <varlistentry><term>toc="0"</term>
30174 <para>If zero, no TOC is generated</para>
30178 <varlistentry><term>toc="1"</term>
30181 <para>If <code>1</code> (or any non-zero value),
30182 a TOC is generated</para>
30188 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
30190 <para><link role="tcg" xlink:href="QandAtoc.html">Q and A list of questions</link>,
30191 <link role="tcg" xlink:href="QandAformat.html">Q and A formatting</link></para>
30193 </refsect1></refentry>
30195 <refentry id="dbfo-need" xml:base="../fo/pi.xml">
30197 <refname>dbfo-need</refname>
30198 <refpurpose>Specify a need for space (a kind of soft page break)</refpurpose>
30202 <synopsis><tag class="xmlpi">dbfo-need height="<replaceable>n</replaceable>" [space-before="<replaceable>n</replaceable>"]</tag></synopsis>
30205 <refsect1><title>Description</title>
30207 <para>A “need” is a request for space on a page. If the
30208 requested space is not available, the page breaks and the
30209 content that follows the need request appears on the next
30210 page. If the requested space is available, then no page break
30211 is inserted.</para>
30213 </refsect1><refsect1><title>Parameters</title>
30216 <varlistentry><term>height="<replaceable>n</replaceable>"</term>
30219 <para>The amount of height needed (including units)</para>
30223 <varlistentry><term>space-before="<replaceable>n</replaceable>"</term>
30226 <para>The amount of extra vertical space to add (including units)</para>
30232 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
30234 <para><link role="tcg" xlink:href="PageBreaking.html#SoftPageBreaks">Soft page breaks</link></para>
30236 </refsect1></refentry>
30238 <refentry id="dbfo_row-height" xml:base="../fo/pi.xml">
30240 <refname>dbfo_row-height</refname>
30241 <refpurpose>Specifies the height for a CALS table row</refpurpose>
30245 <synopsis><tag class="xmlpi">dbfo row-height="<replaceable>height</replaceable>"</tag></synopsis>
30248 <refsect1><title>Description</title>
30250 <para>Use the <tag class="xmlpi">dbfo row-height</tag> PI as a child of a
30251 <tag>row</tag> to specify the height of the row.</para>
30253 </refsect1><refsect1><title>Parameters</title>
30256 <varlistentry><term>row-height="<replaceable>height</replaceable>"</term>
30259 <para>Specifies the row height (including units)</para>
30265 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
30267 <para><link role="tcg" xlink:href="RowHeight.html">Row height</link></para>
30269 </refsect1></refentry>
30273 <info xml:base="../manpages/pi.xml"><title>manpages Processing Instruction Reference</title>
30274 <releaseinfo role="meta">
30275 $Id: pi.xsl 7644 2008-01-16 11:04:07Z xmldoc $
30278 <partintro id="partintro" xml:base="../manpages/pi.xml">
30279 <title>Introduction</title>
30281 <para>This is generated reference documentation for all
30282 user-specifiable processing instructions (PIs) in the DocBook
30283 XSL stylesheets for manpages output.
30286 <para>You add these PIs at particular points in a document to
30287 cause specific “exceptions” to formatting/output behavior. To
30288 make global changes in formatting/output behavior across an
30289 entire document, it’s better to do it by setting an
30290 appropriate stylesheet parameter (if there is one).</para>
30297 <refentry id="dbman_funcsynopsis-style" xml:base="../manpages/pi.xml">
30299 <refname>dbman_funcsynopsis-style</refname>
30300 <refpurpose>Specifies presentation style for a funcsynopsis.</refpurpose>
30304 <synopsis><tag class="xmlpi">dbman funcsynopsis-style="kr"|"ansi"</tag></synopsis>
30307 <refsect1><title>Description</title>
30309 <para>Use the <tag class="xmlpi">dbman
30310 funcsynopsis-style</tag> PI as a child of a
30311 <tag>funcsynopsis</tag> or anywhere within a funcsynopsis
30312 to control the presentation style for output of all
30313 <tag>funcprototype</tag> instances within that funcsynopsis.</para>
30315 </refsect1><refsect1><title>Parameters</title>
30318 <varlistentry><term>funcsynopsis-style="kr"</term>
30321 <para>Displays the <tag>funcprototype</tag> in K&R style</para>
30325 <varlistentry><term>funcsynopsis-style="ansi"</term>
30328 <para>Displays the <tag>funcprototype</tag> in ANSI style</para>
30334 </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
30336 <para><parameter>man.funcsynopsis.style</parameter></para>
30338 </refsect1></refentry>
30341 <part id="pi-common">
30342 <info xml:base="../common/pi.xml"><title>Common Processing Instruction Reference</title>
30343 <releaseinfo role="meta">
30344 $Id: pi.xsl 8782 2010-07-27 21:15:17Z mzjn $
30347 <partintro id="partintro" xml:base="../common/pi.xml">
30348 <title>Introduction</title>
30350 <para>This is generated reference documentation for all
30351 user-specifiable processing instructions (PIs) in the
30352 “common” part of the DocBook XSL stylesheets.
30355 <para>You add these PIs at particular points in a document to
30356 cause specific “exceptions” to formatting/output behavior. To
30357 make global changes in formatting/output behavior across an
30358 entire document, it’s better to do it by setting an
30359 appropriate stylesheet parameter (if there is one).</para>
30366 <refentry id="dbchoice_choice" xml:base="../common/pi.xml">
30368 <refname>dbchoice_choice</refname>
30369 <refpurpose>Generates a localized choice separator</refpurpose>
30373 <synopsis><tag class="xmlpi">dbchoice choice="and"|"or"|<replaceable>string</replaceable>"</tag></synopsis>
30376 <refsect1><title>Description</title>
30378 <para>Use the <tag class="xmlpi">dbchoice choice</tag> PI to
30379 generate an appropriate localized “choice” separator (for
30380 example, <literal>and</literal> or <literal>or</literal>)
30381 before the final item in an inline <tag>simplelist</tag></para>
30385 <para>This PI is a less-than-ideal hack; support for it may
30386 disappear in the future (particularly if and when a more
30387 appropriate means for marking up "choice" lists becomes
30388 available in DocBook).</para>
30391 </refsect1><refsect1><title>Parameters</title>
30394 <varlistentry><term>choice="and"</term>
30397 <para>generates a localized <literal>and</literal> separator</para>
30401 <varlistentry><term>choice="or"</term>
30404 <para>generates a localized <literal>or</literal> separator</para>
30408 <varlistentry><term>choice="<replaceable>string</replaceable>"</term>
30411 <para>generates a literal <replaceable>string</replaceable> separator</para>
30417 </refsect1></refentry>
30419 <refentry id="dbtimestamp" xml:base="../common/pi.xml">
30421 <refname>dbtimestamp</refname>
30422 <refpurpose>Inserts a date timestamp</refpurpose>
30426 <synopsis><tag class="xmlpi">dbtimestamp format="<replaceable>formatstring</replaceable>" [padding="0"|"1"]</tag></synopsis>
30429 <refsect1><title>Description</title>
30431 <para>Use the <tag class="xmlpi">dbtimestamp</tag> PI at any point in a
30432 source document to cause a date timestamp (a formatted
30433 string representing the current date and time) to be
30434 inserted in output of the document.</para>
30436 </refsect1><refsect1><title>Parameters</title>
30439 <varlistentry><term>format="<replaceable>formatstring</replaceable>"</term>
30442 <para>Specifies format in which the date and time are
30447 <para>For details of the content of the format string,
30448 see <link role="tcg" xlink:href="Datetime.html">Date and time</link>.</para>
30453 <varlistentry><term>padding="0"|"1"</term>
30456 <para>Specifies padding behavior; if non-zero, padding is is added</para>
30462 </refsect1></refentry>
30464 <refentry id="dbtex_delims" xml:base="../common/pi.xml">
30466 <refname>dbtex_delims</refname>
30467 <refpurpose>Generates delimiters around embedded TeX equations
30468 in output</refpurpose>
30472 <synopsis><tag class="xmlpi">dbtex delims="no"|"yes"</tag></synopsis>
30475 <refsect1><title>Description</title>
30477 <para>Use the <tag class="xmlpi">dbtex delims</tag> PI as a
30478 child of a <tag>textobject</tag> containing embedded TeX
30479 markup, to cause that markup to be surrounded by
30480 <literal>$</literal> delimiter characters in output.</para>
30484 <para>This feature is useful for print/PDF output only if you
30485 use the obsolete and now unsupported PassiveTeX XSL-FO
30489 </refsect1><refsect1><title>Parameters</title>
30492 <varlistentry><term>dbtex delims="no"|"yes"</term>
30495 <para>Specifies whether delimiters are output</para>
30501 </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
30503 <para><parameter>tex.math.delims</parameter></para>
30505 </refsect1></refentry>
30509 <book id="developer"><title>DocBook XSL Stylesheets Developer Reference</title>
30512 <para>This is technical reference documentation for
30513 developers using the DocBook XSL Stylesheets. It is not
30514 intended to be user documentation, but is instead
30515 provided for developers writing customization layers for
30516 the stylesheets.</para>
30520 <?dbhtml dir="lib"?>
30521 <?dbhtml filename="index.html"?>
30522 <title xml:base="../lib/lib.xml">XSL Library Template Reference</title>
30523 <partintro id="libintro">
30524 <title xml:base="../lib/lib.xml">Introduction</title>
30525 <para xml:base="../lib/lib.xml">This is technical reference documentation for the
30526 vocabulary-independent “library” templates in the DocBook XSL
30527 Stylesheets.</para>
30528 <para xml:base="../lib/lib.xml">This is not intended to be user documentation. It is
30529 provided for developers writing customization layers for the
30530 stylesheets.</para>
30533 <reference id="generallibrary" xml:base="../lib/lib.xml">
30534 <title>General Library Templates</title>
30536 <refentry id="dot.count">
30538 <refname>dot.count</refname>
30539 <refpurpose>Returns the number of <quote>.</quote> characters in a string</refpurpose>
30542 <refsect1><title>Description</title>
30544 <para>Given a string, the <function>dot.count</function>
30545 template returns the number of dot/period characters in the
30546 string. This template is useful, for example, when testing the
30547 nesting level of nested inline markup (for nested emphasis,
30548 quotations, etc.).</para>
30550 <programlisting id="dot.count.frag">
30551 <xsl:template name="dot.count">
30552 <!-- Returns the number of "." characters in a string -->
30553 <xsl:param name="string"></xsl:param>
30554 <xsl:param name="count" select="0"></xsl:param>
30556 <xsl:when test="contains($string, '.')">
30557 <xsl:call-template name="dot.count">
30558 <xsl:with-param name="string" select="substring-after($string, '.')"></xsl:with-param>
30559 <xsl:with-param name="count" select="$count+1"></xsl:with-param>
30560 </xsl:call-template>
30562 <xsl:otherwise>
30563 <xsl:value-of select="$count"></xsl:value-of>
30564 </xsl:otherwise>
30565 </xsl:choose>
30566 </xsl:template>
30574 <refentry id="copy-string">
30576 <refname>copy-string</refname>
30577 <refpurpose>Returns <quote>count</quote> copies of a string</refpurpose>
30580 <refsect1><title>Description</title>
30582 <para>Given a string, the <function>copy-string</function>
30583 template creates <replaceable>n</replaceable> copies of the
30584 string, when the value of <replaceable>n</replaceable> is
30585 given by the <parameter>count</parameter> parameter.</para>
30587 <programlisting id="copy-string.frag">
30588 <xsl:template name="copy-string">
30589 <!-- returns 'count' copies of 'string' -->
30590 <xsl:param name="string"></xsl:param>
30591 <xsl:param name="count" select="0"></xsl:param>
30592 <xsl:param name="result"></xsl:param>
30595 <xsl:when test="$count>0">
30596 <xsl:call-template name="copy-string">
30597 <xsl:with-param name="string" select="$string"></xsl:with-param>
30598 <xsl:with-param name="count" select="$count - 1"></xsl:with-param>
30599 <xsl:with-param name="result">
30600 <xsl:value-of select="$result"></xsl:value-of>
30601 <xsl:value-of select="$string"></xsl:value-of>
30602 </xsl:with-param>
30603 </xsl:call-template>
30605 <xsl:otherwise>
30606 <xsl:value-of select="$result"></xsl:value-of>
30607 </xsl:otherwise>
30608 </xsl:choose>
30609 </xsl:template>
30617 <refentry id="string.subst">
30619 <refname>string.subst</refname>
30620 <refpurpose>Substitute one text string for another in a string</refpurpose>
30623 <refsect1><title>Description</title>
30625 <para>The <function>string.subst</function> template replaces all
30626 occurances of <parameter>target</parameter> in <parameter>string</parameter>
30627 with <parameter>replacement</parameter> and returns the result.
30630 <programlisting id="string.subst.frag">
30631 <xsl:template name="string.subst">
30632 <xsl:param name="string"></xsl:param>
30633 <xsl:param name="target"></xsl:param>
30634 <xsl:param name="replacement"></xsl:param>
30637 <xsl:when test="contains($string, $target)">
30638 <xsl:variable name="rest">
30639 <xsl:call-template name="string.subst">
30640 <xsl:with-param name="string" select="substring-after($string, $target)"></xsl:with-param>
30641 <xsl:with-param name="target" select="$target"></xsl:with-param>
30642 <xsl:with-param name="replacement" select="$replacement"></xsl:with-param>
30643 </xsl:call-template>
30644 </xsl:variable>
30645 <xsl:value-of select="concat(substring-before($string, $target), $replacement, $rest)"></xsl:value-of>
30647 <xsl:otherwise>
30648 <xsl:value-of select="$string"></xsl:value-of>
30649 </xsl:otherwise>
30650 </xsl:choose>
30651 </xsl:template>
30659 <refentry id="xpointer.idref">
30661 <refname>xpointer.idref</refname>
30662 <refpurpose>Extract IDREF from an XPointer</refpurpose>
30665 <refsect1><title>Description</title>
30667 <para>The <function>xpointer.idref</function> template returns the
30668 ID portion of an XPointer which is a pointer to an ID within the current
30669 document, or the empty string if it is not.</para>
30670 <para>In other words, <function>xpointer.idref</function> returns
30671 <quote>foo</quote> when passed either <literal>#foo</literal>
30672 or <literal>#xpointer(id('foo'))</literal>, otherwise it returns
30673 the empty string.</para>
30675 <programlisting id="xpointer.idref.frag">
30676 <xsl:template name="xpointer.idref">
30677 <xsl:param name="xpointer">http://...</xsl:param>
30679 <xsl:when test="starts-with($xpointer, '#xpointer(id(')">
30680 <xsl:variable name="rest" select="substring-after($xpointer, '#xpointer(id(')"></xsl:variable>
30681 <xsl:variable name="quote" select="substring($rest, 1, 1)"></xsl:variable>
30682 <xsl:value-of select="substring-before(substring-after($xpointer, $quote), $quote)"></xsl:value-of>
30684 <xsl:when test="starts-with($xpointer, '#')">
30685 <xsl:value-of select="substring-after($xpointer, '#')"></xsl:value-of>
30687 <!-- otherwise it's a pointer to some other document -->
30688 </xsl:choose>
30689 </xsl:template>
30698 <refentry id="length-magnitude">
30700 <refname>length-magnitude</refname>
30701 <refpurpose>Return the unqualified dimension from a length specification</refpurpose>
30704 <refsect1><title>Description</title>
30706 <para>The <function>length-magnitude</function> template returns the
30707 unqualified length ("20" for "20pt") from a dimension.
30710 <programlisting id="length-magnitude.frag">
30711 <xsl:template name="length-magnitude">
30712 <xsl:param name="length" select="'0pt'"></xsl:param>
30715 <xsl:when test="string-length($length) = 0"></xsl:when>
30716 <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) = '.'">
30717 <xsl:value-of select="substring($length,1,1)"></xsl:value-of>
30718 <xsl:call-template name="length-magnitude">
30719 <xsl:with-param name="length" select="substring($length,2)"></xsl:with-param>
30720 </xsl:call-template>
30722 </xsl:choose>
30723 </xsl:template>
30731 <refentry id="length-units">
30733 <refname>length-units</refname>
30734 <refpurpose>Return the units from a length specification</refpurpose>
30737 <refsect1><title>Description</title>
30739 <para>The <function>length-units</function> template returns the
30740 units ("pt" for "20pt") from a length. If no units are supplied on the
30741 length, the <parameter>defauilt.units</parameter> are returned.</para>
30743 <programlisting id="length-units.frag">
30744 <xsl:template name="length-units">
30745 <xsl:param name="length" select="'0pt'"></xsl:param>
30746 <xsl:param name="default.units" select="'px'"></xsl:param>
30747 <xsl:variable name="magnitude">
30748 <xsl:call-template name="length-magnitude">
30749 <xsl:with-param name="length" select="$length"></xsl:with-param>
30750 </xsl:call-template>
30751 </xsl:variable>
30753 <xsl:variable name="units">
30754 <xsl:value-of select="substring($length, string-length($magnitude)+1)"></xsl:value-of>
30755 </xsl:variable>
30758 <xsl:when test="$units = ''">
30759 <xsl:value-of select="$default.units"></xsl:value-of>
30761 <xsl:otherwise>
30762 <xsl:value-of select="$units"></xsl:value-of>
30763 </xsl:otherwise>
30764 </xsl:choose>
30765 </xsl:template>
30773 <refentry id="length-spec">
30775 <refname>length-spec</refname>
30776 <refpurpose>Return a fully qualified length specification</refpurpose>
30779 <refsect1><title>Description</title>
30781 <para>The <function>length-spec</function> template returns the
30782 qualified length from a dimension. If an unqualified length is given,
30783 the <parameter>default.units</parameter> will be added to it.
30786 <programlisting id="length-spec.frag">
30787 <xsl:template name="length-spec">
30788 <xsl:param name="length" select="'0pt'"></xsl:param>
30789 <xsl:param name="default.units" select="'px'"></xsl:param>
30791 <xsl:variable name="magnitude">
30792 <xsl:call-template name="length-magnitude">
30793 <xsl:with-param name="length" select="$length"></xsl:with-param>
30794 </xsl:call-template>
30795 </xsl:variable>
30797 <xsl:variable name="units">
30798 <xsl:value-of select="substring($length, string-length($magnitude)+1)"></xsl:value-of>
30799 </xsl:variable>
30801 <xsl:value-of select="$magnitude"></xsl:value-of>
30803 <xsl:when test="$units='cm' or $units='mm' or $units='in' or $units='pt' or $units='pc' or $units='px' or $units='em'">
30804 <xsl:value-of select="$units"></xsl:value-of>
30806 <xsl:when test="$units = ''">
30807 <xsl:value-of select="$default.units"></xsl:value-of>
30809 <xsl:otherwise>
30810 <xsl:message>
30811 <xsl:text>Unrecognized unit of measure: </xsl:text>
30812 <xsl:value-of select="$units"></xsl:value-of>
30813 <xsl:text>.</xsl:text>
30814 </xsl:message>
30815 </xsl:otherwise>
30816 </xsl:choose>
30817 </xsl:template>
30825 <refentry id="length-in-points">
30827 <refname>length-in-points</refname>
30828 <refpurpose>Returns the size, in points, of a specified length</refpurpose>
30831 <refsect1><title>Description</title>
30833 <para>The <function>length-in-points</function> template converts a length
30834 specification to points and returns that value as an unqualified
30839 <para>There is no way for the template to infer the size of an
30840 <literal>em</literal>. It relies on the default <parameter>em.size</parameter>
30841 which is initially <literal>10</literal> (for 10pt).</para>
30843 <para>Similarly, converting pixels to points relies on the
30844 <parameter>pixels.per.inch</parameter> parameter which is initially
30845 <literal>90</literal>.
30849 <programlisting id="length-in-points.frag">
30850 <xsl:template name="length-in-points">
30851 <xsl:param name="length" select="'0pt'"></xsl:param>
30852 <xsl:param name="em.size" select="10"></xsl:param>
30853 <xsl:param name="pixels.per.inch" select="90"></xsl:param>
30855 <xsl:variable name="magnitude">
30856 <xsl:call-template name="length-magnitude">
30857 <xsl:with-param name="length" select="$length"></xsl:with-param>
30858 </xsl:call-template>
30859 </xsl:variable>
30861 <xsl:variable name="units">
30862 <xsl:value-of select="substring($length, string-length($magnitude)+1)"></xsl:value-of>
30863 </xsl:variable>
30866 <xsl:when test="$units = 'pt'">
30867 <xsl:value-of select="$magnitude"></xsl:value-of>
30869 <xsl:when test="$units = 'cm'">
30870 <xsl:value-of select="$magnitude div 2.54 * 72.0"></xsl:value-of>
30872 <xsl:when test="$units = 'mm'">
30873 <xsl:value-of select="$magnitude div 25.4 * 72.0"></xsl:value-of>
30875 <xsl:when test="$units = 'in'">
30876 <xsl:value-of select="$magnitude * 72.0"></xsl:value-of>
30878 <xsl:when test="$units = 'pc'">
30879 <xsl:value-of select="$magnitude * 12.0"></xsl:value-of>
30881 <xsl:when test="$units = 'px'">
30882 <xsl:value-of select="$magnitude div $pixels.per.inch * 72.0"></xsl:value-of>
30884 <xsl:when test="$units = 'em'">
30885 <xsl:value-of select="$magnitude * $em.size"></xsl:value-of>
30887 <xsl:otherwise>
30888 <xsl:message>
30889 <xsl:text>Unrecognized unit of measure: </xsl:text>
30890 <xsl:value-of select="$units"></xsl:value-of>
30891 <xsl:text>.</xsl:text>
30892 </xsl:message>
30893 </xsl:otherwise>
30894 </xsl:choose>
30895 </xsl:template>
30903 <refentry id="pi-attribute">
30905 <refname>pi-attribute</refname>
30906 <refpurpose>Extract a pseudo-attribute from a PI</refpurpose>
30909 <refsect1><title>Description</title>
30911 <para>The <function>pi-attribute</function> template extracts a pseudo-attribute
30912 from a processing instruction. For example, given the PI
30913 <quote><literal><?foo bar="1" baz='red'?></literal></quote>,</para>
30914 <programlisting><xsl:call-template name="pi-attribute">
30915 <xsl:with-param name="pis" select="processing-instruction('foo')"/>
30916 <xsl:with-param name="attribute" select="'baz'"/>
30917 </xsl:call-template></programlisting>
30918 <para>will return <quote>red</quote>. This template returns the first matching
30919 attribute that it finds. Presented with processing instructions that
30920 contain badly formed pseudo-attributes (missing or unbalanced quotes,
30921 for example), the template may silently return erroneous results.</para>
30923 <programlisting id="pi-attribute.frag">
30924 <xsl:template name="pi-attribute">
30925 <xsl:param name="pis" select="processing-instruction('BOGUS_PI')"></xsl:param>
30926 <xsl:param name="attribute">filename</xsl:param>
30927 <xsl:param name="count">1</xsl:param>
30930 <xsl:when test="$count>count($pis)">
30931 <!-- not found -->
30933 <xsl:otherwise>
30934 <xsl:variable name="pi">
30935 <xsl:value-of select="$pis[$count]"></xsl:value-of>
30936 </xsl:variable>
30937 <xsl:variable name="pivalue">
30938 <xsl:value-of select="concat(' ', normalize-space($pi))"></xsl:value-of>
30939 </xsl:variable>
30941 <xsl:when test="contains($pivalue,concat(' ', $attribute, '='))">
30942 <xsl:variable name="rest" select="substring-after($pivalue,concat(' ', $attribute,'='))"></xsl:variable>
30943 <xsl:variable name="quote" select="substring($rest,1,1)"></xsl:variable>
30944 <xsl:value-of select="substring-before(substring($rest,2),$quote)"></xsl:value-of>
30946 <xsl:otherwise>
30947 <xsl:call-template name="pi-attribute">
30948 <xsl:with-param name="pis" select="$pis"></xsl:with-param>
30949 <xsl:with-param name="attribute" select="$attribute"></xsl:with-param>
30950 <xsl:with-param name="count" select="$count + 1"></xsl:with-param>
30951 </xsl:call-template>
30952 </xsl:otherwise>
30953 </xsl:choose>
30954 </xsl:otherwise>
30955 </xsl:choose>
30956 </xsl:template>
30964 <refentry id="lookup.key">
30966 <refname>lookup.key</refname>
30967 <refpurpose>Retrieve the value associated with a particular key in a table</refpurpose>
30970 <refsect1><title>Description</title>
30972 <para>Given a table of space-delimited key/value pairs,
30973 the <function>lookup.key</function> template extracts the value associated
30974 with a particular key.</para>
30976 <programlisting id="lookup.key.frag">
30977 <xsl:template name="lookup.key">
30978 <xsl:param name="key" select="''"></xsl:param>
30979 <xsl:param name="table" select="''"></xsl:param>
30981 <xsl:if test="contains($table, ' ')">
30983 <xsl:when test="substring-before($table, ' ') = $key">
30984 <xsl:variable name="rest" select="substring-after($table, ' ')"></xsl:variable>
30986 <xsl:when test="contains($rest, ' ')">
30987 <xsl:value-of select="substring-before($rest, ' ')"></xsl:value-of>
30989 <xsl:otherwise>
30990 <xsl:value-of select="$rest"></xsl:value-of>
30991 </xsl:otherwise>
30992 </xsl:choose>
30994 <xsl:otherwise>
30995 <xsl:call-template name="lookup.key">
30996 <xsl:with-param name="key" select="$key"></xsl:with-param>
30997 <xsl:with-param name="table" select="substring-after(substring-after($table,' '), ' ')"></xsl:with-param>
30998 </xsl:call-template>
30999 </xsl:otherwise>
31000 </xsl:choose>
31002 </xsl:template>
31010 <refentry id="xpath.location">
31012 <refname>xpath.location</refname>
31013 <refpurpose>Calculate the XPath child-sequence to the current node</refpurpose>
31016 <refsect1><title>Description</title>
31018 <para>The <function>xpath.location</function> template calculates the
31019 absolute path from the root of the tree to the current element node.
31022 <programlisting id="xpath.location.frag">
31023 <xsl:template name="xpath.location">
31024 <xsl:param name="node" select="."></xsl:param>
31025 <xsl:param name="path" select="''"></xsl:param>
31027 <xsl:variable name="next.path">
31028 <xsl:value-of select="local-name($node)"></xsl:value-of>
31029 <xsl:if test="$path != ''">/</xsl:if>
31030 <xsl:value-of select="$path"></xsl:value-of>
31031 </xsl:variable>
31034 <xsl:when test="$node/parent::*">
31035 <xsl:call-template name="xpath.location">
31036 <xsl:with-param name="node" select="$node/parent::*"></xsl:with-param>
31037 <xsl:with-param name="path" select="$next.path"></xsl:with-param>
31038 </xsl:call-template>
31040 <xsl:otherwise>
31041 <xsl:text>/</xsl:text>
31042 <xsl:value-of select="$next.path"></xsl:value-of>
31043 </xsl:otherwise>
31044 </xsl:choose>
31045 </xsl:template>
31053 <refentry id="comment-escape-string">
31055 <refname>comment-escape-string</refname>
31056 <refpurpose>Prepare a string for inclusion in an XML comment</refpurpose>
31059 <refsect1><title>Description</title>
31061 <para>The <function>comment-escape-string</function> template returns a string
31062 that has been transformed so that it can safely be output as an XML comment.
31063 Internal occurrences of "--" will be replaced with "- -" and a leading and/or
31064 trailing space will be added to the string, if necessary.</para>
31066 <programlisting id="comment-escape-string.frag">
31067 <xsl:template name="comment-escape-string">
31068 <xsl:param name="string" select="''"></xsl:param>
31070 <xsl:if test="starts-with($string, '-')">
31071 <xsl:text> </xsl:text>
31074 <xsl:call-template name="comment-escape-string.recursive">
31075 <xsl:with-param name="string" select="$string"></xsl:with-param>
31076 </xsl:call-template>
31078 <xsl:if test="substring($string, string-length($string), 1) = '-'">
31079 <xsl:text> </xsl:text>
31081 </xsl:template>
31089 <refentry id="comment-escape-string.recursive">
31091 <refname>comment-escape-string.recursive</refname>
31092 <refpurpose>Internal function used by comment-escape-string</refpurpose>
31095 <refsect1><title>Description</title>
31097 <para>The <function>comment-escape-string.recursive</function> template is used
31098 by <function>comment-escape-string</function>.</para>
31100 <programlisting id="comment-escape-string.recursive.frag">
31101 <xsl:template name="comment-escape-string.recursive">
31102 <xsl:param name="string" select="''"></xsl:param>
31104 <xsl:when test="contains($string, '--')">
31105 <xsl:value-of select="substring-before($string, '--')"></xsl:value-of>
31106 <xsl:value-of select="'- -'"></xsl:value-of>
31107 <xsl:call-template name="comment-escape-string.recursive">
31108 <xsl:with-param name="string" select="substring-after($string, '--')"></xsl:with-param>
31109 </xsl:call-template>
31111 <xsl:otherwise>
31112 <xsl:value-of select="$string"></xsl:value-of>
31113 </xsl:otherwise>
31114 </xsl:choose>
31115 </xsl:template>
31122 <refentry id="trim.text">
31124 <refname>trim.text</refname>
31125 <refpurpose>Trim leading and trailing whitespace from a text node</refpurpose>
31128 <refsect1><title>Description</title>
31130 <para>Given a text node, this function trims leading and trailing
31131 whitespace from it and returns the trimmed contents.</para>
31133 <programlisting id="trim.text.frag">
31135 <xsl:template name="trim.text">
31136 <xsl:param name="contents" select="."></xsl:param>
31137 <xsl:variable name="contents-left-trimmed">
31138 <xsl:call-template name="trim-left">
31139 <xsl:with-param name="contents" select="$contents"></xsl:with-param>
31140 </xsl:call-template>
31141 </xsl:variable>
31142 <xsl:variable name="contents-trimmed">
31143 <xsl:call-template name="trim-right">
31144 <xsl:with-param name="contents" select="$contents-left-trimmed"></xsl:with-param>
31145 </xsl:call-template>
31146 </xsl:variable>
31147 <xsl:value-of select="$contents-trimmed"></xsl:value-of>
31148 </xsl:template>
31150 <xsl:template name="trim-left">
31151 <xsl:param name="contents"></xsl:param>
31153 <xsl:when test="starts-with($contents,'
31154 ') or starts-with($contents,'
') or starts-with($contents,' ') or starts-with($contents,' ')">
31155 <xsl:call-template name="trim-left">
31156 <xsl:with-param name="contents" select="substring($contents, 2)"></xsl:with-param>
31157 </xsl:call-template>
31159 <xsl:otherwise>
31160 <xsl:value-of select="$contents"></xsl:value-of>
31161 </xsl:otherwise>
31162 </xsl:choose>
31163 </xsl:template>
31165 <xsl:template name="trim-right">
31166 <xsl:param name="contents"></xsl:param>
31167 <xsl:variable name="last-char">
31168 <xsl:value-of select="substring($contents, string-length($contents), 1)"></xsl:value-of>
31169 </xsl:variable>
31171 <xsl:when test="($last-char = '
31172 ') or ($last-char = '
') or ($last-char = ' ') or ($last-char = ' ')">
31173 <xsl:call-template name="trim-right">
31174 <xsl:with-param name="contents" select="substring($contents, 1, string-length($contents) - 1)"></xsl:with-param>
31175 </xsl:call-template>
31177 <xsl:otherwise>
31178 <xsl:value-of select="$contents"></xsl:value-of>
31179 </xsl:otherwise>
31180 </xsl:choose>
31181 </xsl:template>
31189 <refentry id="str.tokenize.keep.delimiters">
31191 <refname>str.tokenize.keep.delimiters</refname>
31192 <refpurpose>Tokenize a string while preserving any delimiters</refpurpose>
31194 <refsect1><title>Description</title>
31195 <para>Based on the occurrence of one or more delimiter characters,
31196 this function breaks a string into a list of tokens and delimiters,
31197 marking up each of the tokens with a <tag>token</tag> element
31198 and preserving the delimiters as text nodes between the tokens.</para>
31200 <para>This function is a very slightly modified version of a
31201 function from the <link xlink:href="http://www.exslt.org/">EXSLT
31202 site</link>. The original is available at:
31204 <blockquote><para><link xlink:href="http://www.exslt.org/str/functions/tokenize/str.tokenize.template.xsl"/></para></blockquote>
31206 The <function>str.tokenize.keep.delimiters</function> function
31207 differs only in that it preserves the delimiters instead of
31208 discarding them.</para>
31210 <programlisting id="str.tokenize.keep.delimiters.frag">
31211 <xsl:template name="str.tokenize.keep.delimiters">
31212 <xsl:param name="string" select="''"></xsl:param>
31213 <xsl:param name="delimiters" select="' '"></xsl:param>
31215 <xsl:when test="not($string)"></xsl:when>
31216 <xsl:when test="not($delimiters)">
31217 <xsl:call-template name="str.tokenize.keep.delimiters-characters">
31218 <xsl:with-param name="string" select="$string"></xsl:with-param>
31219 </xsl:call-template>
31221 <xsl:otherwise>
31222 <xsl:call-template name="str.tokenize.keep.delimiters-delimiters">
31223 <xsl:with-param name="string" select="$string"></xsl:with-param>
31224 <xsl:with-param name="delimiters" select="$delimiters"></xsl:with-param>
31225 </xsl:call-template>
31226 </xsl:otherwise>
31227 </xsl:choose>
31228 </xsl:template>
31229 <xsl:template name="str.tokenize.keep.delimiters-characters">
31230 <xsl:param name="string"></xsl:param>
31231 <xsl:if test="$string">
31232 <ssb:token><xsl:value-of select="substring($string, 1, 1)"></xsl:value-of></ssb:token>
31233 <xsl:call-template name="str.tokenize.keep.delimiters-characters">
31234 <xsl:with-param name="string" select="substring($string, 2)"></xsl:with-param>
31235 </xsl:call-template>
31237 </xsl:template>
31238 <xsl:template name="str.tokenize.keep.delimiters-delimiters">
31239 <xsl:param name="string"></xsl:param>
31240 <xsl:param name="delimiters"></xsl:param>
31241 <xsl:variable name="delimiter" select="substring($delimiters, 1, 1)"></xsl:variable>
31243 <xsl:when test="not($delimiter)">
31244 <ssb:token><xsl:value-of select="$string"></xsl:value-of></ssb:token>
31246 <xsl:when test="contains($string, $delimiter)">
31247 <xsl:if test="not(starts-with($string, $delimiter))">
31248 <xsl:call-template name="str.tokenize.keep.delimiters-delimiters">
31249 <xsl:with-param name="string" select="substring-before($string, $delimiter)"></xsl:with-param>
31250 <xsl:with-param name="delimiters" select="substring($delimiters, 2)"></xsl:with-param>
31251 </xsl:call-template>
31253 <!-- output each delimiter -->
31254 <xsl:value-of select="$delimiter"></xsl:value-of>
31255 <xsl:call-template name="str.tokenize.keep.delimiters-delimiters">
31256 <xsl:with-param name="string" select="substring-after($string, $delimiter)"></xsl:with-param>
31257 <xsl:with-param name="delimiters" select="$delimiters"></xsl:with-param>
31258 </xsl:call-template>
31260 <xsl:otherwise>
31261 <xsl:call-template name="str.tokenize.keep.delimiters-delimiters">
31262 <xsl:with-param name="string" select="$string"></xsl:with-param>
31263 <xsl:with-param name="delimiters" select="substring($delimiters, 2)"></xsl:with-param>
31264 </xsl:call-template>
31265 </xsl:otherwise>
31266 </xsl:choose>
31267 </xsl:template>
31274 <refentry id="apply-string-subst-map">
31276 <refname>apply-string-subst-map</refname>
31277 <refpurpose>Apply a string-substitution map</refpurpose>
31279 <refsect1><title>Description</title>
31280 <para>This function applies a “string substitution” map. Use it when
31281 you want to do multiple string substitutions on the same target
31282 content. It reads in two things: <parameter>content</parameter>, the
31283 content on which to perform the substitution, and
31284 <parameter>map.contents</parameter>, a node set of
31285 elements (the names of the elements don't matter), with each element
31286 having the following attributes:
31289 <simpara><tag class="attribute">oldstring</tag>, a string to
31290 be replaced</simpara>
31293 <simpara><tag class="attribute">newstring</tag>, a string with
31294 which to replace <tag class="attribute">oldstring</tag></simpara>
31297 The function uses <parameter>map.contents</parameter> to
31298 do substitution on <parameter>content</parameter>, and then
31299 returns the modified contents.</para>
31301 <para>This function is a very slightly modified version of Jeni
31302 Tennison’s <function>replace_strings</function> function in the
31303 <link xlink:href="http://www.dpawson.co.uk/xsl/sect2/StringReplace.html#d9351e13">multiple string replacements</link> section of Dave Pawson’s
31304 <link xlink:href="http://www.dpawson.co.uk/xsl/index.html">XSLT
31306 <para>The <function>apply-string-subst-map</function> function is
31307 essentially the same function as the
31308 <function>apply-character-map</function> function; the only
31309 difference is that in the map that
31310 <function>apply-string-subst-map</function> expects, <tag class="attribute">oldstring</tag> and <tag class="attribute">newstring</tag> attributes are used instead of
31311 <tag class="attribute">character</tag> and <tag class="attribute">string</tag> attributes.</para>
31313 <programlisting id="apply-string-subst-map.frag">
31314 <xsl:template name="apply-string-subst-map">
31315 <xsl:param name="content"></xsl:param>
31316 <xsl:param name="map.contents"></xsl:param>
31317 <xsl:variable name="replaced_text">
31318 <xsl:call-template name="string.subst">
31319 <xsl:with-param name="string" select="$content"></xsl:with-param>
31320 <xsl:with-param name="target" select="$map.contents[1]/@oldstring"></xsl:with-param>
31321 <xsl:with-param name="replacement" select="$map.contents[1]/@newstring"></xsl:with-param>
31322 </xsl:call-template>
31323 </xsl:variable>
31325 <xsl:when test="$map.contents[2]">
31326 <xsl:call-template name="apply-string-subst-map">
31327 <xsl:with-param name="content" select="$replaced_text"></xsl:with-param>
31328 <xsl:with-param name="map.contents" select="$map.contents[position() > 1]"></xsl:with-param>
31329 </xsl:call-template>
31331 <xsl:otherwise>
31332 <xsl:value-of select="$replaced_text"></xsl:value-of>
31333 </xsl:otherwise>
31334 </xsl:choose>
31335 </xsl:template>
31339 </reference><reference id="relativeuri" xml:base="../lib/lib.xml">
31340 <title>Relative URI Functions</title>
31342 <partintro id="partintro"><title>Introduction</title>
31344 <para>These functions manipulate relative URI references.</para>
31346 <para>The following assumptions must hold true:</para>
31350 <para>All URIs are relative.</para>
31353 <para>No URI contains the <quote><literal>../</literal></quote> sequence
31354 which would effectively move <quote>up</quote> the hierarchy.</para>
31358 <para>If these assumptions do not hold, the results are unpredictable.</para>
31364 <refentry id="count.uri.path.depth">
31366 <refname>count.uri.path.depth</refname>
31367 <refpurpose>Count the number of path components in a relative URI</refpurpose>
31370 <refsect1><title>Description</title>
31372 <para>This function counts the number of path components in a relative URI.</para>
31374 <programlisting id="count.uri.path.depth.frag">
31375 <xsl:template name="count.uri.path.depth">
31376 <xsl:param name="filename" select="''"></xsl:param>
31377 <xsl:param name="count" select="0"></xsl:param>
31380 <xsl:when test="contains($filename, '/')">
31381 <xsl:call-template name="count.uri.path.depth">
31382 <xsl:with-param name="filename" select="substring-after($filename, '/')"></xsl:with-param>
31383 <xsl:with-param name="count" select="$count + 1"></xsl:with-param>
31384 </xsl:call-template>
31386 <xsl:otherwise>
31387 <xsl:value-of select="$count"></xsl:value-of>
31388 </xsl:otherwise>
31389 </xsl:choose>
31390 </xsl:template>
31398 <refentry id="trim.common.uri.paths">
31400 <refname>trim.common.uri.paths</refname>
31401 <refpurpose>Trim common leading path components from a relative URI</refpurpose>
31404 <refsect1><title>Description</title>
31406 <para>This function trims common leading path components from a relative URI.</para>
31408 <programlisting id="trim.common.uri.paths.frag">
31409 <xsl:template name="trim.common.uri.paths">
31410 <xsl:param name="uriA" select="''"></xsl:param>
31411 <xsl:param name="uriB" select="''"></xsl:param>
31412 <xsl:param name="return" select="'A'"></xsl:param>
31415 <xsl:when test="contains($uriA, '/') and contains($uriB, '/') and substring-before($uriA, '/') = substring-before($uriB, '/')">
31416 <xsl:call-template name="trim.common.uri.paths">
31417 <xsl:with-param name="uriA" select="substring-after($uriA, '/')"></xsl:with-param>
31418 <xsl:with-param name="uriB" select="substring-after($uriB, '/')"></xsl:with-param>
31419 <xsl:with-param name="return" select="$return"></xsl:with-param>
31420 </xsl:call-template>
31422 <xsl:otherwise>
31424 <xsl:when test="$return = 'A'">
31425 <xsl:value-of select="$uriA"></xsl:value-of>
31427 <xsl:otherwise>
31428 <xsl:value-of select="$uriB"></xsl:value-of>
31429 </xsl:otherwise>
31430 </xsl:choose>
31431 </xsl:otherwise>
31432 </xsl:choose>
31433 </xsl:template>
31441 <part id="common-part"><title>Common Template Reference</title>
31442 <?dbhtml dir="common"?>
31443 <?dbhtml filename="index.html"?>
31446 <para>This is technical reference documentation for the
31447 “base”, “refentry”, and “utility” sets of common
31448 templates in the DocBook XSL Stylesheets. These
31449 templates are “common” in that they are shared across
31450 output formats (that is, they’re not
31451 output-format-dependent)</para>
31452 <para>This documentation is not intended to be user
31453 documentation. It is provided for developers writing
31454 customization layers for the stylesheets.</para>
31457 <reference id="base" xml:base="../common/common.xml">
31459 <title>Common » Base Template Reference</title>
31460 <releaseinfo role="meta">
31461 $Id: common.xsl 8784 2010-07-28 12:32:54Z mzjn $
31465 <partintro id="partintro">
31466 <title>Introduction</title>
31468 <para>This is technical reference documentation for the “base”
31469 set of common templates in the DocBook XSL Stylesheets.</para>
31472 <para>This is not intended to be user documentation. It is
31473 provided for developers writing customization layers for the
31474 stylesheets.</para>
31478 <refentry id="template.is.component">
31480 <refname>is.component</refname>
31481 <refpurpose>Tests if a given node is a component-level element</refpurpose>
31484 <synopsis><xsl:template name="is.component">
31485 <xsl:param name="node" select="."/>
31487 </xsl:template></synopsis>
31489 <refsect1><title>Description</title>
31491 <para>This template returns '1' if the specified node is a component
31492 (Chapter, Appendix, etc.), and '0' otherwise.</para>
31494 </refsect1><refsect1><title>Parameters</title>
31497 <varlistentry><term>node</term>
31500 <para>The node which is to be tested.</para>
31506 </refsect1><refsect1><title>Returns</title>
31508 <para>This template returns '1' if the specified node is a component
31509 (Chapter, Appendix, etc.), and '0' otherwise.</para>
31511 </refsect1></refentry>
31513 <refentry id="template.is.section">
31515 <refname>is.section</refname>
31516 <refpurpose>Tests if a given node is a section-level element</refpurpose>
31519 <synopsis><xsl:template name="is.section">
31520 <xsl:param name="node" select="."/>
31522 </xsl:template></synopsis>
31524 <refsect1><title>Description</title>
31526 <para>This template returns '1' if the specified node is a section
31527 (Section, Sect1, Sect2, etc.), and '0' otherwise.</para>
31529 </refsect1><refsect1><title>Parameters</title>
31532 <varlistentry><term>node</term>
31535 <para>The node which is to be tested.</para>
31541 </refsect1><refsect1><title>Returns</title>
31543 <para>This template returns '1' if the specified node is a section
31544 (Section, Sect1, Sect2, etc.), and '0' otherwise.</para>
31546 </refsect1></refentry>
31548 <refentry id="template.section.level">
31550 <refname>section.level</refname>
31551 <refpurpose>Returns the hierarchical level of a section</refpurpose>
31554 <synopsis><xsl:template name="section.level">
31555 <xsl:param name="node" select="."/>
31557 </xsl:template></synopsis>
31559 <refsect1><title>Description</title>
31561 <para>This template calculates the hierarchical level of a section.
31562 The element <tag>sect1</tag> is at level 1, <tag>sect2</tag> is
31563 at level 2, etc.</para>
31567 <para>Recursive sections are calculated down to the fifth level.</para>
31569 </refsect1><refsect1><title>Parameters</title>
31572 <varlistentry><term>node</term>
31575 <para>The section node for which the level should be calculated.
31576 Defaults to the context node.</para>
31582 </refsect1><refsect1><title>Returns</title>
31584 <para>The section level, <quote>1</quote>, <quote>2</quote>, etc.
31587 </refsect1></refentry>
31589 <refentry id="template.qanda.section.level">
31591 <refname>qanda.section.level</refname>
31592 <refpurpose>Returns the hierarchical level of a QandASet</refpurpose>
31595 <synopsis><xsl:template name="qanda.section.level"/></synopsis>
31597 <refsect1><title>Description</title>
31599 <para>This template calculates the hierarchical level of a QandASet.
31602 </refsect1><refsect1><title>Returns</title>
31604 <para>The level, <quote>1</quote>, <quote>2</quote>, etc.
31607 </refsect1></refentry>
31609 <refentry id="template.select.mediaobject">
31611 <refname>select.mediaobject</refname>
31612 <refpurpose>Selects and processes an appropriate media object from a list</refpurpose>
31615 <synopsis><xsl:template name="select.mediaobject">
31616 <xsl:param name="olist" select="imageobject|imageobjectco |videoobject|audioobject|textobject"/>
31618 </xsl:template></synopsis>
31620 <refsect1><title>Description</title>
31622 <para>This template takes a list of media objects (usually the
31623 children of a mediaobject or inlinemediaobject) and processes
31624 the "right" object.</para>
31628 <para>This template relies on a template named
31629 "select.mediaobject.index" to determine which object
31630 in the list is appropriate.</para>
31634 <para>If no acceptable object is located, nothing happens.</para>
31636 </refsect1><refsect1><title>Parameters</title>
31639 <varlistentry><term>olist</term>
31642 <para>The node list of potential objects to examine.</para>
31648 </refsect1><refsect1><title>Returns</title>
31650 <para>Calls <xsl:apply-templates> on the selected object.</para>
31652 </refsect1></refentry>
31654 <refentry id="template.select.mediaobject.index">
31656 <refname>select.mediaobject.index</refname>
31657 <refpurpose>Selects the position of the appropriate media object from a list</refpurpose>
31660 <synopsis><xsl:template name="select.mediaobject.index">
31661 <xsl:param name="olist" select="imageobject|imageobjectco |videoobject|audioobject|textobject"/>
31662 <xsl:param name="count">1</xsl:param>
31664 </xsl:template></synopsis>
31666 <refsect1><title>Description</title>
31668 <para>This template takes a list of media objects (usually the
31669 children of a mediaobject or inlinemediaobject) and determines
31670 the "right" object. It returns the position of that object
31671 to be used by the calling template.</para>
31675 <para>If the parameter <parameter>use.role.for.mediaobject</parameter>
31676 is nonzero, then it first checks for an object with
31677 a role attribute of the appropriate value. It takes the first
31678 of those. Otherwise, it takes the first acceptable object
31679 through a recursive pass through the list.</para>
31683 <para>This template relies on a template named "is.acceptable.mediaobject"
31684 to determine if a given object is an acceptable graphic. The semantics
31685 of media objects is that the first acceptable graphic should be used.
31690 <para>If no acceptable object is located, no index is returned.</para>
31692 </refsect1><refsect1><title>Parameters</title>
31695 <varlistentry><term>olist</term>
31698 <para>The node list of potential objects to examine.</para>
31702 <varlistentry><term>count</term>
31705 <para>The position in the list currently being considered by the
31706 recursive process.</para>
31712 </refsect1><refsect1><title>Returns</title>
31714 <para>Returns the position in the original list of the selected object.</para>
31716 </refsect1></refentry>
31718 <refentry id="template.is.acceptable.mediaobject">
31720 <refname>is.acceptable.mediaobject</refname>
31721 <refpurpose>Returns '1' if the specified media object is recognized</refpurpose>
31724 <synopsis><xsl:template name="is.acceptable.mediaobject">
31725 <xsl:param name="object"/>
31727 </xsl:template></synopsis>
31729 <refsect1><title>Description</title>
31731 <para>This template examines a media object and returns '1' if the
31732 object is recognized as a graphic.</para>
31734 </refsect1><refsect1><title>Parameters</title>
31737 <varlistentry><term>object</term>
31740 <para>The media object to consider.</para>
31746 </refsect1><refsect1><title>Returns</title>
31748 <para>0 or 1</para>
31750 </refsect1></refentry>
31752 <refentry id="template.check.id.unique">
31754 <refname>check.id.unique</refname>
31755 <refpurpose>Warn users about references to non-unique IDs</refpurpose>
31758 <synopsis><xsl:template name="check.id.unique">
31759 <xsl:param name="linkend"/>
31761 </xsl:template></synopsis>
31763 <refsect1><title>Description</title>
31765 <para>If passed an ID in <varname>linkend</varname>,
31766 <function>check.id.unique</function> prints
31767 a warning message to the user if either the ID does not exist or
31768 the ID is not unique.</para>
31770 </refsect1></refentry>
31772 <refentry id="template.check.idref.targets">
31774 <refname>check.idref.targets</refname>
31775 <refpurpose>Warn users about incorrectly typed references</refpurpose>
31778 <synopsis><xsl:template name="check.idref.targets">
31779 <xsl:param name="linkend"/>
31780 <xsl:param name="element-list"/>
31782 </xsl:template></synopsis>
31784 <refsect1><title>Description</title>
31786 <para>If passed an ID in <varname>linkend</varname>,
31787 <function>check.idref.targets</function> makes sure that the element
31788 pointed to by the link is one of the elements listed in
31789 <varname>element-list</varname> and warns the user otherwise.</para>
31791 </refsect1></refentry>
31793 <refentry id="template.copyright.years">
31795 <refname>copyright.years</refname>
31796 <refpurpose>Print a set of years with collapsed ranges</refpurpose>
31799 <synopsis><xsl:template name="copyright.years">
31800 <xsl:param name="years"/>
31801 <xsl:param name="print.ranges" select="1"/>
31802 <xsl:param name="single.year.ranges" select="0"/>
31803 <xsl:param name="firstyear" select="0"/>
31804 <xsl:param name="nextyear" select="0"/>
31806 </xsl:template></synopsis>
31808 <refsect1><title>Description</title>
31810 <para>This template prints a list of year elements with consecutive
31811 years printed as a range. In other words:</para>
31814 <screen><year>1992</year>
31815 <year>1993</year>
31816 <year>1994</year></screen>
31819 <para>is printed <quote>1992-1994</quote>, whereas:</para>
31822 <screen><year>1992</year>
31823 <year>1994</year></screen>
31826 <para>is printed <quote>1992, 1994</quote>.</para>
31830 <para>This template assumes that all the year elements contain only
31831 decimal year numbers, that the elements are sorted in increasing
31832 numerical order, that there are no duplicates, and that all the years
31833 are expressed in full <quote>century+year</quote>
31834 (<quote>1999</quote> not <quote>99</quote>) notation.</para>
31836 </refsect1><refsect1><title>Parameters</title>
31839 <varlistentry><term>years</term>
31842 <para>The initial set of year elements.</para>
31846 <varlistentry><term>print.ranges</term>
31849 <para>If non-zero, multi-year ranges are collapsed. If zero, all years
31850 are printed discretely.</para>
31854 <varlistentry><term>single.year.ranges</term>
31857 <para>If non-zero, two consecutive years will be printed as a range,
31858 otherwise, they will be printed discretely. In other words, a single
31859 year range is <quote>1991-1992</quote> but discretely it's
31860 <quote>1991, 1992</quote>.</para>
31866 </refsect1><refsect1><title>Returns</title>
31868 <para>This template returns the formatted list of years.</para>
31870 </refsect1></refentry>
31872 <refentry id="template.find.path.params">
31874 <refname>find.path.params</refname>
31875 <refpurpose>Search in a table for the "best" match for the node</refpurpose>
31878 <synopsis><xsl:template name="find.path.params">
31879 <xsl:param name="node" select="."/>
31880 <xsl:param name="table" select="''"/>
31881 <xsl:param name="location">
31882 <xsl:call-template name="xpath.location">
31883 <xsl:with-param name="node" select="$node"/>
31884 </xsl:call-template>
31887 </xsl:template></synopsis>
31889 <refsect1><title>Description</title>
31891 <para>This template searches in a table for the value that most-closely
31892 (in the typical best-match sense of XSLT) matches the current (element)
31893 node location.</para>
31895 </refsect1></refentry>
31897 <refentry id="template.string.upper">
31899 <refname>string.upper</refname>
31900 <refpurpose>Converts a string to all uppercase letters</refpurpose>
31903 <synopsis><xsl:template name="string.upper">
31904 <xsl:param name="string" select="''"/>
31906 </xsl:template></synopsis>
31908 <refsect1><title>Description</title>
31910 <para>Given a string, this template does a language-aware conversion
31911 of that string to all uppercase letters, based on the values of the
31912 <literal>lowercase.alpha</literal> and
31913 <literal>uppercase.alpha</literal> gentext keys for the current
31914 locale. It affects only those characters found in the values of
31915 <literal>lowercase.alpha</literal> and
31916 <literal>uppercase.alpha</literal>. All other characters are left
31919 </refsect1><refsect1><title>Parameters</title>
31922 <varlistentry><term>string</term>
31925 <para>The string to convert to uppercase.</para>
31931 </refsect1></refentry>
31933 <refentry id="template.string.lower">
31935 <refname>string.lower</refname>
31936 <refpurpose>Converts a string to all lowercase letters</refpurpose>
31939 <synopsis><xsl:template name="string.lower">
31940 <xsl:param name="string" select="''"/>
31942 </xsl:template></synopsis>
31944 <refsect1><title>Description</title>
31946 <para>Given a string, this template does a language-aware conversion
31947 of that string to all lowercase letters, based on the values of the
31948 <literal>uppercase.alpha</literal> and
31949 <literal>lowercase.alpha</literal> gentext keys for the current
31950 locale. It affects only those characters found in the values of
31951 <literal>uppercase.alpha</literal> and
31952 <literal>lowercase.alpha</literal>. All other characters are left
31955 </refsect1><refsect1><title>Parameters</title>
31958 <varlistentry><term>string</term>
31961 <para>The string to convert to lowercase.</para>
31967 </refsect1></refentry>
31969 <refentry id="template.select.choice.separator">
31971 <refname>select.choice.separator</refname>
31972 <refpurpose>Returns localized choice separator</refpurpose>
31975 <synopsis><xsl:template name="select.choice.separator"/></synopsis>
31977 <refsect1><title>Description</title>
31979 <para>This template enables auto-generation of an appropriate
31980 localized "choice" separator (for example, "and" or "or") before
31981 the final item in an inline list (though it could also be useful
31982 for generating choice separators for non-inline lists).</para>
31985 <para>It currently works by evaluating a processing instruction
31986 (PI) of the form <?dbchoice choice="foo"?> :
31990 <simpara>if the value of the <tag>choice</tag>
31991 pseudo-attribute is "and" or "or", returns a localized "and"
31995 <simpara>otherwise returns the literal value of the
31996 <tag>choice</tag> pseudo-attribute</simpara>
32000 The latter is provided only as a temporary workaround because the
32001 locale files do not currently have translations for the word
32002 <wordasword>or</wordasword>. So if you want to generate a a
32003 logical "or" separator in French (for example), you currently need
32005 <literallayout><?dbchoice choice="ou"?></literallayout>
32010 <para>The <tag>dbchoice</tag> processing instruction is
32011 an unfortunate hack; support for it may disappear in the future
32012 (particularly if and when a more appropriate means for marking
32013 up "choice" lists becomes available in DocBook).</para>
32016 </refsect1></refentry>
32018 <refentry id="template.evaluate.info.profile">
32020 <refname>evaluate.info.profile</refname>
32021 <refpurpose>Evaluates an info profile</refpurpose>
32024 <synopsis><xsl:template name="evaluate.info.profile">
32025 <xsl:param name="profile"/>
32026 <xsl:param name="info"/>
32028 </xsl:template></synopsis>
32030 <refsect1><title>Description</title>
32032 <para>This template evaluates an "info profile" matching the XPath
32033 expression given by the <parameter>profile</parameter>
32034 parameter. It relies on the XSLT <function>evaluate()</function>
32035 extension function.</para>
32039 <para>The value of the <parameter>profile</parameter> parameter
32040 can include the literal string <literal>$info</literal>. If found
32041 in the value of the <parameter>profile</parameter> parameter, the
32042 literal string <literal>$info</literal> string is replaced with
32043 the value of the <parameter>info</parameter> parameter, which
32044 should be a set of <replaceable>*info</replaceable> nodes; the
32045 expression is then evaluated using the XSLT
32046 <function>evaluate()</function> extension function.</para>
32048 </refsect1><refsect1><title>Parameters</title>
32052 <term>profile</term>
32055 <para>A string representing an XPath expression </para>
32063 <para>A set of *info nodes</para>
32069 </refsect1><refsect1><title>Returns</title>
32071 <para>Returns a node (the result of evaluating the
32072 <parameter>profile</parameter> parameter)</para>
32074 </refsect1></refentry>
32076 <reference id="refentry" xml:base="../common/refentry.xml">
32078 <title>Common » Refentry Metadata Template Reference</title>
32079 <releaseinfo role="meta">
32080 $Id: refentry.xsl 7867 2008-03-07 09:54:25Z xmldoc $
32084 <partintro id="partintro">
32085 <title>Introduction</title>
32087 <para>This is technical reference documentation for the “refentry
32088 metadata” templates in the DocBook XSL Stylesheets.</para>
32091 <para>This is not intended to be user documentation. It is provided
32092 for developers writing customization layers for the stylesheets.</para>
32096 <para>Currently, only the manpages stylesheets make use of these
32097 templates. They are, however, potentially useful elsewhere.</para>
32102 <refentry id="template.get.refentry.metadata">
32104 <refname>get.refentry.metadata</refname>
32105 <refpurpose>Gathers metadata from a refentry and its ancestors</refpurpose>
32108 <synopsis><xsl:template name="get.refentry.metadata">
32109 <xsl:param name="refname"/>
32110 <xsl:param name="info"/>
32111 <xsl:param name="prefs"/>
32113 </xsl:template></synopsis>
32115 <refsect1><title>Description</title>
32117 <para>Reference documentation for particular commands, functions,
32118 etc., is sometimes viewed in isolation from its greater "context". For
32119 example, users view Unix man pages as, well, individual pages, not as
32120 part of a "book" of some kind. Therefore, it is sometimes necessary to
32121 embed "context" information in output for each <tag>refentry</tag>.</para>
32125 <para>However, one problem is that different users mark up that
32126 context information in different ways. Often (usually), the
32127 context information is not actually part of the content of the
32128 <tag>refentry</tag> itself, but instead part of the content of a
32129 parent or ancestor element to the <tag>refentry</tag>. And
32130 even then, DocBook provides a variety of elements that users might
32131 potentially use to mark up the same kind of information. One user
32132 might use the <tag>productnumber</tag> element to mark up version
32133 information about a particular product, while another might use
32134 the <tag>releaseinfo</tag> element.</para>
32138 <para>Taking all that in mind, the
32139 <function>get.refentry.metadata</function> template tries to gather
32140 metadata from a <tag>refentry</tag> element and its ancestor
32141 elements in an intelligent and user-configurable way. The basic
32142 mechanism used in the XPath expressions throughout this stylesheet
32143 is to select the relevant metadata from the *info element that is
32144 closest to the actual <tag>refentry</tag> – either on the
32145 <tag>refentry</tag> itself, or on its nearest ancestor.</para>
32150 <para>The <function>get.refentry.metadata</function>
32151 template is actually just sort of a "driver" template; it
32152 calls other templates that do the actual data collection,
32153 then returns the data as a set.</para>
32157 </refsect1><refsect1><title>Parameters</title>
32161 <term>refname</term>
32164 <para>The first <tag>refname</tag> in the refentry</para>
32172 <para>A set of info nodes (from a <tag>refentry</tag>
32173 element and its ancestors)</para>
32181 <para>A node containing user preferences (from global
32182 stylesheet parameters)</para>
32188 </refsect1><refsect1><title>Returns</title>
32190 <para>Returns a node set with the following elements. The
32191 descriptions are verbatim from the <literal>man(7)</literal> man
32199 <para>the title of the man page (e.g., <literal>MAN</literal>)</para>
32204 <term>section</term>
32207 <para>the section number the man page should be placed in (e.g.,
32208 <literal>7</literal>)</para>
32216 <para>the date of the last revision</para>
32221 <term>source</term>
32224 <para>the source of the command</para>
32229 <term>manual</term>
32232 <para>the title of the manual (e.g., <citetitle>Linux
32233 Programmer's Manual</citetitle>)</para>
32241 </refsect1></refentry>
32243 <refentry id="template.get.refentry.title">
32245 <refname>get.refentry.title</refname>
32246 <refpurpose>Gets title metadata for a refentry</refpurpose>
32249 <synopsis><xsl:template name="get.refentry.title">
32250 <xsl:param name="refname"/>
32252 </xsl:template></synopsis>
32254 <refsect1><title>Description</title>
32256 <para>The <literal>man(7)</literal> man page describes this as "the
32257 title of the man page (e.g., <literal>MAN</literal>). This differs
32258 from <tag>refname</tag> in that, if the <tag>refentry</tag> has a
32259 <tag>refentrytitle</tag>, we use that as the <tag>title</tag>;
32260 otherwise, we just use first <tag>refname</tag> in the first
32261 <tag>refnamediv</tag> in the source.</para>
32263 </refsect1><refsect1><title>Parameters</title>
32267 <term>refname</term>
32270 <para>The first <tag>refname</tag> in the refentry</para>
32276 </refsect1><refsect1><title>Returns</title>
32278 <para>Returns a <tag>title</tag> node.</para>
32279 </refsect1></refentry>
32281 <refentry id="template.get.refentry.section">
32283 <refname>get.refentry.section</refname>
32284 <refpurpose>Gets section metadata for a refentry</refpurpose>
32287 <synopsis><xsl:template name="get.refentry.section">
32288 <xsl:param name="refname"/>
32289 <xsl:param name="quiet" select="0"/>
32291 </xsl:template></synopsis>
32293 <refsect1><title>Description</title>
32295 <para>The <literal>man(7)</literal> man page describes this as "the
32296 section number the man page should be placed in (e.g.,
32297 <literal>7</literal>)". If we do not find a <tag>manvolnum</tag>
32298 specified in the source, and we find that the <tag>refentry</tag> is
32299 for a function, we use the section number <literal>3</literal>
32300 ["Library calls (functions within program libraries)"]; otherwise, we
32301 default to using <literal>1</literal> ["Executable programs or shell
32304 </refsect1><refsect1><title>Parameters</title>
32308 <term>refname</term>
32311 <para>The first <tag>refname</tag> in the refentry</para>
32319 <para>If non-zero, no "missing" message is emitted</para>
32325 </refsect1><refsect1><title>Returns</title>
32327 <para>Returns a string representing a section number.</para>
32328 </refsect1></refentry>
32330 <refentry id="template.get.refentry.date">
32332 <refname>get.refentry.date</refname>
32333 <refpurpose>Gets date metadata for a refentry</refpurpose>
32336 <synopsis><xsl:template name="get.refentry.date">
32337 <xsl:param name="refname"/>
32338 <xsl:param name="info"/>
32339 <xsl:param name="prefs"/>
32341 </xsl:template></synopsis>
32343 <refsect1><title>Description</title>
32345 <para>The <literal>man(7)</literal> man page describes this as "the
32346 date of the last revision". If we cannot find a date in the source, we
32347 generate one.</para>
32349 </refsect1><refsect1><title>Parameters</title>
32353 <term>refname</term>
32356 <para>The first <tag>refname</tag> in the refentry</para>
32364 <para>A set of info nodes (from a <tag>refentry</tag>
32365 element and its ancestors)</para>
32373 <para>A node containing users preferences (from global stylesheet parameters)</para>
32379 </refsect1><refsect1><title>Returns</title>
32381 <para>Returns a <tag>date</tag> node.</para>
32383 </refsect1></refentry>
32385 <refentry id="template.get.refentry.source">
32387 <refname>get.refentry.source</refname>
32388 <refpurpose>Gets source metadata for a refentry</refpurpose>
32391 <synopsis><xsl:template name="get.refentry.source">
32392 <xsl:param name="refname"/>
32393 <xsl:param name="info"/>
32394 <xsl:param name="prefs"/>
32396 </xsl:template></synopsis>
32398 <refsect1><title>Description</title>
32400 <para>The <literal>man(7)</literal> man page describes this as "the
32401 source of the command", and provides the following examples:
32406 <para>For binaries, use something like: GNU, NET-2, SLS
32407 Distribution, MCC Distribution.</para>
32412 <para>For system calls, use the version of the kernel that you are
32413 currently looking at: Linux 0.99.11.</para>
32418 <para>For library calls, use the source of the function: GNU, BSD
32419 4.3, Linux DLL 4.4.1.</para>
32428 <para>The <literal>solbook(5)</literal> man page describes
32429 something very much like what <literal>man(7)</literal> calls
32430 "source", except that <literal>solbook(5)</literal> names it
32431 "software" and describes it like this:
32434 <para>This is the name of the software product that the topic
32435 discussed on the reference page belongs to. For example UNIX
32436 commands are part of the <literal>SunOS x.x</literal>
32444 <para>In practice, there are many pages that simply have a version
32445 number in the "source" field. So, it looks like what we have is a
32447 <replaceable>Name</replaceable> <replaceable>Version</replaceable>,
32455 <para>product name (e.g., BSD) or org. name (e.g., GNU)</para>
32460 <term>Version</term>
32463 <para>version name</para>
32469 Each part is optional. If the <replaceable>Name</replaceable> is a
32470 product name, then the <replaceable>Version</replaceable> is probably
32471 the version of the product. Or there may be no
32472 <replaceable>Name</replaceable>, in which case, if there is a
32473 <replaceable>Version</replaceable>, it is probably the version of the
32474 item itself, not the product it is part of. Or, if the
32475 <replaceable>Name</replaceable> is an organization name, then there
32476 probably will be no <replaceable>Version</replaceable>.
32479 </refsect1><refsect1><title>Parameters</title>
32483 <term>refname</term>
32486 <para>The first <tag>refname</tag> in the refentry</para>
32494 <para>A set of info nodes (from a <tag>refentry</tag>
32495 element and its ancestors)</para>
32503 <para>A node containing users preferences (from global
32504 stylesheet parameters)</para>
32510 </refsect1><refsect1><title>Returns</title>
32512 <para>Returns a <tag>source</tag> node.</para>
32514 </refsect1></refentry>
32516 <refentry id="template.get.refentry.source.name">
32518 <refname>get.refentry.source.name</refname>
32519 <refpurpose>Gets source-name metadata for a refentry</refpurpose>
32522 <synopsis><xsl:template name="get.refentry.source.name">
32523 <xsl:param name="refname"/>
32524 <xsl:param name="info"/>
32525 <xsl:param name="prefs"/>
32527 </xsl:template></synopsis>
32529 <refsect1><title>Description</title>
32531 <para>A "source name" is one part of a (potentially) two-part
32532 <replaceable>Name</replaceable> <replaceable>Version</replaceable>
32533 source field. For more details, see the documentation for the
32534 <function>get.refentry.source</function> template.</para>
32536 </refsect1><refsect1><title>Parameters</title>
32540 <term>refname</term>
32543 <para>The first <tag>refname</tag> in the refentry</para>
32551 <para>A set of info nodes (from a <tag>refentry</tag>
32552 element and its ancestors)</para>
32560 <para>A node containing users preferences (from global
32561 stylesheet parameters)</para>
32567 </refsect1><refsect1><title>Returns</title>
32569 <para>Depending on what output method is used for the
32570 current stylesheet, either returns a text node or possibly an element
32571 node, containing "source name" data.</para>
32573 </refsect1></refentry>
32575 <refentry id="template.get.refentry.version">
32577 <refname>get.refentry.version</refname>
32578 <refpurpose>Gets version metadata for a refentry</refpurpose>
32581 <synopsis><xsl:template name="get.refentry.version">
32582 <xsl:param name="refname"/>
32583 <xsl:param name="info"/>
32584 <xsl:param name="prefs"/>
32586 </xsl:template></synopsis>
32588 <refsect1><title>Description</title>
32590 <para>A "version" is one part of a (potentially) two-part
32591 <replaceable>Name</replaceable> <replaceable>Version</replaceable>
32592 source field. For more details, see the documentation for the
32593 <function>get.refentry.source</function> template.</para>
32595 </refsect1><refsect1><title>Parameters</title>
32599 <term>refname</term>
32602 <para>The first <tag>refname</tag> in the refentry</para>
32610 <para>A set of info nodes (from a <tag>refentry</tag>
32611 element and its ancestors)</para>
32619 <para>A node containing users preferences (from global
32620 stylesheet parameters)</para>
32626 </refsect1><refsect1><title>Returns</title>
32628 <para>Depending on what output method is used for the
32629 current stylesheet, either returns a text node or possibly an element
32630 node, containing "version" data.</para>
32632 </refsect1></refentry>
32634 <refentry id="template.get.refentry.manual">
32636 <refname>get.refentry.manual</refname>
32637 <refpurpose>Gets source metadata for a refentry</refpurpose>
32640 <synopsis><xsl:template name="get.refentry.manual">
32641 <xsl:param name="refname"/>
32642 <xsl:param name="info"/>
32643 <xsl:param name="prefs"/>
32645 </xsl:template></synopsis>
32647 <refsect1><title>Description</title>
32649 <para>The <literal>man(7)</literal> man page describes this as "the
32650 title of the manual (e.g., <citetitle>Linux Programmer's
32651 Manual</citetitle>)". Here are some examples from existing man pages:
32656 <para><citetitle>dpkg utilities</citetitle>
32657 (<command>dpkg-name</command>)</para>
32662 <para><citetitle>User Contributed Perl Documentation</citetitle>
32663 (<command>GET</command>)</para>
32668 <para><citetitle>GNU Development Tools</citetitle>
32669 (<command>ld</command>)</para>
32674 <para><citetitle>Emperor Norton Utilities</citetitle>
32675 (<command>ddate</command>)</para>
32680 <para><citetitle>Debian GNU/Linux manual</citetitle>
32681 (<command>faked</command>)</para>
32686 <para><citetitle>GIMP Manual Pages</citetitle>
32687 (<command>gimp</command>)</para>
32692 <para><citetitle>KDOC Documentation System</citetitle>
32693 (<command>qt2kdoc</command>)</para>
32702 <para>The <literal>solbook(5)</literal> man page describes
32703 something very much like what <literal>man(7)</literal> calls
32704 "manual", except that <literal>solbook(5)</literal> names it
32705 "sectdesc" and describes it like this:
32708 <para>This is the section title of the reference page; for
32709 example <literal>User Commands</literal>.</para>
32715 </refsect1><refsect1><title>Parameters</title>
32719 <term>refname</term>
32722 <para>The first <tag>refname</tag> in the refentry</para>
32730 <para>A set of info nodes (from a <tag>refentry</tag>
32731 element and its ancestors)</para>
32739 <para>A node containing users preferences (from global
32740 stylesheet parameters)</para>
32746 </refsect1><refsect1><title>Returns</title>
32748 <para>Returns a <tag>manual</tag> node.</para>
32750 </refsect1></refentry>
32752 <refentry id="template.get.refentry.metadata.prefs">
32754 <refname>get.refentry.metadata.prefs</refname>
32755 <refpurpose>Gets user preferences for refentry metadata gathering</refpurpose>
32758 <synopsis><xsl:template name="get.refentry.metadata.prefs"/></synopsis>
32760 <refsect1><title>Description</title>
32762 <para>The DocBook XSL stylesheets include several user-configurable
32763 global stylesheet parameters for controlling <tag>refentry</tag>
32764 metadata gathering. Those parameters are not read directly by the
32765 other <tag>refentry</tag> metadata-gathering
32766 templates. Instead, they are read only by the
32767 <function>get.refentry.metadata.prefs</function> template,
32768 which assembles them into a structure that is then passed to
32769 the other <tag>refentry</tag> metadata-gathering
32774 <para>So the, <function>get.refentry.metadata.prefs</function>
32775 template is the only interface to collecting stylesheet parameters for
32776 controlling <tag>refentry</tag> metadata gathering.</para>
32778 </refsect1><refsect1><title>Parameters</title>
32780 <para>There are no local parameters for this template; however, it
32781 does rely on a number of global parameters.</para>
32783 </refsect1><refsect1><title>Returns</title>
32785 <para>Returns a <tag>manual</tag> node.</para>
32787 </refsect1></refentry>
32789 <refentry id="template.set.refentry.metadata">
32791 <refname>set.refentry.metadata</refname>
32792 <refpurpose>Sets content of a refentry metadata item</refpurpose>
32795 <synopsis><xsl:template name="set.refentry.metadata">
32796 <xsl:param name="refname"/>
32797 <xsl:param name="info"/>
32798 <xsl:param name="contents"/>
32799 <xsl:param name="context"/>
32800 <xsl:param name="preferred"/>
32802 </xsl:template></synopsis>
32804 <refsect1><title>Description</title>
32806 <para>The <function>set.refentry.metadata</function> template is
32807 called each time a suitable source element is found for a certain
32808 metadata field.</para>
32810 </refsect1><refsect1><title>Parameters</title>
32814 <term>refname</term>
32817 <para>The first <tag>refname</tag> in the refentry</para>
32825 <para>A single *info node that contains the selected source element.</para>
32830 <term>contents</term>
32833 <para>A node containing the selected source element.</para>
32838 <term>context</term>
32841 <para>A string describing the metadata context in which the
32842 <function>set.refentry.metadata</function> template was
32843 called: either "date", "source", "version", or "manual".</para>
32849 </refsect1><refsect1><title>Returns</title>
32851 <para>Returns formatted contents of a selected source element.</para>
32852 </refsect1></refentry>
32854 <reference id="utility" xml:base="../common/utility.xml">
32856 <title>Common » Utility Template Reference</title>
32857 <releaseinfo role="meta">
32858 $Id: utility.xsl 7101 2007-07-20 15:32:12Z xmldoc $
32862 <partintro id="partintro">
32863 <title>Introduction</title>
32865 <para>This is technical reference documentation for the
32866 miscellaneous utility templates in the DocBook XSL
32867 Stylesheets.</para>
32871 <para>These templates are defined in a separate file from the set
32872 of “common” templates because some of the common templates
32873 reference DocBook XSL stylesheet parameters, requiring the
32874 entire set of parameters to be imported/included in any
32875 stylesheet that imports/includes the common templates.</para>
32878 <para>The utility templates don’t import or include any DocBook
32879 XSL stylesheet parameters, so the utility templates can be used
32880 without importing the whole set of parameters.</para>
32884 <para>This is not intended to be user documentation. It is
32885 provided for developers writing customization layers for the
32886 stylesheets.</para>
32890 <refentry id="template.log.message">
32892 <refname>log.message</refname>
32893 <refpurpose>Logs/emits formatted notes and warnings</refpurpose>
32896 <synopsis><xsl:template name="log.message">
32897 <xsl:param name="level"/>
32898 <xsl:param name="source"/>
32899 <xsl:param name="context-desc"/>
32900 <xsl:param name="context-desc-field-length">12</xsl:param>
32901 <xsl:param name="context-desc-padded">
32902 <xsl:if test="not($context-desc = '')">
32903 <xsl:call-template name="pad-string">
32904 <xsl:with-param name="leftRight">right</xsl:with-param>
32905 <xsl:with-param name="padVar" select="substring($context-desc, 1, $context-desc-field-length)"/>
32906 <xsl:with-param name="length" select="$context-desc-field-length"/>
32907 </xsl:call-template>
32910 <xsl:param name="message"/>
32911 <xsl:param name="message-field-length" select="45"/>
32912 <xsl:param name="message-padded">
32913 <xsl:variable name="spaces-for-blank-level">
32914 <!-- * if the level field is blank, we'll need to pad out -->
32915 <!-- * the message field with spaces to compensate -->
32917 <xsl:when test="$level = ''">
32918 <xsl:value-of select="4 + 2"/>
32919 <!-- * 4 = hard-coded length of comment text ("Note" or "Warn") -->
32920 <!-- * + 2 = length of colon-plus-space separator ": " -->
32922 <xsl:otherwise>
32923 <xsl:value-of select="0"/>
32924 </xsl:otherwise>
32925 </xsl:choose>
32926 </xsl:variable>
32927 <xsl:variable name="spaces-for-blank-context-desc">
32928 <!-- * if the context-description field is blank, we'll need -->
32929 <!-- * to pad out the message field with spaces to compensate -->
32931 <xsl:when test="$context-desc = ''">
32932 <xsl:value-of select="$context-desc-field-length + 2"/>
32933 <!-- * + 2 = length of colon-plus-space separator ": " -->
32935 <xsl:otherwise>
32936 <xsl:value-of select="0"/>
32937 </xsl:otherwise>
32938 </xsl:choose>
32939 </xsl:variable>
32940 <xsl:variable name="extra-spaces" select="$spaces-for-blank-level + $spaces-for-blank-context-desc"/>
32941 <xsl:call-template name="pad-string">
32942 <xsl:with-param name="leftRight">right</xsl:with-param>
32943 <xsl:with-param name="padVar" select="substring($message, 1, ($message-field-length + $extra-spaces))"/>
32944 <xsl:with-param name="length" select="$message-field-length + $extra-spaces"/>
32945 </xsl:call-template>
32948 </xsl:template></synopsis>
32950 <refsect1><title>Description</title>
32952 <para>The <function>log.message</function> template is a utility
32953 template for logging/emitting formatted messages – that is,
32954 notes and warnings, along with a given log “level” and an
32955 identifier for the “source” that the message relates to.</para>
32957 </refsect1><refsect1><title>Parameters</title>
32960 <varlistentry><term>level</term>
32963 <para>Text to log/emit in the message-level field to
32964 indicate the message level
32965 (<literal>Note</literal> or
32966 <literal>Warning</literal>)</para>
32970 <varlistentry><term>source</term>
32973 <para>Text to log/emit in the source field to identify the
32974 “source” to which the notification/warning relates.
32975 This can be any arbitrary string, but because the
32976 message lacks line and column numbers to identify the
32977 exact part of the source document to which it
32978 relates, the intention is that the value you pass
32979 into the <literal>source</literal> parameter should
32980 give the user some way to identify the portion of
32981 their source document on which to take potentially
32982 take action in response to the log message (for
32983 example, to edit, change, or add content).</para>
32986 <para>So the <literal>source</literal> value should be,
32987 for example, an ID, book/chapter/article title, title
32988 of some formal object, or even a string giving an
32989 XPath expression.</para>
32993 <varlistentry><term>context-desc</term>
32996 <para>Text to log/emit in the context-description field to
32997 describe the context for the message.</para>
33001 <varlistentry><term>context-desc-field-length</term>
33004 <para>Specifies length of the context-description field
33005 (in characters); default is 12</para>
33008 <para>If the text specified by the
33009 <literal>context-desc</literal> parameter is longer
33010 than the number of characters specified in
33011 <literal>context-desc-field-length</literal>, it is
33012 truncated to <literal>context-desc-field-length</literal>
33013 (12 characters by default).</para>
33016 <para>If the specified text is shorter than
33017 <literal>context-desc-field-length</literal>,
33018 it is right-padded out to
33019 <literal>context-desc-field-length</literal> (12 by
33023 <para>If no value has been specified for the
33024 <literal>context-desc</literal> parameter, the field is
33025 left empty and the text of the log message begins with
33026 the value of the <literal>message</literal>
33031 <varlistentry><term>message</term>
33034 <para>Text to log/emit in the actual message field</para>
33038 <varlistentry><term>message-field-length</term>
33041 <para>Specifies length of the message
33042 field (in characters); default is 45</para>
33048 </refsect1><refsect1><title>Returns</title>
33050 <para>Outputs a message (generally, to standard error).</para>
33051 </refsect1></refentry>
33053 <refentry id="template.get.doc.title">
33055 <refname>get.doc.title</refname>
33056 <refpurpose>Gets a title from the current document</refpurpose>
33059 <synopsis><xsl:template name="get.doc.title"/></synopsis>
33061 <refsect1><title>Description</title>
33063 <para>The <function>get.doc.title</function> template is a
33064 utility template for returning the first title found in the
33065 current document.</para>
33067 </refsect1><refsect1><title>Returns</title>
33069 <para>Returns a string containing some identifying title for the
33070 current document .</para>
33071 </refsect1></refentry>
33073 <refentry id="template.pad-string">
33075 <refname>pad-string</refname>
33076 <refpurpose>Right-pads or left-pads a string out to a certain length</refpurpose>
33079 <synopsis><xsl:template name="pad-string">
33080 <xsl:param name="padChar" select="' '"/>
33081 <xsl:param name="leftRight">left</xsl:param>
33082 <xsl:param name="padVar"/>
33083 <xsl:param name="length"/>
33085 </xsl:template></synopsis>
33087 <refsect1><title>Description</title>
33089 <para>This function takes string <parameter>padVar</parameter> and
33090 pads it out in the direction <parameter>rightLeft</parameter> to
33091 the string-length <parameter>length</parameter>, using string
33092 <parameter>padChar</parameter> (a space character by default) as
33093 the padding string (note that <parameter>padChar</parameter> can
33094 be a string; it is not limited to just being a single
33099 <para>This function began as a copy of Nate Austin's
33100 <function>prepend-pad</function> function in the <link xlink:href="http://www.dpawson.co.uk/xsl/sect2/padding.html">Padding
33101 Content</link> section of Dave Pawson's <link xlink:href="http://www.dpawson.co.uk/xsl/index.html">XSLT
33105 </refsect1><refsect1><title>Returns</title>
33107 <para>Returns a (padded) string.</para>
33108 </refsect1></refentry>
33110 <reference id="charmap" xml:base="../common/charmap.xml">
33112 <title>Common » Character-Map Template Reference</title>
33113 <releaseinfo role="meta">
33114 $Id: charmap.xsl 7266 2007-08-22 11:58:42Z xmldoc $
33118 <partintro id="partintro">
33119 <title>Introduction</title>
33121 <para>This is technical reference documentation for the
33122 character-map templates in the DocBook XSL Stylesheets.</para>
33126 <para>These templates are defined in a separate file from the set
33127 of “common” templates because some of the common templates
33128 reference DocBook XSL stylesheet parameters, requiring the
33129 entire set of parameters to be imported/included in any
33130 stylesheet that imports/includes the common templates.</para>
33133 <para>The character-map templates don’t import or include
33134 any DocBook XSL stylesheet parameters, so the
33135 character-map templates can be used without importing the
33136 whole set of parameters.</para>
33140 <para>This is not intended to be user documentation. It is
33141 provided for developers writing customization layers for the
33142 stylesheets.</para>
33146 <refentry id="template.apply-character-map">
33148 <refname>apply-character-map</refname>
33149 <refpurpose>Applies an XSLT character map</refpurpose>
33152 <synopsis><xsl:template name="apply-character-map">
33153 <xsl:param name="content"/>
33154 <xsl:param name="map.contents"/>
33156 </xsl:template></synopsis>
33158 <refsect1><title>Description</title>
33160 <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
33161 individual characters to be substituted with strings of one
33162 or more characters. It is useful mainly for replacing
33163 multiple “special” characters or symbols in the same target
33164 content. It uses the value of
33165 <parameter>map.contents</parameter> to do substitution on
33166 <parameter>content</parameter>, and then returns the
33167 modified contents.</para>
33171 <para>This template is a very slightly modified version of
33172 Jeni Tennison’s <function>replace_strings</function>
33173 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
33174 <link xlink:href="http://www.dpawson.co.uk/xsl/index.html">XSLT FAQ</link>.</para>
33177 <para>The <function>apply-string-subst-map</function>
33178 template is essentially the same template as the
33179 <function>apply-character-map</function> template; the
33180 only difference is that in the map that
33181 <function>apply-string-subst-map</function> expects, <tag class="attribute">oldstring</tag> and <tag class="attribute">newstring</tag> attributes are used
33182 instead of <tag class="attribute">character</tag> and <tag class="attribute">string</tag> attributes.</para>
33185 </refsect1><refsect1><title>Parameters</title>
33188 <varlistentry><term>content</term>
33191 <para>The content on which to perform the character-map
33192 substitution.</para>
33196 <varlistentry><term>map.contents</term>
33199 <para>A node set of elements, with each element having
33200 the following attributes:
33204 <simpara><tag class="attribute">character</tag>, a
33205 character to be replaced</simpara>
33208 <simpara><tag class="attribute">string</tag>, a
33209 string with which to replace <tag class="attribute">character</tag></simpara>
33219 </refsect1></refentry>
33221 <refentry id="template.read-character-map">
33223 <refname>read-character-map</refname>
33224 <refpurpose>Reads in all or part of an XSLT character map</refpurpose>
33227 <synopsis><xsl:template name="read-character-map">
33228 <xsl:param name="use.subset"/>
33229 <xsl:param name="subset.profile"/>
33230 <xsl:param name="uri"/>
33232 </xsl:template></synopsis>
33234 <refsect1><title>Description</title>
33236 <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
33237 to allow a specific character appearing in a text or
33238 attribute node in a final result tree to be substituted by
33239 a specified string of characters during serialization. The
33240 <function>read-character-map</function> template provides a
33241 means for reading and using character maps with XSLT
33242 1.0-based tools.</para>
33245 <para>This template reads the character-map contents from
33246 <parameter>uri</parameter> (in full or in part, depending on
33247 the value of the <parameter>use.subset</parameter>
33248 parameter), then passes those contents to the
33249 <function>apply-character-map</function> template, along with
33250 <parameter>content</parameter>, the data on which to perform
33251 the character substitution.</para>
33254 <para>Using the character map “in part” means that it uses only
33255 those <tag>output-character</tag> elements that match the
33256 XPath expression given in the value of the
33257 <parameter>subset.profile</parameter> parameter. The current
33258 implementation of that capability here relies on the
33259 <function>evaluate</function> extension XSLT function.</para>
33261 </refsect1><refsect1><title>Parameters</title>
33264 <varlistentry><term>use.subset</term>
33267 <para>Specifies whether to use a subset of the character
33268 map instead of the whole map; boolean
33269 <literal>0</literal> or <literal>1</literal></para>
33273 <varlistentry><term>subset.profile</term>
33276 <para>XPath expression that specifies what subset of the
33277 character map to use</para>
33281 <varlistentry><term>uri</term>
33284 <para>URI for a character map</para>
33290 </refsect1></refentry>
33293 <part id="table-templates">
33294 <?dbhtml dir="fo"?>
33296 <info xml:base="../fo/table.xml">
33297 <title>Formatting Object Table Reference</title>
33298 <releaseinfo role="meta">
33299 $Id: table.xsl 8814 2010-08-09 21:19:53Z bobstayton $
33302 <partintro id="partintro" xml:base="../fo/table.xml">
33303 <title>Introduction</title>
33305 <para>This is technical reference documentation for the FO
33306 table-processing templates in the DocBook XSL Stylesheets.</para>
33309 <para>This is not intended to be user documentation. It is
33310 provided for developers writing customization layers for the
33311 stylesheets.</para>
33315 <refentry id="template.calc.column.width" xml:base="../fo/table.xml">
33317 <refname>calc.column.width</refname>
33318 <refpurpose>Calculate an XSL FO table column width specification from a
33319 CALS table column width specification.</refpurpose>
33322 <synopsis><xsl:template name="calc.column.width">
33323 <xsl:param name="colwidth">1*</xsl:param>
33325 </xsl:template></synopsis>
33327 <refsect1><title>Description</title>
33329 <para>CALS expresses table column widths in the following basic
33337 <para><emphasis>99.99units</emphasis>, a fixed length specifier.</para>
33342 <para><emphasis>99.99</emphasis>, a fixed length specifier without any units.</para>
33347 <para><emphasis>99.99*</emphasis>, a relative length specifier.</para>
33352 <para><emphasis>99.99*+99.99units</emphasis>, a combination of both.</para>
33359 <para>The CALS units are points (pt), picas (pi), centimeters (cm),
33360 millimeters (mm), and inches (in). These are the same units as XSL,
33361 except that XSL abbreviates picas "pc" instead of "pi". If a length
33362 specifier has no units, the CALS default unit (pt) is assumed.</para>
33366 <para>Relative length specifiers are represented in XSL with the
33367 proportional-column-width() function.</para>
33371 <para>Here are some examples:</para>
33378 <para>"36pt" becomes "36pt"</para>
33383 <para>"3pi" becomes "3pc"</para>
33388 <para>"36" becomes "36pt"</para>
33393 <para>"3*" becomes "proportional-column-width(3)"</para>
33398 <para>"3*+2pi" becomes "proportional-column-width(3)+2pc"</para>
33403 <para>"1*+2" becomes "proportional-column-width(1)+2pt"</para>
33408 </refsect1><refsect1><title>Parameters</title>
33411 <varlistentry><term>colwidth</term>
33414 <para>The CALS column width specification.</para>
33420 </refsect1><refsect1><title>Returns</title>
33422 <para>The XSL column width specification.</para>
33424 </refsect1></refentry>
33427 <part id="template">
33428 <?dbhtml dir="template"?><?dbhtml filename="index.html"?>
33431 <info xml:base="../template/titlepage.xml">
33432 <title>Titlepage Template Stylesheet Reference</title>
33433 <releaseinfo role="meta">
33434 $Id: titlepage.xsl 7058 2007-07-17 13:59:29Z xmldoc $
33437 <partintro id="intro_partintro" xml:base="../template/titlepage.xml">
33438 <title>Introduction</title>
33440 <para>This is technical reference documentation for the
33441 “titlepage” templates in the DocBook XSL Stylesheets.</para>
33444 <para>This is not intended to be user documentation. It is
33445 provided for developers writing customization layers for the
33446 stylesheets.</para>
33450 <refentry id="templates" xml:base="../template/titlepage.xml">
33452 <refname>t:templates</refname>
33453 <refpurpose>Construct a stylesheet for the templates provided</refpurpose>
33456 <synopsis><xsl:template match="t:templates"/></synopsis>
33458 <refsect1><title>Description</title>
33460 <para>The <literal>t:templates</literal> element is the root of a
33461 set of templates. This template creates an appropriate
33462 <literal>xsl:stylesheet</literal> for the templates.</para>
33466 <para>If the <literal>t:templates</literal> element has a
33467 <literal>base-stylesheet</literal> attribute, an
33468 <literal>xsl:import</literal> statement is constructed for it.</para>
33470 </refsect1></refentry>
33472 <refentry id="star" xml:base="../template/titlepage.xml">
33474 <refname>xsl:*</refname>
33475 <refpurpose>Copy xsl: elements straight through</refpurpose>
33478 <synopsis><xsl:template match="xsl:*"/></synopsis>
33480 <refsect1><title>Description</title>
33482 <para>This template simply copies the xsl: elements
33483 straight through into the result tree.</para>
33485 </refsect1></refentry>
33487 <refentry id="titlepage" xml:base="../template/titlepage.xml">
33489 <refname>t:titlepage</refname>
33490 <refpurpose>Create the templates necessary to construct a title page</refpurpose>
33493 <synopsis><xsl:template match="t:titlepage"/></synopsis>
33495 <refsect1><title>Description</title>
33497 <para>The <literal>t:titlepage</literal> element creates a set of
33498 templates for processing the titlepage for an element. The
33499 <quote>root</quote> of this template set is the template named
33500 <quote><literal>wrapper.titlepage</literal></quote>. That is the
33501 template that should be called to generate the title page.
33506 <para>The <literal>t:titlepage</literal> element has three attributes:
33510 <varlistentry><term>element</term>
33512 <para>The name of the source document element for which
33513 these templates apply. In other words, to make a title page for the
33514 <tag>article</tag> element, set the
33515 <tag class="attribute">element</tag> attribute to
33516 <quote><literal>article</literal></quote>. This attribute is required.
33520 <varlistentry><term>wrapper</term>
33522 <para>The entire title page can be wrapped with an element.
33523 This attribute identifies that element.
33527 <varlistentry><term>class</term>
33529 <para>If the <tag class="attribute">class</tag> attribute
33530 is set, a <tag class="attribute">class</tag> attribute with this
33531 value will be added to the wrapper element that surrounds the entire
33542 <para>Any other attributes are copied through literally to the
33543 wrapper element.</para>
33547 <para>The content of a <literal>t:titlepage</literal> is one or
33548 more <literal>t:titlepage-content</literal>,
33549 <literal>t:titlepage-separator</literal>, and
33550 <literal>t:titlepage-before</literal> elements.</para>
33554 <para>Each of these elements may be provided for the <quote>recto</quote>
33555 and <quote>verso</quote> sides of the title page.</para>
33558 </refsect1></refentry>
33560 <refentry id="attr_star_in_copy.literal.atts" xml:base="../template/titlepage.xml">
33562 <refname>@* (in copy.literal.atts mode)</refname>
33563 <refpurpose>Copy t:titlepage attributes</refpurpose>
33566 <synopsis><xsl:template match="@*" mode="copy.literal.atts"/></synopsis>
33568 <refsect1><title>Description</title>
33570 <para>This template copies all of the <quote>other</quote> attributes
33571 from a <literal>t:titlepage</literal> element onto the specified
33574 </refsect1></refentry>
33576 <refentry id="titlepage-content" xml:base="../template/titlepage.xml">
33578 <refname>t:titlepage-content</refname>
33579 <refpurpose>Create templates for the content of one side of a title page</refpurpose>
33582 <synopsis><xsl:template match="t:titlepage-content"/></synopsis>
33584 <refsect1><title>Description</title>
33586 <para>The title page content, that is, the elements from the source
33587 document that are rendered on the title page, can be controlled independently
33588 for the recto and verso sides of the title page.</para>
33592 <para>The <literal>t:titlepage-content</literal> element has two attributes:
33596 <varlistentry><term>side</term>
33598 <para>Identifies the side of the page to which this title
33599 page content applies. The
33600 <tag class="attribute">side</tag> attribute is required and
33601 must be set to either
33602 <quote><literal>recto</literal></quote> or
33603 <quote><literal>verso</literal></quote>. In addition, you must specify
33604 exactly one <literal>t:titlepage-content</literal> for each side
33605 within each <literal>t:titlepage</literal>.</para>
33609 <varlistentry><term>order</term>
33611 <para>Indicates how the order of the elements presented on
33612 the title page is determined. If the
33613 <tag class="attribute">order</tag> is
33614 <quote><literal>document</literal></quote>, the elements are presented
33615 in document order. Otherwise (if the
33616 <tag class="attribute">order</tag> is
33617 <quote><literal>stylesheet</literal></quote>), the elements are presented
33618 in the order that they appear in the template (and consequently in
33619 the stylesheet).</para>
33629 <para>The content of a <literal>t:titlepage-content</literal> element is
33630 a list of element names. These names should be unqualified. They identify
33631 the elements in the source document that should appear on the title page.
33636 <para>Each element may have a single attribute:
33637 <tag class="attribute">predicate</tag>. The value of this
33638 attribute is used as a predicate for the expression that matches
33639 the element on which it occurs.</para>
33643 <para>In other words, to put only the first three authors on the
33644 recto-side of a title
33645 page, you could specify:
33648 <t:titlepage-contents side="recto">
33649 <!-- other titlepage elements -->
33650 <author predicate="[count(previous-sibling::author)<2]"/>
33651 <!-- other titlepage elements -->
33652 </t:titlepage-contents>
33658 <para>Usually, the elements so named are empty. But it is possible to
33659 make one level of selection within them. Suppose that you want to
33660 process <literal>authorgroup</literal> elements on the title page, but
33661 you want to select only proper authors, editors, or corporate authors,
33662 not collaborators or other credited authors.</para>
33666 <para>In that case, you can put a <literal>t:or</literal> group inside
33667 the <literal>authorgroup</literal> element:
33670 <t:titlepage-contents side="recto">
33671 <!-- other titlepage elements -->
33672 <authorgroup>
33676 <corpauthor/>
33678 </authorgroup>
33679 <!-- other titlepage elements -->
33680 </t:titlepage-contents>
33686 <para>This will have the effect of automatically generating a template
33687 for processing <literal>authorgroup</literal>s in the title page mode,
33688 selecting only the specified children. If you need more complex processing,
33689 you'll have to construct the templates by hand.</para>
33692 </refsect1></refentry>
33694 <refentry id="titlepage-separator" xml:base="../template/titlepage.xml">
33696 <refname>t:titlepage-separator</refname>
33697 <refpurpose>Create templates for the separator</refpurpose>
33700 <synopsis><xsl:template match="t:titlepage-separator"/></synopsis>
33702 <refsect1><title>Description</title>
33704 <para>The title page is separated from the content which follows it by
33705 the markup specified in the <literal>t:titlepage-separator</literal>
33708 </refsect1></refentry>
33710 <refentry id="titlepage-before" xml:base="../template/titlepage.xml">
33712 <refname>t:titlepage-before</refname>
33713 <refpurpose>Create templates for what precedes a title page</refpurpose>
33716 <synopsis><xsl:template match="t:titlepage-before"/></synopsis>
33718 <refsect1><title>Description</title>
33720 <para>Each side of the title page is preceded by the markup specified
33721 in the <literal>t:titlepage-before</literal> element for that
33724 </refsect1></refentry>
33726 <refentry id="star_in_copy" xml:base="../template/titlepage.xml">
33728 <refname>* (in copy mode)</refname>
33729 <refpurpose>Copy elements</refpurpose>
33732 <synopsis><xsl:template match="*" mode="copy"/></synopsis>
33734 <refsect1><title>Description</title>
33736 <para>This template simply copies the elements that it applies to
33737 straight through into the result tree.</para>
33739 </refsect1></refentry>
33741 <refentry id="attr_star_in_copy" xml:base="../template/titlepage.xml">
33743 <refname>@* (in copy mode)</refname>
33744 <refpurpose>Copy attributes</refpurpose>
33747 <synopsis><xsl:template match="@*" mode="copy"/></synopsis>
33749 <refsect1><title>Description</title>
33751 <para>This template simply copies the attributes that it applies to
33752 straight through into the result tree.</para>
33754 </refsect1></refentry>
33756 <refentry id="attr_star_in_document.order" xml:base="../template/titlepage.xml">
33758 <refname>* (in document.order mode)</refname>
33759 <refpurpose>Create rules to process titlepage elements in document order</refpurpose>
33762 <synopsis><xsl:template match="*" mode="document.order"/></synopsis>
33764 <refsect1><title>Description</title>
33766 <para>This template is called to process all of the children of the
33767 <literal>t:titlepage-content</literal> element. It creates the hairy
33768 select expression necessary to process each of those elements in
33769 the title page.</para>
33773 <para>Note that this template automatically handles the case where
33774 some DocBook elements, like title and subtitle, can occur both inside
33775 the *info elements where metadata is usually stored and outside.
33780 <para>It also automatically calculates the name for the *info container
33781 and handles elements that have historically had containers with different
33785 </refsect1></refentry>
33787 <refentry id="star_in_document.order" xml:base="../template/titlepage.xml">
33789 <refname>* (in document.order mode)</refname>
33790 <refpurpose>Create rules to process titlepage elements in stylesheet order</refpurpose>
33793 <synopsis><xsl:template match="*" mode="document.order"/></synopsis>
33795 <refsect1><title>Description</title>
33797 <para>This template is called to process all of the children of the
33798 <literal>t:titlepage-content</literal> element. It creates the set
33799 of <literal>xsl:apply-templates</literal> elements necessary
33800 process each of those elements in the title page.</para>
33804 <para>Note that this template automatically handles the case where
33805 some DocBook elements, like title and subtitle, can occur both inside
33806 the *info elements where metadata is usually stored and outside.
33811 <para>It also automatically calculates the name for the *info container
33812 and handles elements that have historically had containers with different
33816 </refsect1></refentry>
33818 <refentry id="star_in_titlepage.specialrules" xml:base="../template/titlepage.xml">
33820 <refname>* (in titlepage.specialrules mode)</refname>
33821 <refpurpose>Create templates for special rules</refpurpose>
33824 <synopsis><xsl:template match="*" mode="titlepage.specialrules"/></synopsis>
33826 <refsect1><title>Description</title>
33828 <para>This template is called to process all of the descendants of the
33829 <literal>t:titlepage-content</literal> element that require special
33830 processing. At present, that's just <literal>t:or</literal> elements.
33833 </refsect1></refentry>
33835 <refentry id="star_in_titlepage.subrules" xml:base="../template/titlepage.xml">
33837 <refname>* (in titlepage.subrules mode)</refname>
33838 <refpurpose>Create template for individual special rules</refpurpose>
33841 <synopsis><xsl:template match="*" mode="titlepage.subrules"/></synopsis>
33843 <refsect1><title>Description</title>
33845 <para>This template is called to process the children of special
33849 </refsect1></refentry>
33851 <refentry id="or" xml:base="../template/titlepage.xml">
33853 <refname>t:or</refname>
33854 <refpurpose>Process the t:or special rule</refpurpose>
33857 <synopsis><xsl:template match="t:or"/><xsl:template match="t:or" mode="titlepage.subrules"/></synopsis>
33859 <refsect1><title>Description</title>
33861 <para>This template processes t:or.</para>
33863 </refsect1></refentry>
33865 <refentry id="or_in_titlepage.subrules" xml:base="../template/titlepage.xml">
33867 <refname>t:or (in titlepage.subrules mode)</refname>
33868 <refpurpose>Process the t:or special rule in
33869 titlepage.subrules mode</refpurpose>
33872 <synopsis><xsl:template match="t:or" mode="titlepage.subrules"/></synopsis>
33874 <refsect1><title>Description</title>
33876 <para>The titlepage.subrules mode doesn't apply to t:or, so just
33877 reprocess this node in the normal mode.</para>
33879 </refsect1></refentry>
33881 <refentry id="template.element-or-list" xml:base="../template/titlepage.xml">
33883 <refname>element-or-list</refname>
33884 <refpurpose>Construct the "or-list" used in the select attribute for
33885 special rules.</refpurpose>
33888 <synopsis><xsl:template name="element-or-list">
33889 <xsl:param name="elements" select="*"/>
33890 <xsl:param name="element.count" select="count($elements)"/>
33891 <xsl:param name="count" select="1"/>
33892 <xsl:param name="orlist"/>
33894 </xsl:template></synopsis>
33896 <refsect1><title>Description</title>
33898 <para>Walk through each of the children of t:or, producing the
33899 text of the select attribute.</para>
33901 </refsect1></refentry>
33905 </set><!-- * vim: set ft=docbk foldlevel=2: -->