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">maybe</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">http://docbook.sourceforge.net/release/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 </reference><reference id="xslt" xml:base="../html/param.xml"><title>XSLT Processing</title>
2849 <refentry version="5.0" id="rootid">
2851 <refentrytitle>rootid</refentrytitle>
2852 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
2855 <refname>rootid</refname>
2856 <refpurpose>Specify the root element to format</refpurpose>
2860 <programlisting id="rootid.frag">
2861 <xsl:param name="rootid"></xsl:param></programlisting>
2864 <refsection><info><title>Description</title></info>
2866 <para>If <parameter>rootid</parameter> is not empty, it must be the
2867 value of an ID that occurs in the document being formatted. The entire
2868 document will be loaded and parsed, but formatting will begin at the
2869 element identified, rather than at the root. For example, this allows
2870 you to process only <tag>chapter</tag> 4 of a <tag>book</tag>.</para>
2871 <para>Because the entire document is available to the processor, automatic
2872 numbering, cross references, and other dependencies are correctly
2878 <refentry version="5.0" id="suppress.navigation">
2880 <refentrytitle>suppress.navigation</refentrytitle>
2881 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
2884 <refname>suppress.navigation</refname>
2885 <refpurpose>Disable header and footer navigation</refpurpose>
2889 <programlisting id="suppress.navigation.frag">
2890 <xsl:param name="suppress.navigation" select="0"></xsl:param>
2894 <refsection><info><title>Description</title></info>
2897 If non-zero, header and footer navigation will be suppressed.</para>
2902 <refentry version="5.0" id="suppress.header.navigation">
2904 <refentrytitle>suppress.header.navigation</refentrytitle>
2905 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
2908 <refname>suppress.header.navigation</refname>
2909 <refpurpose>Disable header navigation</refpurpose>
2913 <programlisting id="suppress.header.navigation.frag">
2914 <xsl:param name="suppress.header.navigation" select="0"></xsl:param>
2918 <refsection><info><title>Description</title></info>
2920 <para>If non-zero, header navigation will be suppressed.</para>
2925 <refentry version="5.0" id="suppress.footer.navigation">
2927 <refentrytitle>suppress.footer.navigation</refentrytitle>
2928 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
2931 <refname>suppress.footer.navigation</refname>
2932 <refpurpose>Disable footer navigation</refpurpose>
2936 <programlisting id="suppress.footer.navigation.frag"><xsl:param name="suppress.footer.navigation">0</xsl:param></programlisting>
2939 <refsection><info><title>Description</title></info>
2942 If non-zero, footer navigation will be suppressed.</para>
2947 <refentry version="5.0" id="header.rule">
2949 <refentrytitle>header.rule</refentrytitle>
2950 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
2953 <refname>header.rule</refname>
2954 <refpurpose>Rule under headers?</refpurpose>
2958 <programlisting id="header.rule.frag">
2959 <xsl:param name="header.rule" select="1"></xsl:param>
2963 <refsection><info><title>Description</title></info>
2965 <para>If non-zero, a rule will be drawn below the page headers.</para>
2970 <refentry version="5.0" id="footer.rule">
2972 <refentrytitle>footer.rule</refentrytitle>
2973 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
2976 <refname>footer.rule</refname>
2977 <refpurpose>Rule over footers?</refpurpose>
2981 <programlisting id="footer.rule.frag">
2982 <xsl:param name="footer.rule" select="1"></xsl:param>
2986 <refsection><info><title>Description</title></info>
2988 <para>If non-zero, a rule will be drawn above the page footers.</para>
2993 <refentry version="5.0" id="id.warnings">
2995 <refentrytitle>id.warnings</refentrytitle>
2996 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
2999 <refname>id.warnings</refname>
3000 <refpurpose>Should warnings be generated for titled elements without IDs?</refpurpose>
3003 <programlisting id="id.warnings.frag">
3004 <xsl:param name="id.warnings" select="0"></xsl:param>
3007 <refsection><info><title>Description</title></info>
3008 <para>If non-zero, the stylesheet will issue a warning for any element
3009 (other than the root element) which has a <tag>title</tag> but does not have an
3014 </reference><reference id="meta" xml:base="../html/param.xml"><title>Meta/*Info and Titlepages</title>
3015 <refentry version="5.0" id="inherit.keywords">
3017 <refentrytitle>inherit.keywords</refentrytitle>
3018 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3021 <refname>inherit.keywords</refname>
3022 <refpurpose>Inherit keywords from ancestor elements?</refpurpose>
3026 <programlisting id="inherit.keywords.frag">
3027 <xsl:param name="inherit.keywords" select="1"></xsl:param></programlisting>
3030 <refsection><info><title>Description</title></info>
3032 <para>If <parameter>inherit.keywords</parameter>
3033 is non-zero, the keyword <literal>meta</literal> for each HTML
3034 <literal>head</literal> element will include all of the keywords from
3035 ancestor elements. Otherwise, only the keywords from the current section
3042 <refentry version="5.0" id="make.single.year.ranges">
3044 <refentrytitle>make.single.year.ranges</refentrytitle>
3045 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3048 <refname>make.single.year.ranges</refname>
3049 <refpurpose>Print single-year ranges (e.g., 1998-1999)</refpurpose>
3053 <programlisting id="make.single.year.ranges.frag">
3054 <xsl:param name="make.single.year.ranges" select="0"></xsl:param></programlisting>
3057 <refsection><info><title>Description</title></info>
3059 <para>If non-zero, year ranges that span a single year will be printed
3060 in range notation (1998-1999) instead of discrete notation
3061 (1998, 1999).</para>
3066 <refentry version="5.0" id="make.year.ranges">
3068 <refentrytitle>make.year.ranges</refentrytitle>
3069 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3072 <refname>make.year.ranges</refname>
3073 <refpurpose>Collate copyright years into ranges?</refpurpose>
3077 <programlisting id="make.year.ranges.frag"><xsl:param name="make.year.ranges" select="0"></xsl:param></programlisting>
3080 <refsection><info><title>Description</title></info>
3082 <para>If non-zero, multiple copyright <tag>year</tag> elements will be
3083 collated into ranges.
3084 This works only if each year number is put into a separate
3085 year element. The copyright element permits multiple
3086 year elements. If a year element contains a dash or
3087 a comma, then that year element will not be merged into
3094 <refentry version="5.0" id="author.othername.in.middle">
3096 <refentrytitle>author.othername.in.middle</refentrytitle>
3097 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3100 <refname>author.othername.in.middle</refname>
3101 <refpurpose>Is <tag>othername</tag> in <tag>author</tag> a
3102 middle name?</refpurpose>
3106 <programlisting id="author.othername.in.middle.frag">
3107 <xsl:param name="author.othername.in.middle" select="1"></xsl:param></programlisting>
3110 <refsection><info><title>Description</title></info>
3112 <para>If non-zero, the <tag>othername</tag> of an <tag>author</tag>
3113 appears between the <tag>firstname</tag> and
3114 <tag>surname</tag>. Otherwise, <tag>othername</tag>
3121 <refentry version="5.0" id="blurb.on.titlepage.enabled">
3123 <refentrytitle>blurb.on.titlepage.enabled</refentrytitle>
3124 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3127 <refname>blurb.on.titlepage.enabled</refname>
3128 <refpurpose>Display personblurb and authorblurb on title pages?</refpurpose>
3132 <programlisting id="blurb.on.titlepage.enabled.frag">
3133 <xsl:param name="blurb.on.titlepage.enabled" select="0"></xsl:param>
3137 <refsection><info><title>Description</title></info>
3139 <para>If non-zero, output from <tag>authorblurb</tag> and
3140 <tag>personblurb</tag> elements is displayed on title pages. If zero
3141 (the default), output from those elements is suppressed on title pages
3142 (unless you are using a <literal>titlepage</literal> customization
3143 that causes them to be included).</para>
3148 <refentry version="5.0" id="contrib.inline.enabled">
3150 <refentrytitle>contrib.inline.enabled</refentrytitle>
3151 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3154 <refname>contrib.inline.enabled</refname>
3155 <refpurpose>Display contrib output inline?</refpurpose>
3159 <programlisting id="contrib.inline.enabled.frag"><xsl:param name="contrib.inline.enabled">1</xsl:param></programlisting>
3162 <refsection><info><title>Description</title></info>
3164 <para>If non-zero (the default), output of the <tag>contrib</tag> element is
3165 displayed as inline content rather than as block content.</para>
3170 <refentry version="5.0" id="editedby.enabled">
3172 <refentrytitle>editedby.enabled</refentrytitle>
3173 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3176 <refname>editedby.enabled</refname>
3177 <refpurpose>Display “Edited by” heading above editor name?</refpurpose>
3181 <programlisting id="editedby.enabled.frag"><xsl:param name="editedby.enabled">1</xsl:param></programlisting>
3184 <refsection><info><title>Description</title></info>
3186 <para>If non-zero, a localized <emphasis role="bold">Edited
3187 by</emphasis> heading is displayed above editor names in output of the
3188 <tag>editor</tag> element.</para>
3193 <refentry version="5.0" id="abstract.notitle.enabled">
3195 <refentrytitle>abstract.notitle.enabled</refentrytitle>
3196 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3199 <refname>abstract.notitle.enabled</refname>
3200 <refpurpose>Suppress display of abstract titles?</refpurpose>
3203 <programlisting id="abstract.notitle.enabled.frag"><xsl:param name="abstract.notitle.enabled" select="0"></xsl:param></programlisting>
3205 <refsection><info><title>Description</title></info>
3206 <para>If non-zero, in output of the <tag>abstract</tag> element on titlepages,
3207 display of the abstract title is suppressed.</para>
3211 <refentry version="5.0" id="othercredit.like.author.enabled">
3213 <refentrytitle>othercredit.like.author.enabled</refentrytitle>
3214 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3217 <refname>othercredit.like.author.enabled</refname>
3218 <refpurpose>Display othercredit in same style as author?</refpurpose>
3222 <programlisting id="othercredit.like.author.enabled.frag"><xsl:param name="othercredit.like.author.enabled">0</xsl:param></programlisting>
3225 <refsection><info><title>Description</title></info>
3227 <para>If non-zero, output of the
3228 <tag>othercredit</tag> element on titlepages is displayed in
3229 the same style as <tag>author</tag> and
3230 <tag>editor</tag> output. If zero then
3231 <tag>othercredit</tag> output is displayed using a style
3232 different than that of <tag>author</tag> and
3233 <tag>editor</tag>.</para>
3238 <refentry version="5.0" id="generate.legalnotice.link">
3240 <refentrytitle>generate.legalnotice.link</refentrytitle>
3241 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3244 <refname>generate.legalnotice.link</refname>
3245 <refpurpose>Write legalnotice to separate chunk and generate link?</refpurpose>
3249 <programlisting id="generate.legalnotice.link.frag"><xsl:param name="generate.legalnotice.link" select="0"></xsl:param></programlisting>
3252 <refsection><info><title>Description</title></info>
3254 <para>If the value of <parameter>generate.legalnotice.link</parameter>
3255 is non-zero, the stylesheet:
3259 <para>writes the contents of <tag>legalnotice</tag> to a separate
3263 <para>inserts a hyperlink to the <tag>legalnotice</tag> file</para>
3266 <para>adds (in the HTML <literal>head</literal>) either a single
3267 <literal>link</literal> or element or multiple
3268 <literal>link</literal> elements (depending on the value of the
3269 <parameter>html.head.legalnotice.link.multiple</parameter>
3270 parameter), with the value or values derived from the
3271 <parameter>html.head.legalnotice.link.types</parameter>
3276 Otherwise, if <parameter>generate.legalnotice.link</parameter> is
3277 zero, <tag>legalnotice</tag> contents are rendered on the title
3280 <para>The name of the separate HTML file is computed as follows:
3284 <para>If a filename is given by the <tag class="xmlpi">dbhtml filename</tag>
3285 processing instruction, that filename is used.</para>
3288 <para>If the legalnotice has an <tag class="attribute">id</tag>/<tag class="attribute">xml:id</tag>
3289 attribute, and if <parameter>use.id.as.filename</parameter> != 0, the filename
3290 is the concatenation of the id value and the value of the <parameter>html.ext</parameter>
3294 <para>If the legalnotice does not have an <tag class="attribute">id</tag>/<tag class="attribute">xml:id</tag>
3295 attribute, or if <parameter>use.id.as.filename</parameter> = 0, the filename is the concatenation of "ln-",
3296 auto-generated id value, and <parameter>html.ext</parameter> value.
3306 <refentry version="5.0" id="generate.revhistory.link">
3308 <refentrytitle>generate.revhistory.link</refentrytitle>
3309 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3312 <refname>generate.revhistory.link</refname>
3313 <refpurpose>Write revhistory to separate chunk and generate link?</refpurpose>
3317 <programlisting id="generate.revhistory.link.frag"><xsl:param name="generate.revhistory.link" select="0"></xsl:param></programlisting>
3320 <refsection><info><title>Description</title></info>
3322 <para>If non-zero, the contents of <tag>revhistory</tag> are written
3323 to a separate HTML file and a link to the file is
3324 generated. Otherwise, <tag>revhistory</tag> contents are rendered on
3325 the title page.</para>
3327 <para>The name of the separate HTML file is computed as follows:
3331 <para>If a filename is given by the <tag class="xmlpi">dbhtml filename</tag> processing instruction,
3332 that filename is used.</para>
3335 <para>If the revhistory has an <tag class="attribute">id</tag>/<tag class="attribute">xml:id</tag>
3336 attribute, and if <parameter>use.id.as.filename</parameter> != 0, the filename is the concatenation of
3337 the id value and the value of the <parameter>html.ext</parameter> parameter.</para>
3340 <para>If the revhistory does not have an <tag class="attribute">id</tag>/<tag class="attribute">xml:id</tag>
3341 attribute, or if <parameter>use.id.as.filename</parameter> = 0, the filename is the concatenation of "rh-",
3342 auto-generated id value, and <parameter>html.ext</parameter> value.
3352 <refentry version="5.0" id="html.head.legalnotice.link.types">
3354 <refentrytitle>html.head.legalnotice.link.types</refentrytitle>
3355 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
3358 <refname>html.head.legalnotice.link.types</refname>
3359 <refpurpose>Specifies link types for legalnotice link in html head</refpurpose>
3363 <programlisting id="html.head.legalnotice.link.types.frag">
3364 <xsl:param name="html.head.legalnotice.link.types">copyright</xsl:param>
3368 <refsection><info><title>Description</title></info>
3371 <parameter>html.head.legalnotice.link.types</parameter> is a
3372 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
3373 of the HTML 4.01 specification</link>. If the value of the
3374 <parameter>generate.legalnotice.link</parameter> parameter is
3375 non-zero, then the stylesheet generates (in the
3376 <literal>head</literal> section of the HTML source) either a single
3377 HTML <literal>link</literal> element or, if the value of the
3378 <parameter>html.head.legalnotice.link.multiple</parameter> is
3379 non-zero, one <literal>link</literal> element for each link type
3380 specified. Each <literal>link</literal> has the following attributes:
3384 <para>a <tag class="attribute">rel</tag> attribute whose
3385 value is derived from the value of
3386 <parameter>html.head.legalnotice.link.types</parameter></para>
3389 <para>an <tag class="attribute">href</tag> attribute whose
3390 value is set to the URL of the file containing the
3391 <tag>legalnotice</tag></para>
3394 <para>a <tag class="attribute">title</tag> attribute whose
3395 value is set to the title of the corresponding
3396 <tag>legalnotice</tag> (or a title programatically
3397 determined by the stylesheet)</para>
3403 <screen> <link rel="license" href="ln-id2524073.html" title="Legal Notice"></screen>
3406 <refsection><info><title>About the default value</title></info>
3408 <para>In an ideal world, the default value of
3409 <parameter>html.head.legalnotice.link.types</parameter> would
3410 probably be “<literal>license</literal>”, since the content of the
3411 DocBook <tag>legalnotice</tag> is typically license
3412 information, not copyright information. However, the default value
3413 is “<literal>copyright</literal>” for pragmatic reasons: because
3414 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
3415 6.12 of the HTML 4.01 specification</link>, and because certain
3416 browsers and browser extensions are preconfigured to recognize that
3423 <refentry version="5.0" id="html.head.legalnotice.link.multiple">
3425 <refentrytitle>html.head.legalnotice.link.multiple</refentrytitle>
3426 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3429 <refname>html.head.legalnotice.link.multiple</refname>
3430 <refpurpose>Generate multiple link instances in html head for legalnotice?</refpurpose>
3434 <programlisting id="html.head.legalnotice.link.multiple.frag">
3435 <xsl:param name="html.head.legalnotice.link.multiple" select="1"></xsl:param>
3439 <refsection><info><title>Description</title></info>
3441 <para>If <parameter>html.head.legalnotice.link.multiple</parameter> is
3442 non-zero and the value of
3443 <parameter>html.head.legalnotice.link.types</parameter> contains
3444 multiple link types, then the stylesheet generates (in the
3445 <literal>head</literal> section of the HTML source) one
3446 <literal>link</literal> element for each link type specified. For
3447 example, if the value of
3448 <parameter>html.head.legalnotice.link.types</parameter> is
3449 “<literal>copyright license</literal>”:
3451 <screen> <link rel="copyright" href="ln-id2524073.html" title="Legal Notice">
3452 <link rel="license" href="ln-id2524073.html" title="Legal Notice"></screen>
3454 Otherwise, the stylesheet generates generates a single
3455 <literal>link</literal> instance; for example:
3457 <screen> <link rel="copyright license" href="ln-id2524073.html" title="Legal Notice"></screen>
3463 </reference><reference id="refentry" xml:base="../html/param.xml"><title>Reference Pages</title>
3464 <refentry version="5.0" id="funcsynopsis.decoration">
3466 <refentrytitle>funcsynopsis.decoration</refentrytitle>
3467 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3470 <refname>funcsynopsis.decoration</refname>
3471 <refpurpose>Decorate elements of a <tag>funcsynopsis</tag>?</refpurpose>
3475 <programlisting id="funcsynopsis.decoration.frag">
3476 <xsl:param name="funcsynopsis.decoration" select="1"></xsl:param>
3480 <refsection><info><title>Description</title></info>
3482 <para>If non-zero, elements of the <tag>funcsynopsis</tag> will be
3483 decorated (e.g. rendered as bold or italic text). The decoration is controlled by
3484 templates that can be redefined in a customization layer.
3490 <refentry version="5.0" id="funcsynopsis.style">
3492 <refentrytitle>funcsynopsis.style</refentrytitle>
3493 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
3494 <refmiscinfo class="other" otherclass="value">ansi</refmiscinfo>
3495 <refmiscinfo class="other" otherclass="value">kr</refmiscinfo>
3498 <refname>funcsynopsis.style</refname>
3499 <refpurpose>What style of <tag>funcsynopsis</tag> should be generated?</refpurpose>
3503 <programlisting id="funcsynopsis.style.frag"><xsl:param name="funcsynopsis.style">kr</xsl:param></programlisting>
3506 <refsection><info><title>Description</title></info>
3508 <para>If <parameter>funcsynopsis.style</parameter> is <literal>ansi</literal>,
3509 ANSI-style function synopses are generated for a
3510 <tag>funcsynopsis</tag>, otherwise K&R-style
3511 function synopses are generated.
3517 <refentry version="5.0" id="function.parens">
3519 <refentrytitle>function.parens</refentrytitle>
3520 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3523 <refname>function.parens</refname>
3524 <refpurpose>Generate parens after a function?</refpurpose>
3528 <programlisting id="function.parens.frag">
3529 <xsl:param name="function.parens" select="0"></xsl:param>
3533 <refsection><info><title>Description</title></info>
3535 <para>If non-zero, the formatting of a <tag>function</tag> element
3536 will include generated parentheses.
3542 <refentry version="5.0" id="refentry.generate.name">
3544 <refentrytitle>refentry.generate.name</refentrytitle>
3545 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3548 <refname>refentry.generate.name</refname>
3549 <refpurpose>Output NAME header before <tag>refname</tag>s?</refpurpose>
3553 <programlisting id="refentry.generate.name.frag">
3554 <xsl:param name="refentry.generate.name" select="1"></xsl:param>
3558 <refsection><info><title>Description</title></info>
3560 <para>If non-zero, a "NAME" section title is output before the list
3561 of <tag>refname</tag>s. This parameter and
3562 <parameter>refentry.generate.title</parameter> are mutually
3563 exclusive. This means that if you change this parameter to zero, you
3564 should set <parameter>refentry.generate.title</parameter> to non-zero unless
3565 you want get quite strange output.
3571 <refentry version="5.0" id="refentry.generate.title">
3573 <refentrytitle>refentry.generate.title</refentrytitle>
3574 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3577 <refname>refentry.generate.title</refname>
3578 <refpurpose>Output title before <tag>refname</tag>s?</refpurpose>
3582 <programlisting id="refentry.generate.title.frag">
3583 <xsl:param name="refentry.generate.title" select="0"></xsl:param>
3587 <refsection><info><title>Description</title></info>
3589 <para>If non-zero, the reference page title or first name is
3590 output before the list of <tag>refname</tag>s. This parameter and
3591 <parameter>refentry.generate.name</parameter> are mutually exclusive.
3592 This means that if you change this parameter to non-zero, you
3593 should set <parameter>refentry.generate.name</parameter> to zero unless
3594 you want get quite strange output.</para>
3600 <refentry version="5.0" id="refentry.xref.manvolnum">
3602 <refentrytitle>refentry.xref.manvolnum</refentrytitle>
3603 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3606 <refname>refentry.xref.manvolnum</refname>
3607 <refpurpose>Output <tag>manvolnum</tag> as part of
3608 <tag>refentry</tag> cross-reference?</refpurpose>
3612 <programlisting id="refentry.xref.manvolnum.frag">
3613 <xsl:param name="refentry.xref.manvolnum" select="1"></xsl:param>
3617 <refsection><info><title>Description</title></info>
3619 <para>if non-zero, the <tag>manvolnum</tag> is used when cross-referencing
3620 <tag>refentry</tag>s, either with <tag>xref</tag>
3621 or <tag>citerefentry</tag>.
3627 <refentry version="5.0" id="citerefentry.link">
3629 <refentrytitle>citerefentry.link</refentrytitle>
3630 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3633 <refname>citerefentry.link</refname>
3634 <refpurpose>Generate URL links when cross-referencing RefEntrys?</refpurpose>
3638 <programlisting id="citerefentry.link.frag">
3639 <xsl:param name="citerefentry.link" select="0"></xsl:param></programlisting>
3642 <refsection><info><title>Description</title></info>
3644 <para>If non-zero, a web link will be generated, presumably
3645 to an online man->HTML gateway. The text of the link is
3646 generated by the <literal>generate.citerefentry.link</literal> template.
3652 <refentry version="5.0" id="refentry.separator">
3654 <refentrytitle>refentry.separator</refentrytitle>
3655 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3658 <refname>refentry.separator</refname>
3659 <refpurpose>Generate a separator between consecutive RefEntry elements?</refpurpose>
3663 <programlisting id="refentry.separator.frag">
3664 <xsl:param name="refentry.separator" select="1"></xsl:param>
3668 <refsection><info><title>Description</title></info>
3670 <para>If true, a separator will be generated between consecutive
3677 <refentry version="5.0" id="refclass.suppress">
3679 <refentrytitle>refclass.suppress</refentrytitle>
3680 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3683 <refname>refclass.suppress</refname>
3684 <refpurpose>Suppress display of refclass contents?</refpurpose>
3688 <programlisting id="refclass.suppress.frag">
3689 <xsl:param name="refclass.suppress" select="0"></xsl:param></programlisting>
3692 <refsection><info><title>Description</title></info>
3694 <para>If the value of <parameter>refclass.suppress</parameter> is
3695 non-zero, then display of <tag>refclass</tag> contents is
3696 suppressed in output.</para>
3701 </reference><reference id="tables" xml:base="../html/param.xml"><title>Tables</title>
3702 <refentry version="5.0" id="default.table.width">
3704 <refentrytitle>default.table.width</refentrytitle>
3705 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
3708 <refname>default.table.width</refname>
3709 <refpurpose>The default width of tables</refpurpose>
3712 <programlisting id="default.table.width.frag">
3713 <xsl:param name="default.table.width"></xsl:param>
3716 <refsection><info><title>Description</title></info>
3717 <para>If non-zero, this value will be used for the
3718 <literal>width</literal> attribute on <tag>table</tag>s that do not specify an
3719 alternate width (with the <tag class="xmlpi">dbhtml table-width</tag> or
3720 <tag class="xmlpi">dbfo table-width</tag> processing instruction).</para>
3724 <refentry version="5.0" id="nominal.table.width">
3726 <refentrytitle>nominal.table.width</refentrytitle>
3727 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
3730 <refname>nominal.table.width</refname>
3731 <refpurpose>The (absolute) nominal width of tables</refpurpose>
3735 <programlisting id="nominal.table.width.frag">
3736 <xsl:param name="nominal.table.width">6in</xsl:param>
3740 <refsection><info><title>Description</title></info>
3742 <para>In order to convert CALS column widths into HTML column widths, it
3743 is sometimes necessary to have an absolute table width to use for conversion
3744 of mixed absolute and relative widths. This value must be an absolute
3745 length (not a percentage).</para>
3750 <refentry version="5.0" id="table.borders.with.css">
3752 <refentrytitle>table.borders.with.css</refentrytitle>
3753 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3756 <refname>table.borders.with.css</refname>
3757 <refpurpose>Use CSS to specify table, row, and cell borders?</refpurpose>
3761 <programlisting id="table.borders.with.css.frag">
3762 <xsl:param name="table.borders.with.css" select="0"></xsl:param>
3766 <refsection><info><title>Description</title></info>
3768 <para>If non-zero, CSS will be used to draw table borders.
3774 <refentry version="5.0" id="table.cell.border.style">
3776 <refentrytitle>table.cell.border.style</refentrytitle>
3777 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
3778 <refmiscinfo class="other" otherclass="value">none</refmiscinfo>
3779 <refmiscinfo class="other" otherclass="value">solid</refmiscinfo>
3780 <refmiscinfo class="other" otherclass="value">dotted</refmiscinfo>
3781 <refmiscinfo class="other" otherclass="value">dashed</refmiscinfo>
3782 <refmiscinfo class="other" otherclass="value">double</refmiscinfo>
3783 <refmiscinfo class="other" otherclass="value">groove</refmiscinfo>
3784 <refmiscinfo class="other" otherclass="value">ridge</refmiscinfo>
3785 <refmiscinfo class="other" otherclass="value">inset</refmiscinfo>
3786 <refmiscinfo class="other" otherclass="value">outset</refmiscinfo>
3787 <refmiscinfo class="other" otherclass="value">solid</refmiscinfo>
3790 <refname>table.cell.border.style</refname>
3791 <refpurpose>Specifies the border style of table cells</refpurpose>
3795 <programlisting id="table.cell.border.style.frag">
3796 <xsl:param name="table.cell.border.style">solid</xsl:param>
3800 <refsection><info><title>Description</title></info>
3802 <para>Specifies the border style of table cells.</para>
3805 <para>To control properties of cell borders in HTML output, you must also turn on the
3806 <parameter>table.borders.with.css</parameter> parameter.</para>
3812 <refentry version="5.0" id="table.cell.border.thickness">
3814 <refentrytitle>table.cell.border.thickness</refentrytitle>
3815 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
3818 <refname>table.cell.border.thickness</refname>
3819 <refpurpose>Specifies the thickness of table cell borders</refpurpose>
3823 <programlisting id="table.cell.border.thickness.frag">
3824 <xsl:param name="table.cell.border.thickness">0.5pt</xsl:param>
3828 <refsection><info><title>Description</title></info>
3830 <para>If non-zero, specifies the thickness of borders on table
3831 cells. The units are points. See <link xlink:href="http://www.w3.org/TR/CSS21/box.html#border-width-properties">
3835 <para>To control properties of cell borders in HTML output, you must also turn on the
3836 <parameter>table.borders.with.css</parameter> parameter.</para>
3842 <refentry version="5.0" id="table.cell.border.color">
3844 <refentrytitle>table.cell.border.color</refentrytitle>
3845 <refmiscinfo class="other" otherclass="datatype">color</refmiscinfo>
3848 <refname>table.cell.border.color</refname>
3849 <refpurpose>Specifies the border color of table cells</refpurpose>
3853 <programlisting id="table.cell.border.color.frag">
3854 <xsl:param name="table.cell.border.color"></xsl:param>
3859 <refsection><info><title>Description</title></info>
3861 <para>Set the color of table cell borders. If non-zero, the value is used
3862 for the border coloration. See <link xlink:href="http://www.w3.org/TR/CSS21/syndata.html#value-def-color">CSS</link>. A
3863 <literal>color</literal> is either a keyword or a numerical RGB specification.
3864 Keywords are aqua, black, blue, fuchsia, gray, green, lime, maroon,
3865 navy, olive, orange, purple, red, silver, teal, white, and
3869 <para>To control properties of cell borders in HTML output, you must also turn on the
3870 <parameter>table.borders.with.css</parameter> parameter.</para>
3876 <refentry version="5.0" id="table.frame.border.style">
3878 <refentrytitle>table.frame.border.style</refentrytitle>
3879 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
3880 <refmiscinfo class="other" otherclass="value">none</refmiscinfo>
3881 <refmiscinfo class="other" otherclass="value">solid</refmiscinfo>
3882 <refmiscinfo class="other" otherclass="value">dotted</refmiscinfo>
3883 <refmiscinfo class="other" otherclass="value">dashed</refmiscinfo>
3884 <refmiscinfo class="other" otherclass="value">double</refmiscinfo>
3885 <refmiscinfo class="other" otherclass="value">groove</refmiscinfo>
3886 <refmiscinfo class="other" otherclass="value">ridge</refmiscinfo>
3887 <refmiscinfo class="other" otherclass="value">inset</refmiscinfo>
3888 <refmiscinfo class="other" otherclass="value">outset</refmiscinfo>
3889 <refmiscinfo class="other" otherclass="value">solid</refmiscinfo>
3892 <refname>table.frame.border.style</refname>
3893 <refpurpose>Specifies the border style of table frames</refpurpose>
3897 <programlisting id="table.frame.border.style.frag">
3898 <xsl:param name="table.frame.border.style">solid</xsl:param>
3902 <refsection><info><title>Description</title></info>
3904 <para>Specifies the border style of table frames.</para>
3909 <refentry version="5.0" id="table.frame.border.thickness">
3911 <refentrytitle>table.frame.border.thickness</refentrytitle>
3912 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
3915 <refname>table.frame.border.thickness</refname>
3916 <refpurpose>Specifies the thickness of the frame border</refpurpose>
3920 <programlisting id="table.frame.border.thickness.frag">
3921 <xsl:param name="table.frame.border.thickness">0.5pt</xsl:param>
3925 <refsection><info><title>Description</title></info>
3927 <para>Specifies the thickness of the border on the table's frame.</para>
3932 <refentry version="5.0" id="table.frame.border.color">
3934 <refentrytitle>table.frame.border.color</refentrytitle>
3935 <refmiscinfo class="other" otherclass="datatype">color</refmiscinfo>
3938 <refname>table.frame.border.color</refname>
3939 <refpurpose>Specifies the border color of table frames</refpurpose>
3943 <programlisting id="table.frame.border.color.frag">
3944 <xsl:param name="table.frame.border.color"></xsl:param>
3949 <refsection><info><title>Description</title></info>
3951 <para>Specifies the border color of table frames.</para>
3956 <refentry version="5.0" id="default.table.frame">
3958 <refentrytitle>default.table.frame</refentrytitle>
3959 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
3962 <refname>default.table.frame</refname>
3963 <refpurpose>The default framing of tables</refpurpose>
3967 <programlisting id="default.table.frame.frag">
3968 <xsl:param name="default.table.frame">all</xsl:param>
3972 <refsection><info><title>Description</title></info>
3974 <para>This value will be used when there is no frame attribute on the
3980 <refentry version="5.0" id="html.cellspacing">
3982 <refentrytitle>html.cellspacing</refentrytitle>
3983 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
3986 <refname>html.cellspacing</refname>
3987 <refpurpose>Default value for cellspacing in HTML tables</refpurpose>
3991 <programlisting id="html.cellspacing.frag">
3992 <xsl:param name="html.cellspacing"></xsl:param>
3996 <refsection><info><title>Description</title></info>
3998 <para>If non-zero, this value will be used as the default cellspacing
3999 value in HTML tables. nn for pixels or nn% for percentage
4000 length. E.g. 5 or 5%</para>
4005 <refentry version="5.0" id="html.cellpadding">
4007 <refentrytitle>html.cellpadding</refentrytitle>
4008 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
4011 <refname>html.cellpadding</refname>
4012 <refpurpose>Default value for cellpadding in HTML tables</refpurpose>
4016 <programlisting id="html.cellpadding.frag">
4017 <xsl:param name="html.cellpadding"></xsl:param>
4021 <refsection><info><title>Description</title></info>
4023 <para>If non-zero, this value will be used as the default cellpadding value
4024 in HTML tables. nn for pixels or nn% for percentage length. E.g. 5 or
4030 </reference><reference id="qa" xml:base="../html/param.xml"><title>QAndASet</title>
4031 <refentry version="5.0" id="qanda.defaultlabel">
4033 <refentrytitle>qanda.defaultlabel</refentrytitle>
4034 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
4035 <refmiscinfo class="other" otherclass="value">number</refmiscinfo>
4036 <refmiscinfo class="other" otherclass="value">qanda</refmiscinfo>
4037 <refmiscinfo class="other" otherclass="value">none</refmiscinfo>
4040 <refname>qanda.defaultlabel</refname>
4041 <refpurpose>Sets the default for defaultlabel on QandASet.</refpurpose>
4045 <programlisting id="qanda.defaultlabel.frag">
4046 <xsl:param name="qanda.defaultlabel">number</xsl:param>
4050 <refsection><info><title>Description</title></info>
4052 <para>If no <literal>defaultlabel</literal> attribute is specified on
4053 a <tag>qandaset</tag>, this value is used. It is generally one of the legal
4054 values for the defaultlabel attribute (<literal>none</literal>,
4055 <literal>number</literal> or
4056 <literal>qanda</literal>), or one of the additional stylesheet-specific values
4057 (<literal>qnumber</literal> or <literal>qnumberanda</literal>).
4058 The default value is 'number'.
4060 <para>The values are rendered as follows:</para>
4062 <varlistentry><term><literal>qanda</literal></term>
4064 <para><tag>question</tag>s are labeled "Q:" and
4065 <tag>answer</tag>s are labeled "A:". </para>
4069 <varlistentry><term><literal>number</literal></term>
4071 <para>The questions are enumerated and the answers
4072 are not labeled. </para>
4076 <varlistentry><term><literal>qnumber</literal></term>
4078 <para>The questions are labeled "Q:" followed by a number, and answers are not
4080 When sections are numbered, adding a label
4081 to the number distinguishes the question numbers
4082 from the section numbers.
4083 This value is not allowed in the
4084 <tag class="attribute">defaultlabel</tag> attribute
4085 of a <tag>qandaset</tag> element.</para>
4089 <varlistentry><term><literal>qnumberanda</literal></term>
4091 <para>The questions are labeled "Q:" followed by a number, and
4092 the answers are labeled "A:".
4093 When sections are numbered, adding a label
4094 to the number distinguishes the question numbers
4095 from the section numbers.
4096 This value is not allowed in the
4097 <tag class="attribute">defaultlabel</tag> attribute
4098 of a <tag>qandaset</tag> element.</para>
4102 <varlistentry><term><literal>none</literal></term>
4104 <para>No distinguishing label precedes Questions or Answers.
4113 <refentry version="5.0" id="qanda.inherit.numeration">
4115 <refentrytitle>qanda.inherit.numeration</refentrytitle>
4116 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
4119 <refname>qanda.inherit.numeration</refname>
4120 <refpurpose>Does enumeration of QandASet components inherit the numeration of parent elements?</refpurpose>
4124 <programlisting id="qanda.inherit.numeration.frag">
4125 <xsl:param name="qanda.inherit.numeration" select="1"></xsl:param>
4129 <refsection><info><title>Description</title></info>
4131 <para>If non-zero, numbered <tag>qandadiv</tag> elements and
4132 <tag>question</tag> and <tag>answer</tag> inherit the enumeration of
4133 the ancestors of the <tag>qandaset</tag>.
4139 <refentry version="5.0" id="qanda.in.toc">
4141 <refentrytitle>qanda.in.toc</refentrytitle>
4142 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
4145 <refname>qanda.in.toc</refname>
4146 <refpurpose>Should qandaentry questions appear in
4147 the document table of contents?</refpurpose>
4151 <programlisting id="qanda.in.toc.frag"><xsl:param name="qanda.in.toc" select="0"></xsl:param></programlisting>
4154 <refsection><info><title>Description</title></info>
4156 <para>If true (non-zero), then the generated table of contents
4157 for a document will include <tag>qandaset</tag> titles,
4158 <tag>qandadiv</tag> titles,
4159 and <tag>question</tag> elements. The default value (zero) excludes
4162 <para>This parameter does not affect any tables of contents
4163 that may be generated inside a qandaset or qandadiv.
4169 <refentry version="5.0" id="qanda.nested.in.toc">
4171 <refentrytitle>qanda.nested.in.toc</refentrytitle>
4172 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
4175 <refname>qanda.nested.in.toc</refname>
4176 <refpurpose>Should nested answer/qandaentry instances appear in TOC?</refpurpose>
4180 <programlisting id="qanda.nested.in.toc.frag">
4181 <xsl:param name="qanda.nested.in.toc" select="0"></xsl:param>
4185 <refsection><info><title>Description</title></info>
4187 <para>If non-zero, instances of <tag>qandaentry</tag>
4188 that are children of <tag>answer</tag> elements are shown in
4194 </reference><reference id="links" xml:base="../html/param.xml"><title>Linking</title>
4195 <refentry version="5.0" id="target.database.document">
4197 <refentrytitle>target.database.document</refentrytitle>
4198 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
4201 <refname>target.database.document</refname>
4202 <refpurpose>Name of master database file for resolving
4206 <programlisting id="target.database.document.frag">
4207 <xsl:param name="target.database.document">olinkdb.xml</xsl:param>
4210 <refsection><info><title>Description</title></info>
4213 To resolve olinks between documents, the stylesheets use a master
4214 database document that identifies the target datafiles for all the
4215 documents within the scope of the olinks. This parameter value is the
4216 URI of the master document to be read during processing to resolve
4217 olinks. The default value is <filename>olinkdb.xml</filename>.</para>
4219 <para>The data structure of the file is defined in the
4220 <filename>targetdatabase.dtd</filename> DTD. The database file
4221 provides the high level elements to record the identifiers, locations,
4222 and relationships of documents. The cross reference data for
4223 individual documents is generally pulled into the database using
4224 system entity references or XIncludes. See also
4225 <parameter>targets.filename</parameter>. </para> </refsection>
4228 <refentry version="5.0" id="targets.filename">
4230 <refentrytitle>targets.filename</refentrytitle>
4231 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
4234 <refname>targets.filename</refname>
4235 <refpurpose>Name of cross reference targets data file</refpurpose>
4237 <refsynopsisdiv> <programlisting id="targets.filename.frag">
4238 <xsl:param name="targets.filename">target.db</xsl:param>
4241 <refsection><info><title>Description</title></info>
4244 In order to resolve olinks efficiently, the stylesheets can
4245 generate an external data file containing information about
4246 all potential cross reference endpoints in a document.
4247 This parameter lets you change the name of the generated
4248 file from the default name <filename>target.db</filename>.
4249 The name must agree with that used in the target database
4250 used to resolve olinks during processing.
4251 See also <parameter>target.database.document</parameter>.
4256 <refentry version="5.0" id="olink.base.uri">
4258 <refentrytitle>olink.base.uri</refentrytitle>
4259 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
4262 <refname>olink.base.uri</refname>
4263 <refpurpose>Base URI used in olink hrefs</refpurpose>
4265 <refsynopsisdiv> <programlisting id="olink.base.uri.frag">
4266 <xsl:param name="olink.base.uri"></xsl:param>
4269 <refsection><info><title>Description</title></info>
4271 <para>When cross reference data is collected for resolving olinks, it
4272 may be necessary to prepend a base URI to each target's href. This
4273 parameter lets you set that base URI when cross reference data is
4274 collected. This feature is needed when you want to link to a document
4275 that is processed without chunking. The output filename for such a
4276 document is not known to the XSL stylesheet; the only target
4277 information consists of fragment identifiers such as
4278 <literal>#idref</literal>. To enable the resolution of olinks between
4279 documents, you should pass the name of the HTML output file as the
4280 value of this parameter. Then the hrefs recorded in the cross
4281 reference data collection look like
4282 <literal>outfile.html#idref</literal>, which can be reached as links
4283 from other documents.</para>
4287 <refentry version="5.0" id="use.local.olink.style">
4289 <refentrytitle>use.local.olink.style</refentrytitle>
4290 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
4293 <refname>use.local.olink.style</refname>
4294 <refpurpose>Process olinks using xref style of current
4295 document</refpurpose>
4297 <refsynopsisdiv> <programlisting id="use.local.olink.style.frag">
4298 <xsl:param name="use.local.olink.style" select="0"></xsl:param> </programlisting>
4300 <refsection><info><title>Description</title></info>
4302 <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
4303 reference string is formed again from the target title, number, and
4304 element name, using the stylesheet processing the targeting document.
4305 Then olinks will match the xref style in the targeting document
4306 rather than in the target document. If both documents are processed
4307 with the same stylesheet, then the results will be the same.</para>
4311 <refentry version="5.0" id="current.docid">
4313 <refentrytitle>current.docid</refentrytitle>
4314 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
4317 <refname>current.docid</refname>
4318 <refpurpose>targetdoc identifier for the document being
4319 processed</refpurpose>
4321 <refsynopsisdiv> <programlisting id="current.docid.frag">
4322 <xsl:param name="current.docid"></xsl:param>
4325 <refsection><info><title>Description</title></info>
4327 <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
4328 the targetdoc identifier of the current document, since that
4329 identifier does not appear in the document itself. </para>
4330 <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>
4334 <refentry version="5.0" id="olink.doctitle">
4336 <refentrytitle>olink.doctitle</refentrytitle>
4337 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
4338 <refmiscinfo class="other" otherclass="value">no</refmiscinfo>
4339 <refmiscinfo class="other" otherclass="value">yes</refmiscinfo>
4340 <refmiscinfo class="other" otherclass="value">maybe</refmiscinfo>
4343 <refname>olink.doctitle</refname>
4344 <refpurpose>show the document title for external olinks?</refpurpose>
4347 <refsynopsisdiv> <programlisting id="olink.doctitle.frag">
4348 <xsl:param name="olink.doctitle">no</xsl:param>
4351 <refsection><info><title>Description</title></info>
4353 <para>When olinks between documents are resolved, the generated text
4354 may not make it clear that the reference is to another document.
4355 It is possible for the stylesheets to append the other document's
4356 title to external olinks. For this to happen, two parameters must
4360 <para>This <parameter>olink.doctitle</parameter> parameter
4361 should be set to either <literal>yes</literal> or <literal>maybe</literal>
4362 to enable this feature.
4366 <para>And you should also set the <parameter>current.docid</parameter>
4367 parameter to the document id for the document currently
4368 being processed for output.
4374 Then if an olink's <literal>targetdoc</literal> id differs from
4375 the <literal>current.docid</literal> value, the stylesheet knows
4376 that it is a reference to another document and can
4377 append the target document's
4378 title to the generated olink text. </para>
4380 <para>The text for the target document's title is copied from the
4381 olink database from the <tag>ttl</tag> element
4382 of the top-level <tag>div</tag> for that document.
4383 If that <tag>ttl</tag> element is missing or empty,
4387 <para>The supported values for <parameter>olink.doctitle</parameter> are:
4391 <term><literal>yes</literal></term>
4394 Always insert the title to the target document if it is not
4395 the current document.
4400 <term><literal>no</literal></term>
4403 Never insert the title to the target document, even if requested
4404 in an <tag class="attribute">xrefstyle</tag> attribute.
4409 <term><literal>maybe</literal></term>
4412 Only insert the title to the target document, if requested
4413 in an <tag class="attribute">xrefstyle</tag> attribute.
4418 <para>An <tag class="attribute">xrefstyle</tag> attribute
4419 may override the global setting for individual olinks.
4420 The following values are supported in an
4421 <tag class="attribute">xrefstyle</tag>
4422 attribute using the <literal>select:</literal> syntax:
4427 <term><literal>docname</literal></term>
4430 Insert the target document name for this olink using the
4431 <literal>docname</literal> gentext template, but only
4432 if the value of <parameter>olink.doctitle</parameter>
4433 is not <literal>no</literal>.
4438 <term><literal>docnamelong</literal></term>
4441 Insert the target document name for this olink using the
4442 <literal>docnamelong</literal> gentext template, but only
4443 if the value of <parameter>olink.doctitle</parameter>
4444 is not <literal>no</literal>.
4449 <term><literal>nodocname</literal></term>
4452 Omit the target document name even if
4453 the value of <parameter>olink.doctitle</parameter>
4454 is <literal>yes</literal>.
4459 <para>Another way of inserting the target document name
4460 for a single olink is to employ an
4461 <tag class="attribute">xrefstyle</tag>
4462 attribute using the <literal>template:</literal> syntax.
4463 The <literal>%o</literal> placeholder (the letter o, not zero)
4465 will be filled in with the target document's title when it is processed.
4466 This will occur regardless of
4467 the value of <parameter>olink.doctitle</parameter>.
4469 <para>Note that prior to version 1.66 of the XSL stylesheets,
4470 the allowed values for this parameter were 0 and 1. Those
4471 values are still supported and mapped to 'no' and 'yes', respectively.
4476 <refentry version="5.0" id="olink.debug">
4478 <refentrytitle>olink.debug</refentrytitle>
4479 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
4482 <refname>olink.debug</refname>
4483 <refpurpose>Turn on debugging messages for olinks</refpurpose>
4487 <programlisting id="olink.debug.frag">
4488 <xsl:param name="olink.debug" select="0"></xsl:param>
4492 <refsection><info><title>Description</title></info>
4494 <para>If non-zero, then each olink will generate several
4495 messages about how it is being resolved during processing.
4496 This is useful when an olink does not resolve properly
4497 and the standard error messages are not sufficient to
4501 <para>You may need to read through the olink XSL templates
4502 to understand the context for some of the debug messages.
4508 <refentry version="5.0" id="olink.properties">
4510 <refentrytitle>olink.properties</refentrytitle>
4511 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
4514 <refname>olink.properties</refname>
4515 <refpurpose>Properties associated with the cross-reference
4516 text of an olink.</refpurpose>
4520 <programlisting id="olink.properties.frag">
4521 <xsl:attribute-set name="olink.properties">
4522 <xsl:attribute name="show-destination">replace</xsl:attribute>
4523 </xsl:attribute-set>
4527 <refsection><info><title>Description</title></info>
4529 <para>This <literal>attribute set</literal> is applied to the
4530 <literal>fo:basic-link</literal> element of an olink. It is not applied to the
4531 optional page number or optional title of the external
4537 <refentry version="5.0" id="olink.lang.fallback.sequence">
4539 <refentrytitle>olink.lang.fallback.sequence</refentrytitle>
4540 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
4543 <refname>olink.lang.fallback.sequence</refname>
4544 <refpurpose>look up translated documents if olink not found?</refpurpose>
4547 <refsynopsisdiv> <programlisting id="olink.lang.fallback.sequence.frag">
4548 <xsl:param name="olink.lang.fallback.sequence"></xsl:param>
4551 <refsection><info><title>Description</title></info>
4554 <para>This parameter defines a list of lang values
4555 to search among to resolve olinks.
4558 <para>Normally an olink tries to resolve to a document in the same
4559 language as the olink itself. The language of an olink
4560 is determined by its nearest ancestor element with a
4561 <tag class="attribute">lang</tag> attribute, otherwise the
4562 value of the <parameter>l10n.gentext.default.lang</parameter>
4566 <para>An olink database can contain target data for the same
4567 document in multiple languages. Each set of data has the
4568 same value for the <tag>targetdoc</tag> attribute in
4569 the <tag>document</tag> element in the database, but with a
4570 different <tag>lang</tag> attribute value.
4573 <para>When an olink is being resolved, the target is first
4574 sought in the document with the same language as the olink.
4575 If no match is found there, then this parameter is consulted
4576 for additional languages to try.</para>
4578 <para>The <parameter>olink.lang.fallback.sequence</parameter>
4579 must be a whitespace separated list of lang values to
4580 try. The first one with a match in the olink database is used.
4581 The default value is empty.</para>
4583 <para>For example, a document might be written in German
4584 and contain an olink with
4585 <literal>targetdoc="adminguide"</literal>.
4586 When the document is processed, the processor
4587 first looks for a target dataset in the
4588 olink database starting with:</para>
4590 <literallayout><literal><document targetdoc="adminguide" lang="de"></literal>.
4593 <para>If there is no such element, then the
4594 <parameter>olink.lang.fallback.sequence</parameter>
4595 parameter is consulted.
4596 If its value is, for example, <quote>fr en</quote>, then the processor next
4597 looks for <literal>targetdoc="adminguide" lang="fr"</literal>, and
4598 then for <literal>targetdoc="adminguide" lang="en"</literal>.
4599 If there is still no match, it looks for
4600 <literal>targetdoc="adminguide"</literal> with no
4604 <para>This parameter is useful when a set of documents is only
4605 partially translated, or is in the process of being translated.
4606 If a target of an olink has not yet been translated, then this
4607 parameter permits the processor to look for the document in
4608 other languages. This assumes the reader would rather have
4609 a link to a document in a different language than to have
4616 <refentry version="5.0" id="insert.olink.page.number">
4618 <refentrytitle>insert.olink.page.number</refentrytitle>
4619 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
4620 <refmiscinfo class="other" otherclass="value">no</refmiscinfo>
4621 <refmiscinfo class="other" otherclass="value">yes</refmiscinfo>
4622 <refmiscinfo class="other" otherclass="value">maybe</refmiscinfo>
4625 <refname>insert.olink.page.number</refname>
4626 <refpurpose>Turns page numbers in olinks on and off</refpurpose>
4630 <programlisting id="insert.olink.page.number.frag">
4631 <xsl:param name="insert.olink.page.number">no</xsl:param>
4635 <refsection><info><title>Description</title></info>
4637 <para>The value of this parameter determines if
4638 cross references made between documents with
4639 <tag>olink</tag> will
4640 include page number citations.
4641 In most cases this is only applicable to references in printed output.
4643 <para>The parameter has three possible values.
4648 <listitem><para>No page number references will be generated for olinks.
4653 <listitem><para>Page number references will be generated
4654 for all <tag>olink</tag> references.
4655 The style of page reference may be changed
4656 if an <tag class="attribute">xrefstyle</tag>
4662 <listitem><para>Page number references will not be generated
4663 for an <tag>olink</tag> element unless
4665 <tag class="attribute">xrefstyle</tag>
4666 attribute whose value specifies a page reference.
4670 <para>Olinks that point to targets within the same document
4671 are treated as <tag>xref</tag>s, and controlled by
4672 the <parameter>insert.xref.page.number</parameter> parameter.
4675 <para>Page number references for olinks to
4676 external documents can only be inserted if the
4677 information exists in the olink database.
4678 This means each olink target element
4679 (<tag>div</tag> or <tag>obj</tag>)
4680 must have a <tag class="attribute">page</tag> attribute
4681 whose value is its page number in the target document.
4682 The XSL stylesheets are not able to extract that information
4683 during processing because pages have not yet been created in
4684 XSLT transformation. Only the XSL-FO processor knows what
4685 page each element is placed on.
4686 Therefore some postprocessing must take place to populate
4687 page numbers in the olink database.
4695 <refentry version="5.0" id="insert.olink.pdf.frag">
4697 <refentrytitle>insert.olink.pdf.frag</refentrytitle>
4698 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
4701 <refname>insert.olink.pdf.frag</refname>
4702 <refpurpose>Add fragment identifiers for links into PDF files</refpurpose>
4706 <programlisting id="insert.olink.pdf.frag.frag">
4707 <xsl:param name="insert.olink.pdf.frag" select="0"></xsl:param>
4711 <refsection><info><title>Description</title></info>
4713 <para>The value of this parameter determines whether
4714 the cross reference URIs to PDF documents made with
4715 <tag>olink</tag> will
4716 include fragment identifiers.
4719 <para>When forming a URI to link to a PDF document,
4720 a fragment identifier (typically a '#' followed by an
4721 id value) appended to the PDF filename can be used by
4722 the PDF viewer to open
4723 the PDF file to a location within the document instead of
4725 However, not all PDF files have id
4726 values embedded in them, and not all PDF viewers can
4727 handle fragment identifiers.
4730 <para>If <parameter>insert.olink.pdf.frag</parameter> is set
4731 to a non-zero value, then any olink targeting a
4732 PDF file will have the fragment identifier appended to the URI.
4733 The URI is formed by concatenating the value of the
4734 <parameter>olink.base.uri</parameter> parameter, the
4735 value of the <tag class="attribute">baseuri</tag>
4736 attribute from the <tag class="element">document</tag>
4737 element in the olink database with the matching
4738 <tag class="attribute">targetdoc</tag> value,
4739 and the value of the <tag class="attribute">href</tag>
4740 attribute for the targeted element in the olink database.
4741 The <tag class="attribute">href</tag> attribute
4742 contains the fragment identifier.
4745 <para>If <parameter>insert.olink.pdf.frag</parameter> is set
4746 to zero (the default value), then
4747 the <tag class="attribute">href</tag> attribute
4748 from the olink database
4749 is not appended to PDF olinks, so the fragment identifier is left off.
4750 A PDF olink is any olink for which the
4751 <tag class="attribute">baseuri</tag> attribute
4752 from the matching <tag class="element">document</tag>
4753 element in the olink database ends with '.pdf'.
4754 Any other olinks will still have the fragment identifier added.
4759 <refentry version="5.0" id="prefer.internal.olink">
4761 <refentrytitle>prefer.internal.olink</refentrytitle>
4762 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
4765 <refname>prefer.internal.olink</refname>
4766 <refpurpose>Prefer a local olink reference to an external reference</refpurpose>
4770 <programlisting id="prefer.internal.olink.frag">
4771 <xsl:param name="prefer.internal.olink" select="0"></xsl:param>
4775 <refsection><info><title>Description</title></info>
4777 <para>If you are re-using XML content modules in multiple documents,
4778 you may want to redirect some of your olinks. This parameter
4779 permits you to redirect an olink to the current document.
4782 <para>For example: you are writing documentation for a product,
4783 which includes 3 manuals: a little installation
4784 booklet (booklet.xml), a user
4785 guide (user.xml), and a reference manual (reference.xml).
4786 All 3 documents begin with the same introduction section (intro.xml) that
4787 contains a reference to the customization section (custom.xml) which is
4788 included in both user.xml and reference.xml documents.
4791 <para>How do you write the link to custom.xml in intro.xml
4792 so that it is interpreted correctly in all 3 documents?</para>
4794 <listitem><para>If you use xref, it will fail in user.xml.</para>
4796 <listitem><para>If you use olink (pointing to reference.xml),
4797 the reference in user.xml
4798 will point to the customization section of the reference manual, while it is
4799 actually available in user.xml.</para>
4803 <para>If you set the <parameter>prefer.internal.olink</parameter>
4804 parameter to a non-zero value, then the processor will
4805 first look in the olink database
4806 for the olink's <tag>targetptr</tag> attribute value
4807 in document matching the <parameter>current.docid</parameter>
4808 parameter value. If it isn't found there, then
4809 it tries the document in the database
4810 with the <tag>targetdoc</tag>
4811 value that matches the olink's <tag>targetdoc</tag>
4815 <para>This feature permits an olink reference to resolve to
4816 the current document if there is an element
4817 with an id matching the olink's <tag>targetptr</tag>
4818 value. The current document's olink data must be
4819 included in the target database for this to work.</para>
4822 <para>There is a potential for incorrect links if
4823 the same <tag>id</tag> attribute value is used for different
4824 content in different documents.
4825 Some of your olinks may be redirected to the current document
4826 when they shouldn't be. It is not possible to control
4827 individual olink instances.</para>
4833 <refentry version="5.0" id="link.mailto.url">
4835 <refentrytitle>link.mailto.url</refentrytitle>
4836 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
4839 <refname>link.mailto.url</refname>
4840 <refpurpose>Mailto URL for the LINK REL=made HTML HEAD element</refpurpose>
4844 <programlisting id="link.mailto.url.frag">
4845 <xsl:param name="link.mailto.url"></xsl:param>
4849 <refsection><info><title>Description</title></info>
4851 <para>If not the empty string, this address will be used for the
4852 rel=made <literal>link</literal> element in the html <literal>head</literal>
4858 <refentry version="5.0" id="ulink.target">
4860 <refentrytitle>ulink.target</refentrytitle>
4861 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
4864 <refname>ulink.target</refname>
4865 <refpurpose>The HTML anchor target for ULinks</refpurpose>
4869 <programlisting id="ulink.target.frag">
4870 <xsl:param name="ulink.target">_top</xsl:param>
4874 <refsection><info><title>Description</title></info>
4876 <para>If <parameter>ulink.target</parameter> is non-zero, its value will
4877 be used for the <literal>target</literal> attribute
4878 on anchors generated for <tag>ulink</tag>s.</para>
4883 <refentry version="5.0" id="olink.fragid">
4885 <refentrytitle>olink.fragid</refentrytitle>
4886 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
4889 <refname>olink.fragid</refname>
4890 <refpurpose>Names the fragment identifier portion of an OLink resolver query</refpurpose>
4893 <programlisting id="olink.fragid.frag">
4894 <xsl:param name="olink.fragid">fragid=</xsl:param>
4897 <refsection><info><title>Description</title></info>
4898 <para>The fragment identifier portion of an <tag>olink</tag> target.</para>
4902 <refentry version="5.0" id="olink.outline.ext">
4904 <refentrytitle>olink.outline.ext</refentrytitle>
4905 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
4908 <refname>olink.outline.ext</refname>
4909 <refpurpose>The extension of OLink outline files</refpurpose>
4913 <programlisting id="olink.outline.ext.frag">
4914 <xsl:param name="olink.outline.ext">.olink</xsl:param>
4918 <refsection><info><title>Description</title></info>
4920 <para>The extension to be expected for OLink outline files</para>
4921 <para>Bob has this parameter as dead. Please don't use</para>
4926 <refentry version="5.0" id="olink.pubid">
4928 <refentrytitle>olink.pubid</refentrytitle>
4929 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
4932 <refname>olink.pubid</refname>
4933 <refpurpose>Names the public identifier portion of an OLink resolver query</refpurpose>
4937 <programlisting id="olink.pubid.frag">
4938 <xsl:param name="olink.pubid">pubid</xsl:param>
4942 <refsection><info><title>Description</title></info>
4949 <refentry version="5.0" id="olink.sysid">
4951 <refentrytitle>olink.sysid</refentrytitle>
4952 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
4955 <refname>olink.sysid</refname>
4956 <refpurpose>Names the system identifier portion of an OLink resolver query</refpurpose>
4960 <programlisting id="olink.sysid.frag">
4961 <xsl:param name="olink.sysid">sysid</xsl:param>
4965 <refsection><info><title>Description</title></info>
4972 <refentry version="5.0" id="olink.resolver">
4974 <refentrytitle>olink.resolver</refentrytitle>
4975 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
4978 <refname>olink.resolver</refname>
4979 <refpurpose>The root name of the OLink resolver (usually a script)</refpurpose>
4982 <programlisting id="olink.resolver.frag">
4983 <xsl:param name="olink.resolver">/cgi-bin/olink</xsl:param>
4986 <refsection><info><title>Description</title></info>
4991 </reference><reference id="xrefs" xml:base="../html/param.xml"><title>Cross References</title>
4992 <refentry version="5.0" id="collect.xref.targets">
4994 <refentrytitle>collect.xref.targets</refentrytitle>
4995 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
4996 <refmiscinfo class="other" otherclass="value">no</refmiscinfo>
4997 <refmiscinfo class="other" otherclass="value">yes</refmiscinfo>
4998 <refmiscinfo class="other" otherclass="value">only</refmiscinfo>
5001 <refname>collect.xref.targets</refname>
5002 <refpurpose>Controls whether cross reference data is
5003 collected</refpurpose>
5005 <refsynopsisdiv> <programlisting id="collect.xref.targets.frag">
5006 <xsl:param name="collect.xref.targets">no</xsl:param>
5009 <refsection><info><title>Description</title></info>
5012 In order to resolve olinks efficiently, the stylesheets can
5013 generate an external data file containing information about
5014 all potential cross reference endpoints in a document.
5015 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.
5016 See also <parameter>targets.filename</parameter>.
5021 <refentry version="5.0" id="insert.xref.page.number">
5023 <refentrytitle>insert.xref.page.number</refentrytitle>
5024 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
5025 <refmiscinfo class="other" otherclass="value">no</refmiscinfo>
5026 <refmiscinfo class="other" otherclass="value">yes</refmiscinfo>
5027 <refmiscinfo class="other" otherclass="value">maybe</refmiscinfo>
5030 <refname>insert.xref.page.number</refname>
5031 <refpurpose>Turns page numbers in xrefs on and off</refpurpose>
5035 <programlisting id="insert.xref.page.number.frag">
5036 <xsl:param name="insert.xref.page.number">no</xsl:param>
5040 <refsection><info><title>Description</title></info>
5042 <para>The value of this parameter determines if
5043 cross references (<tag>xref</tag>s) in
5045 include page number citations.
5046 It has three possible values.
5051 <listitem><para>No page number references will be generated.
5056 <listitem><para>Page number references will be generated
5057 for all <tag>xref</tag> elements.
5058 The style of page reference may be changed
5059 if an <tag class="attribute">xrefstyle</tag>
5065 <listitem><para>Page number references will not be generated
5066 for an <tag>xref</tag> element unless
5068 <tag class="attribute">xrefstyle</tag>
5069 attribute whose value specifies a page reference.
5077 <refentry version="5.0" id="use.role.as.xrefstyle">
5079 <refentrytitle>use.role.as.xrefstyle</refentrytitle>
5080 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
5083 <refname>use.role.as.xrefstyle</refname>
5084 <refpurpose>Use <tag class="attribute">role</tag> attribute for
5085 <tag class="attribute">xrefstyle</tag> on <tag>xref</tag>?</refpurpose>
5089 <programlisting id="use.role.as.xrefstyle.frag">
5090 <xsl:param name="use.role.as.xrefstyle" select="1"></xsl:param>
5094 <refsection><info><title>Description</title></info>
5096 <para>In DocBook documents that conform to a schema older than V4.3, this parameter allows
5097 <tag class="attribute">role</tag> to serve the purpose of specifying the cross reference style.</para>
5099 <para>If non-zero, the <tag class="attribute">role</tag> attribute on
5100 <tag>xref</tag> will be used to select the cross reference style.
5101 In DocBook V4.3, the <tag class="attribute">xrefstyle</tag> attribute was added for this purpose.
5102 If the <tag class="attribute">xrefstyle</tag> attribute is present,
5103 <tag class="attribute">role</tag> will be ignored, regardless of the setting
5104 of this parameter.</para>
5108 <refsection><info><title>Example</title></info>
5110 <para>The following small stylesheet shows how to configure the
5111 stylesheets to make use of the cross reference style:</para>
5113 <programlisting><?xml version="1.0"?>
5114 <xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
5117 <xsl:import href="../xsl/html/docbook.xsl"/>
5119 <xsl:output method="html"/>
5121 <xsl:param name="local.l10n.xml" select="document('')"/>
5122 <l:i18n xmlns:l="http://docbook.sourceforge.net/xmlns/l10n/1.0">
5123 <l:l10n xmlns:l="http://docbook.sourceforge.net/xmlns/l10n/1.0" language="en">
5124 <l:context name="xref">
5125 <l:template name="chapter" style="title" text="Chapter %n, %t"/>
5126 <l:template name="chapter" text="Chapter %n"/>
5131 </xsl:stylesheet></programlisting>
5133 <para>With this stylesheet, the cross references in the following document:</para>
5135 <programlisting><?xml version="1.0" encoding="utf-8"?>
5136 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
5137 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
5138 <book id="book"><title>Book</title>
5141 <title>Preface</title>
5143 <para>Normal: <xref linkend="ch1"/>.</para>
5144 <para>Title: <xref xrefstyle="title" linkend="ch1"/>.</para>
5148 <chapter id="ch1">
5149 <title>First Chapter</title>
5151 <para>Irrelevant.</para>
5154 </book></programlisting>
5156 <para>will appear as:</para>
5159 <para>Normal: Chapter 1.</para>
5160 <para>Title: Chapter 1, <emphasis>First Chapter</emphasis>.</para>
5166 <refentry version="5.0" id="xref.with.number.and.title">
5168 <refentrytitle>xref.with.number.and.title</refentrytitle>
5169 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
5172 <refname>xref.with.number.and.title</refname>
5173 <refpurpose>Use number and title in cross references</refpurpose>
5177 <programlisting id="xref.with.number.and.title.frag">
5178 <xsl:param name="xref.with.number.and.title" select="1"></xsl:param>
5182 <refsection><info><title>Description</title></info>
5184 <para>A cross reference may include the number (for example, the number of
5185 an example or figure) and the <tag>title</tag> which is a required child of some
5186 targets. This parameter inserts both the relevant number as well as
5187 the title into the link. </para>
5192 <refentry version="5.0" id="xref.label-page.separator">
5194 <refentrytitle>xref.label-page.separator</refentrytitle>
5195 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
5198 <refname>xref.label-page.separator</refname>
5199 <refpurpose>Punctuation or space separating label from page number in xref</refpurpose>
5203 <programlisting id="xref.label-page.separator.frag"><xsl:param name="xref.label-page.separator"><xsl:text> </xsl:text></xsl:param></programlisting>
5206 <refsection><info><title>Description</title></info>
5209 This parameter allows you to control the punctuation of certain
5210 types of generated cross reference text.
5211 When cross reference text is generated for an
5212 <tag class="element">xref</tag> or
5213 <tag class="element">olink</tag> element
5214 using an <tag class="attribute">xrefstyle</tag> attribute
5215 that makes use of the <literal>select:</literal> feature,
5216 and the selected components include both label and page
5218 then the value of this parameter is inserted between
5219 label and page number in the output.
5220 If a title is included, then other separators are used.
5226 <refentry version="5.0" id="xref.label-title.separator">
5228 <refentrytitle>xref.label-title.separator</refentrytitle>
5229 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
5232 <refname>xref.label-title.separator</refname>
5233 <refpurpose>Punctuation or space separating label from title in xref</refpurpose>
5237 <programlisting id="xref.label-title.separator.frag"><xsl:param name="xref.label-title.separator">: </xsl:param></programlisting>
5240 <refsection><info><title>Description</title></info>
5243 This parameter allows you to control the punctuation of certain
5244 types of generated cross reference text.
5245 When cross reference text is generated for an
5246 <tag class="element">xref</tag> or
5247 <tag class="element">olink</tag> element
5248 using an <tag class="attribute">xrefstyle</tag> attribute
5249 that makes use of the <literal>select:</literal> feature,
5250 and the selected components include both label and title,
5251 then the value of this parameter is inserted between
5252 label and title in the output.
5258 <refentry version="5.0" id="xref.title-page.separator">
5260 <refentrytitle>xref.title-page.separator</refentrytitle>
5261 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
5264 <refname>xref.title-page.separator</refname>
5265 <refpurpose>Punctuation or space separating title from page number in xref</refpurpose>
5269 <programlisting id="xref.title-page.separator.frag"><xsl:param name="xref.title-page.separator"><xsl:text> </xsl:text></xsl:param></programlisting>
5272 <refsection><info><title>Description</title></info>
5275 This parameter allows you to control the punctuation of certain
5276 types of generated cross reference text.
5277 When cross reference text is generated for an
5278 <tag class="element">xref</tag> or
5279 <tag class="element">olink</tag> element
5280 using an <tag class="attribute">xrefstyle</tag> attribute
5281 that makes use of the <literal>select:</literal> feature,
5282 and the selected components include both title and page number,
5283 then the value of this parameter is inserted between
5284 title and page number in the output.
5290 </reference><reference id="lists" xml:base="../html/param.xml"><title>Lists</title>
5291 <refentry version="5.0" id="segmentedlist.as.table">
5293 <refentrytitle>segmentedlist.as.table</refentrytitle>
5294 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
5297 <refname>segmentedlist.as.table</refname>
5298 <refpurpose>Format segmented lists as tables?</refpurpose>
5302 <programlisting id="segmentedlist.as.table.frag">
5303 <xsl:param name="segmentedlist.as.table" select="0"></xsl:param>
5307 <refsection><info><title>Description</title></info>
5309 <para>If non-zero, <tag>segmentedlist</tag>s will be formatted as
5315 <refentry version="5.0" id="variablelist.as.table">
5317 <refentrytitle>variablelist.as.table</refentrytitle>
5318 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
5321 <refname>variablelist.as.table</refname>
5322 <refpurpose>Format <tag>variablelist</tag>s as tables?</refpurpose>
5326 <programlisting id="variablelist.as.table.frag">
5327 <xsl:param name="variablelist.as.table" select="0"></xsl:param>
5331 <refsection><info><title>Description</title></info>
5333 <para>If non-zero, <tag>variablelist</tag>s will be formatted as
5334 tables. A processing instruction exists to specify a particular width for the
5335 column containing the <tag>term</tag>s:
5336 <tag class="xmlpi">dbhtml term-width=".25in"</tag></para>
5338 <para>You can override this setting with a processing instruction as the
5339 child of <tag>variablelist</tag>: <tag class="xmlpi">dbhtml
5340 list-presentation="table"</tag> or <tag class="xmlpi">dbhtml
5341 list-presentation="list"</tag>.</para>
5343 <para>This parameter only applies to the HTML transformations. In the
5344 FO case, proper list markup is robust enough to handle the formatting.
5345 But see also <parameter>variablelist.as.blocks</parameter>.</para>
5347 <programlisting> <variablelist>
5348 <?dbhtml list-presentation="table"?>
5349 <?dbhtml term-width="1.5in"?>
5350 <?dbfo list-presentation="list"?>
5351 <?dbfo term-width="1in"?>
5352 <varlistentry>
5353 <term>list</term>
5356 Formatted as a table even if variablelist.as.table is set to 0.
5359 </varlistentry>
5360 </variablelist></programlisting>
5365 <refentry version="5.0" id="variablelist.term.separator">
5367 <refentrytitle>variablelist.term.separator</refentrytitle>
5368 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
5371 <refname>variablelist.term.separator</refname>
5372 <refpurpose>Text to separate <tag>term</tag>s within a multi-term
5373 <tag>varlistentry</tag></refpurpose>
5377 <programlisting id="variablelist.term.separator.frag">
5378 <xsl:param name="variablelist.term.separator">, </xsl:param></programlisting>
5381 <refsection><info><title>Description</title></info>
5383 <para>When a <tag>varlistentry</tag> contains multiple <tag>term</tag>
5384 elements, the string specified in the value of the
5385 <parameter>variablelist.term.separator</parameter> parameter is placed
5386 after each <tag>term</tag> except the last.</para>
5389 <para>To generate a line break between multiple <tag>term</tag>s in
5390 a <tag>varlistentry</tag>, set a non-zero value for the
5391 <parameter>variablelist.term.break.after</parameter> parameter. If
5392 you do so, you may also want to set the value of the
5393 <parameter>variablelist.term.separator</parameter> parameter to an
5394 empty string (to suppress rendering of the default comma and space
5395 after each <tag>term</tag>).</para>
5401 <refentry version="5.0" id="variablelist.term.break.after">
5403 <refentrytitle>variablelist.term.break.after</refentrytitle>
5404 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
5407 <refname>variablelist.term.break.after</refname>
5408 <refpurpose>Generate line break after each <tag>term</tag> within a
5409 multi-term <tag>varlistentry</tag>?</refpurpose>
5413 <programlisting id="variablelist.term.break.after.frag">
5414 <xsl:param name="variablelist.term.break.after">0</xsl:param></programlisting>
5417 <refsection><info><title>Description</title></info>
5419 <para>Set a non-zero value for the
5420 <parameter>variablelist.term.break.after</parameter> parameter to
5421 generate a line break between <tag>term</tag>s in a
5422 multi-term <tag>varlistentry</tag>.</para>
5425 <para>If you set a non-zero value for
5426 <parameter>variablelist.term.break.after</parameter>, you may also
5427 want to set the value of the
5428 <parameter>variablelist.term.separator</parameter> parameter to an
5429 empty string (to suppress rendering of the default comma and space
5430 after each <tag>term</tag>).</para>
5436 </reference><reference id="biblio" xml:base="../html/param.xml"><title>Bibliography</title>
5437 <refentry version="5.0" id="bibliography.style">
5439 <refentrytitle>bibliography.style</refentrytitle>
5440 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
5441 <refmiscinfo class="other" otherclass="value">normal</refmiscinfo>
5442 <refmiscinfo class="other" otherclass="value">iso690</refmiscinfo>
5445 <refname>bibliography.style</refname>
5446 <refpurpose>Style used for formatting of biblioentries.</refpurpose>
5450 <programlisting id="bibliography.style.frag">
5451 <xsl:param name="bibliography.style">normal</xsl:param>
5455 <refsection><info><title>Description</title></info>
5457 <para>Currently only <literal>normal</literal> and
5458 <literal>iso690</literal> styles are supported.</para>
5460 <para>In order to use ISO690 style to the full extent you might need
5461 to use additional markup described on <link xlink:href="http://wiki.docbook.org/topic/ISO690Bibliography">the
5462 following WiKi page</link>.</para>
5467 <refentry version="5.0" id="biblioentry.item.separator">
5469 <refentrytitle>biblioentry.item.separator</refentrytitle>
5470 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
5473 <refname>biblioentry.item.separator</refname>
5474 <refpurpose>Text to separate bibliography entries</refpurpose>
5478 <programlisting id="biblioentry.item.separator.frag"><xsl:param name="biblioentry.item.separator">. </xsl:param></programlisting>
5481 <refsection><info><title>Description</title></info>
5483 <para>Text to separate bibliography entries
5489 <refentry version="5.0" id="bibliography.collection">
5491 <refentrytitle>bibliography.collection</refentrytitle>
5492 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
5495 <refname>bibliography.collection</refname>
5496 <refpurpose>Name of the bibliography collection file</refpurpose>
5500 <programlisting id="bibliography.collection.frag">
5501 <xsl:param name="bibliography.collection">http://docbook.sourceforge.net/release/bibliography/bibliography.xml</xsl:param>
5506 <refsection><info><title>Description</title></info>
5508 <para>Maintaining bibliography entries across a set of documents is tedious, time
5509 consuming, and error prone. It makes much more sense, usually, to store all of
5510 the bibliography entries in a single place and simply <quote>extract</quote>
5511 the ones you need in each document.</para>
5513 <para>That's the purpose of the
5514 <parameter>bibliography.collection</parameter> parameter. To setup a global
5515 bibliography <quote>database</quote>, follow these steps:</para>
5517 <para>First, create a stand-alone bibliography document that contains all of
5518 the documents that you wish to reference. Make sure that each bibliography
5519 entry (whether you use <tag>biblioentry</tag> or <tag>bibliomixed</tag>)
5522 <para>My global bibliography, <filename>~/bibliography.xml</filename> begins
5526 <programlisting><!DOCTYPE bibliography
5527 PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
5528 "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
5529 <bibliography><title>References</title>
5531 <bibliomixed id="xml-rec"><abbrev>XML 1.0</abbrev>Tim Bray,
5532 Jean Paoli, C. M. Sperberg-McQueen, and Eve Maler, editors.
5533 <citetitle><ulink url="http://www.w3.org/TR/REC-xml">Extensible Markup
5534 Language (XML) 1.0 Second Edition</ulink></citetitle>.
5535 World Wide Web Consortium, 2000.
5536 </bibliomixed>
5538 <bibliomixed id="xml-names"><abbrev>Namespaces</abbrev>Tim Bray,
5540 and Andrew Layman, editors.
5541 <citetitle><ulink url="http://www.w3.org/TR/REC-xml-names/">Namespaces in
5542 XML</ulink></citetitle>.
5543 World Wide Web Consortium, 1999.
5544 </bibliomixed>
5547 </bibliography>
5551 <para>When you create a bibliography in your document, simply
5552 provide <emphasis>empty</emphasis> <tag>bibliomixed</tag>
5553 entries for each document that you wish to cite. Make sure that these
5554 elements have the same ID as the corresponding <quote>real</quote>
5555 entry in your global bibliography.</para>
5557 <para>For example:</para>
5560 <programlisting><bibliography><title>Bibliography</title>
5562 <bibliomixed id="xml-rec"/>
5563 <bibliomixed id="xml-names"/>
5564 <bibliomixed id="DKnuth86">Donald E. Knuth. <citetitle>Computers and
5565 Typesetting: Volume B, TeX: The Program</citetitle>. Addison-Wesley,
5566 1986. ISBN 0-201-13437-3.
5567 </bibliomixed>
5568 <bibliomixed id="relaxng"/>
5570 </bibliography></programlisting>
5573 <para>Note that it's perfectly acceptable to mix entries from your
5574 global bibliography with <quote>normal</quote> entries. You can use
5575 <tag>xref</tag> or other elements to cross-reference your
5576 bibliography entries in exactly the same way you do now.</para>
5578 <para>Finally, when you are ready to format your document, simply set the
5579 <parameter>bibliography.collection</parameter> parameter (in either a
5580 customization layer or directly through your processor's interface) to
5581 point to your global bibliography.</para>
5583 <para>The stylesheets will format the bibliography in your document as if
5584 all of the entries referenced appeared there literally.</para>
5589 <refentry version="5.0" id="bibliography.numbered">
5591 <refentrytitle>bibliography.numbered</refentrytitle>
5592 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
5595 <refname>bibliography.numbered</refname>
5596 <refpurpose>Should bibliography entries be numbered?</refpurpose>
5600 <programlisting id="bibliography.numbered.frag">
5601 <xsl:param name="bibliography.numbered" select="0"></xsl:param>
5605 <refsection><info><title>Description</title></info>
5607 <para>If non-zero bibliography entries will be numbered</para>
5612 </reference><reference id="glossary" xml:base="../html/param.xml"><title>Glossary</title>
5613 <refentry version="5.0" id="glossterm.auto.link">
5615 <refentrytitle>glossterm.auto.link</refentrytitle>
5616 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
5619 <refname>glossterm.auto.link</refname>
5620 <refpurpose>Generate links from glossterm to glossentry automatically?</refpurpose>
5624 <programlisting id="glossterm.auto.link.frag">
5625 <xsl:param name="glossterm.auto.link" select="0"></xsl:param>
5629 <refsection><info><title>Description</title></info>
5631 <para>If non-zero, links from inline <tag>glossterm</tag>s to the corresponding
5632 <tag>glossentry</tag> elements in a <tag>glossary</tag> or <tag>glosslist</tag>
5633 will be automatically generated. This is useful when your glossterms are consistent
5634 and you don't want to add links manually.</para>
5636 <para>The automatic link generation feature is not used on <tag>glossterm</tag> elements
5637 that have a <tag class="attribute">linkend</tag> attribute.</para>
5642 <refentry version="5.0" id="firstterm.only.link">
5644 <refentrytitle>firstterm.only.link</refentrytitle>
5645 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
5648 <refname>firstterm.only.link</refname>
5649 <refpurpose>Does automatic glossterm linking only apply to firstterms?</refpurpose>
5653 <programlisting id="firstterm.only.link.frag">
5654 <xsl:param name="firstterm.only.link" select="0"></xsl:param>
5658 <refsection><info><title>Description</title></info>
5660 <para>If non-zero, only <tag>firstterm</tag>s will be automatically linked
5661 to the glossary. If glossary linking is not enabled, this parameter
5662 has no effect.</para>
5667 <refentry version="5.0" id="glossary.collection">
5669 <refentrytitle>glossary.collection</refentrytitle>
5670 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
5673 <refname>glossary.collection</refname>
5674 <refpurpose>Name of the glossary collection file</refpurpose>
5678 <programlisting id="glossary.collection.frag">
5679 <xsl:param name="glossary.collection"></xsl:param>
5683 <refsection><info><title>Description</title></info>
5685 <para>Glossaries maintained independently across a set of documents
5686 are likely to become inconsistent unless considerable effort is
5687 expended to keep them in sync. It makes much more sense, usually, to
5688 store all of the glossary entries in a single place and simply
5689 <quote>extract</quote> the ones you need in each document.</para>
5691 <para>That's the purpose of the
5692 <parameter>glossary.collection</parameter> parameter. To setup a global
5693 glossary <quote>database</quote>, follow these steps:</para>
5695 <refsection><info><title>Setting Up the Glossary Database</title></info>
5697 <para>First, create a stand-alone glossary document that contains all of
5698 the entries that you wish to reference. Make sure that each glossary
5699 entry has an ID.</para>
5701 <para>Here's an example glossary:</para>
5705 <?xml version="1.0" encoding="utf-8"?>
5706 <!DOCTYPE glossary
5707 PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
5708 "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
5710 <glossaryinfo>
5711 <editor><firstname>Eric</firstname><surname>Raymond</surname></editor>
5712 <title>Jargon File 4.2.3 (abridged)</title>
5713 <releaseinfo>Just some test data</releaseinfo>
5714 </glossaryinfo>
5716 <glossdiv><title>0</title>
5719 <glossterm>0</glossterm>
5721 <para>Numeric zero, as opposed to the letter `O' (the 15th letter of
5722 the English alphabet). In their unmodified forms they look a lot
5723 alike, and various kluges invented to make them visually distinct have
5724 compounded the confusion. If your zero is center-dotted and letter-O
5725 is not, or if letter-O looks almost rectangular but zero looks more
5726 like an American football stood on end (or the reverse), you're
5727 probably looking at a modern character display (though the dotted zero
5728 seems to have originated as an option on IBM 3270 controllers). If
5729 your zero is slashed but letter-O is not, you're probably looking at
5730 an old-style ASCII graphic set descended from the default typewheel on
5731 the venerable ASR-33 Teletype (Scandinavians, for whom /O is a letter,
5732 curse this arrangement). (Interestingly, the slashed zero long
5733 predates computers; Florian Cajori's monumental "A History of
5734 Mathematical Notations" notes that it was used in the twelfth and
5735 thirteenth centuries.) If letter-O has a slash across it and the zero
5736 does not, your display is tuned for a very old convention used at IBM
5737 and a few other early mainframe makers (Scandinavians curse <emphasis>this</emphasis>
5738 arrangement even more, because it means two of their letters collide).
5739 Some Burroughs/Unisys equipment displays a zero with a <emphasis>reversed</emphasis>
5740 slash. Old CDC computers rendered letter O as an unbroken oval and 0
5741 as an oval broken at upper right and lower left. And yet another
5742 convention common on early line printers left zero unornamented but
5743 added a tail or hook to the letter-O so that it resembled an inverted
5744 Q or cursive capital letter-O (this was endorsed by a draft ANSI
5745 standard for how to draw ASCII characters, but the final standard
5746 changed the distinguisher to a tick-mark in the upper-left corner).
5747 Are we sufficiently confused yet?</para>
5752 <glossterm>1TBS</glossterm>
5754 <para role="accidence">
5755 <phrase role="pronounce"></phrase>
5756 <phrase role="partsofspeach">n</phrase>
5758 <para>The "One True Brace Style"</para>
5759 <glossseealso>indent style</glossseealso>
5769 </glossary></programlisting>
5774 <refsection><info><title>Marking Up Glossary Terms</title></info>
5776 <para>That takes care of the glossary database, now you have to get the entries
5777 into your document. Unlike bibliography entries, which can be empty, creating
5778 <quote>placeholder</quote> glossary entries would be very tedious. So instead,
5779 support for <parameter>glossary.collection</parameter> relies on implicit linking.</para>
5781 <para>In your source document, simply use <tag>firstterm</tag> and
5782 <tag>glossterm</tag> to identify the terms you wish to have included
5783 in the glossary. The stylesheets assume that you will either set the
5784 <tag class="attribute">baseform</tag> attribute correctly, or that the
5785 content of the element exactly matches a term in your glossary.</para>
5787 <para>If you're using a <parameter>glossary.collection</parameter>, don't
5788 make explicit links on the terms in your document.</para>
5790 <para>So, in your document, you might write things like this:</para>
5793 <programlisting><para>This is dummy text, without any real meaning.
5794 The point is simply to reference glossary terms like <glossterm>0</glossterm>
5795 and the <firstterm baseform="1TBS">One True Brace Style (1TBS)</firstterm>.
5796 The <glossterm>1TBS</glossterm>, as you can probably imagine, is a nearly
5797 religious issue.</para></programlisting>
5800 <para>If you set the <parameter>firstterm.only.link</parameter> parameter,
5801 only the terms marked with <tag>firstterm</tag> will be links.
5802 Otherwise, all the terms will be linked.</para>
5806 <refsection><info><title>Marking Up the Glossary</title></info>
5808 <para>The glossary itself has to be identified for the stylesheets. For lack
5809 of a better choice, the <tag class="attribute">role</tag> is used.
5810 To identify the glossary as the target for automatic processing, set
5811 the role to <quote><literal>auto</literal></quote>. The title of this
5812 glossary (and any other information from the <tag>glossaryinfo</tag>
5813 that's rendered by your stylesheet) will be displayed, but the entries will
5814 come from the database.
5817 <para>Unfortunately, the glossary can't be empty, so you must put in
5818 at least one <tag>glossentry</tag>. The content of this entry
5819 is irrelevant, it will not be rendered:</para>
5822 <programlisting><glossary role="auto">
5824 <glossterm>Irrelevant</glossterm>
5826 <para>If you can see this, the document was processed incorrectly. Use
5827 the <parameter>glossary.collection</parameter> parameter.</para>
5830 </glossary></programlisting>
5833 <para>What about glossary divisions? If your glossary database has glossary
5834 divisions <emphasis>and</emphasis> your automatic glossary contains at least
5835 one <tag>glossdiv</tag>, the automic glossary will have divisions.
5836 If the <tag>glossdiv</tag> is missing from either location, no divisions
5837 will be rendered.</para>
5839 <para>Glossary entries (and divisions, if appropriate) in the glossary will
5840 occur in precisely the order they occur in your database.</para>
5844 <refsection><info><title>Formatting the Document</title></info>
5846 <para>Finally, when you are ready to format your document, simply set the
5847 <parameter>glossary.collection</parameter> parameter (in either a
5848 customization layer or directly through your processor's interface) to
5849 point to your global glossary.</para>
5851 <para>The stylesheets will format the glossary in your document as if
5852 all of the entries implicilty referenced appeared there literally.</para>
5855 <refsection><info><title>Limitations</title></info>
5857 <para>Glossary cross-references <emphasis>within the glossary</emphasis> are
5858 not supported. For example, this <emphasis>will not</emphasis> work:</para>
5861 <programlisting><glossentry>
5862 <glossterm>gloss-1</glossterm>
5863 <glossdef><para>A description that references <glossterm>gloss-2</glossterm>.</para>
5864 <glossseealso>gloss-2</glossseealso>
5866 </glossentry></programlisting>
5869 <para>If you put glossary cross-references in your glossary that way,
5870 you'll get the cryptic error: <computeroutput>Warning:
5871 glossary.collection specified, but there are 0 automatic
5872 glossaries</computeroutput>.</para>
5874 <para>Instead, you must do two things:</para>
5878 <para>Markup your glossary using <tag>glossseealso</tag>:</para>
5881 <programlisting><glossentry>
5882 <glossterm>gloss-1</glossterm>
5883 <glossdef><para>A description that references <glossterm>gloss-2</glossterm>.</para>
5884 <glossseealso>gloss-2</glossseealso>
5886 </glossentry></programlisting>
5891 <para>Make sure there is at least one <tag>glossterm</tag> reference to
5892 <glossterm>gloss-2</glossterm> <emphasis>in your document</emphasis>. The
5893 easiest way to do that is probably within a <tag>remark</tag> in your
5894 automatic glossary:</para>
5897 <programlisting><glossary role="auto">
5898 <remark>Make sure there's a reference to <glossterm>gloss-2</glossterm>.</remark>
5900 <glossterm>Irrelevant</glossterm>
5902 <para>If you can see this, the document was processed incorrectly. Use
5903 the <parameter>glossary.collection</parameter> parameter.</para>
5906 </glossary></programlisting>
5915 <refentry version="5.0" id="glossary.sort">
5917 <refentrytitle>glossary.sort</refentrytitle>
5918 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
5921 <refname>glossary.sort</refname>
5922 <refpurpose>Sort glossentry elements?</refpurpose>
5926 <programlisting id="glossary.sort.frag">
5927 <xsl:param name="glossary.sort" select="0"></xsl:param>
5931 <refsection><info><title>Description</title></info>
5933 <para>If non-zero, then the glossentry elements within a
5934 glossary, glossdiv, or glosslist are sorted on the glossterm, using
5935 the current lang setting. If zero (the default), then
5936 glossentry elements are not sorted and are presented
5943 <refentry version="5.0" id="glossentry.show.acronym">
5945 <refentrytitle>glossentry.show.acronym</refentrytitle>
5946 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
5947 <refmiscinfo class="other" otherclass="value">no</refmiscinfo>
5948 <refmiscinfo class="other" otherclass="value">yes</refmiscinfo>
5949 <refmiscinfo class="other" otherclass="value">primary</refmiscinfo>
5952 <refname>glossentry.show.acronym</refname>
5953 <refpurpose>Display <tag>glossentry</tag> acronyms?</refpurpose>
5957 <programlisting id="glossentry.show.acronym.frag">
5958 <xsl:param name="glossentry.show.acronym">no</xsl:param>
5962 <refsection><info><title>Description</title></info>
5964 <para>A setting of <quote>yes</quote> means they should be displayed;
5965 <quote>no</quote> means they shouldn't. If <quote>primary</quote> is used,
5966 then they are shown as the primary text for the entry.</para>
5969 <para>This setting controls both <tag>acronym</tag> and
5970 <tag>abbrev</tag> elements in the <tag>glossentry</tag>.</para>
5976 </reference><reference id="misc" xml:base="../html/param.xml"><title>Miscellaneous</title>
5977 <refentry version="5.0" id="formal.procedures">
5979 <refentrytitle>formal.procedures</refentrytitle>
5980 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
5983 <refname>formal.procedures</refname>
5984 <refpurpose>Selects formal or informal procedures</refpurpose>
5988 <programlisting id="formal.procedures.frag">
5989 <xsl:param name="formal.procedures" select="1"></xsl:param>
5993 <refsection><info><title>Description</title></info>
5995 <para>Formal procedures are numbered and always have a title.
6001 <refentry version="5.0" id="formal.title.placement">
6003 <refentrytitle>formal.title.placement</refentrytitle>
6004 <refmiscinfo class="other" otherclass="datatype">table</refmiscinfo>
6007 <refname>formal.title.placement</refname>
6008 <refpurpose>Specifies where formal object titles should occur</refpurpose>
6012 <programlisting id="formal.title.placement.frag">
6013 <xsl:param name="formal.title.placement">
6024 <refsection><info><title>Description</title></info>
6026 <para>Specifies where formal object titles should occur. For each formal object
6027 type (<tag>figure</tag>,
6029 <tag>equation</tag>,
6030 <tag>table</tag>, and <tag>procedure</tag>)
6031 you can specify either the keyword
6032 <quote><literal>before</literal></quote> or
6033 <quote><literal>after</literal></quote>.</para>
6038 <refentry version="5.0" id="runinhead.default.title.end.punct">
6040 <refentrytitle>runinhead.default.title.end.punct</refentrytitle>
6041 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
6044 <refname>runinhead.default.title.end.punct</refname>
6045 <refpurpose>Default punctuation character on a run-in-head</refpurpose>
6049 <programlisting id="runinhead.default.title.end.punct.frag"><xsl:param name="runinhead.default.title.end.punct">.</xsl:param>
6053 <refsection><info><title>Description</title></info>
6055 <para>If non-zero, For a <tag>formalpara</tag>, use the specified
6056 string as the separator between the title and following text. The period is the default value.</para>
6061 <refentry version="5.0" id="runinhead.title.end.punct">
6063 <refentrytitle>runinhead.title.end.punct</refentrytitle>
6064 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
6067 <refname>runinhead.title.end.punct</refname>
6068 <refpurpose>Characters that count as punctuation on a run-in-head</refpurpose>
6072 <programlisting id="runinhead.title.end.punct.frag">
6073 <xsl:param name="runinhead.title.end.punct">.!?:</xsl:param>
6077 <refsection><info><title>Description</title></info>
6079 <para>Specify which characters are to be counted as punctuation. These
6080 characters are checked for a match with the last character of the
6081 title. If no match is found, the
6082 <parameter>runinhead.default.title.end.punct</parameter> contents are
6083 inserted. This is to avoid duplicated punctuation in the output.
6089 <refentry version="5.0" id="show.comments">
6091 <refentrytitle>show.comments</refentrytitle>
6092 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
6095 <refname>show.comments</refname>
6096 <refpurpose>Display <tag>remark</tag> elements?</refpurpose>
6100 <programlisting id="show.comments.frag">
6101 <xsl:param name="show.comments" select="1"></xsl:param>
6105 <refsection><info><title>Description</title></info>
6107 <para>If non-zero, comments will be displayed, otherwise they
6108 are suppressed. Comments here refers to the <tag>remark</tag> element
6109 (which was called <literal>comment</literal> prior to DocBook
6110 4.0), not XML comments (<-- like this -->) which are
6117 <refentry version="5.0" id="show.revisionflag">
6119 <refentrytitle>show.revisionflag</refentrytitle>
6120 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
6123 <refname>show.revisionflag</refname>
6124 <refpurpose>Enable decoration of elements that have a revisionflag</refpurpose>
6128 <programlisting id="show.revisionflag.frag">
6129 <xsl:param name="show.revisionflag" select="0"></xsl:param>
6133 <refsection><info><title>Description</title></info>
6136 If <parameter>show.revisionflag</parameter> is turned on, then the stylesheets
6137 may produce additional markup designed to allow a CSS stylesheet to
6138 highlight elements that have specific revisionflag settings.</para>
6140 <para>The markup inserted will be usually be either a <span> or
6141 <div> with an appropriate <literal>class</literal>
6142 attribute. (The value of the class attribute will be the same as the
6143 value of the revisionflag attribute). In some contexts, for example
6144 tables, where extra markup would be structurally illegal, the class
6145 attribute will be added to the appropriate container element.</para>
6147 <para>In general, the stylesheets only test for revisionflag in contexts
6148 where an importing stylesheet would have to redefine whole templates.
6149 Most of the revisionflag processing is expected to be done by another
6150 stylesheet, for example <filename>changebars.xsl</filename>.</para>
6155 <refentry version="5.0" id="shade.verbatim">
6157 <refentrytitle>shade.verbatim</refentrytitle>
6158 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
6161 <refname>shade.verbatim</refname>
6162 <refpurpose>Should verbatim environments be shaded?</refpurpose>
6166 <programlisting id="shade.verbatim.frag"><xsl:param name="shade.verbatim" select="0"></xsl:param></programlisting>
6169 <refsection><info><title>Description</title></info>
6171 <para>In the FO stylesheet, if this parameter is non-zero then the
6172 <property>shade.verbatim.style</property> properties will be applied
6173 to verbatim environments.</para>
6175 <para>In the HTML stylesheet, this parameter is now deprecated. Use
6181 <refentry version="5.0" id="shade.verbatim.style">
6183 <refentrytitle>shade.verbatim.style</refentrytitle>
6184 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
6187 <refname>shade.verbatim.style</refname>
6188 <refpurpose>Properties that specify the style of shaded verbatim listings</refpurpose>
6192 <programlisting id="shade.verbatim.style.frag">
6193 <xsl:attribute-set name="shade.verbatim.style">
6194 <xsl:attribute name="border">0</xsl:attribute>
6195 <xsl:attribute name="bgcolor">#E0E0E0</xsl:attribute>
6196 </xsl:attribute-set>
6201 <refsection><info><title>Description</title></info>
6203 <para>Properties that specify the style of shaded verbatim listings. The
6204 parameters specified (the border and background color) are added to
6205 the styling of the xsl-fo output. A border might be specified as "thin
6206 black solid" for example. See <link xlink:href="http://www.w3.org/TR/2004/WD-xsl11-20041216/#border">xsl-fo</link></para>
6211 <refentry version="5.0" id="punct.honorific">
6213 <refentrytitle>punct.honorific</refentrytitle>
6214 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
6217 <refname>punct.honorific</refname>
6218 <refpurpose>Punctuation after an honorific in a personal name.</refpurpose>
6222 <programlisting id="punct.honorific.frag">
6223 <xsl:param name="punct.honorific">.</xsl:param>
6227 <refsection><info><title>Description</title></info>
6229 <para>This parameter specifies the punctuation that should be added after an
6230 honorific in a personal name.</para>
6235 <refentry version="5.0" id="tex.math.in.alt">
6237 <refentrytitle>tex.math.in.alt</refentrytitle>
6238 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
6239 <refmiscinfo class="other" otherclass="value">plain</refmiscinfo>
6240 <refmiscinfo class="other" otherclass="value">latex</refmiscinfo>
6243 <refname>tex.math.in.alt</refname>
6244 <refpurpose>TeX notation used for equations</refpurpose>
6248 <programlisting id="tex.math.in.alt.frag">
6249 <xsl:param name="tex.math.in.alt"></xsl:param>
6253 <refsection><info><title>Description</title></info>
6255 <para>If you want type math directly in TeX notation in equations,
6256 this parameter specifies notation used. Currently are supported two
6257 values -- <literal>plain</literal> and <literal>latex</literal>. Empty
6258 value means that you are not using TeX math at all.</para>
6260 <para>Preferred way for including TeX alternative of math is inside of
6261 <tag>textobject</tag> element. Eg.:</para>
6263 <programlisting><inlineequation>
6264 <inlinemediaobject>
6266 <imagedata fileref="eq1.gif"/>
6267 </imageobject>
6268 <textobject><phrase>E=mc squared</phrase></textobject>
6269 <textobject role="tex"><phrase>E=mc^2</phrase></textobject>
6270 </inlinemediaobject>
6271 </inlineequation></programlisting>
6273 <para>If you are using <tag>graphic</tag> element, you can
6274 store TeX inside <tag>alt</tag> element:</para>
6276 <programlisting><inlineequation>
6277 <alt role="tex">a^2+b^2=c^2</alt>
6278 <graphic fileref="a2b2c2.gif"/>
6279 </inlineequation></programlisting>
6281 <para>If you want use this feature, you should process your FO with
6282 PassiveTeX, which only supports TeX math notation. When calling
6283 stylsheet, don't forget to specify also
6284 passivetex.extensions=1.</para>
6286 <para>If you want equations in HTML, just process generated file
6287 <filename>tex-math-equations.tex</filename> by TeX or LaTeX. Then run
6288 dvi2bitmap program on result DVI file. You will get images for
6289 equations in your document.</para>
6292 <para>This feature is useful for print/PDF output only if you
6293 use the obsolete and now unsupported PassiveTeX XSL-FO
6299 <refsection><info><title>Related Parameters</title></info>
6300 <para><parameter>tex.math.delims</parameter>,
6301 <parameter>passivetex.extensions</parameter>,
6302 <parameter>tex.math.file</parameter></para>
6304 <refsection><info><title>More information</title></info>
6305 <para>For how-to documentation on embedding TeX equations and
6306 generating output from them, see
6307 <link role="tcg" xlink:href="TexMath.html">DBTeXMath</link>.</para>
6311 <refentry version="5.0" id="tex.math.file">
6313 <refentrytitle>tex.math.file</refentrytitle>
6314 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
6317 <refname>tex.math.file</refname>
6318 <refpurpose>Name of temporary file for generating images from equations</refpurpose>
6322 <programlisting id="tex.math.file.frag">
6323 <xsl:param name="tex.math.file">tex-math-equations.tex</xsl:param>
6327 <refsection><info><title>Description</title></info>
6329 <para>Name of auxiliary file for TeX equations. This file can be
6330 processed by dvi2bitmap to get bitmap versions of equations for HTML
6334 <refsection><info><title>Related Parameters</title></info>
6335 <para><parameter>tex.math.in.alt</parameter>,
6336 <parameter>tex.math.delims</parameter>,
6339 <refsection><info><title>More information</title></info>
6340 <para>For how-to documentation on embedding TeX equations and
6341 generating output from them, see
6342 <link role="tcg" xlink:href="TexMath.html">DBTeXMath</link>.</para>
6346 <refentry version="5.0" id="tex.math.delims">
6348 <refentrytitle>tex.math.delims</refentrytitle>
6349 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
6352 <refname>tex.math.delims</refname>
6353 <refpurpose>Should equations output for processing by TeX be
6354 surrounded by math mode delimiters?</refpurpose>
6358 <programlisting id="tex.math.delims.frag">
6359 <xsl:param name="tex.math.delims" select="1"></xsl:param>
6363 <refsection><info><title>Description</title></info>
6365 <para>For compatibility with DSSSL based DBTeXMath from Allin Cottrell
6366 you should set this parameter to 0.</para>
6369 <refsection><info><title>Related Parameters</title></info>
6370 <para><parameter>tex.math.in.alt</parameter>,
6371 <parameter>passivetex.extensions</parameter></para>
6374 <refsection><info><title>See Also</title></info>
6375 <para>You can also use the <tag class="xmlpi">dbtex delims</tag> processing
6376 instruction to control whether delimiters are output.</para>
6378 <refsection><info><title>More information</title></info>
6379 <para>For how-to documentation on embedding TeX equations and
6380 generating output from them, see
6381 <link role="tcg" xlink:href="TexMath.html">DBTeXMath</link>.</para>
6385 <refentry version="5.0" id="pixels.per.inch">
6387 <refentrytitle>pixels.per.inch</refentrytitle>
6388 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
6391 <refname>pixels.per.inch</refname>
6392 <refpurpose>How many pixels are there per inch?</refpurpose>
6396 <programlisting id="pixels.per.inch.frag">
6397 <xsl:param name="pixels.per.inch">90</xsl:param>
6401 <refsection><info><title>Description</title></info>
6403 <para>When lengths are converted to pixels, this value is used to
6404 determine the size of a pixel. The default value is taken from the
6405 <link xlink:href="http://www.w3.org/TR/2004/WD-xsl11-20041216/">XSL
6406 Recommendation</link>.
6412 <refentry version="5.0" id="points.per.em">
6414 <refentrytitle>points.per.em</refentrytitle>
6415 <refmiscinfo class="other" otherclass="datatype">number</refmiscinfo>
6418 <refname>points.per.em</refname>
6419 <refpurpose>Specify the nominal size of an em-space in points</refpurpose>
6423 <programlisting id="points.per.em.frag">
6424 <xsl:param name="points.per.em">10</xsl:param>
6428 <refsection><info><title>Description</title></info>
6430 <para>The fixed value used for calculations based upon the size of a
6431 character. The assumption made is that ten point font is in use. This
6432 assumption may not be valid.</para>
6437 <refentry version="5.0" id="use.svg">
6439 <refentrytitle>use.svg</refentrytitle>
6440 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
6443 <refname>use.svg</refname>
6444 <refpurpose>Allow SVG in the result tree?</refpurpose>
6448 <programlisting id="use.svg.frag">
6449 <xsl:param name="use.svg" select="1"></xsl:param>
6453 <refsection><info><title>Description</title></info>
6455 <para>If non-zero, SVG will be considered an acceptable image format. SVG
6456 is passed through to the result tree, so correct rendering of the resulting
6457 diagram depends on the formatter (FO processor or web browser) that is used
6458 to process the output from the stylesheet.</para>
6463 <refentry version="5.0" id="menuchoice.separator">
6465 <refentrytitle>menuchoice.separator</refentrytitle>
6466 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
6469 <refname>menuchoice.separator</refname>
6470 <refpurpose>Separator between items of a <tag>menuchoice</tag>
6471 other than <tag>guimenuitem</tag> and
6472 <tag>guisubmenu</tag></refpurpose>
6476 <programlisting id="menuchoice.separator.frag">
6477 <xsl:param name="menuchoice.separator">+</xsl:param>
6481 <refsection><info><title>Description</title></info>
6483 <para>Separator used to connect items of a <tag>menuchoice</tag> other
6484 than <tag>guimenuitem</tag> and <tag>guisubmenu</tag>. The latter
6485 elements are linked with <parameter>menuchoice.menu.separator</parameter>.
6491 <refentry version="5.0" id="menuchoice.menu.separator">
6493 <refentrytitle>menuchoice.menu.separator</refentrytitle>
6494 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
6497 <refname>menuchoice.menu.separator</refname>
6498 <refpurpose>Separator between items of a <tag>menuchoice</tag>
6499 with <tag>guimenuitem</tag> or
6500 <tag>guisubmenu</tag></refpurpose>
6504 <programlisting id="menuchoice.menu.separator.frag">
6505 <xsl:param name="menuchoice.menu.separator"> → </xsl:param>
6509 <refsection><info><title>Description</title></info>
6511 <para>Separator used to connect items of a <tag>menuchoice</tag> with
6512 <tag>guimenuitem</tag> or <tag>guisubmenu</tag>. Other elements
6513 are linked with <parameter>menuchoice.separator</parameter>.
6515 <para>The default value is &#x2192;, which is the
6516 &rarr; (right arrow) character entity.
6517 The current FOP (0.20.5) requires setting the font-family
6520 <para>The default value also includes spaces around the arrow,
6521 which will allow a line to break. Replace the spaces with
6522 &#xA0; (nonbreaking space) if you don't want those
6529 <refentry version="5.0" id="default.float.class">
6531 <refentrytitle>default.float.class</refentrytitle>
6532 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
6535 <refname>default.float.class</refname>
6536 <refpurpose>Specifies the default float class</refpurpose>
6540 <programlisting id="default.float.class.frag">
6541 <xsl:param name="default.float.class">
6543 <xsl:when test="contains($stylesheet.result.type,'html')">left</xsl:when>
6544 <xsl:otherwise>before</xsl:otherwise>
6550 <refsection><info><title>Description</title></info>
6552 <para>Selects the direction in which a float should be placed. for
6553 xsl-fo this is before, for html it is left. For Western texts, the
6554 before direction is the top of the page.</para>
6559 <refentry version="5.0" id="footnote.number.format">
6561 <refentrytitle>footnote.number.format</refentrytitle>
6562 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
6563 <refmiscinfo class="other" otherclass="value">1<alt>1,2,3...</alt></refmiscinfo>
6564 <refmiscinfo class="other" otherclass="value">A<alt>A,B,C...</alt></refmiscinfo>
6565 <refmiscinfo class="other" otherclass="value">a<alt>a,b,c...</alt></refmiscinfo>
6566 <refmiscinfo class="other" otherclass="value">i<alt>i,ii,iii...</alt></refmiscinfo>
6567 <refmiscinfo class="other" otherclass="value">I<alt>I,II,III...</alt></refmiscinfo>
6570 <refname>footnote.number.format</refname>
6571 <refpurpose>Identifies the format used for footnote numbers</refpurpose>
6575 <programlisting id="footnote.number.format.frag">
6576 <xsl:param name="footnote.number.format">1</xsl:param>
6580 <refsection><info><title>Description</title></info>
6582 <para>The <parameter>footnote.number.format</parameter> specifies the format
6583 to use for footnote numeration (1, i, I, a, or A).</para>
6588 <refentry version="5.0" id="table.footnote.number.format">
6590 <refentrytitle>table.footnote.number.format</refentrytitle>
6591 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
6592 <refmiscinfo class="other" otherclass="value">1<alt>1,2,3...</alt></refmiscinfo>
6593 <refmiscinfo class="other" otherclass="value">A<alt>A,B,C...</alt></refmiscinfo>
6594 <refmiscinfo class="other" otherclass="value">a<alt>a,b,c...</alt></refmiscinfo>
6595 <refmiscinfo class="other" otherclass="value">i<alt>i,ii,iii...</alt></refmiscinfo>
6596 <refmiscinfo class="other" otherclass="value">I<alt>I,II,III...</alt></refmiscinfo>
6599 <refname>table.footnote.number.format</refname>
6600 <refpurpose>Identifies the format used for footnote numbers in tables</refpurpose>
6604 <programlisting id="table.footnote.number.format.frag">
6605 <xsl:param name="table.footnote.number.format">a</xsl:param>
6609 <refsection><info><title>Description</title></info>
6611 <para>The <parameter>table.footnote.number.format</parameter> specifies the format
6612 to use for footnote numeration (1, i, I, a, or A) in tables.</para>
6617 <refentry version="5.0" id="footnote.number.symbols">
6619 <refentrytitle>footnote.number.symbols</refentrytitle>
6620 <refmiscinfo class="other" otherclass="datatype"/>
6623 <refname>footnote.number.symbols</refname>
6624 <refpurpose>Special characters to use as footnote markers</refpurpose>
6628 <programlisting id="footnote.number.symbols.frag">
6629 <xsl:param name="footnote.number.symbols"></xsl:param>
6633 <refsection><info><title>Description</title></info>
6635 <para>If <parameter>footnote.number.symbols</parameter> is not the empty string,
6636 footnotes will use the characters it contains as footnote symbols. For example,
6637 <quote>*&#x2020;&#x2021;&#x25CA;&#x2720;</quote> will identify
6638 footnotes with <quote>*</quote>, <quote>†</quote>, <quote>‡</quote>,
6639 <quote>◊</quote>, and <quote>✠</quote>. If there are more footnotes
6640 than symbols, the stylesheets will fall back to numbered footnotes using
6641 <parameter>footnote.number.format</parameter>.</para>
6643 <para>The use of symbols for footnotes depends on the ability of your
6644 processor (or browser) to render the symbols you select. Not all systems are
6645 capable of displaying the full range of Unicode characters. If the quoted characters
6646 in the preceding paragraph are not displayed properly, that's a good indicator
6647 that you may have trouble using those symbols for footnotes.</para>
6652 <refentry version="5.0" id="table.footnote.number.symbols">
6654 <refentrytitle>table.footnote.number.symbols</refentrytitle>
6655 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
6658 <refname>table.footnote.number.symbols</refname>
6659 <refpurpose>Special characters to use a footnote markers in tables</refpurpose>
6663 <programlisting id="table.footnote.number.symbols.frag">
6664 <xsl:param name="table.footnote.number.symbols"></xsl:param>
6668 <refsection><info><title>Description</title></info>
6670 <para>If <parameter>table.footnote.number.symbols</parameter> is not the empty string,
6671 table footnotes will use the characters it contains as footnote symbols. For example,
6672 <quote>*&#x2020;&#x2021;&#x25CA;&#x2720;</quote> will identify
6673 footnotes with <quote>*</quote>, <quote>†</quote>, <quote>‡</quote>,
6674 <quote>◊</quote>, and <quote>✠</quote>. If there are more footnotes
6675 than symbols, the stylesheets will fall back to numbered footnotes using
6676 <parameter>table.footnote.number.format</parameter>.</para>
6678 <para>The use of symbols for footnotes depends on the ability of your
6679 processor (or browser) to render the symbols you select. Not all systems are
6680 capable of displaying the full range of Unicode characters. If the quoted characters
6681 in the preceding paragraph are not displayed properly, that's a good indicator
6682 that you may have trouble using those symbols for footnotes.</para>
6687 <refentry version="5.0" id="highlight.source">
6689 <refentrytitle>highlight.source</refentrytitle>
6690 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
6693 <refname>highlight.source</refname>
6694 <refpurpose>Should the content of <tag>programlisting</tag>
6695 be syntactically highlighted?</refpurpose>
6699 <programlisting id="highlight.source.frag">
6700 <xsl:param name="highlight.source" select="0"></xsl:param>
6704 <refsection><info><title>Description</title></info>
6706 <para>When this parameter is non-zero, the stylesheets will try to do syntax highlighting of the
6707 content of <tag>programlisting</tag> elements. You specify the language for each programlisting
6708 by using the <tag class="attribute">language</tag> attribute. The <parameter>highlight.default.language</parameter>
6709 parameter can be used to specify the language for programlistings without a <tag class="attribute">language</tag>
6710 attribute. Syntax highlighting also works for <tag>screen</tag> and <tag>synopsis</tag> elements.</para>
6712 <para>The actual highlighting work is done by the XSLTHL extension module. This is an external Java library that has to be
6713 downloaded separately (see below).</para>
6716 <para>In order to use this extension, you must</para>
6718 <listitem><para>add <filename>xslthl-2.x.x.jar</filename> to your Java classpath. The latest version is available
6719 from <link xlink:href="http://sourceforge.net/projects/xslthl">the XSLT syntax highlighting project</link>
6720 at SourceForge.</para>
6723 <para>use a customization layer in which you import one of the following stylesheet modules:
6726 <para><filename>html/highlight.xsl</filename>
6730 <para><filename>xhtml/highlight.xsl</filename>
6734 <para><filename>xhtml-1_1/highlight.xsl</filename>
6738 <para><filename>fo/highlight.xsl</filename>
6744 <listitem><para>let either the <literal>xslthl.config</literal> Java system property or the
6745 <parameter>highlight.xslthl.config</parameter> parameter point to the configuration file for syntax
6746 highlighting (using URL syntax). DocBook XSL comes with a ready-to-use configuration file,
6747 <filename>highlighting/xslthl-config.xml</filename>.</para>
6751 <para>The extension works with Saxon 6.5.x and Xalan-J. (Saxon 8.5 or later is also supported, but since it is
6752 an XSLT 2.0 processor it is not guaranteed to work with DocBook XSL in all circumstances.)</para>
6754 <para>The following is an example of a Saxon 6 command adapted for syntax highlighting, to be used on Windows:</para>
6757 <para><command>java -cp c:/Java/saxon.jar;c:/Java/xslthl-2.0.1.jar
6758 -Dxslthl.config=file:///c:/docbook-xsl/highlighting/xslthl-config.xml com.icl.saxon.StyleSheet
6759 -o test.html test.xml myhtml.xsl</command></para>
6765 <refentry version="5.0" id="highlight.xslthl.config">
6767 <refentrytitle>highlight.xslthl.config</refentrytitle>
6768 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
6771 <refname>highlight.xslthl.config</refname>
6772 <refpurpose>Location of XSLTHL configuration file</refpurpose>
6776 <programlisting id="highlight.xslthl.config.frag">
6777 <xsl:param name="highlight.xslthl.config"></xsl:param>
6781 <refsection><info><title>Description</title></info>
6783 <para>This location has precedence over the corresponding Java property.</para>
6788 <refentry version="5.0" id="highlight.default.language">
6790 <refentrytitle>highlight.default.language</refentrytitle>
6791 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
6794 <refname>highlight.default.language</refname>
6795 <refpurpose>Default language of programlisting</refpurpose>
6799 <programlisting id="highlight.default.language.frag">
6800 <xsl:param name="highlight.default.language"></xsl:param>
6804 <refsection><info><title>Description</title></info>
6806 <para>This language is used when there is no language attribute on programlisting.</para>
6811 <refentry version="5.0" id="email.delimiters.enabled">
6813 <refentrytitle>email.delimiters.enabled</refentrytitle>
6814 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
6817 <refname>email.delimiters.enabled</refname>
6818 <refpurpose>Generate delimiters around email addresses?</refpurpose>
6822 <programlisting id="email.delimiters.enabled.frag">
6823 <xsl:param name="email.delimiters.enabled" select="1"></xsl:param>
6827 <refsection><info><title>Description</title></info>
6829 <para>If non-zero, delimiters
6831 <footnote><para>For delimiters, the
6832 stylesheets are currently hard-coded to output angle
6833 brackets.</para></footnote>
6835 are generated around e-mail addresses
6836 (the output of the <tag>email</tag> element).</para>
6841 <refentry version="5.0" id="exsl.node.set.available">
6843 <refentrytitle>exsl.node.set.available</refentrytitle>
6844 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
6847 <refname>exsl.node.set.available</refname>
6848 <refpurpose>Is the test function-available('exsl:node-set') true?</refpurpose>
6852 <programlisting id="exsl.node.set.available.frag"><xsl:param name="exsl.node.set.available">
6854 <xsl:when exsl:foo="" test="function-available('exsl:node-set') or contains(system-property('xsl:vendor'), 'Apache Software Foundation')">1</xsl:when>
6855 <xsl:otherwise>0</xsl:otherwise>
6861 <refsection><info><title>Description</title></info>
6864 then the exsl:node-set() function is available to be used in
6866 If zero, then the function is not available.
6867 This param automatically detects the presence of
6868 the function and does not normally need to be set manually.</para>
6870 <para>This param was created to handle a long-standing
6871 bug in the Xalan processor that fails to detect the
6872 function even though it is available.</para>
6877 </reference><reference id="annos" xml:base="../html/param.xml"><title>Annotations</title>
6878 <refentry version="5.0" id="annotation.support">
6880 <refentrytitle>annotation.support</refentrytitle>
6881 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
6884 <refname>annotation.support</refname>
6885 <refpurpose>Enable annotations?</refpurpose>
6889 <programlisting id="annotation.support.frag">
6890 <xsl:param name="annotation.support" select="0"></xsl:param>
6894 <refsection><info><title>Description</title></info>
6896 <para>If non-zero, the stylesheets will attempt to support annotation
6897 elements in HTML by including some JavaScript (see
6898 <parameter>annotation.js</parameter>).</para>
6903 <refentry version="5.0" id="annotation.js">
6905 <refentrytitle>annotation.js</refentrytitle>
6906 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
6909 <refname>annotation.js</refname>
6910 <refpurpose>URIs identifying JavaScript files with support for annotation popups</refpurpose>
6914 <programlisting id="annotation.js.frag">
6916 <xsl:param name="annotation.js">
6917 <xsl:text>http://docbook.sourceforge.net/release/script/AnchorPosition.js http://docbook.sourceforge.net/release/script/PopupWindow.js</xsl:text></xsl:param>
6922 <refsection><info><title>Description</title></info>
6924 <para>If <property>annotation.support</property> is enabled and the
6925 document contains <tag>annotation</tag>s, then the URIs listed
6926 in this parameter will be included. These JavaScript files are required
6927 for popup annotation support.</para>
6932 <refentry version="5.0" id="annotation.css">
6934 <refentrytitle>annotation.css</refentrytitle>
6935 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
6938 <refname>annotation.css</refname>
6939 <refpurpose>CSS rules for annotations</refpurpose>
6943 <programlisting id="annotation.css.frag">
6944 <xsl:param name="annotation.css">
6945 /* ======================================================================
6949 div.annotation-list { visibility: hidden;
6952 div.annotation-nocss { position: absolute;
6956 div.annotation-popup { position: absolute;
6961 border-style: solid;
6964 background-color: white;
6967 div.annotation-title { padding: 1px;
6969 border-bottom-style: solid;
6970 border-bottom-width: 1px;
6972 background-color: black;
6975 div.annotation-body { padding: 2px;
6978 div.annotation-body p { margin-top: 0px;
6982 div.annotation-close { position: absolute;
6990 <refsection><info><title>Description</title></info>
6992 <para>If <parameter>annotation.support</parameter> is enabled and the
6993 document contains <tag>annotation</tag>s, then the CSS in this
6994 parameter will be included in the document.</para>
6999 <refentry version="5.0" id="annotation.graphic.open">
7001 <refentrytitle>annotation.graphic.open</refentrytitle>
7002 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
7005 <refname>annotation.graphic.open</refname>
7006 <refpurpose>Image for identifying a link that opens an annotation popup</refpurpose>
7010 <programlisting id="annotation.graphic.open.frag">
7011 <xsl:param name="annotation.graphic.open">http://docbook.sourceforge.net/release/images/annot-open.png</xsl:param>
7015 <refsection><info><title>Description</title></info>
7017 <para>This image is used inline to identify the location of
7018 annotations. It may be replaced by a user provided graphic. The size should be approximately 10x10 pixels.</para>
7023 <refentry version="5.0" id="annotation.graphic.close">
7025 <refentrytitle>annotation.graphic.close</refentrytitle>
7026 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
7029 <refname>annotation.graphic.close</refname>
7030 <refpurpose>Image for identifying a link that closes an annotation popup</refpurpose>
7034 <programlisting id="annotation.graphic.close.frag">
7035 <xsl:param name="annotation.graphic.close">
7036 http://docbook.sourceforge.net/release/images/annot-close.png</xsl:param>
7040 <refsection><info><title>Description</title></info>
7042 <para>This image is used on popup annotations as the “x” that the
7043 user can click to dismiss the popup.</para>
7044 <para>This image is used on popup annotations as the “x” that the user can
7045 click to dismiss the popup. It may be replaced by a user provided graphic. The size should be approximately 10x10 pixels.</para>
7050 </reference><reference id="graphics" xml:base="../html/param.xml"><title>Graphics</title>
7051 <refentry version="5.0" id="img.src.path">
7053 <refentrytitle>img.src.path</refentrytitle>
7054 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
7057 <refname>img.src.path</refname>
7058 <refpurpose>Path to HTML/FO image files</refpurpose>
7062 <programlisting id="img.src.path.frag"><xsl:param name="img.src.path"></xsl:param></programlisting>
7065 <refsection><info><title>Description</title></info>
7067 <para>Add a path prefix to the value of the <tag class="attribute">fileref</tag>
7068 attribute of <tag>graphic</tag>, <tag>inlinegraphic</tag>, and <tag>imagedata</tag> elements. The resulting
7069 compound path is used in the output as the value of the <tag class="attribute">src</tag>
7070 attribute of <tag class="element">img</tag> (HTML) or <tag class="element">external-graphic</tag> (FO).
7074 The path given by <literal>img.src.path</literal> could be relative to the directory where the HTML/FO
7075 files are created, or it could be an absolute URI.
7076 The default value is empty.
7077 Be sure to include a trailing slash if needed.
7080 <para>This prefix is not applied to any filerefs that start
7081 with "/" or contain "//:".
7087 <refentry version="5.0" id="keep.relative.image.uris">
7089 <refentrytitle>keep.relative.image.uris</refentrytitle>
7090 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
7093 <refname>keep.relative.image.uris</refname>
7094 <refpurpose>Should image URIs be resolved against xml:base?</refpurpose>
7098 <programlisting id="keep.relative.image.uris.frag">
7099 <xsl:param name="keep.relative.image.uris" select="1"></xsl:param>
7104 <refsection><info><title>Description</title></info>
7106 <para>If non-zero, relative URIs (in, for example
7107 <literal>fileref</literal> attributes) will be used in the generated
7108 output. Otherwise, the URIs will be made absolute with respect to the
7111 <para>Note that the stylesheets calculate (and use) the absolute form
7112 for some purposes, this only applies to the resulting output.</para>
7117 <refentry version="5.0" id="graphic.default.extension">
7119 <refentrytitle>graphic.default.extension</refentrytitle>
7120 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
7123 <refname>graphic.default.extension</refname>
7124 <refpurpose>Default extension for graphic filenames</refpurpose>
7128 <programlisting id="graphic.default.extension.frag"><xsl:param name="graphic.default.extension"></xsl:param></programlisting>
7131 <refsection><info><title>Description</title></info>
7133 <para>If a <tag>graphic</tag> or <tag>mediaobject</tag>
7134 includes a reference to a filename that does not include an extension,
7135 and the <tag class="attribute">format</tag> attribute is
7136 <emphasis>unspecified</emphasis>, the default extension will be used.
7142 <refentry version="5.0" id="default.image.width">
7144 <refentrytitle>default.image.width</refentrytitle>
7145 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
7148 <refname>default.image.width</refname>
7149 <refpurpose>The default width of images</refpurpose>
7153 <programlisting id="default.image.width.frag">
7154 <xsl:param name="default.image.width"></xsl:param>
7158 <refsection><info><title>Description</title></info>
7160 <para>If specified, this value will be used for the
7161 <tag class="attribute">width</tag> attribute on
7162 images that do not specify any
7163 <link xlink:href="http://docbook.org/tdg/en/html/imagedata.html#viewport.area">viewport
7164 dimensions</link>.</para>
7169 <refentry version="5.0" id="nominal.image.width">
7171 <refentrytitle>nominal.image.width</refentrytitle>
7172 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
7175 <refname>nominal.image.width</refname>
7176 <refpurpose>The nominal image width</refpurpose>
7180 <programlisting id="nominal.image.width.frag">
7181 <xsl:param name="nominal.image.width" select="6 * $pixels.per.inch"></xsl:param>
7185 <refsection><info><title>Description</title></info>
7187 <para>Graphic widths expressed as a percentage are problematic. In the
7188 following discussion, we speak of width and contentwidth, but
7189 the same issues apply to depth and contentdepth.</para>
7191 <para>A width of 50% means "half of the available space for the image."
7192 That's fine. But note that in HTML, this is a dynamic property and
7193 the image size will vary if the browser window is resized.</para>
7195 <para>A contentwidth of 50% means "half of the actual image width".
7196 But what does that mean if the stylesheets cannot assess the image's
7197 actual size? Treating this as a width of 50% is one possibility, but
7198 it produces behavior (dynamic scaling) that seems entirely out of
7199 character with the meaning.</para>
7201 <para>Instead, the stylesheets define a
7202 <parameter>nominal.image.width</parameter> and convert percentages to
7203 actual values based on that nominal size.</para>
7208 <refentry version="5.0" id="nominal.image.depth">
7210 <refentrytitle>nominal.image.depth</refentrytitle>
7211 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
7214 <refname>nominal.image.depth</refname>
7215 <refpurpose>Nominal image depth</refpurpose>
7219 <programlisting id="nominal.image.depth.frag">
7220 <xsl:param name="nominal.image.depth" select="4 * $pixels.per.inch"></xsl:param>
7224 <refsection><info><title>Description</title></info>
7226 <para>See <parameter>nominal.image.width</parameter>.</para>
7231 <refentry version="5.0" id="use.embed.for.svg">
7233 <refentrytitle>use.embed.for.svg</refentrytitle>
7234 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
7237 <refname>use.embed.for.svg</refname>
7238 <refpurpose>Use HTML <tag>embed</tag> for SVG?</refpurpose>
7242 <programlisting id="use.embed.for.svg.frag">
7243 <xsl:param name="use.embed.for.svg" select="0"></xsl:param>
7247 <refsection><info><title>Description</title></info>
7249 <para>If non-zero, an <tag>embed</tag> element will be created for
7250 SVG figures. An <tag>object</tag> is <emphasis>always</emphasis> created,
7251 this parameter merely controls whether or not an additional <tag>embed</tag>
7252 is generated inside the <tag>object</tag>.</para>
7254 <para>On the plus side, this may be more portable among browsers and plug-ins.
7255 On the minus side, it isn't valid HTML.</para>
7260 <refentry version="5.0" id="make.graphic.viewport">
7262 <refentrytitle>make.graphic.viewport</refentrytitle>
7263 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
7266 <refname>make.graphic.viewport</refname>
7267 <refpurpose>Use tables in HTML to make viewports for graphics</refpurpose>
7271 <programlisting id="make.graphic.viewport.frag">
7272 <xsl:param name="make.graphic.viewport" select="1"></xsl:param>
7276 <refsection><info><title>Description</title></info>
7278 <para>The HTML <tag>img</tag> element only supports the notion
7279 of content-area scaling; it doesn't support the distinction between a
7280 content-area and a viewport-area, so we have to make some compromises.</para>
7282 <para>If <parameter>make.graphic.viewport</parameter> is non-zero, a table
7283 will be used to frame the image. This creates an effective viewport-area.
7286 <para>Tables and alignment don't work together, so this parameter is ignored
7287 if alignment is specified on an image.</para>
7291 <refentry version="5.0" id="preferred.mediaobject.role">
7293 <refentrytitle>preferred.mediaobject.role</refentrytitle>
7294 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
7297 <refname>preferred.mediaobject.role</refname>
7298 <refpurpose>Select which mediaobject to use based on
7299 this value of an object's <tag class="attribute">role</tag> attribute.
7304 <programlisting id="preferred.mediaobject.role.frag">
7305 <xsl:param name="preferred.mediaobject.role"></xsl:param>
7309 <refsection><info><title>Description</title></info>
7311 <para>A mediaobject may contain several objects such as imageobjects.
7312 If the parameter <parameter>use.role.for.mediaobject</parameter> is
7313 non-zero, then the <literal>role</literal> attribute on
7314 <tag>imageobject</tag>s and other objects within a
7315 <tag>mediaobject</tag> container will be used to select which object
7316 will be used. If one of the objects has a role value that matches the
7317 <parameter>preferred.mediaobject.role</parameter> parameter, then it
7318 has first priority for selection. If more than one has such a role
7319 value, the first one is used.
7322 See the <parameter>use.role.for.mediaobject</parameter> parameter
7323 for the sequence of selection.</para>
7327 <refentry version="5.0" id="use.role.for.mediaobject">
7329 <refentrytitle>use.role.for.mediaobject</refentrytitle>
7330 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
7333 <refname>use.role.for.mediaobject</refname>
7334 <refpurpose>Use <tag class="attribute">role</tag> attribute
7335 value for selecting which of several objects within a mediaobject to use.
7340 <programlisting id="use.role.for.mediaobject.frag">
7341 <xsl:param name="use.role.for.mediaobject" select="1"></xsl:param>
7345 <refsection><info><title>Description</title></info>
7347 <para>If non-zero, the <tag class="attribute">role</tag> attribute on
7348 <tag>imageobject</tag>s or other objects within a <tag>mediaobject</tag> container will be used to select which object will be
7352 The order of selection when then parameter is non-zero is:
7356 <para>If the stylesheet parameter <parameter>preferred.mediaobject.role</parameter> has a value, then the object whose role equals that value is selected.</para>
7359 <para>Else if an object's role attribute has a value of
7360 <literal>html</literal> for HTML processing or
7361 <literal>fo</literal> for FO output, then the first
7362 of such objects is selected.
7366 <para>Else the first suitable object is selected.</para>
7371 <parameter>use.role.for.mediaobject</parameter>
7372 is zero, then role attributes are not considered
7373 and the first suitable object
7374 with or without a role value is used.
7379 <refentry version="5.0" id="ignore.image.scaling">
7381 <refentrytitle>ignore.image.scaling</refentrytitle>
7382 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
7385 <refname>ignore.image.scaling</refname>
7386 <refpurpose>Tell the stylesheets to ignore the author's image scaling attributes</refpurpose>
7390 <programlisting id="ignore.image.scaling.frag">
7391 <xsl:param name="ignore.image.scaling" select="0"></xsl:param>
7395 <refsection><info><title>Description</title></info>
7397 <para>If non-zero, the scaling attributes on graphics and media objects are
7403 </reference><reference id="chunking" xml:base="../html/param.xml"><title>Chunking</title>
7404 <refentry version="5.0" id="chunker.output.cdata-section-elements">
7406 <refentrytitle>chunker.output.cdata-section-elements</refentrytitle>
7407 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
7410 <refname>chunker.output.cdata-section-elements</refname>
7411 <refpurpose>List of elements to escape with CDATA sections</refpurpose>
7414 <programlisting id="chunker.output.cdata-section-elements.frag">
7415 <xsl:param name="chunker.output.cdata-section-elements"></xsl:param>
7418 <refsection><info><title>Description</title></info>
7419 <para>This parameter specifies the list of elements that should be escaped
7420 as CDATA sections by the chunking stylesheet. Not all processors support
7421 specification of this parameter.
7424 <para>This parameter is documented here, but the declaration is actually
7425 in the <filename>chunker.xsl</filename> stylesheet module.</para>
7430 <refentry version="5.0" id="chunker.output.doctype-public">
7432 <refentrytitle>chunker.output.doctype-public</refentrytitle>
7433 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
7436 <refname>chunker.output.doctype-public</refname>
7437 <refpurpose>Public identifer to use in the document type of generated pages</refpurpose>
7440 <programlisting id="chunker.output.doctype-public.frag">
7441 <xsl:param name="chunker.output.doctype-public"></xsl:param>
7444 <refsection><info><title>Description</title></info>
7445 <para>This parameter specifies the public identifier that should be used by
7446 the chunking stylesheet in the document type declaration of chunked pages.
7447 Not all processors support specification of
7451 <para>This parameter is documented here, but the declaration is actually
7452 in the <filename>chunker.xsl</filename> stylesheet module.</para>
7457 <refentry version="5.0" id="chunker.output.doctype-system">
7459 <refentrytitle>chunker.output.doctype-system</refentrytitle>
7460 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
7463 <refname>chunker.output.doctype-system</refname>
7464 <refpurpose>System identifier to use for the document type in generated pages</refpurpose>
7467 <programlisting id="chunker.output.doctype-system.frag">
7468 <xsl:param name="chunker.output.doctype-system"></xsl:param>
7471 <refsection><info><title>Description</title></info>
7472 <para>This parameter specifies the system identifier that should be used by
7473 the chunking stylesheet in the document type declaration of chunked pages.
7474 Not all processors support specification of
7478 <para>This parameter is documented here, but the declaration is actually
7479 in the <filename>chunker.xsl</filename> stylesheet module.</para>
7484 <refentry version="5.0" id="chunker.output.encoding">
7486 <refentrytitle>chunker.output.encoding</refentrytitle>
7487 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
7490 <refname>chunker.output.encoding</refname>
7491 <refpurpose>Encoding used in generated pages</refpurpose>
7494 <programlisting id="chunker.output.encoding.frag">
7495 <xsl:param name="chunker.output.encoding">ISO-8859-1</xsl:param>
7498 <refsection><info><title>Description</title></info>
7499 <para>This parameter specifies the encoding to be used in files
7500 generated by the chunking stylesheet. Not all processors support
7501 specification of this parameter.
7503 <para>This parameter used to be named <literal>default.encoding</literal>.</para>
7505 <para>This parameter is documented here, but the declaration is actually
7506 in the <filename>chunker.xsl</filename> stylesheet module.</para>
7511 <refentry version="5.0" id="chunker.output.indent">
7513 <refentrytitle>chunker.output.indent</refentrytitle>
7514 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
7517 <refname>chunker.output.indent</refname>
7518 <refpurpose>Specification of indentation on generated pages</refpurpose>
7521 <programlisting id="chunker.output.indent.frag">
7522 <xsl:param name="chunker.output.indent">no</xsl:param>
7525 <refsection><info><title>Description</title></info>
7526 <para>This parameter specifies the value of the indent
7527 specification for generated pages. Not all processors support
7528 specification of this parameter.
7531 <para>This parameter is documented here, but the declaration is actually
7532 in the <filename>chunker.xsl</filename> stylesheet module.</para>
7537 <refentry version="5.0" id="chunker.output.media-type">
7539 <refentrytitle>chunker.output.media-type</refentrytitle>
7540 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
7543 <refname>chunker.output.media-type</refname>
7544 <refpurpose>Media type to use in generated pages</refpurpose>
7547 <programlisting id="chunker.output.media-type.frag">
7548 <xsl:param name="chunker.output.media-type"></xsl:param>
7551 <refsection><info><title>Description</title></info>
7552 <para>This parameter specifies the media type that should be used by
7553 the chunking stylesheet. Not all processors support specification of
7556 <para>This parameter specifies the media type that should be used by the
7557 chunking stylesheet. This should be one from those defined in
7558 <link xlink:href="http://www.ietf.org/rfc/rfc2045.txt">[RFC2045]</link> and
7559 <link xlink:href="http://www.ietf.org/rfc/rfc2046.txt">[RFC2046]</link> </para>
7561 <para>This parameter is documented here, but the declaration is actually
7562 in the <filename>chunker.xsl</filename> stylesheet module.</para>
7563 <para>It must be one from html, xml or text</para>
7568 <refentry version="5.0" id="chunker.output.method">
7570 <refentrytitle>chunker.output.method</refentrytitle>
7571 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
7572 <refmiscinfo class="other" otherclass="value">html</refmiscinfo>
7573 <refmiscinfo class="other" otherclass="value">xml</refmiscinfo>
7576 <refname>chunker.output.method</refname>
7577 <refpurpose>Method used in generated pages</refpurpose>
7580 <programlisting id="chunker.output.method.frag">
7581 <xsl:param name="chunker.output.method">html</xsl:param>
7584 <refsection><info><title>Description</title></info>
7585 <para>This parameter specifies the output method to be used in files
7586 generated by the chunking stylesheet.
7588 <para>This parameter used to be named <literal>output.method</literal>.</para>
7590 <para>This parameter is documented here, but the declaration is actually
7591 in the <filename>chunker.xsl</filename> stylesheet module.</para>
7596 <refentry version="5.0" id="chunker.output.omit-xml-declaration">
7598 <refentrytitle>chunker.output.omit-xml-declaration</refentrytitle>
7599 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
7602 <refname>chunker.output.omit-xml-declaration</refname>
7603 <refpurpose>Omit-xml-declaration for generated pages</refpurpose>
7606 <programlisting id="chunker.output.omit-xml-declaration.frag">
7607 <xsl:param name="chunker.output.omit-xml-declaration">no</xsl:param>
7610 <refsection><info><title>Description</title></info>
7611 <para>This parameter specifies the value of the omit-xml-declaration
7612 specification for generated pages. Not all processors support
7613 specification of this parameter.
7616 <para>This parameter is documented here, but the declaration is actually
7617 in the <filename>chunker.xsl</filename> stylesheet module.</para>
7622 <refentry version="5.0" id="chunker.output.standalone">
7624 <refentrytitle>chunker.output.standalone</refentrytitle>
7625 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
7628 <refname>chunker.output.standalone</refname>
7629 <refpurpose>Standalone declaration for generated pages</refpurpose>
7632 <programlisting id="chunker.output.standalone.frag">
7633 <xsl:param name="chunker.output.standalone">no</xsl:param>
7636 <refsection><info><title>Description</title></info>
7637 <para>This parameter specifies the value of the standalone
7638 specification for generated pages. It must be either
7639 <literal>yes</literal> or <literal>no</literal>. Not all
7640 processors support specification of this parameter.
7643 <para>This parameter is documented here, but the declaration is actually
7644 in the <filename>chunker.xsl</filename> stylesheet module.</para>
7649 <refentry version="5.0" id="saxon.character.representation">
7651 <refentrytitle>saxon.character.representation</refentrytitle>
7652 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
7655 <refname>saxon.character.representation</refname>
7656 <refpurpose>Saxon character representation used in generated HTML pages</refpurpose>
7660 <programlisting id="saxon.character.representation.frag"><xsl:param name="saxon.character.representation" select="'entity;decimal'"></xsl:param></programlisting>
7663 <refsection><info><title>Description</title></info>
7665 <para>This parameter has effect only when Saxon 6 is used (version 6.4.2 or later).
7666 It sets the character representation in files generated by the chunking stylesheets.
7667 If you want to suppress entity references for characters with direct representations in
7668 <parameter>chunker.output.encoding</parameter>, set the parameter value to <literal>native</literal>.
7671 <para> For more information, see <link role="tcg" xlink:href="OutputEncoding.html#SaxonCharacter">Saxon output character representation</link>.</para>
7674 <para>This parameter is documented here, but the declaration is actually
7675 in the <filename>chunker.xsl</filename> stylesheet module.</para>
7682 <refentry version="5.0" id="html.ext">
7684 <refentrytitle>html.ext</refentrytitle>
7685 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
7688 <refname>html.ext</refname>
7689 <refpurpose>Identifies the extension of generated HTML files</refpurpose>
7693 <programlisting id="html.ext.frag">
7694 <xsl:param name="html.ext">.html</xsl:param>
7698 <refsection><info><title>Description</title></info>
7700 <para>The extension identified by <parameter>html.ext</parameter> will
7701 be used as the filename extension for chunks created by this
7707 <refentry version="5.0" id="use.id.as.filename">
7709 <refentrytitle>use.id.as.filename</refentrytitle>
7710 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
7713 <refname>use.id.as.filename</refname>
7714 <refpurpose>Use ID value of chunk elements as the filename?</refpurpose>
7718 <programlisting id="use.id.as.filename.frag">
7719 <xsl:param name="use.id.as.filename" select="0"></xsl:param>
7723 <refsection><info><title>Description</title></info>
7725 <para>If <parameter>use.id.as.filename</parameter>
7726 is non-zero, the filename of chunk elements that have IDs will be
7727 derived from the ID value.
7733 <refentry version="5.0" id="html.extra.head.links">
7735 <refentrytitle>html.extra.head.links</refentrytitle>
7736 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
7739 <refname>html.extra.head.links</refname>
7740 <refpurpose>Toggle extra HTML head link information</refpurpose>
7744 <programlisting id="html.extra.head.links.frag">
7745 <xsl:param name="html.extra.head.links" select="0"></xsl:param>
7749 <refsection><info><title>Description</title></info>
7751 <para>If non-zero, extra <tag>link</tag> elements will be
7752 generated in the <tag>head</tag> of chunked HTML files. These
7753 extra links point to chapters, appendixes, sections, etc. as supported
7754 by the <quote>Site Navigation Bar</quote> in Mozilla 1.0 (as of CR1, at least).
7760 <refentry version="5.0" id="root.filename">
7762 <refentrytitle>root.filename</refentrytitle>
7763 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
7766 <refname>root.filename</refname>
7767 <refpurpose>Identifies the name of the root HTML file when chunking</refpurpose>
7771 <programlisting id="root.filename.frag">
7772 <xsl:param name="root.filename">index</xsl:param>
7776 <refsection><info><title>Description</title></info>
7778 <para>The <parameter>root.filename</parameter> is the base filename for
7779 the chunk created for the root of each document processed.
7785 <refentry version="5.0" id="base.dir">
7787 <refentrytitle>base.dir</refentrytitle>
7788 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
7791 <refname>base.dir</refname>
7792 <refpurpose>The base directory of chunks</refpurpose>
7796 <programlisting id="base.dir.frag">
7797 <xsl:param name="base.dir"></xsl:param>
7801 <refsection><info><title>Description</title></info>
7803 <para>If specified, the <parameter>base.dir</parameter> identifies
7804 the output directory for chunks. (If not specified, the output directory
7805 is system dependent.)</para>
7810 <refentry version="5.0" id="generate.manifest">
7812 <refentrytitle>generate.manifest</refentrytitle>
7813 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
7816 <refname>generate.manifest</refname>
7817 <refpurpose>Generate a manifest file?</refpurpose>
7821 <programlisting id="generate.manifest.frag"><xsl:param name="generate.manifest" select="0"></xsl:param></programlisting>
7824 <refsection><info><title>Description</title></info>
7826 <para>If non-zero, a list of HTML files generated by the
7827 stylesheet transformation is written to the file named by
7828 the <parameter>manifest</parameter> parameter.</para>
7833 <refentry version="5.0" id="manifest">
7835 <refentrytitle>manifest</refentrytitle>
7836 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
7839 <refname>manifest</refname>
7840 <refpurpose>Name of manifest file</refpurpose>
7844 <programlisting id="manifest.frag">
7845 <xsl:param name="manifest">HTML.manifest</xsl:param>
7849 <refsection><info><title>Description</title></info>
7851 <para>The name of the file to which a manifest is written (if the
7852 value of the <parameter>generate.manifest</parameter> parameter
7853 is non-zero).</para>
7858 <refentry version="5.0" id="manifest.in.base.dir">
7860 <refentrytitle>manifest.in.base.dir</refentrytitle>
7861 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
7864 <refname>manifest.in.base.dir</refname>
7865 <refpurpose>Should the manifest file be written into <parameter>base.dir</parameter>?</refpurpose>
7869 <programlisting id="manifest.in.base.dir.frag">
7870 <xsl:param name="manifest.in.base.dir" select="0"></xsl:param>
7874 <refsection><info><title>Description</title></info>
7876 <para>If non-zero, the manifest file as well as project files for HTML Help and
7877 Eclipse Help are written into <parameter>base.dir</parameter> instead
7878 of the current directory.</para>
7883 <refentry version="5.0" id="chunk.toc">
7885 <refentrytitle>chunk.toc</refentrytitle>
7886 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
7889 <refname>chunk.toc</refname>
7890 <refpurpose>An explicit TOC to be used for chunking</refpurpose>
7894 <programlisting id="chunk.toc.frag">
7895 <xsl:param name="chunk.toc"></xsl:param>
7899 <refsection><info><title>Description</title></info>
7901 <para>The <parameter>chunk.toc</parameter> identifies an explicit TOC that
7902 will be used for chunking. This parameter is only used by the
7903 <filename>chunktoc.xsl</filename> stylesheet (and customization layers built
7909 <refentry version="5.0" id="chunk.tocs.and.lots">
7911 <refentrytitle>chunk.tocs.and.lots</refentrytitle>
7912 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
7915 <refname>chunk.tocs.and.lots</refname>
7916 <refpurpose>Should ToC and LoTs be in separate chunks?</refpurpose>
7920 <programlisting id="chunk.tocs.and.lots.frag">
7921 <xsl:param name="chunk.tocs.and.lots" select="0"></xsl:param>
7925 <refsection><info><title>Description</title></info>
7927 <para>If non-zero, ToC and LoT (List of Examples, List of Figures, etc.)
7928 will be put in a separate chunk. At the moment, this chunk is not in the
7929 normal forward/backward navigation list. Instead, a new link is added to the
7930 navigation footer.</para>
7932 <para>This feature is still somewhat experimental. Feedback welcome.</para>
7937 <refentry version="5.0" id="chunk.separate.lots">
7939 <refentrytitle>chunk.separate.lots</refentrytitle>
7940 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
7943 <refname>chunk.separate.lots</refname>
7944 <refpurpose>Should each LoT be in its own separate chunk?</refpurpose>
7948 <programlisting id="chunk.separate.lots.frag">
7949 <xsl:param name="chunk.separate.lots" select="0"></xsl:param>
7953 <refsection><info><title>Description</title></info>
7955 <para>If non-zero, each of the ToC and LoTs
7956 (List of Examples, List of Figures, etc.)
7957 will be put in its own separate chunk.
7958 The title page includes generated links to each of the separate files.
7961 This feature depends on the
7962 <parameter>chunk.tocs.and.lots</parameter>
7963 parameter also being non-zero.
7969 <refentry version="5.0" id="chunk.tocs.and.lots.has.title">
7971 <refentrytitle>chunk.tocs.and.lots.has.title</refentrytitle>
7972 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
7975 <refname>chunk.tocs.and.lots.has.title</refname>
7976 <refpurpose>Should ToC and LoTs in a separate chunks have title?</refpurpose>
7980 <programlisting id="chunk.tocs.and.lots.has.title.frag">
7981 <xsl:param name="chunk.tocs.and.lots.has.title" select="1"></xsl:param>
7985 <refsection><info><title>Description</title></info>
7987 <para>If non-zero title of document is shown before ToC/LoT in
7988 separate chunk.</para>
7993 <refentry version="5.0" id="chunk.section.depth">
7995 <refentrytitle>chunk.section.depth</refentrytitle>
7996 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
7999 <refname>chunk.section.depth</refname>
8000 <refpurpose>Depth to which sections should be chunked</refpurpose>
8004 <programlisting id="chunk.section.depth.frag">
8005 <xsl:param name="chunk.section.depth" select="1"></xsl:param>
8009 <refsection><info><title>Description</title></info>
8011 <para>This parameter sets the depth of section chunking.</para>
8016 <refentry version="5.0" id="chunk.first.sections">
8018 <refentrytitle>chunk.first.sections</refentrytitle>
8019 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
8022 <refname>chunk.first.sections</refname>
8023 <refpurpose>Chunk the first top-level section?</refpurpose>
8027 <programlisting id="chunk.first.sections.frag">
8028 <xsl:param name="chunk.first.sections" select="0"></xsl:param>
8032 <refsection><info><title>Description</title></info>
8034 <para>If non-zero, a chunk will be created for the first top-level
8035 <tag>sect1</tag> or <tag>section</tag> elements in
8036 each component. Otherwise, that section will be part of the chunk for
8043 <refentry version="5.0" id="chunk.quietly">
8045 <refentrytitle>chunk.quietly</refentrytitle>
8046 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
8049 <refname>chunk.quietly</refname>
8050 <refpurpose>Omit the chunked filename messages.</refpurpose>
8054 <programlisting id="chunk.quietly.frag">
8055 <xsl:param name="chunk.quietly" select="0"></xsl:param>
8059 <refsection><info><title>Description</title></info>
8061 <para>If zero (the default), the XSL processor emits a message naming
8062 each separate chunk filename as it is being output.
8063 If nonzero, then the messages are suppressed.
8069 <refentry version="5.0" id="chunk.append">
8071 <refentrytitle>chunk.append</refentrytitle>
8072 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
8075 <refname>chunk.append</refname>
8076 <refpurpose>Specifies content to append to chunked HTML output</refpurpose>
8080 <programlisting id="chunk.append.frag"><xsl:param name="chunk.append"></xsl:param></programlisting>
8083 <refsection><info><title>Description</title></info>
8085 <para>Specifies content to append to the end of HTML files output by
8086 the <filename>html/chunk.xsl</filename> stylesheet, after the closing
8087 <code><html></code> tag. You probably don’t want to set any value
8088 for this parameter; but if you do, the only value it should ever be
8089 set to is a newline character: <code>&#x0a;</code> or
8090 <code>&#10;</code></para>
8095 <refentry version="5.0" id="navig.graphics">
8097 <refentrytitle>navig.graphics</refentrytitle>
8098 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
8101 <refname>navig.graphics</refname>
8102 <refpurpose>Use graphics in navigational headers and footers?</refpurpose>
8106 <programlisting id="navig.graphics.frag">
8107 <xsl:param name="navig.graphics" select="0"></xsl:param>
8111 <refsection><info><title>Description</title></info>
8113 <para>If non-zero, the navigational headers and footers in chunked
8114 HTML are presented in an alternate style that uses graphical icons for
8115 Next, Previous, Up, and Home. Default graphics are provided in the
8116 distribution. If zero, text is used instead of graphics.
8122 <refentry version="5.0" id="navig.graphics.extension">
8124 <refentrytitle>navig.graphics.extension</refentrytitle>
8125 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
8128 <refname>navig.graphics.extension</refname>
8129 <refpurpose>Extension for navigational graphics</refpurpose>
8133 <programlisting id="navig.graphics.extension.frag">
8134 <xsl:param name="navig.graphics.extension">.gif</xsl:param>
8138 <refsection><info><title>Description</title></info>
8140 <para>Sets the filename extension to use on navigational graphics used
8141 in the headers and footers of chunked HTML.</para>
8146 <refentry version="5.0" id="navig.graphics.path">
8148 <refentrytitle>navig.graphics.path</refentrytitle>
8149 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
8152 <refname>navig.graphics.path</refname>
8153 <refpurpose>Path to navigational graphics</refpurpose>
8157 <programlisting id="navig.graphics.path.frag">
8158 <xsl:param name="navig.graphics.path">images/</xsl:param>
8162 <refsection><info><title>Description</title></info>
8164 <para>Sets the path, probably relative to the directory where the HTML
8165 files are created, to the navigational graphics used in the
8166 headers and footers of chunked HTML.
8172 <refentry version="5.0" id="navig.showtitles">
8174 <refentrytitle>navig.showtitles</refentrytitle>
8175 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
8178 <refname>navig.showtitles</refname>
8179 <refpurpose>Display titles in HTML headers and footers?</refpurpose>
8183 <programlisting id="navig.showtitles.frag"><xsl:param name="navig.showtitles">1</xsl:param></programlisting>
8186 <refsection><info><title>Description</title></info>
8189 the headers and footers of chunked HTML
8190 display the titles of the next and previous chunks,
8191 along with the words 'Next' and 'Previous' (or the
8192 equivalent graphical icons if navig.graphics is true).
8193 If false (zero), then only the words 'Next' and 'Previous'
8194 (or the icons) are displayed.
8200 </reference><reference id="profiling" xml:base="../html/param.xml"><title>Profiling</title>
8201 <partintro id="partintro">
8202 <para>The following parameters can be used for attribute-based
8203 profiling of your document. For more information about profiling, see
8204 <link role="tcg" xlink:href="Profiling.html">Profiling (conditional text)</link>.</para>
8206 <refentry version="5.0" id="profile.arch">
8208 <refentrytitle>profile.arch</refentrytitle>
8209 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
8212 <refname>profile.arch</refname>
8213 <refpurpose>Target profile for <tag class="attribute">arch</tag>
8214 attribute</refpurpose>
8218 <programlisting id="profile.arch.frag">
8219 <xsl:param name="profile.arch"></xsl:param>
8224 <refsection><info><title>Description</title></info>
8226 <para>The value of this parameter specifies profiles which should be
8227 included in the output. You can specify multiple profiles by
8228 separating them by semicolon. You can change separator character by
8229 <parameter>profile.separator</parameter>
8232 <para>This parameter has effect only when you are using profiling
8233 stylesheets (<filename>profile-docbook.xsl</filename>,
8234 <filename>profile-chunk.xsl</filename>, …) instead of normal
8235 ones (<filename>docbook.xsl</filename>,
8236 <filename>chunk.xsl</filename>, …).</para>
8241 <refentry version="5.0" id="profile.audience">
8243 <refentrytitle>profile.audience</refentrytitle>
8244 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
8247 <refname>profile.audience</refname>
8248 <refpurpose>Target profile for <tag class="attribute">audience</tag>
8249 attribute</refpurpose>
8253 <programlisting id="profile.audience.frag">
8254 <xsl:param name="profile.audience"></xsl:param>
8258 <refsection><info><title>Description</title></info>
8260 <para>Value of this parameter specifies profiles which should be
8261 included in the output. You can specify multiple profiles by
8262 separating them by semicolon. You can change separator character by
8263 <parameter>profile.separator</parameter>
8266 <para>This parameter has effect only when you are using profiling
8267 stylesheets (<filename>profile-docbook.xsl</filename>,
8268 <filename>profile-chunk.xsl</filename>, …) instead of normal
8269 ones (<filename>docbook.xsl</filename>,
8270 <filename>chunk.xsl</filename>, …).</para>
8275 <refentry version="5.0" id="profile.condition">
8277 <refentrytitle>profile.condition</refentrytitle>
8278 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
8281 <refname>profile.condition</refname>
8282 <refpurpose>Target profile for <tag class="attribute">condition</tag>
8283 attribute</refpurpose>
8287 <programlisting id="profile.condition.frag">
8288 <xsl:param name="profile.condition"></xsl:param>
8292 <refsection><info><title>Description</title></info>
8294 <para>The value of this parameter specifies profiles which should be
8295 included in the output. You can specify multiple profiles by
8296 separating them by semicolon. You can change separator character by
8297 <parameter>profile.separator</parameter>
8300 <para>This parameter has effect only when you are using profiling
8301 stylesheets (<filename>profile-docbook.xsl</filename>,
8302 <filename>profile-chunk.xsl</filename>, …) instead of normal
8303 ones (<filename>docbook.xsl</filename>,
8304 <filename>chunk.xsl</filename>, …).</para>
8309 <refentry version="5.0" id="profile.conformance">
8311 <refentrytitle>profile.conformance</refentrytitle>
8312 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
8315 <refname>profile.conformance</refname>
8316 <refpurpose>Target profile for <tag class="attribute">conformance</tag>
8317 attribute</refpurpose>
8321 <programlisting id="profile.conformance.frag">
8322 <xsl:param name="profile.conformance"></xsl:param>
8326 <refsection><info><title>Description</title></info>
8328 <para>The value of this parameter specifies profiles which should be
8329 included in the output. You can specify multiple profiles by
8330 separating them by semicolon. You can change separator character by
8331 <parameter>profile.separator</parameter>
8334 <para>This parameter has effect only when you are using profiling
8335 stylesheets (<filename>profile-docbook.xsl</filename>,
8336 <filename>profile-chunk.xsl</filename>, …) instead of normal
8337 ones (<filename>docbook.xsl</filename>,
8338 <filename>chunk.xsl</filename>, …).</para>
8343 <refentry version="5.0" id="profile.lang">
8345 <refentrytitle>profile.lang</refentrytitle>
8346 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
8349 <refname>profile.lang</refname>
8350 <refpurpose>Target profile for <tag class="attribute">lang</tag>
8351 attribute</refpurpose>
8355 <programlisting id="profile.lang.frag">
8356 <xsl:param name="profile.lang"></xsl:param>
8360 <refsection><info><title>Description</title></info>
8362 <para>The value of this parameter specifies profiles which should be
8363 included in the output. You can specify multiple profiles by
8364 separating them by semicolon. You can change separator character by
8365 <parameter>profile.separator</parameter>
8368 <para>This parameter has effect only when you are using profiling
8369 stylesheets (<filename>profile-docbook.xsl</filename>,
8370 <filename>profile-chunk.xsl</filename>, …) instead of normal
8371 ones (<filename>docbook.xsl</filename>,
8372 <filename>chunk.xsl</filename>, …).</para>
8377 <refentry version="5.0" id="profile.os">
8379 <refentrytitle>profile.os</refentrytitle>
8380 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
8383 <refname>profile.os</refname>
8384 <refpurpose>Target profile for <tag class="attribute">os</tag>
8385 attribute</refpurpose>
8389 <programlisting id="profile.os.frag">
8390 <xsl:param name="profile.os"></xsl:param>
8394 <refsection><info><title>Description</title></info>
8396 <para>The value of this parameter specifies profiles which should be
8397 included in the output. You can specify multiple profiles by
8398 separating them by semicolon. You can change separator character by
8399 <parameter>profile.separator</parameter>
8402 <para>This parameter has effect only when you are using profiling
8403 stylesheets (<filename>profile-docbook.xsl</filename>,
8404 <filename>profile-chunk.xsl</filename>, …) instead of normal
8405 ones (<filename>docbook.xsl</filename>,
8406 <filename>chunk.xsl</filename>, …).</para>
8411 <refentry version="5.0" id="profile.revision">
8413 <refentrytitle>profile.revision</refentrytitle>
8414 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
8417 <refname>profile.revision</refname>
8418 <refpurpose>Target profile for <tag class="attribute">revision</tag>
8419 attribute</refpurpose>
8423 <programlisting id="profile.revision.frag">
8424 <xsl:param name="profile.revision"></xsl:param>
8428 <refsection><info><title>Description</title></info>
8430 <para>The value of this parameter specifies profiles which should be
8431 included in the output. You can specify multiple profiles by
8432 separating them by semicolon. You can change separator character by
8433 <parameter>profile.separator</parameter>
8436 <para>This parameter has effect only when you are using profiling
8437 stylesheets (<filename>profile-docbook.xsl</filename>,
8438 <filename>profile-chunk.xsl</filename>, …) instead of normal
8439 ones (<filename>docbook.xsl</filename>,
8440 <filename>chunk.xsl</filename>, …).</para>
8445 <refentry version="5.0" id="profile.revisionflag">
8447 <refentrytitle>profile.revisionflag</refentrytitle>
8448 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
8451 <refname>profile.revisionflag</refname>
8452 <refpurpose>Target profile for <tag class="attribute">revisionflag</tag>
8453 attribute</refpurpose>
8457 <programlisting id="profile.revisionflag.frag">
8458 <xsl:param name="profile.revisionflag"></xsl:param>
8462 <refsection><info><title>Description</title></info>
8464 <para>The value of this parameter specifies profiles which should be
8465 included in the output. You can specify multiple profiles by
8466 separating them by semicolon. You can change separator character by
8467 <parameter>profile.separator</parameter>
8470 <para>This parameter has effect only when you are using profiling
8471 stylesheets (<filename>profile-docbook.xsl</filename>,
8472 <filename>profile-chunk.xsl</filename>, …) instead of normal
8473 ones (<filename>docbook.xsl</filename>,
8474 <filename>chunk.xsl</filename>, …).</para>
8479 <refentry version="5.0" id="profile.role">
8481 <refentrytitle>profile.role</refentrytitle>
8482 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
8485 <refname>profile.role</refname>
8486 <refpurpose>Target profile for <tag class="attribute">role</tag>
8487 attribute</refpurpose>
8491 <programlisting id="profile.role.frag">
8492 <xsl:param name="profile.role"></xsl:param>
8496 <refsection><info><title>Description</title></info>
8498 <para>The value of this parameter specifies profiles which should be
8499 included in the output. You can specify multiple profiles by
8500 separating them by semicolon. You can change separator character by
8501 <parameter>profile.separator</parameter>
8504 <para>This parameter has effect only when you are using profiling
8505 stylesheets (<filename>profile-docbook.xsl</filename>,
8506 <filename>profile-chunk.xsl</filename>, …) instead of normal
8507 ones (<filename>docbook.xsl</filename>,
8508 <filename>chunk.xsl</filename>, …).</para>
8511 <para>Note that <tag class="attribute">role</tag> is often
8512 used for other purposes than profiling. For example it is commonly
8513 used to get emphasize in bold font:</para>
8515 <programlisting><emphasis role="bold">very important</emphasis></programlisting>
8517 <para>If you are using <tag class="attribute">role</tag> for
8518 these purposes do not forget to add values like <literal>bold</literal> to
8519 value of this parameter. If you forgot you will get document with
8520 small pieces missing which are very hard to track.</para>
8522 <para>For this reason it is not recommended to use <tag class="attribute">role</tag> attribute for profiling. You should
8523 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>
8529 <refentry version="5.0" id="profile.security">
8531 <refentrytitle>profile.security</refentrytitle>
8532 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
8535 <refname>profile.security</refname>
8536 <refpurpose>Target profile for <tag class="attribute">security</tag>
8537 attribute</refpurpose>
8541 <programlisting id="profile.security.frag">
8542 <xsl:param name="profile.security"></xsl:param>
8546 <refsection><info><title>Description</title></info>
8548 <para>The value of this parameter specifies profiles which should be
8549 included in the output. You can specify multiple profiles by
8550 separating them by semicolon. You can change separator character by
8551 <parameter>profile.separator</parameter>
8554 <para>This parameter has effect only when you are using profiling
8555 stylesheets (<filename>profile-docbook.xsl</filename>,
8556 <filename>profile-chunk.xsl</filename>, …) instead of normal
8557 ones (<filename>docbook.xsl</filename>,
8558 <filename>chunk.xsl</filename>, …).</para>
8563 <refentry version="5.0" id="profile.status">
8565 <refentrytitle>profile.status</refentrytitle>
8566 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
8569 <refname>profile.status</refname>
8570 <refpurpose>Target profile for <tag class="attribute">status</tag>
8571 attribute</refpurpose>
8575 <programlisting id="profile.status.frag">
8576 <xsl:param name="profile.status"></xsl:param>
8580 <refsection><info><title>Description</title></info>
8582 <para>The value of this parameter specifies profiles which should be
8583 included in the output. You can specify multiple profiles by
8584 separating them by semicolon. You can change separator character by
8585 <parameter>profile.separator</parameter>
8588 <para>This parameter has effect only when you are using profiling
8589 stylesheets (<filename>profile-docbook.xsl</filename>,
8590 <filename>profile-chunk.xsl</filename>, …) instead of normal
8591 ones (<filename>docbook.xsl</filename>,
8592 <filename>chunk.xsl</filename>, …).</para>
8597 <refentry version="5.0" id="profile.userlevel">
8599 <refentrytitle>profile.userlevel</refentrytitle>
8600 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
8603 <refname>profile.userlevel</refname>
8604 <refpurpose>Target profile for <tag class="attribute">userlevel</tag>
8605 attribute</refpurpose>
8609 <programlisting id="profile.userlevel.frag">
8610 <xsl:param name="profile.userlevel"></xsl:param>
8614 <refsection><info><title>Description</title></info>
8616 <para>The value of this parameter specifies profiles which should be
8617 included in the output. You can specify multiple profiles by
8618 separating them by semicolon. You can change separator character by
8619 <parameter>profile.separator</parameter>
8622 <para>This parameter has effect only when you are using profiling
8623 stylesheets (<filename>profile-docbook.xsl</filename>,
8624 <filename>profile-chunk.xsl</filename>, …) instead of normal
8625 ones (<filename>docbook.xsl</filename>,
8626 <filename>chunk.xsl</filename>, …).</para>
8631 <refentry version="5.0" id="profile.vendor">
8633 <refentrytitle>profile.vendor</refentrytitle>
8634 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
8637 <refname>profile.vendor</refname>
8638 <refpurpose>Target profile for <tag class="attribute">vendor</tag>
8639 attribute</refpurpose>
8643 <programlisting id="profile.vendor.frag">
8644 <xsl:param name="profile.vendor"></xsl:param>
8648 <refsection><info><title>Description</title></info>
8650 <para>The value of this parameter specifies profiles which should be
8651 included in the output. You can specify multiple profiles by
8652 separating them by semicolon. You can change separator character by
8653 <parameter>profile.separator</parameter>
8656 <para>This parameter has effect only when you are using profiling
8657 stylesheets (<filename>profile-docbook.xsl</filename>,
8658 <filename>profile-chunk.xsl</filename>, …) instead of normal
8659 ones (<filename>docbook.xsl</filename>,
8660 <filename>chunk.xsl</filename>, …).</para>
8665 <refentry version="5.0" id="profile.wordsize">
8667 <refentrytitle>profile.wordsize</refentrytitle>
8668 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
8671 <refname>profile.wordsize</refname>
8672 <refpurpose>Target profile for <tag class="attribute">wordsize</tag>
8673 attribute</refpurpose>
8677 <programlisting id="profile.wordsize.frag">
8678 <xsl:param name="profile.wordsize"></xsl:param>
8682 <refsection><info><title>Description</title></info>
8684 <para>The value of this parameter specifies profiles which should be
8685 included in the output. You can specify multiple profiles by
8686 separating them by semicolon. You can change separator character by
8687 <parameter>profile.separator</parameter>
8690 <para>This parameter has effect only when you are using profiling
8691 stylesheets (<filename>profile-docbook.xsl</filename>,
8692 <filename>profile-chunk.xsl</filename>, …) instead of normal
8693 ones (<filename>docbook.xsl</filename>,
8694 <filename>chunk.xsl</filename>, …).</para>
8699 <refentry version="5.0" id="profile.attribute">
8701 <refentrytitle>profile.attribute</refentrytitle>
8702 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
8705 <refname>profile.attribute</refname>
8706 <refpurpose>Name of user-specified profiling attribute</refpurpose>
8710 <programlisting id="profile.attribute.frag">
8711 <xsl:param name="profile.attribute"></xsl:param>
8715 <refsection><info><title>Description</title></info>
8717 <para>This parameter is used in conjuction with
8718 <parameter>profile.value</parameter>.</para>
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.value">
8731 <refentrytitle>profile.value</refentrytitle>
8732 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
8735 <refname>profile.value</refname>
8736 <refpurpose>Target profile for user-specified attribute</refpurpose>
8740 <programlisting id="profile.value.frag">
8741 <xsl:param name="profile.value"></xsl:param>
8745 <refsection><info><title>Description</title></info>
8747 <para>When you are using this parameter you must also specify name of
8748 profiling attribute with parameter
8749 <parameter>profile.attribute</parameter>.</para>
8751 <para>The value of this parameter specifies profiles which should be
8752 included in the output. You can specify multiple profiles by
8753 separating them by semicolon. You can change separator character by
8754 <parameter>profile.separator</parameter>
8757 <para>This parameter has effect only when you are using profiling
8758 stylesheets (<filename>profile-docbook.xsl</filename>,
8759 <filename>profile-chunk.xsl</filename>, …) instead of normal
8760 ones (<filename>docbook.xsl</filename>,
8761 <filename>chunk.xsl</filename>, …).</para>
8766 <refentry version="5.0" id="profile.separator">
8768 <refentrytitle>profile.separator</refentrytitle>
8769 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
8772 <refname>profile.separator</refname>
8773 <refpurpose>Separator character for compound profile values</refpurpose>
8777 <programlisting id="profile.separator.frag">
8778 <xsl:param name="profile.separator">;</xsl:param>
8782 <refsection><info><title>Description</title></info>
8784 <para>Separator character used for compound profile values. See <parameter>profile.arch</parameter></para>
8789 </reference><reference id="htmlhelp" xml:base="../html/param.xml"><title>HTML Help</title>
8790 <refentry version="5.0" id="htmlhelp.encoding">
8792 <refentrytitle>htmlhelp.encoding</refentrytitle>
8793 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
8796 <refname>htmlhelp.encoding</refname>
8797 <refpurpose>Character encoding to use in files for HTML Help compiler.</refpurpose>
8801 <programlisting id="htmlhelp.encoding.frag">
8802 <xsl:param name="htmlhelp.encoding">iso-8859-1</xsl:param>
8806 <refsection><info><title>Description</title></info>
8808 <para>HTML Help Compiler is not UTF-8 aware, so you should always use an
8809 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>
8814 <refentry version="5.0" id="htmlhelp.autolabel">
8816 <refentrytitle>htmlhelp.autolabel</refentrytitle>
8817 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
8820 <refname>htmlhelp.autolabel</refname>
8821 <refpurpose>Should tree-like ToC use autonumbering feature?</refpurpose>
8825 <programlisting id="htmlhelp.autolabel.frag">
8826 <xsl:param name="htmlhelp.autolabel" select="0"></xsl:param>
8830 <refsection><info><title>Description</title></info>
8832 <para>Set this to non-zero to include chapter and section numbers into ToC
8833 in the left panel.</para>
8838 <refentry version="5.0" id="htmlhelp.chm">
8840 <refentrytitle>htmlhelp.chm</refentrytitle>
8841 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
8844 <refname>htmlhelp.chm</refname>
8845 <refpurpose>Filename of output HTML Help file.</refpurpose>
8849 <programlisting id="htmlhelp.chm.frag">
8850 <xsl:param name="htmlhelp.chm">htmlhelp.chm</xsl:param>
8854 <refsection><info><title>Description</title></info>
8856 <para>Set the name of resulting CHM file</para>
8861 <refentry version="5.0" id="htmlhelp.default.topic">
8863 <refentrytitle>htmlhelp.default.topic</refentrytitle>
8864 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
8867 <refname>htmlhelp.default.topic</refname>
8868 <refpurpose>Name of file with default topic</refpurpose>
8872 <programlisting id="htmlhelp.default.topic.frag">
8873 <xsl:param name="htmlhelp.default.topic"></xsl:param>
8877 <refsection><info><title>Description</title></info>
8879 <para>Normally first chunk of document is displayed when you open HTML
8880 Help file. If you want to display another topic, simply set its
8881 filename by this parameter.</para>
8883 <para>This is useful especially if you don't generate ToC in front of
8884 your document and you also hide root element in ToC. E.g.:</para>
8886 <programlisting><xsl:param name="generate.book.toc" select="0"/>
8887 <xsl:param name="htmlhelp.hhc.show.root" select="0"/>
8888 <xsl:param name="htmlhelp.default.topic">pr01.html</xsl:param>
8894 <refentry version="5.0" id="htmlhelp.display.progress">
8896 <refentrytitle>htmlhelp.display.progress</refentrytitle>
8897 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
8900 <refname>htmlhelp.display.progress</refname>
8901 <refpurpose>Display compile progress?</refpurpose>
8905 <programlisting id="htmlhelp.display.progress.frag">
8906 <xsl:param name="htmlhelp.display.progress" select="1"></xsl:param>
8910 <refsection><info><title>Description</title></info>
8912 <para>Set to non-zero to to display compile progress
8918 <refentry version="5.0" id="htmlhelp.hhp">
8920 <refentrytitle>htmlhelp.hhp</refentrytitle>
8921 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
8924 <refname>htmlhelp.hhp</refname>
8925 <refpurpose>Filename of project file.</refpurpose>
8929 <programlisting id="htmlhelp.hhp.frag">
8930 <xsl:param name="htmlhelp.hhp">htmlhelp.hhp</xsl:param>
8934 <refsection><info><title>Description</title></info>
8936 <para>Change this parameter if you want different name of project
8937 file than htmlhelp.hhp.</para>
8942 <refentry version="5.0" id="htmlhelp.hhc">
8944 <refentrytitle>htmlhelp.hhc</refentrytitle>
8945 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
8948 <refname>htmlhelp.hhc</refname>
8949 <refpurpose>Filename of TOC file.</refpurpose>
8953 <programlisting id="htmlhelp.hhc.frag">
8954 <xsl:param name="htmlhelp.hhc">toc.hhc</xsl:param>
8958 <refsection><info><title>Description</title></info>
8960 <para>Set the name of the TOC file. The default is <filename>toc.hhc</filename>.</para>
8965 <refentry version="5.0" id="htmlhelp.hhk">
8967 <refentrytitle>htmlhelp.hhk</refentrytitle>
8968 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
8971 <refname>htmlhelp.hhk</refname>
8972 <refpurpose>Filename of index file.</refpurpose>
8976 <programlisting id="htmlhelp.hhk.frag">
8977 <xsl:param name="htmlhelp.hhk">index.hhk</xsl:param>
8981 <refsection><info><title>Description</title></info>
8983 <para>set the name of the index file. The default is <filename>index.hhk</filename>.</para>
8988 <refentry version="5.0" id="htmlhelp.hhp.tail">
8990 <refentrytitle>htmlhelp.hhp.tail</refentrytitle>
8991 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
8994 <refname>htmlhelp.hhp.tail</refname>
8995 <refpurpose>Additional content for project file.</refpurpose>
8999 <programlisting id="htmlhelp.hhp.tail.frag">
9000 <xsl:param name="htmlhelp.hhp.tail"></xsl:param>
9004 <refsection><info><title>Description</title></info>
9006 <para>If you want to include some additional parameters into project file,
9007 store appropriate part of project file into this parameter.</para>
9012 <refentry version="5.0" id="htmlhelp.hhp.window">
9014 <refentrytitle>htmlhelp.hhp.window</refentrytitle>
9015 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
9018 <refname>htmlhelp.hhp.window</refname>
9019 <refpurpose>Name of default window.</refpurpose>
9023 <programlisting id="htmlhelp.hhp.window.frag">
9024 <xsl:param name="htmlhelp.hhp.window">Main</xsl:param>
9028 <refsection><info><title>Description</title></info>
9030 <para>Name of default window. If empty no [WINDOWS] section will be
9031 added to project file.</para>
9036 <refentry version="5.0" id="htmlhelp.hhp.windows">
9038 <refentrytitle>htmlhelp.hhp.windows</refentrytitle>
9039 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
9042 <refname>htmlhelp.hhp.windows</refname>
9043 <refpurpose>Definition of additional windows</refpurpose>
9047 <programlisting id="htmlhelp.hhp.windows.frag">
9048 <xsl:param name="htmlhelp.hhp.windows"></xsl:param>
9052 <refsection><info><title>Description</title></info>
9054 <para>Content of this parameter is placed at the end of [WINDOWS]
9055 section of project file. You can use it for defining your own
9056 addtional windows.</para>
9061 <refentry version="5.0" id="htmlhelp.enhanced.decompilation">
9063 <refentrytitle>htmlhelp.enhanced.decompilation</refentrytitle>
9064 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
9067 <refname>htmlhelp.enhanced.decompilation</refname>
9068 <refpurpose>Allow enhanced decompilation of CHM?</refpurpose>
9072 <programlisting id="htmlhelp.enhanced.decompilation.frag">
9073 <xsl:param name="htmlhelp.enhanced.decompilation" select="0"></xsl:param>
9077 <refsection><info><title>Description</title></info>
9079 <para>When non-zero this parameter enables enhanced decompilation of CHM.</para>
9084 <refentry version="5.0" id="htmlhelp.enumerate.images">
9086 <refentrytitle>htmlhelp.enumerate.images</refentrytitle>
9087 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
9090 <refname>htmlhelp.enumerate.images</refname>
9091 <refpurpose>Should the paths to all used images be added to the project file?</refpurpose>
9095 <programlisting id="htmlhelp.enumerate.images.frag">
9096 <xsl:param name="htmlhelp.enumerate.images" select="0"></xsl:param>
9100 <refsection><info><title>Description</title></info>
9102 <para>Set to non-zero if you insert images into your documents as
9103 external binary entities or if you are using absolute image paths.</para>
9108 <refentry version="5.0" id="htmlhelp.force.map.and.alias">
9110 <refentrytitle>htmlhelp.force.map.and.alias</refentrytitle>
9111 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
9114 <refname>htmlhelp.force.map.and.alias</refname>
9115 <refpurpose>Should [MAP] and [ALIAS] sections be added to the project file unconditionally?</refpurpose>
9118 <programlisting id="htmlhelp.force.map.and.alias.frag">
9119 <xsl:param name="htmlhelp.force.map.and.alias" select="0"></xsl:param>
9122 <refsection><info><title>Description</title></info>
9123 <para>Set to non-zero if you have your own
9124 <literal>alias.h</literal> and <literal>context.h</literal>
9125 files and you want to include references to them in the project
9130 <refentry version="5.0" id="htmlhelp.map.file">
9132 <refentrytitle>htmlhelp.map.file</refentrytitle>
9133 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
9136 <refname>htmlhelp.map.file</refname>
9137 <refpurpose>Filename of map file.</refpurpose>
9140 <programlisting id="htmlhelp.map.file.frag">
9141 <xsl:param name="htmlhelp.map.file">context.h</xsl:param>
9144 <refsection><info><title>Description</title></info>
9145 <para>Set the name of map file. The default is
9146 <filename>context.h</filename>. (used for context-sensitive
9151 <refentry version="5.0" id="htmlhelp.alias.file">
9153 <refentrytitle>htmlhelp.alias.file</refentrytitle>
9154 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
9157 <refname>htmlhelp.alias.file</refname>
9158 <refpurpose>Filename of alias file.</refpurpose>
9162 <programlisting id="htmlhelp.alias.file.frag">
9163 <xsl:param name="htmlhelp.alias.file">alias.h</xsl:param>
9167 <refsection><info><title>Description</title></info>
9169 <para>Specifies the filename of the alias file (used for context-sensitive help).</para>
9174 <refentry version="5.0" id="htmlhelp.hhc.section.depth">
9176 <refentrytitle>htmlhelp.hhc.section.depth</refentrytitle>
9177 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
9180 <refname>htmlhelp.hhc.section.depth</refname>
9181 <refpurpose>Depth of TOC for sections in a left pane.</refpurpose>
9185 <programlisting id="htmlhelp.hhc.section.depth.frag">
9186 <xsl:param name="htmlhelp.hhc.section.depth">5</xsl:param>
9190 <refsection><info><title>Description</title></info>
9192 <para>Set the section depth in the left pane of HTML Help viewer. </para>
9197 <refentry version="5.0" id="htmlhelp.hhc.show.root">
9199 <refentrytitle>htmlhelp.hhc.show.root</refentrytitle>
9200 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
9203 <refname>htmlhelp.hhc.show.root</refname>
9204 <refpurpose>Should there be an entry for the root element in the ToC?</refpurpose>
9208 <programlisting id="htmlhelp.hhc.show.root.frag">
9209 <xsl:param name="htmlhelp.hhc.show.root" select="1"></xsl:param>
9213 <refsection><info><title>Description</title></info>
9215 <para>If set to zero, there will be no entry for the root element in the
9216 ToC. This is useful when you want to provide the user with an expanded
9217 ToC as a default.</para>
9222 <refentry version="5.0" id="htmlhelp.hhc.folders.instead.books">
9224 <refentrytitle>htmlhelp.hhc.folders.instead.books</refentrytitle>
9225 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
9228 <refname>htmlhelp.hhc.folders.instead.books</refname>
9229 <refpurpose>Use folder icons in ToC (instead of book icons)?</refpurpose>
9233 <programlisting id="htmlhelp.hhc.folders.instead.books.frag">
9234 <xsl:param name="htmlhelp.hhc.folders.instead.books" select="1"></xsl:param>
9238 <refsection><info><title>Description</title></info>
9240 <para>Set non-zero for folder-like icons or zero for book-like icons in the TOC
9241 ToC. If you want to use folder-like icons you must swith off binary
9242 ToC using (xref) <parameter>htmlhelp.hhc.binary</parameter>.
9251 <refentry version="5.0" id="htmlhelp.hhc.binary">
9253 <refentrytitle>htmlhelp.hhc.binary</refentrytitle>
9254 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
9257 <refname>htmlhelp.hhc.binary</refname>
9258 <refpurpose>Generate binary ToC?</refpurpose>
9262 <programlisting id="htmlhelp.hhc.binary.frag">
9263 <xsl:param name="htmlhelp.hhc.binary" select="1"></xsl:param>
9267 <refsection><info><title>Description</title></info>
9269 <para>Set to non-zero to generate a binary TOC. You must create a binary TOC
9270 if you want to add Prev/Next buttons to toolbar (which is default
9271 behaviour). Files with binary TOC can't be merged.</para>
9276 <refentry version="5.0" id="htmlhelp.hhc.width">
9278 <refentrytitle>htmlhelp.hhc.width</refentrytitle>
9279 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
9282 <refname>htmlhelp.hhc.width</refname>
9283 <refpurpose>Width of navigation pane</refpurpose>
9287 <programlisting id="htmlhelp.hhc.width.frag">
9288 <xsl:param name="htmlhelp.hhc.width"></xsl:param>
9292 <refsection><info><title>Description</title></info>
9294 <para>This parameter specifies the width of the navigation pane (containing TOC and
9295 other navigation tabs) in pixels.</para>
9300 <refentry version="5.0" id="htmlhelp.title">
9302 <refentrytitle>htmlhelp.title</refentrytitle>
9303 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
9306 <refname>htmlhelp.title</refname>
9307 <refpurpose>Title of HTML Help</refpurpose>
9311 <programlisting id="htmlhelp.title.frag">
9312 <xsl:param name="htmlhelp.title"></xsl:param>
9316 <refsection><info><title>Description</title></info>
9318 <para>Content of this parameter will be used as a title for generated
9319 HTML Help. If empty, title will be automatically taken from document.</para>
9324 <refentry version="5.0" id="htmlhelp.show.menu">
9326 <refentrytitle>htmlhelp.show.menu</refentrytitle>
9327 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
9330 <refname>htmlhelp.show.menu</refname>
9331 <refpurpose>Should the menu bar be shown?</refpurpose>
9335 <programlisting id="htmlhelp.show.menu.frag">
9336 <xsl:param name="htmlhelp.show.menu" select="0"></xsl:param>
9340 <refsection><info><title>Description</title></info>
9342 <para>Set to non-zero to have an application menu bar in your HTML Help window.
9348 <refentry version="5.0" id="htmlhelp.show.toolbar.text">
9350 <refentrytitle>htmlhelp.show.toolbar.text</refentrytitle>
9351 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
9354 <refname>htmlhelp.show.toolbar.text</refname>
9355 <refpurpose>Show text under toolbar buttons?</refpurpose>
9359 <programlisting id="htmlhelp.show.toolbar.text.frag">
9360 <xsl:param name="htmlhelp.show.toolbar.text" select="1"></xsl:param>
9364 <refsection><info><title>Description</title></info>
9366 <para>Set to non-zero to display texts under toolbar buttons, zero to switch
9367 off displays.</para>
9372 <refentry version="5.0" id="htmlhelp.show.advanced.search">
9374 <refentrytitle>htmlhelp.show.advanced.search</refentrytitle>
9375 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
9378 <refname>htmlhelp.show.advanced.search</refname>
9379 <refpurpose>Should advanced search features be available?</refpurpose>
9383 <programlisting id="htmlhelp.show.advanced.search.frag">
9384 <xsl:param name="htmlhelp.show.advanced.search" select="0"></xsl:param>
9388 <refsection><info><title>Description</title></info>
9390 <para>If you want advanced search features in your help, turn this
9391 parameter to 1.</para>
9396 <refentry version="5.0" id="htmlhelp.show.favorities">
9398 <refentrytitle>htmlhelp.show.favorities</refentrytitle>
9399 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
9402 <refname>htmlhelp.show.favorities</refname>
9403 <refpurpose>Should the Favorites tab be shown?</refpurpose>
9407 <programlisting id="htmlhelp.show.favorities.frag">
9408 <xsl:param name="htmlhelp.show.favorities" select="0"></xsl:param>
9412 <refsection><info><title>Description</title></info>
9414 <para>Set to non-zero to include a Favorites tab in the navigation pane
9415 of the help window.</para>
9420 <refentry version="5.0" id="htmlhelp.button.hideshow">
9422 <refentrytitle>htmlhelp.button.hideshow</refentrytitle>
9423 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
9426 <refname>htmlhelp.button.hideshow</refname>
9427 <refpurpose>Should the Hide/Show button be shown?</refpurpose>
9431 <programlisting id="htmlhelp.button.hideshow.frag">
9432 <xsl:param name="htmlhelp.button.hideshow" select="1"></xsl:param>
9436 <refsection><info><title>Description</title></info>
9438 <para>Set to non-zero to include the Hide/Show button shown on toolbar</para>
9443 <refentry version="5.0" id="htmlhelp.button.back">
9445 <refentrytitle>htmlhelp.button.back</refentrytitle>
9446 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
9449 <refname>htmlhelp.button.back</refname>
9450 <refpurpose>Should the Back button be shown?</refpurpose>
9454 <programlisting id="htmlhelp.button.back.frag">
9455 <xsl:param name="htmlhelp.button.back" select="1"></xsl:param>
9459 <refsection><info><title>Description</title></info>
9461 <para>Set to non-zero to include the Hide/Show button shown on toolbar</para>
9466 <refentry version="5.0" id="htmlhelp.button.forward">
9468 <refentrytitle>htmlhelp.button.forward</refentrytitle>
9469 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
9472 <refname>htmlhelp.button.forward</refname>
9473 <refpurpose>Should the Forward button be shown?</refpurpose>
9477 <programlisting id="htmlhelp.button.forward.frag">
9478 <xsl:param name="htmlhelp.button.forward" select="0"></xsl:param>
9482 <refsection><info><title>Description</title></info>
9484 <para>Set to non-zero to include the Forward button on the toolbar.</para>
9489 <refentry version="5.0" id="htmlhelp.button.stop">
9491 <refentrytitle>htmlhelp.button.stop</refentrytitle>
9492 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
9495 <refname>htmlhelp.button.stop</refname>
9496 <refpurpose>Should the Stop button be shown?</refpurpose>
9500 <programlisting id="htmlhelp.button.stop.frag">
9501 <xsl:param name="htmlhelp.button.stop" select="0"></xsl:param>
9505 <refsection><info><title>Description</title></info>
9507 <para>If you want Stop button shown on toolbar, turn this
9508 parameter to 1.</para>
9513 <refentry version="5.0" id="htmlhelp.button.refresh">
9515 <refentrytitle>htmlhelp.button.refresh</refentrytitle>
9516 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
9519 <refname>htmlhelp.button.refresh</refname>
9520 <refpurpose>Should the Refresh button be shown?</refpurpose>
9524 <programlisting id="htmlhelp.button.refresh.frag">
9525 <xsl:param name="htmlhelp.button.refresh" select="0"></xsl:param>
9529 <refsection><info><title>Description</title></info>
9531 <para>Set to non-zero to include the Stop button on the toolbar.</para>
9536 <refentry version="5.0" id="htmlhelp.button.home">
9538 <refentrytitle>htmlhelp.button.home</refentrytitle>
9539 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
9542 <refname>htmlhelp.button.home</refname>
9543 <refpurpose>Should the Home button be shown?</refpurpose>
9547 <programlisting id="htmlhelp.button.home.frag">
9548 <xsl:param name="htmlhelp.button.home" select="0"></xsl:param>
9552 <refsection><info><title>Description</title></info>
9554 <para>Set to non-zero to include the Home button on the toolbar.</para>
9559 <refentry version="5.0" id="htmlhelp.button.home.url">
9561 <refentrytitle>htmlhelp.button.home.url</refentrytitle>
9562 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
9565 <refname>htmlhelp.button.home.url</refname>
9566 <refpurpose>URL address of page accessible by Home button</refpurpose>
9570 <programlisting id="htmlhelp.button.home.url.frag">
9571 <xsl:param name="htmlhelp.button.home.url"></xsl:param>
9575 <refsection><info><title>Description</title></info>
9577 <para>URL address of page accessible by Home button.</para>
9582 <refentry version="5.0" id="htmlhelp.button.options">
9584 <refentrytitle>htmlhelp.button.options</refentrytitle>
9585 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
9588 <refname>htmlhelp.button.options</refname>
9589 <refpurpose>Should the Options button be shown?</refpurpose>
9593 <programlisting id="htmlhelp.button.options.frag">
9594 <xsl:param name="htmlhelp.button.options" select="1"></xsl:param>
9598 <refsection><info><title>Description</title></info>
9600 <para>If you want Options button shown on toolbar, turn this
9601 parameter to 1.</para>
9606 <refentry version="5.0" id="htmlhelp.button.print">
9608 <refentrytitle>htmlhelp.button.print</refentrytitle>
9609 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
9612 <refname>htmlhelp.button.print</refname>
9613 <refpurpose>Should the Print button be shown?</refpurpose>
9617 <programlisting id="htmlhelp.button.print.frag">
9618 <xsl:param name="htmlhelp.button.print" select="1"></xsl:param>
9622 <refsection><info><title>Description</title></info>
9624 <para>Set to non-zero to include the Print button on the toolbar.
9630 <refentry version="5.0" id="htmlhelp.button.locate">
9632 <refentrytitle>htmlhelp.button.locate</refentrytitle>
9633 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
9636 <refname>htmlhelp.button.locate</refname>
9637 <refpurpose>Should the Locate button be shown?</refpurpose>
9641 <programlisting id="htmlhelp.button.locate.frag">
9642 <xsl:param name="htmlhelp.button.locate" select="0"></xsl:param>
9646 <refsection><info><title>Description</title></info>
9648 <para>If you want Locate button shown on toolbar, turn this
9649 parameter to 1.</para>
9654 <refentry version="5.0" id="htmlhelp.button.jump1">
9656 <refentrytitle>htmlhelp.button.jump1</refentrytitle>
9657 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
9660 <refname>htmlhelp.button.jump1</refname>
9661 <refpurpose>Should the Jump1 button be shown?</refpurpose>
9664 <programlisting id="htmlhelp.button.jump1.frag">
9665 <xsl:param name="htmlhelp.button.jump1" select="0"></xsl:param>
9668 <refsection><info><title>Description</title></info>
9669 <para>Set to non-zero to include the <literal>Jump1</literal> button on the toolbar.</para>
9673 <refentry version="5.0" id="htmlhelp.button.jump1.url">
9675 <refentrytitle>htmlhelp.button.jump1.url</refentrytitle>
9676 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
9679 <refname>htmlhelp.button.jump1.url</refname>
9680 <refpurpose>URL address of page accessible by Jump1 button</refpurpose>
9684 <programlisting id="htmlhelp.button.jump1.url.frag">
9685 <xsl:param name="htmlhelp.button.jump1.url"></xsl:param>
9689 <refsection><info><title>Description</title></info>
9691 <para>URL address of page accessible by Jump1 button.</para>
9696 <refentry version="5.0" id="htmlhelp.button.jump1.title">
9698 <refentrytitle>htmlhelp.button.jump1.title</refentrytitle>
9699 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
9702 <refname>htmlhelp.button.jump1.title</refname>
9703 <refpurpose>Title of Jump1 button</refpurpose>
9707 <programlisting id="htmlhelp.button.jump1.title.frag">
9708 <xsl:param name="htmlhelp.button.jump1.title">User1</xsl:param>
9712 <refsection><info><title>Description</title></info>
9714 <para>Title of Jump1 button.</para>
9719 <refentry version="5.0" id="htmlhelp.button.jump2">
9721 <refentrytitle>htmlhelp.button.jump2</refentrytitle>
9722 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
9725 <refname>htmlhelp.button.jump2</refname>
9726 <refpurpose>Should the Jump2 button be shown?</refpurpose>
9730 <programlisting id="htmlhelp.button.jump2.frag">
9731 <xsl:param name="htmlhelp.button.jump2" select="0"></xsl:param>
9735 <refsection><info><title>Description</title></info>
9737 <para>Set to non-zero to include the Jump2 button on the toolbar.</para>
9742 <refentry version="5.0" id="htmlhelp.button.jump2.url">
9744 <refentrytitle>htmlhelp.button.jump2.url</refentrytitle>
9745 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
9748 <refname>htmlhelp.button.jump2.url</refname>
9749 <refpurpose>URL address of page accessible by Jump2 button</refpurpose>
9753 <programlisting id="htmlhelp.button.jump2.url.frag">
9754 <xsl:param name="htmlhelp.button.jump2.url"></xsl:param>
9758 <refsection><info><title>Description</title></info>
9760 <para>URL address of page accessible by Jump2 button.</para>
9765 <refentry version="5.0" id="htmlhelp.button.jump2.title">
9767 <refentrytitle>htmlhelp.button.jump2.title</refentrytitle>
9768 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
9771 <refname>htmlhelp.button.jump2.title</refname>
9772 <refpurpose>Title of Jump2 button</refpurpose>
9776 <programlisting id="htmlhelp.button.jump2.title.frag">
9777 <xsl:param name="htmlhelp.button.jump2.title">User2</xsl:param>
9781 <refsection><info><title>Description</title></info>
9783 <para>Title of Jump2 button.</para>
9788 <refentry version="5.0" id="htmlhelp.button.next">
9790 <refentrytitle>htmlhelp.button.next</refentrytitle>
9791 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
9794 <refname>htmlhelp.button.next</refname>
9795 <refpurpose>Should the Next button be shown?</refpurpose>
9799 <programlisting id="htmlhelp.button.next.frag">
9800 <xsl:param name="htmlhelp.button.next" select="1"></xsl:param>
9804 <refsection><info><title>Description</title></info>
9806 <para>Set to non-zero to include the Next button on the toolbar.</para>
9811 <refentry version="5.0" id="htmlhelp.button.prev">
9813 <refentrytitle>htmlhelp.button.prev</refentrytitle>
9814 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
9817 <refname>htmlhelp.button.prev</refname>
9818 <refpurpose>Should the Prev button be shown?</refpurpose>
9822 <programlisting id="htmlhelp.button.prev.frag">
9823 <xsl:param name="htmlhelp.button.prev" select="1"></xsl:param>
9827 <refsection><info><title>Description</title></info>
9829 <para>Set to non-zero to include the Prev button on the toolbar.
9835 <refentry version="5.0" id="htmlhelp.button.zoom">
9837 <refentrytitle>htmlhelp.button.zoom</refentrytitle>
9838 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
9841 <refname>htmlhelp.button.zoom</refname>
9842 <refpurpose>Should the Zoom button be shown?</refpurpose>
9846 <programlisting id="htmlhelp.button.zoom.frag">
9847 <xsl:param name="htmlhelp.button.zoom" select="0"></xsl:param>
9851 <refsection><info><title>Description</title></info>
9853 <para>Set to non-zero to include the Zoom button on the toolbar.
9859 <refentry version="5.0" id="htmlhelp.remember.window.position">
9861 <refentrytitle>htmlhelp.remember.window.position</refentrytitle>
9862 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
9865 <refname>htmlhelp.remember.window.position</refname>
9866 <refpurpose>Remember help window position?</refpurpose>
9870 <programlisting id="htmlhelp.remember.window.position.frag">
9871 <xsl:param name="htmlhelp.remember.window.position" select="0"></xsl:param>
9875 <refsection><info><title>Description</title></info>
9877 <para>Set to non-zero to remember help window position between starts.</para>
9882 <refentry version="5.0" id="htmlhelp.window.geometry">
9884 <refentrytitle>htmlhelp.window.geometry</refentrytitle>
9885 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
9888 <refname>htmlhelp.window.geometry</refname>
9889 <refpurpose>Set initial geometry of help window</refpurpose>
9893 <programlisting id="htmlhelp.window.geometry.frag">
9894 <xsl:param name="htmlhelp.window.geometry"></xsl:param>
9898 <refsection><info><title>Description</title></info>
9900 <para>This parameter specifies initial position of help
9903 <programlisting><xsl:param name="htmlhelp.window.geometry">[160,64,992,704]</xsl:param></programlisting>
9908 <refentry version="5.0" id="htmlhelp.use.hhk">
9910 <refentrytitle>htmlhelp.use.hhk</refentrytitle>
9911 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
9914 <refname>htmlhelp.use.hhk</refname>
9915 <refpurpose>Should the index be built using the HHK file?</refpurpose>
9919 <programlisting id="htmlhelp.use.hhk.frag">
9920 <xsl:param name="htmlhelp.use.hhk" select="0"></xsl:param>
9924 <refsection><info><title>Description</title></info>
9926 <para>If non-zero, the index is created using the HHK file (instead of using <tag role="html">object</tag>
9927 elements in the HTML files). For more information, see <link role="tcg" xlink:href="HtmlHelp.html#HHGenIndex">Generating an index</link>.</para>
9931 <refentry version="5.0" id="htmlhelp.only">
9933 <refentrytitle>htmlhelp.only</refentrytitle>
9934 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
9937 <refname>htmlhelp.only</refname>
9938 <refpurpose>Should only project files be generated?</refpurpose>
9942 <programlisting id="htmlhelp.only.frag">
9943 <xsl:param name="htmlhelp.only" select="0"></xsl:param>
9947 <refsection><info><title>Description</title></info>
9950 <para>Set to non-zero if you want to play with various HTML Help parameters
9951 and you don't need to regenerate all HTML files. This setting will not
9952 process whole document, only project files (hhp, hhc, hhk,...) will be
9959 </reference><reference id="eclipse_help" xml:base="../html/param.xml"><title>Eclipse Help Platform</title>
9960 <refentry version="5.0" id="eclipse.autolabel">
9962 <refentrytitle>eclipse.autolabel</refentrytitle>
9963 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
9966 <refname>eclipse.autolabel</refname>
9967 <refpurpose>Should tree-like ToC use autonumbering feature?</refpurpose>
9971 <programlisting id="eclipse.autolabel.frag">
9972 <xsl:param name="eclipse.autolabel" select="0"></xsl:param>
9976 <refsection><info><title>Description</title></info>
9978 <para>If you want to include chapter and section numbers into ToC in
9979 the left panel, set this parameter to 1.</para>
9984 <refentry version="5.0" id="eclipse.plugin.name">
9986 <refentrytitle>eclipse.plugin.name</refentrytitle>
9987 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
9990 <refname>eclipse.plugin.name</refname>
9991 <refpurpose>Eclipse Help plugin name</refpurpose>
9995 <programlisting id="eclipse.plugin.name.frag">
9996 <xsl:param name="eclipse.plugin.name">DocBook Online Help Sample</xsl:param>
10000 <refsection><info><title>Description</title></info>
10002 <para>Eclipse Help plugin name.</para>
10007 <refentry version="5.0" id="eclipse.plugin.id">
10009 <refentrytitle>eclipse.plugin.id</refentrytitle>
10010 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
10013 <refname>eclipse.plugin.id</refname>
10014 <refpurpose>Eclipse Help plugin id</refpurpose>
10018 <programlisting id="eclipse.plugin.id.frag">
10019 <xsl:param name="eclipse.plugin.id">com.example.help</xsl:param>
10023 <refsection><info><title>Description</title></info>
10025 <para>Eclipse Help plugin id. You should change this id to something
10026 unique for each help.</para>
10031 <refentry version="5.0" id="eclipse.plugin.provider">
10033 <refentrytitle>eclipse.plugin.provider</refentrytitle>
10034 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
10037 <refname>eclipse.plugin.provider</refname>
10038 <refpurpose>Eclipse Help plugin provider name</refpurpose>
10042 <programlisting id="eclipse.plugin.provider.frag">
10043 <xsl:param name="eclipse.plugin.provider">Example provider</xsl:param>
10047 <refsection><info><title>Description</title></info>
10049 <para>Eclipse Help plugin provider name.</para>
10054 </reference><reference id="javahelp" xml:base="../html/param.xml"><title>JavaHelp</title>
10055 <refentry version="5.0" id="javahelp.encoding">
10057 <refentrytitle>javahelp.encoding</refentrytitle>
10058 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
10061 <refname>javahelp.encoding</refname>
10062 <refpurpose>Character encoding to use in control files for JavaHelp.</refpurpose>
10066 <programlisting id="javahelp.encoding.frag">
10067 <xsl:param name="javahelp.encoding">iso-8859-1</xsl:param>
10071 <refsection><info><title>Description</title></info>
10073 <para>JavaHelp crashes on some characters when written as character
10074 references. In that case you can use this parameter to select an appropriate encoding.</para>
10082 </reference><reference id="l10n" xml:base="../html/param.xml"><title>Localization</title>
10083 <refentry version="5.0" id="l10n.gentext.language">
10085 <refentrytitle>l10n.gentext.language</refentrytitle>
10086 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
10089 <refname>l10n.gentext.language</refname>
10090 <refpurpose>Sets the gentext language</refpurpose>
10094 <programlisting id="l10n.gentext.language.frag">
10095 <xsl:param name="l10n.gentext.language"></xsl:param>
10099 <refsection><info><title>Description</title></info>
10101 <para>If this parameter is set to any value other than the empty string, its
10102 value will be used as the value for the language when generating text. Setting
10103 <parameter>l10n.gentext.language</parameter> overrides any settings within the
10104 document being formatted.</para>
10106 <para>It's much more likely that you might want to set the
10107 <parameter>l10n.gentext.default.language</parameter> parameter.</para>
10112 <refentry version="5.0" id="l10n.gentext.default.language">
10114 <refentrytitle>l10n.gentext.default.language</refentrytitle>
10115 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
10118 <refname>l10n.gentext.default.language</refname>
10119 <refpurpose>Sets the default language for generated text</refpurpose>
10123 <programlisting id="l10n.gentext.default.language.frag">
10124 <xsl:param name="l10n.gentext.default.language">en</xsl:param>
10128 <refsection><info><title>Description</title></info>
10130 <para>The value of the <parameter>l10n.gentext.default.language</parameter>
10131 parameter is used as the language for generated text if no setting is provided
10132 in the source document.</para>
10137 <refentry version="5.0" id="l10n.gentext.use.xref.language">
10139 <refentrytitle>l10n.gentext.use.xref.language</refentrytitle>
10140 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
10143 <refname>l10n.gentext.use.xref.language</refname>
10144 <refpurpose>Use the language of target when generating cross-reference text?</refpurpose>
10148 <programlisting id="l10n.gentext.use.xref.language.frag">
10149 <xsl:param name="l10n.gentext.use.xref.language" select="0"></xsl:param>
10153 <refsection><info><title>Description</title></info>
10155 <para>If non-zero, the language of the target will be used when
10156 generating cross reference text. Usually, the <quote>current</quote>
10157 language is used when generating text (that is, the language of the
10158 element that contains the cross-reference element). But setting this parameter
10159 allows the language of the element <emphasis>pointed to</emphasis> to control
10160 the generated text.</para>
10162 <para>Consider the following example:</para>
10165 <programlisting><para lang="en">See also <xref linkend="chap3"/>.</para>
10169 <para>Suppose that Chapter 3 happens to be written in German.
10170 If <parameter>l10n.gentext.use.xref.language</parameter> is non-zero, the
10171 resulting text will be something like this:</para>
10174 <para>See also Kapital 3.</para>
10177 <para>Where the more traditional rendering would be:</para>
10180 <para>See also Chapter 3.</para>
10186 <refentry version="5.0" id="l10n.lang.value.rfc.compliant">
10188 <refentrytitle>l10n.lang.value.rfc.compliant</refentrytitle>
10189 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
10192 <refname>l10n.lang.value.rfc.compliant</refname>
10193 <refpurpose>Make value of lang attribute RFC compliant?</refpurpose>
10197 <programlisting id="l10n.lang.value.rfc.compliant.frag">
10198 <xsl:param name="l10n.lang.value.rfc.compliant" select="1"></xsl:param>
10202 <refsection><info><title>Description</title></info>
10204 <para>If non-zero, ensure that the values for all <tag class="attribute">lang</tag> attributes in HTML output are RFC
10205 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:
10207 <blockquote><para>[RFC1766] defines and explains the language codes
10208 that must be used in HTML documents.</para>
10209 <para>Briefly, language codes consist of a primary code and a possibly
10210 empty series of subcodes:
10212 <literallayout class="monospaced">language-code = primary-code ( "-" subcode )*</literallayout>
10214 <para>And in RFC 1766, <link xlink:href="http://www.ietf.org/rfc/rfc1766.txt">Tags for the Identification
10215 of Languages</link>, the EBNF for "language tag" is given as:
10217 <literallayout class="monospaced">Language-Tag = Primary-tag *( "-" Subtag )
10218 Primary-tag = 1*8ALPHA
10219 Subtag = 1*8ALPHA</literallayout>
10222 </para></footnote>.
10224 by taking any underscore characters in any <tag class="attribute">lang</tag> values found in source documents, and
10225 replacing them with hyphen characters in output HTML files. For
10226 example, <literal>zh_CN</literal> in a source document becomes
10227 <literal>zh-CN</literal> in the HTML output form that source.
10230 <para>This parameter does not cause any case change in <tag class="attribute">lang</tag> values, because RFC 1766
10231 explicitly states that all "language tags" (as it calls them) "are
10232 to be treated as case insensitive".</para>
10239 <refentry version="5.0" id="writing.mode">
10241 <refentrytitle>writing.mode</refentrytitle>
10242 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
10245 <refname>writing.mode</refname>
10246 <refpurpose>Direction of text flow based on locale</refpurpose>
10250 <programlisting id="writing.mode.frag">
10251 <xsl:param name="writing.mode">
10252 <xsl:call-template name="gentext">
10253 <xsl:with-param name="key">writing-mode</xsl:with-param>
10254 <xsl:with-param name="lang">
10255 <xsl:call-template name="l10n.language">
10256 <xsl:with-param name="target" select="/*[1]"></xsl:with-param>
10257 </xsl:call-template>
10258 </xsl:with-param>
10259 </xsl:call-template>
10264 <refsection><info><title>Description</title></info>
10266 <para>Sets direction of text flow and text alignment based on locale.
10267 The value is normally taken from the gentext file for the
10268 lang attribute of the document's root element, using the
10269 key name 'writing-mode' to look it up in the gentext file.
10270 But the param can also be
10271 set on the command line to override that gentext value.
10273 <para>Accepted values are:
10278 <para>Left-to-right text flow in each line, lines stack top to bottom.</para>
10284 <para>Right-to-left text flow in each line, lines stack top to bottom.</para>
10290 <para>Top-to-bottom text flow in each vertical line, lines stack right to left.
10291 Supported by only a few XSL-FO processors. Not supported in HTML output.</para>
10297 <para>Shorthand for lr-tb.</para>
10303 <para>Shorthand for rl-tb.</para>
10309 <para>Shorthand for tb-rl.</para>
10321 <?dbhtml dir="fo"?>
10322 <?dbhtml filename="index.html"?>
10323 <title xml:base="../fo/param.xml">FO Parameter Reference</title>
10324 <partintro id="fointro">
10326 <para xml:base="../fo/param.xml">This is reference documentation for all user-configurable
10327 parameters in the DocBook XSL FO stylesheets (for generating
10328 XSL-FO output destined for final print/PDF output).</para>
10331 <reference id="admons" xml:base="../fo/param.xml"><title>Admonitions</title>
10332 <refentry version="5.0" id="admon.graphics">
10334 <refentrytitle>admon.graphics</refentrytitle>
10335 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
10338 <refname>admon.graphics</refname>
10339 <refpurpose>Use graphics in admonitions?</refpurpose>
10343 <programlisting id="admon.graphics.frag">
10344 <xsl:param name="admon.graphics" select="0"></xsl:param>
10348 <refsection><info><title>Description</title></info>
10350 <para>If true (non-zero), admonitions are presented in an alternate style that uses
10351 a graphic. Default graphics are provided in the distribution.
10357 <refentry version="5.0" id="admon.graphics.extension">
10359 <refentrytitle>admon.graphics.extension</refentrytitle>
10360 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
10363 <refname>admon.graphics.extension</refname>
10364 <refpurpose>Filename extension for admonition graphics</refpurpose>
10368 <programlisting id="admon.graphics.extension.frag">
10369 <xsl:param name="admon.graphics.extension">.png</xsl:param>
10373 <refsection><info><title>Description</title></info>
10375 <para>Sets the filename extension to use on admonition graphics.</para>
10380 <refentry version="5.0" id="admon.graphics.path">
10382 <refentrytitle>admon.graphics.path</refentrytitle>
10383 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
10386 <refname>admon.graphics.path</refname>
10387 <refpurpose>Path to admonition graphics</refpurpose>
10391 <programlisting id="admon.graphics.path.frag"><xsl:param name="admon.graphics.path">images/</xsl:param></programlisting>
10394 <refsection><info><title>Description</title></info>
10396 <para>Sets the path to the directory containing the admonition graphics
10397 (caution.png, important.png etc). This location is normally relative
10398 to the output html directory. See <parameter>base.dir</parameter></para>
10403 <refentry version="5.0" id="admon.textlabel">
10405 <refentrytitle>admon.textlabel</refentrytitle>
10406 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
10409 <refname>admon.textlabel</refname>
10410 <refpurpose>Use text label in admonitions?</refpurpose>
10414 <programlisting id="admon.textlabel.frag">
10415 <xsl:param name="admon.textlabel" select="1"></xsl:param>
10419 <refsection><info><title>Description</title></info>
10421 <para>If true (non-zero), admonitions are presented with a generated
10422 text label such as Note or Warning in the appropriate language.
10423 If zero, such labels are turned off, but any title child
10424 of the admonition element are still output.
10425 The default value is 1.
10431 <refentry version="5.0" id="admonition.title.properties">
10434 <refentrytitle>admonition.title.properties</refentrytitle>
10435 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
10438 <refname>admonition.title.properties</refname>
10439 <refpurpose>To set the style for admonitions titles.</refpurpose>
10443 <programlisting id="admonition.title.properties.frag">
10444 <xsl:attribute-set name="admonition.title.properties">
10445 <xsl:attribute name="font-size">14pt</xsl:attribute>
10446 <xsl:attribute name="font-weight">bold</xsl:attribute>
10447 <xsl:attribute name="hyphenate">false</xsl:attribute>
10448 <xsl:attribute name="keep-with-next.within-column">always</xsl:attribute>
10449 </xsl:attribute-set>
10452 <refsection><info><title>Description</title></info>
10453 <para>How do you want admonitions titles styled? </para>
10454 <para>Set the font-size, weight etc to the style required.</para>
10459 <refentry version="5.0" id="admonition.properties">
10461 <refentrytitle>admonition.properties</refentrytitle>
10462 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
10465 <refname>admonition.properties</refname>
10466 <refpurpose>To set the style for admonitions.</refpurpose>
10470 <programlisting id="admonition.properties.frag"><xsl:attribute-set name="admonition.properties"></xsl:attribute-set>
10473 <refsection><info><title>Description</title></info>
10474 <para>How do you want admonitions styled? </para>
10475 <para>Set the font-size, weight, etc. to the style required</para>
10480 <refentry version="5.0" id="graphical.admonition.properties">
10482 <refentrytitle>graphical.admonition.properties</refentrytitle>
10483 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
10486 <refname>graphical.admonition.properties</refname>
10487 <refpurpose>To add properties to the outer block of a graphical admonition.</refpurpose>
10491 <programlisting id="graphical.admonition.properties.frag"><xsl:attribute-set name="graphical.admonition.properties">
10492 <xsl:attribute name="space-before.optimum">1em</xsl:attribute>
10493 <xsl:attribute name="space-before.minimum">0.8em</xsl:attribute>
10494 <xsl:attribute name="space-before.maximum">1.2em</xsl:attribute>
10495 <xsl:attribute name="space-after.optimum">1em</xsl:attribute>
10496 <xsl:attribute name="space-after.minimum">0.8em</xsl:attribute>
10497 <xsl:attribute name="space-after.maximum">1.2em</xsl:attribute>
10498 </xsl:attribute-set>
10501 <refsection><info><title>Description</title></info>
10502 <para>These properties are added to the outer block containing the
10503 entire graphical admonition, including its title.
10504 It is used when the parameter
10505 <parameter>admon.graphics</parameter> is set to nonzero.
10506 Use this attribute-set to set the space above and below,
10507 and any indent for the whole admonition.</para>
10509 <para>In addition to these properties, a graphical admonition
10510 also applies the <parameter>admonition.title.properties</parameter>
10511 attribute-set to the title, and applies the
10512 <parameter>admonition.properties</parameter> attribute-set
10513 to the rest of the content.</para>
10518 <refentry version="5.0" id="nongraphical.admonition.properties">
10520 <refentrytitle>nongraphical.admonition.properties</refentrytitle>
10521 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
10524 <refname>nongraphical.admonition.properties</refname>
10525 <refpurpose>To add properties to the outer block of a nongraphical admonition.</refpurpose>
10529 <programlisting id="nongraphical.admonition.properties.frag"><xsl:attribute-set name="nongraphical.admonition.properties">
10530 <xsl:attribute name="space-before.minimum">0.8em</xsl:attribute>
10531 <xsl:attribute name="space-before.optimum">1em</xsl:attribute>
10532 <xsl:attribute name="space-before.maximum">1.2em</xsl:attribute>
10533 <xsl:attribute name="margin-{$direction.align.start}">0.25in</xsl:attribute>
10534 <xsl:attribute name="margin-{$direction.align.end}">0.25in</xsl:attribute>
10535 </xsl:attribute-set>
10538 <refsection><info><title>Description</title></info>
10539 <para>These properties are added to the outer block containing the
10540 entire nongraphical admonition, including its title.
10541 It is used when the parameter
10542 <parameter>admon.graphics</parameter> is set to zero.
10543 Use this attribute-set to set the space above and below,
10544 and any indent for the whole admonition.</para>
10546 <para>In addition to these properties, a nongraphical admonition
10547 also applies the <parameter>admonition.title.properties</parameter>
10548 attribute-set to the title, and the
10549 <parameter>admonition.properties</parameter> attribute-set
10550 to the rest of the content.</para>
10555 </reference><reference id="callouts" xml:base="../fo/param.xml"><title>Callouts</title>
10556 <refentry version="5.0" id="callout.defaultcolumn">
10558 <refentrytitle>callout.defaultcolumn</refentrytitle>
10559 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
10562 <refname>callout.defaultcolumn</refname>
10563 <refpurpose>Indicates what column callouts appear in by default</refpurpose>
10567 <programlisting id="callout.defaultcolumn.frag">
10568 <xsl:param name="callout.defaultcolumn">60</xsl:param>
10572 <refsection><info><title>Description</title></info>
10574 <para>If a callout does not identify a column (for example, if it uses
10575 the <literal>linerange</literal> <tag class="attribute">unit</tag>),
10576 it will appear in the default column.
10582 <refentry version="5.0" id="callout.graphics">
10584 <refentrytitle>callout.graphics</refentrytitle>
10585 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
10588 <refname>callout.graphics</refname>
10589 <refpurpose>Use graphics for callouts?</refpurpose>
10593 <programlisting id="callout.graphics.frag">
10594 <xsl:param name="callout.graphics" select="1"></xsl:param>
10598 <refsection><info><title>Description</title></info>
10600 <para>If non-zero, callouts are presented with graphics (e.g., reverse-video
10601 circled numbers instead of "(1)", "(2)", etc.).
10602 Default graphics are provided in the distribution.
10608 <refentry version="5.0" id="callout.graphics.extension">
10610 <refentrytitle>callout.graphics.extension</refentrytitle>
10611 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
10614 <refname>callout.graphics.extension</refname>
10615 <refpurpose>Filename extension for callout graphics</refpurpose>
10619 <programlisting id="callout.graphics.extension.frag">
10621 <xsl:param name="callout.graphics.extension">.svg</xsl:param>
10625 <refsection><info><title>Description</title></info>
10626 <para>Sets the filename extension to use on callout graphics. </para>
10629 <para>The Docbook XSL distribution provides callout graphics in the following formats:</para>
10630 <listitem><para>SVG (extension: <filename class="extension">.svg</filename>)</para></listitem>
10631 <listitem><para>PNG (extension: <filename class="extension">.png</filename>)</para></listitem>
10632 <listitem><para>GIF (extension: <filename class="extension">.gif</filename>)</para></listitem>
10637 <refentry version="5.0" id="callout.graphics.number.limit">
10639 <refentrytitle>callout.graphics.number.limit</refentrytitle>
10640 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
10643 <refname>callout.graphics.number.limit</refname>
10644 <refpurpose>Number of the largest callout graphic</refpurpose>
10648 <programlisting id="callout.graphics.number.limit.frag">
10650 <xsl:param name="callout.graphics.number.limit">30</xsl:param>
10654 <refsection><info><title>Description</title></info>
10656 <para>If <parameter>callout.graphics</parameter> is non-zero, graphics
10657 are used to represent callout numbers instead of plain text. The value
10658 of <parameter>callout.graphics.number.limit</parameter> is the largest
10659 number for which a graphic exists. If the callout number exceeds this
10660 limit, the default presentation "(plain text instead of a graphic)"
10667 <refentry version="5.0" id="callout.graphics.path">
10669 <refentrytitle>callout.graphics.path</refentrytitle>
10670 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
10673 <refname>callout.graphics.path</refname>
10674 <refpurpose>Path to callout graphics</refpurpose>
10678 <programlisting id="callout.graphics.path.frag">
10679 <xsl:param name="callout.graphics.path">images/callouts/</xsl:param>
10683 <refsection><info><title>Description</title></info>
10685 <para>Sets the path to the directory holding the callout graphics. his
10686 location is normally relative to the output html directory. see
10687 base.dir. Always terminate the directory with / since the graphic file
10688 is appended to this string, hence needs the separator.
10694 <refentry version="5.0" id="callout.icon.size">
10696 <refentrytitle>callout.icon.size</refentrytitle>
10697 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
10700 <refname>callout.icon.size</refname>
10701 <refpurpose>Specifies the size of callout marker icons</refpurpose>
10705 <programlisting id="callout.icon.size.frag">
10706 <xsl:param name="callout.icon.size">7pt</xsl:param>
10710 <refsection><info><title>Description</title></info>
10712 <para>Specifies the size of the callout marker icons.
10713 The default size is 7 points.</para>
10718 <refentry version="5.0" id="callout.unicode">
10720 <refentrytitle>callout.unicode</refentrytitle>
10721 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
10724 <refname>callout.unicode</refname>
10725 <refpurpose>Use Unicode characters rather than images for callouts.</refpurpose>
10729 <programlisting id="callout.unicode.frag"><xsl:param name="callout.unicode" select="0"></xsl:param></programlisting>
10732 <refsection><info><title>Description</title></info>
10734 <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.
10740 <refentry version="5.0" id="callout.unicode.font">
10742 <refentrytitle>callout.unicode.font</refentrytitle>
10743 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
10746 <refname>callout.unicode.font</refname>
10747 <refpurpose>Specify a font for Unicode glyphs</refpurpose>
10751 <programlisting id="callout.unicode.font.frag">
10752 <xsl:param name="callout.unicode.font">ZapfDingbats</xsl:param>
10756 <refsection><info><title>Description</title></info>
10758 <para>The name of the font to specify around Unicode callout glyphs.
10759 If set to the empty string, no font change will occur.
10765 <refentry version="5.0" id="callout.unicode.number.limit">
10767 <refentrytitle>callout.unicode.number.limit</refentrytitle>
10768 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
10771 <refname>callout.unicode.number.limit</refname>
10772 <refpurpose>Number of the largest unicode callout character</refpurpose>
10776 <programlisting id="callout.unicode.number.limit.frag">
10777 <xsl:param name="callout.unicode.number.limit">10</xsl:param>
10781 <refsection><info><title>Description</title></info>
10783 <para>If <parameter>callout.unicode</parameter>
10784 is non-zero, unicode characters are used to represent
10785 callout numbers. The value of
10786 <parameter>callout.unicode.number.limit</parameter>
10788 the largest number for which a unicode character exists. If the callout number
10789 exceeds this limit, the default presentation "(nnn)" will always
10796 <refentry version="5.0" id="callout.unicode.start.character">
10798 <refentrytitle>callout.unicode.start.character</refentrytitle>
10799 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
10802 <refname>callout.unicode.start.character</refname>
10803 <refpurpose>First Unicode character to use, decimal value.</refpurpose>
10807 <programlisting id="callout.unicode.start.character.frag">
10808 <xsl:param name="callout.unicode.start.character">10102</xsl:param>
10812 <refsection><info><title>Description</title></info>
10814 <para>If <parameter>callout.graphics</parameter> is zero and <parameter>callout.unicode</parameter>
10815 is non-zero, unicode characters are used to represent
10816 callout numbers. The value of
10817 <parameter>callout.unicode.start.character</parameter>
10818 is the decimal unicode value used for callout number one. Currently,
10819 only 10102 is supported in the stylesheets for this parameter.
10825 <refentry version="5.0" id="callouts.extension">
10827 <refentrytitle>callouts.extension</refentrytitle>
10828 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
10831 <refname>callouts.extension</refname>
10832 <refpurpose>Enable the callout extension</refpurpose>
10836 <programlisting id="callouts.extension.frag">
10837 <xsl:param name="callouts.extension" select="1"></xsl:param>
10841 <refsection><info><title>Description</title></info>
10843 <para>The callouts extension processes <tag>areaset</tag>
10844 elements in <tag>ProgramListingCO</tag> and other text-based
10851 </reference><reference id="toc_index" xml:base="../fo/param.xml"><title>ToC/LoT/Index Generation</title>
10852 <refentry version="5.0" id="autotoc.label.separator">
10854 <refentrytitle>autotoc.label.separator</refentrytitle>
10855 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
10858 <refname>autotoc.label.separator</refname>
10859 <refpurpose>Separator between labels and titles in the ToC</refpurpose>
10863 <programlisting id="autotoc.label.separator.frag">
10864 <xsl:param name="autotoc.label.separator">. </xsl:param>
10868 <refsection><info><title>Description</title></info>
10870 <para>String used to separate labels and titles in a table of contents.</para>
10875 <refentry version="5.0" id="process.empty.source.toc">
10877 <refentrytitle>process.empty.source.toc</refentrytitle>
10878 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
10881 <refname>process.empty.source.toc</refname>
10882 <refpurpose>Generate automated TOC if <tag>toc</tag> element occurs in a source document?</refpurpose>
10886 <programlisting id="process.empty.source.toc.frag"><xsl:param name="process.empty.source.toc" select="0"></xsl:param></programlisting>
10889 <refsection><info><title>Description</title></info>
10891 <para>Specifies that if an empty <tag>toc</tag> element is found in a
10892 source document, an automated TOC is generated at this point in the
10895 <para>Depending on what the value of the
10896 <parameter>generate.toc</parameter> parameter is, setting this
10897 parameter to <literal>1</literal> could result in generation of
10898 duplicate automated TOCs. So the
10899 <parameter>process.empty.source.toc</parameter> is primarily useful
10900 as an "override": by placing an empty <tag>toc</tag> in your
10901 document and setting this parameter to <literal>1</literal>, you can
10902 force a TOC to be generated even if <tag>generate.toc</tag>
10903 says not to.</para>
10910 <refentry version="5.0" id="process.source.toc">
10912 <refentrytitle>process.source.toc</refentrytitle>
10913 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
10916 <refname>process.source.toc</refname>
10917 <refpurpose>Process a non-empty <tag>toc</tag> element if it occurs in a source document?</refpurpose>
10921 <programlisting id="process.source.toc.frag"><xsl:param name="process.source.toc" select="0"></xsl:param></programlisting>
10924 <refsection><info><title>Description</title></info>
10926 <para>Specifies that the contents of a non-empty "hard-coded"
10927 <tag>toc</tag> element in a source document are processed to
10928 generate a TOC in output.
10930 <para>This parameter has no effect on automated generation of
10931 TOCs. An automated TOC may still be generated along with the
10932 "hard-coded" TOC. To suppress automated TOC generation, adjust the
10933 value of the <parameter>generate.toc</parameter> paramameter.</para>
10935 <para>The <tag>process.source.toc</tag> parameter also has
10936 no effect if the <tag>toc</tag> element is empty; handling
10937 for empty <tag>toc</tag> is controlled by the
10938 <parameter>process.empty.source.toc</parameter> parameter.</para>
10945 <refentry version="5.0" id="generate.toc">
10947 <refentrytitle>generate.toc</refentrytitle>
10948 <refmiscinfo class="other" otherclass="datatype">table</refmiscinfo>
10951 <refname>generate.toc</refname>
10952 <refpurpose>Control generation of ToCs and LoTs</refpurpose>
10956 <programlisting id="generate.toc.frag">
10958 <xsl:param name="generate.toc">
10959 /appendix toc,title
10960 article/appendix nop
10962 book toc,title,figure,table,example,equation
10966 reference toc,title
10978 <refsection><info><title>Description</title></info>
10980 <para>This parameter has a structured value. It is a table of space-delimited
10981 path/value pairs. Each path identifies some element in the source document
10982 using a restricted subset of XPath (only the implicit child axis, no wildcards,
10983 no predicates). Paths can be either relative or absolute.</para>
10985 <para>When processing a particular element, the stylesheets consult this table to
10986 determine if a ToC (or LoT(s)) should be generated.</para>
10988 <para>For example, consider the entry:</para>
10990 <screen>book toc,figure</screen>
10992 <para>This indicates that whenever a <tag>book</tag> is formatted, a
10993 Table Of Contents and a List of Figures should be generated. Similarly,</para>
10995 <screen>/chapter toc</screen>
10997 <para>indicates that whenever a document <emphasis>that has a root
10998 of</emphasis> <tag>chapter</tag> is formatted, a Table of
10999 Contents should be generated. The entry <literal>chapter</literal> would match
11000 all chapters, but <literal>/chapter</literal> matches only <tag>chapter</tag>
11001 document elements.</para>
11003 <para>Generally, the longest match wins. So, for example, if you want to distinguish
11004 articles in books from articles in parts, you could use these two entries:</para>
11006 <screen>book/article toc,figure
11007 part/article toc</screen>
11009 <para>Note that an article in a part can never match a <literal>book/article</literal>,
11010 so if you want nothing to be generated for articles in parts, you can simply leave
11011 that rule out.</para>
11013 <para>If you want to leave the rule in, to make it explicit that you're turning
11014 something off, use the value <quote>nop</quote>. For example, the following
11015 entry disables ToCs and LoTs for articles:</para>
11017 <screen>article nop</screen>
11019 <para>Do not simply leave the word <quote>article</quote> in the file
11020 without a matching value. That'd be just begging the silly little
11021 path/value parser to get confused.</para>
11023 <para>Section ToCs are further controlled by the
11024 <parameter>generate.section.toc.level</parameter> parameter.
11025 For a given section level to have a ToC, it must have both an entry in
11026 <parameter>generate.toc</parameter> and be within the range enabled by
11027 <parameter>generate.section.toc.level</parameter>.</para>
11031 <refentry version="5.0" id="generate.index">
11033 <refentrytitle>generate.index</refentrytitle>
11034 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
11037 <refname>generate.index</refname>
11038 <refpurpose>Do you want an index?</refpurpose>
11042 <programlisting id="generate.index.frag"><xsl:param name="generate.index" select="1"></xsl:param></programlisting>
11045 <refsection><info><title>Description</title></info>
11047 <para>Specify if an index should be generated. </para>
11052 <refentry version="5.0" id="make.index.markup">
11054 <refentrytitle>make.index.markup</refentrytitle>
11055 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
11058 <refname>make.index.markup</refname>
11059 <refpurpose>Generate XML index markup in the index?</refpurpose>
11063 <programlisting id="make.index.markup.frag">
11064 <xsl:param name="make.index.markup" select="0"></xsl:param>
11068 <refsection><info><title>Description</title></info>
11070 <para>This parameter enables a very neat trick for getting properly
11071 merged, collated back-of-the-book indexes. G. Ken Holman suggested
11072 this trick at Extreme Markup Languages 2002 and I'm indebted to him
11075 <para>Jeni Tennison's excellent code in
11076 <filename>autoidx.xsl</filename> does a great job of merging and
11077 sorting <tag>indexterm</tag>s in the document and building a
11078 back-of-the-book index. However, there's one thing that it cannot
11079 reasonably be expected to do: merge page numbers into ranges. (I would
11080 not have thought that it could collate and suppress duplicate page
11081 numbers, but in fact it appears to manage that task somehow.)</para>
11083 <para>Ken's trick is to produce a document in which the index at the
11084 back of the book is <quote>displayed</quote> in XML. Because the index
11085 is generated by the FO processor, all of the page numbers have been resolved.
11086 It's a bit hard to explain, but what it boils down to is that instead of having
11087 an index at the back of the book that looks like this:</para>
11090 <formalpara><info><title>A</title></info>
11091 <para>ap1, 1, 2, 3</para>
11095 <para>you get one that looks like this:</para>
11098 <programlisting><indexdiv>A</indexdiv>
11100 <primaryie>ap1</primaryie>,
11101 <phrase role="pageno">1</phrase>,
11102 <phrase role="pageno">2</phrase>,
11103 <phrase role="pageno">3</phrase>
11104 </indexentry></programlisting>
11107 <para>After building a PDF file with this sort of odd-looking index, you can
11108 extract the text from the PDF file and the result is a proper index expressed in
11111 <para>Now you have data that's amenable to processing and a simple Perl script
11112 (such as <filename>fo/pdf2index</filename>) can
11113 merge page ranges and generate a proper index.</para>
11115 <para>Finally, reformat your original document using this literal index instead of
11116 an automatically generated one and <quote>bingo</quote>!</para>
11121 <refentry version="5.0" id="index.method">
11123 <refentrytitle>index.method</refentrytitle>
11124 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
11125 <refmiscinfo class="other" otherclass="value">basic</refmiscinfo>
11126 <refmiscinfo class="other" otherclass="value">kosek</refmiscinfo>
11127 <refmiscinfo class="other" otherclass="value">kimber</refmiscinfo>
11130 <refname>index.method</refname>
11131 <refpurpose>Select method used to group index entries in an index</refpurpose>
11135 <programlisting id="index.method.frag">
11136 <xsl:param name="index.method">basic</xsl:param>
11140 <refsection><info><title>Description</title></info>
11142 <para>This parameter lets you select which method to use for sorting and grouping
11143 index entries in an index.
11144 Indexes in Latin-based languages that have accented characters typically
11145 sort together accented words and unaccented words.
11146 Thus <quote>Á</quote> (U+00C1 LATIN CAPITAL LETTER A WITH ACUTE) would sort together
11147 with <quote>A</quote> (U+0041 LATIN CAPITAL LETTER A), so both would appear in the <quote>A</quote>
11148 section of the index.
11149 Languages using other alphabets (such as Russian, which is written in the Cyrillic alphabet)
11150 and languages using ideographic chararacters (such as Japanese)
11151 require grouping specific to the languages and alphabets.
11154 <para>The default indexing method is limited.
11155 It can group accented characters in Latin-based languages only.
11156 It cannot handle non-Latin alphabets or ideographic languages.
11157 The other indexing methods require extensions of one type or
11158 another, and do not work with
11159 all XSLT processors, which is why they are not used by default.</para>
11161 <para>The three choices for indexing method are:</para>
11164 <term><literal>basic</literal></term>
11167 (default) Sort and groups words based only on the Latin alphabet.
11168 Words with accented Latin letters will group and sort with
11169 their respective primary letter, but
11170 words in non-Latin alphabets will be
11171 put in the <quote>Symbols</quote> section of the index.
11176 <term><literal>kosek</literal></term>
11179 This method sorts and groups words based on letter groups configured in
11180 the DocBook locale file for the given language.
11181 See, for example, the French locale file <filename>common/fr.xml</filename>.
11182 This method requires that the XSLT processor
11183 supports the EXSLT extensions (most do).
11184 It also requires support for using
11185 user-defined functions in xsl:key (xsltproc does not).
11187 <para>This method is suitable for any language for which you can
11188 list all the individual characters that should appear
11189 in each letter group in an index.
11190 It is probably not practical to use it for ideographic languages
11191 such as Chinese that have hundreds or thousands of characters.
11194 <para>To use the kosek method, you must:</para>
11198 <para>Use a processor that supports its extensions, such as
11199 Saxon 6 or Xalan (xsltproc and Saxon 8 do not).
11203 <para>Set the index.method parameter's value to <quote>kosek</quote>.
11207 <para>Import the appropriate index extensions stylesheet module
11208 <filename>fo/autoidx-kosek.xsl</filename> or
11209 <filename>html/autoidx-kosek.xsl</filename> into your
11218 <term><literal>kimber</literal></term>
11221 This method uses extensions to the Saxon processor to implement
11222 sophisticated indexing processes. It uses its own
11223 configuration file, which can include information for any number of
11224 languages. Each language's configuration can group
11225 words using one of two processes. In the
11226 enumerated process similar to that used in the kosek method,
11227 you indicate the groupings character-by-character.
11228 In the between-key process, you specify the
11229 break-points in the sort order that should start a new group.
11230 The latter configuration is useful for ideographic languages
11231 such as Chinese, Japanese, and Korean.
11232 You can also define your own collation algorithms and how you
11233 want mixed Latin-alphabet words sorted.</para>
11236 <para>For a whitepaper describing the extensions, see:
11237 <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>.
11241 <para>To download the extension library, see
11242 <link xlink:href="http://www.innodata-isogen.com/knowledge_center/tools_downloads/i18nsupport">http://www.innodata-isogen.com/knowledge_center/tools_downloads/i18nsupport</link>.
11247 <para>To use the kimber method, you must:</para>
11251 <para>Use Saxon (version 6 or 8) as your XSLT processor.
11255 <para>Install and configure the Innodata Isogen library, using
11256 the documentation that comes with it.
11260 <para>Set the index.method parameter's value to <quote>kimber</quote>.
11264 <para>Import the appropriate index extensions stylesheet module
11265 <filename>fo/autoidx-kimber.xsl</filename> or
11266 <filename>html/autoidx-kimber.xsl</filename> into your
11279 <refentry version="5.0" id="index.on.type">
11281 <refentrytitle>index.on.type</refentrytitle>
11282 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
11285 <refname>index.on.type</refname>
11286 <refpurpose>Select indexterms based on <tag class="attribute">type</tag>
11287 attribute value</refpurpose>
11291 <programlisting id="index.on.type.frag">
11292 <xsl:param name="index.on.type" select="0"></xsl:param>
11296 <refsection><info><title>Description</title></info>
11300 then an <tag>index</tag> element that has a
11301 <tag class="attribute">type</tag> attribute
11302 value will contain only those <tag>indexterm</tag>
11303 elements with a matching <tag class="attribute">type</tag> attribute value.
11304 If an <tag>index</tag> has no <tag class="attribute">type</tag>
11305 attribute or it is blank, then the index will contain
11306 all <tag>indexterm</tag>s in the current scope.
11310 If <literal>index.on.type</literal> is zero, then the
11311 <tag class="attribute">type</tag> attribute has no effect
11312 on selecting indexterms for an index.
11315 <para>For those using DocBook version 4.2 or earlier,
11316 the <tag class="attribute">type</tag> attribute is not available
11317 for index terms. However, you can achieve the same
11318 effect by using the <tag class="attribute">role</tag> attribute
11319 in the same manner on <tag>indexterm</tag>
11320 and <tag>index</tag>, and setting the stylesheet parameter
11321 <parameter>index.on.role</parameter> to a nonzero value.
11327 <refentry version="5.0" id="index.on.role">
11329 <refentrytitle>index.on.role</refentrytitle>
11330 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
11333 <refname>index.on.role</refname>
11334 <refpurpose>Select indexterms based on <tag class="attribute">role</tag> value</refpurpose>
11338 <programlisting id="index.on.role.frag">
11339 <xsl:param name="index.on.role" select="0"></xsl:param>
11343 <refsection><info><title>Description</title></info>
11347 then an <tag>index</tag> element that has a
11348 <tag class="attribute">role</tag> attribute
11349 value will contain only those <tag>indexterm</tag>
11350 elements with a matching role value.
11351 If an <tag>index</tag> has no <tag class="attribute">role</tag>
11352 attribute or it is blank, then the index will contain
11353 all <tag>indexterm</tag>s in the current scope.
11356 If <literal>index.on.role</literal> is zero, then the
11357 <tag class="attribute">role</tag> attribute has no effect
11358 on selecting indexterms for an index.
11361 <para>If you are using DocBook version 4.3 or later, you should
11362 use the <tag class="attribute">type</tag> attribute instead of <tag class="attribute">role</tag>
11363 on <tag>indexterm</tag> and <tag>index</tag>,
11364 and set the <parameter>index.on.type</parameter> to a nonzero
11371 <refentry version="5.0" id="index.preferred.page.properties">
11373 <refentrytitle>index.preferred.page.properties</refentrytitle>
11374 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
11377 <refname>index.preferred.page.properties</refname>
11378 <refpurpose>Properties used to emphasize page number references for
11379 significant index terms</refpurpose>
11383 <programlisting id="index.preferred.page.properties.frag">
11384 <xsl:attribute-set name="index.preferred.page.properties">
11385 <xsl:attribute name="font-weight">bold</xsl:attribute>
11386 </xsl:attribute-set>
11390 <refsection><info><title>Description</title></info>
11392 <para>Properties used to emphasize page number references for
11393 significant index terms (<tag class="attribute">significance</tag>=<tag class="attvalue">preferred</tag>). Currently works only with
11399 <refentry version="5.0" id="index.entry.properties">
11401 <refentrytitle>index.entry.properties</refentrytitle>
11402 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
11405 <refname>index.entry.properties</refname>
11406 <refpurpose>Properties applied to the formatted entries
11407 in an index</refpurpose>
11411 <programlisting id="index.entry.properties.frag">
11412 <xsl:attribute-set name="index.entry.properties">
11413 <xsl:attribute name="start-indent">0pt</xsl:attribute>
11414 </xsl:attribute-set>
11418 <refsection><info><title>Description</title></info>
11420 <para>This attribute set is applied to the block containing
11421 the entries in a letter division in an index. It can be used to set the
11422 font-size, font-family, and other inheritable properties that will be
11423 applied to all index entries.</para>
11428 <refentry version="5.0" id="index.div.title.properties">
11430 <refentrytitle>index.div.title.properties</refentrytitle>
11431 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
11434 <refname>index.div.title.properties</refname>
11435 <refpurpose>Properties associated with the letter headings in an
11440 <programlisting id="index.div.title.properties.frag">
11441 <xsl:attribute-set name="index.div.title.properties">
11442 <xsl:attribute name="margin-{$direction.align.start}">0pt</xsl:attribute>
11443 <xsl:attribute name="font-size">14.4pt</xsl:attribute>
11444 <xsl:attribute name="font-family"><xsl:value-of select="$title.fontset"></xsl:value-of></xsl:attribute>
11445 <xsl:attribute name="font-weight">bold</xsl:attribute>
11446 <xsl:attribute name="keep-with-next.within-column">always</xsl:attribute>
11447 <xsl:attribute name="space-before.optimum"><xsl:value-of select="concat($body.font.master,'pt')"></xsl:value-of></xsl:attribute>
11448 <xsl:attribute name="space-before.minimum"><xsl:value-of select="concat($body.font.master,'pt * 0.8')"></xsl:value-of></xsl:attribute>
11449 <xsl:attribute name="space-before.maximum"><xsl:value-of select="concat($body.font.master,'pt * 1.2')"></xsl:value-of></xsl:attribute>
11450 <xsl:attribute name="start-indent">0pt</xsl:attribute>
11451 </xsl:attribute-set>
11455 <refsection><info><title>Description</title></info>
11457 <para>This attribute set is used on the letter headings that separate
11458 the divisions in an index.</para>
11463 <refentry version="5.0" id="index.number.separator">
11465 <refentrytitle>index.number.separator</refentrytitle>
11466 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
11469 <refname>index.number.separator</refname>
11470 <refpurpose>Override for punctuation separating page numbers in index</refpurpose>
11474 <programlisting id="index.number.separator.frag">
11475 <xsl:param name="index.number.separator"></xsl:param>
11479 <refsection><info><title>Description</title></info>
11481 <para>This parameter permits you to override the text to insert between
11482 page references in a formatted index entry. Typically
11483 that would be a comma and a space.
11486 <para>Because this text may be locale dependent,
11487 this parameter's value is normally taken from a gentext
11488 template named 'number-separator' in the
11489 context 'index' in the stylesheet
11490 locale file for the language
11491 of the current document.
11492 This parameter can be used to override the gentext string,
11493 and would typically be used on the command line.
11494 This parameter would apply to all languages.
11497 <para>So this text string can be customized in two ways.
11498 You can reset the default gentext string using
11499 the <parameter>local.l10n.xml</parameter> parameter, or you can
11500 override the gentext with the content of this parameter.
11501 The content can be a simple string, or it can be
11502 something more complex such as a call-template.
11505 <para>In HTML index output, section title references are used instead of
11506 page number references. This punctuation appears between
11507 such section titles in an HTML index.
11513 <refentry version="5.0" id="index.range.separator">
11515 <refentrytitle>index.range.separator</refentrytitle>
11516 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
11519 <refname>index.range.separator</refname>
11520 <refpurpose>Override for punctuation separating the two numbers
11521 in a page range in index</refpurpose>
11525 <programlisting id="index.range.separator.frag">
11526 <xsl:param name="index.range.separator"></xsl:param>
11530 <refsection><info><title>Description</title></info>
11532 <para>This parameter permits you
11533 to override the text to insert between
11534 the two numbers of a page range in an index.
11535 This parameter is only used by those XSL-FO processors
11536 that support an extension for generating such page ranges
11537 (such as XEP).</para>
11539 <para>Because this text may be locale dependent,
11540 this parameter's value is normally taken from a gentext
11541 template named 'range-separator' in the
11542 context 'index' in the stylesheet
11543 locale file for the language
11544 of the current document.
11545 This parameter can be used to override the gentext string,
11546 and would typically be used on the command line.
11547 This parameter would apply to all languages.
11550 <para>So this text string can be customized in two ways.
11551 You can reset the default gentext string using
11552 the <parameter>local.l10n.xml</parameter> parameter, or you can
11553 override the gentext with the content of this parameter.
11554 The content can be a simple string, or it can be
11555 something more complex such as a call-template.
11558 <para>In HTML index output, section title references are used instead of
11559 page number references. So there are no page ranges
11560 and this parameter has no effect.
11566 <refentry version="5.0" id="index.term.separator">
11568 <refentrytitle>index.term.separator</refentrytitle>
11569 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
11572 <refname>index.term.separator</refname>
11573 <refpurpose>Override for punctuation separating an index term
11574 from its list of page references in an index</refpurpose>
11578 <programlisting id="index.term.separator.frag">
11579 <xsl:param name="index.term.separator"></xsl:param>
11583 <refsection><info><title>Description</title></info>
11585 <para>This parameter permits you to override
11586 the text to insert between
11587 the end of an index term and its list of page references.
11588 Typically that might be a comma and a space.
11591 <para>Because this text may be locale dependent,
11592 this parameter's value is normally taken from a gentext
11593 template named 'term-separator' in the
11594 context 'index' in the stylesheet
11595 locale file for the language
11596 of the current document.
11597 This parameter can be used to override the gentext string,
11598 and would typically be used on the command line.
11599 This parameter would apply to all languages.
11602 <para>So this text string can be customized in two ways.
11603 You can reset the default gentext string using
11604 the <parameter>local.l10n.xml</parameter> parameter, or you can
11605 fill in the content for this normally empty
11606 override parameter.
11607 The content can be a simple string, or it can be
11608 something more complex such as a call-template.
11609 For fo output, it could be an <tag>fo:leader</tag>
11610 element to provide space of a specific length, or a dot leader.
11616 <refentry version="5.0" id="xep.index.item.properties">
11618 <refentrytitle>xep.index.item.properties</refentrytitle>
11619 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
11622 <refname>xep.index.item.properties</refname>
11623 <refpurpose>Properties associated with XEP index-items</refpurpose>
11627 <programlisting id="xep.index.item.properties.frag">
11628 <xsl:attribute-set name="xep.index.item.properties" use-attribute-sets="index.page.number.properties">
11629 <xsl:attribute name="merge-subsequent-page-numbers">true</xsl:attribute>
11630 <xsl:attribute name="link-back">true</xsl:attribute>
11631 </xsl:attribute-set>
11635 <refsection><info><title>Description</title></info>
11637 <para>Properties associated with XEP index-items, which generate
11638 page numbers in an index processed by XEP. For more info see
11639 the XEP documentation section "Indexes" in
11640 <uri xlink:href="http://www.renderx.com/reference.html#Indexes">http://www.renderx.com/reference.html#Indexes</uri>.</para>
11642 <para>This attribute-set also adds by default any properties from the
11643 <tag class="attribute">index.page.number.properties</tag>
11644 attribute-set.</para>
11648 <refentry version="5.0" id="toc.section.depth">
11650 <refentrytitle>toc.section.depth</refentrytitle>
11651 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
11654 <refname>toc.section.depth</refname>
11655 <refpurpose>How deep should recursive <tag>section</tag>s appear
11656 in the TOC?</refpurpose>
11660 <programlisting id="toc.section.depth.frag"><xsl:param name="toc.section.depth">2</xsl:param></programlisting>
11663 <refsection><info><title>Description</title></info>
11665 <para>Specifies the depth to which recursive sections should appear in the
11672 <refentry version="5.0" id="toc.max.depth">
11674 <refentrytitle>toc.max.depth</refentrytitle>
11675 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
11678 <refname>toc.max.depth</refname>
11679 <refpurpose>How many levels should be created for each TOC?</refpurpose>
11683 <programlisting id="toc.max.depth.frag"><xsl:param name="toc.max.depth">8</xsl:param></programlisting>
11686 <refsection><info><title>Description</title></info>
11688 <para>Specifies the maximal depth of TOC on all levels.</para>
11693 <refentry version="5.0" id="toc.indent.width">
11695 <refentrytitle>toc.indent.width</refentrytitle>
11696 <refmiscinfo class="other" otherclass="datatype">float</refmiscinfo>
11699 <refname>toc.indent.width</refname>
11700 <refpurpose>Amount of indentation for TOC entries</refpurpose>
11704 <programlisting id="toc.indent.width.frag">
11705 <xsl:param name="toc.indent.width">24</xsl:param>
11706 <!-- inconsistant point specification? -->
11710 <refsection><info><title>Description</title></info>
11712 <para>Specifies, in points, the distance by which each level of the
11713 TOC is indented from its parent.</para>
11715 <para>This value is expressed in points, without
11716 a unit (in other words, it is a bare number). Using a bare number allows the stylesheet
11717 to perform calculations that would otherwise have to be performed by the FO processor
11718 because not all processors support expressions.</para>
11723 <refentry version="5.0" id="toc.line.properties">
11725 <refentrytitle>toc.line.properties</refentrytitle>
11726 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
11729 <refname>toc.line.properties</refname>
11730 <refpurpose>Properties for lines in ToC and LoTs</refpurpose>
11734 <programlisting id="toc.line.properties.frag">
11735 <xsl:attribute-set name="toc.line.properties">
11736 <xsl:attribute name="text-align-last">justify</xsl:attribute>
11737 <xsl:attribute name="text-align">start</xsl:attribute>
11738 <xsl:attribute name="end-indent"><xsl:value-of select="concat($toc.indent.width, 'pt')"></xsl:value-of></xsl:attribute>
11739 <xsl:attribute name="last-line-end-indent"><xsl:value-of select="concat('-', $toc.indent.width, 'pt')"></xsl:value-of></xsl:attribute>
11740 </xsl:attribute-set>
11744 <refsection><info><title>Description</title></info>
11746 <para>Properties which are applied to every line in ToC (or LoT). You can
11747 modify them in order to change appearance of all, or some lines. For
11748 example in order to make lines for chapters in bold specify the
11749 following in your customization layer.</para>
11751 <programlisting><xsl:attribute-set name="toc.line.properties">
11752 <xsl:attribute name="font-weight">
11753 <xsl:when test="self::chapter | self::preface | self::appendix">bold</xsl:when>
11754 <xsl:otherwise>normal</xsl:otherwise>
11755 </xsl:attribute>
11756 </xsl:attribute-set></programlisting>
11761 <refentry version="5.0" id="toc.margin.properties">
11763 <refentrytitle>toc.margin.properties</refentrytitle>
11764 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
11767 <refname>toc.margin.properties</refname>
11768 <refpurpose>Margin properties used on Tables of Contents</refpurpose>
11772 <programlisting id="toc.margin.properties.frag">
11773 <xsl:attribute-set name="toc.margin.properties">
11774 <xsl:attribute name="space-before.minimum">0.5em</xsl:attribute>
11775 <xsl:attribute name="space-before.optimum">1em</xsl:attribute>
11776 <xsl:attribute name="space-before.maximum">2em</xsl:attribute>
11777 <xsl:attribute name="space-after.minimum">0.5em</xsl:attribute>
11778 <xsl:attribute name="space-after.optimum">1em</xsl:attribute>
11779 <xsl:attribute name="space-after.maximum">2em</xsl:attribute>
11780 </xsl:attribute-set>
11784 <refsection><info><title>Description</title></info>
11785 <para>This attribute set is used on Tables of Contents. These attributes are set
11786 on the wrapper that surrounds the ToC block, not on each individual lines.</para>
11790 <refentry version="5.0" id="bridgehead.in.toc">
11792 <refentrytitle>bridgehead.in.toc</refentrytitle>
11793 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
11796 <refname>bridgehead.in.toc</refname>
11797 <refpurpose>Should bridgehead elements appear in the TOC?</refpurpose>
11801 <programlisting id="bridgehead.in.toc.frag"><xsl:param name="bridgehead.in.toc" select="0"></xsl:param></programlisting>
11804 <refsection><info><title>Description</title></info>
11806 <para>If non-zero, <tag>bridgehead</tag>s appear in the TOC. Note that
11807 this option is not fully supported and may be removed in a future
11808 version of the stylesheets.
11814 <refentry version="5.0" id="simplesect.in.toc">
11816 <refentrytitle>simplesect.in.toc</refentrytitle>
11817 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
11820 <refname>simplesect.in.toc</refname>
11821 <refpurpose>Should <tag>simplesect</tag> elements appear in the TOC?</refpurpose>
11825 <programlisting id="simplesect.in.toc.frag"><xsl:param name="simplesect.in.toc" select="0"></xsl:param></programlisting>
11828 <refsection><info><title>Description</title></info>
11830 <para>If non-zero, <tag>simplesect</tag>s will be included in the TOC.
11836 <refentry version="5.0" id="generate.section.toc.level">
11838 <refentrytitle>generate.section.toc.level</refentrytitle>
11839 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
11842 <refname>generate.section.toc.level</refname>
11843 <refpurpose>Control depth of TOC generation in sections</refpurpose>
11847 <programlisting id="generate.section.toc.level.frag">
11848 <xsl:param name="generate.section.toc.level" select="0"></xsl:param>
11852 <refsection><info><title>Description</title></info>
11854 <para>The <parameter>generate.section.toc.level</parameter> parameter
11855 controls the depth of <tag>section</tag> in which TOCs will be generated. Note
11856 that this is related to, but not the same as
11857 <parameter>toc.section.depth</parameter>, which controls the depth to
11858 which TOC entries will be generated in a given TOC.</para>
11859 <para>If, for example, <parameter>generate.section.toc.level</parameter>
11860 is <literal>3</literal>, TOCs will be generated in first, second, and third
11861 level sections, but not in fourth level sections.
11870 </reference><reference id="fo_ext" xml:base="../fo/param.xml"><title>Processor Extensions</title>
11871 <refentry version="5.0" id="arbortext.extensions">
11873 <refentrytitle>arbortext.extensions</refentrytitle>
11874 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
11877 <refname>arbortext.extensions</refname>
11878 <refpurpose>Enable Arbortext extensions?</refpurpose>
11882 <programlisting id="arbortext.extensions.frag"><xsl:param name="arbortext.extensions" select="0"></xsl:param></programlisting>
11885 <refsection><info><title>Description</title></info>
11888 <link xlink:href="http://www.arbortext.com/">Arbortext</link>
11889 extensions will be used.
11891 <para>This parameter can also affect which graphics file formats
11892 are supported</para>
11897 <refentry version="5.0" id="axf.extensions">
11899 <refentrytitle>axf.extensions</refentrytitle>
11900 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
11903 <refname>axf.extensions</refname>
11904 <refpurpose>Enable XSL Formatter extensions?</refpurpose>
11908 <programlisting id="axf.extensions.frag">
11909 <xsl:param name="axf.extensions" select="0"></xsl:param>
11913 <refsection><info><title>Description</title></info>
11916 <link xlink:href="http://www.antennahouse.com/">XSL Formatter</link>
11917 extensions will be used. XSL Formatter extensions consists of PDF bookmarks,
11918 document information and better index processing.</para>
11920 <para>This parameter can also affect which graphics file formats
11921 are supported</para>
11926 <refentry version="5.0" id="fop.extensions">
11928 <refentrytitle>fop.extensions</refentrytitle>
11929 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
11932 <refname>fop.extensions</refname>
11933 <refpurpose>Enable extensions for FOP version 0.20.5 and earlier</refpurpose>
11937 <programlisting id="fop.extensions.frag"><xsl:param name="fop.extensions" select="0"></xsl:param></programlisting>
11940 <refsection><info><title>Description</title></info>
11942 <para>If non-zero, extensions intended for
11943 <link xlink:href="http://xml.apache.org/fop/">FOP</link>
11944 version 0.20.5 and earlier will be used.
11945 At present, this consists of PDF bookmarks.
11948 <para>This parameter can also affect which graphics file formats
11949 are supported.</para>
11951 <para>If you are using a version of FOP beyond
11952 version 0.20.5, then use the <parameter>fop1.extensions</parameter> parameter
11958 <refentry version="5.0" id="fop1.extensions">
11960 <refentrytitle>fop1.extensions</refentrytitle>
11961 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
11964 <refname>fop1.extensions</refname>
11965 <refpurpose>Enable extensions for FOP version 0.90 and later</refpurpose>
11969 <programlisting id="fop1.extensions.frag"><xsl:param name="fop1.extensions" select="0"></xsl:param></programlisting>
11972 <refsection><info><title>Description</title></info>
11974 <para>If non-zero, extensions for
11975 <link xlink:href="http://xml.apache.org/fop/">FOP</link>
11976 version 0.90 and later will be used.
11979 <para>This parameter can also affect which graphics file formats
11980 are supported.</para>
11982 <para>The original <parameter>fop.extensions</parameter> parameter
11983 should still be used for FOP version 0.20.5 and earlier.
11988 <refentry version="5.0" id="passivetex.extensions">
11990 <refentrytitle>passivetex.extensions</refentrytitle>
11991 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
11994 <refname>passivetex.extensions</refname>
11995 <refpurpose>Enable PassiveTeX extensions?</refpurpose>
11999 <programlisting id="passivetex.extensions.frag"><xsl:param name="passivetex.extensions" select="0"></xsl:param></programlisting>
12002 <refsection><info><title>Description</title></info>
12005 <link xlink:href="http://www.tei-c.org.uk/Software/passivetex/">PassiveTeX</link>
12006 extensions will be used. At present, this consists of PDF bookmarks
12007 and sorted index terms.
12010 <para>This parameter can also affect which graphics file formats
12011 are supported</para>
12014 <para>PassiveTeX is incomplete and development has ceased. In most cases,
12015 another XSL-FO engine is probably a better choice.</para>
12021 <refentry version="5.0" id="tex.math.in.alt">
12023 <refentrytitle>tex.math.in.alt</refentrytitle>
12024 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
12025 <refmiscinfo class="other" otherclass="value">plain</refmiscinfo>
12026 <refmiscinfo class="other" otherclass="value">latex</refmiscinfo>
12029 <refname>tex.math.in.alt</refname>
12030 <refpurpose>TeX notation used for equations</refpurpose>
12034 <programlisting id="tex.math.in.alt.frag">
12035 <xsl:param name="tex.math.in.alt"></xsl:param>
12039 <refsection><info><title>Description</title></info>
12041 <para>If you want type math directly in TeX notation in equations,
12042 this parameter specifies notation used. Currently are supported two
12043 values -- <literal>plain</literal> and <literal>latex</literal>. Empty
12044 value means that you are not using TeX math at all.</para>
12046 <para>Preferred way for including TeX alternative of math is inside of
12047 <tag>textobject</tag> element. Eg.:</para>
12049 <programlisting><inlineequation>
12050 <inlinemediaobject>
12051 <imageobject>
12052 <imagedata fileref="eq1.gif"/>
12053 </imageobject>
12054 <textobject><phrase>E=mc squared</phrase></textobject>
12055 <textobject role="tex"><phrase>E=mc^2</phrase></textobject>
12056 </inlinemediaobject>
12057 </inlineequation></programlisting>
12059 <para>If you are using <tag>graphic</tag> element, you can
12060 store TeX inside <tag>alt</tag> element:</para>
12062 <programlisting><inlineequation>
12063 <alt role="tex">a^2+b^2=c^2</alt>
12064 <graphic fileref="a2b2c2.gif"/>
12065 </inlineequation></programlisting>
12067 <para>If you want use this feature, you should process your FO with
12068 PassiveTeX, which only supports TeX math notation. When calling
12069 stylsheet, don't forget to specify also
12070 passivetex.extensions=1.</para>
12072 <para>If you want equations in HTML, just process generated file
12073 <filename>tex-math-equations.tex</filename> by TeX or LaTeX. Then run
12074 dvi2bitmap program on result DVI file. You will get images for
12075 equations in your document.</para>
12078 <para>This feature is useful for print/PDF output only if you
12079 use the obsolete and now unsupported PassiveTeX XSL-FO
12085 <refsection><info><title>Related Parameters</title></info>
12086 <para><parameter>tex.math.delims</parameter>,
12087 <parameter>passivetex.extensions</parameter>,
12088 <parameter>tex.math.file</parameter></para>
12090 <refsection><info><title>More information</title></info>
12091 <para>For how-to documentation on embedding TeX equations and
12092 generating output from them, see
12093 <link role="tcg" xlink:href="TexMath.html">DBTeXMath</link>.</para>
12097 <refentry version="5.0" id="tex.math.delims">
12099 <refentrytitle>tex.math.delims</refentrytitle>
12100 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
12103 <refname>tex.math.delims</refname>
12104 <refpurpose>Should equations output for processing by TeX be
12105 surrounded by math mode delimiters?</refpurpose>
12109 <programlisting id="tex.math.delims.frag">
12110 <xsl:param name="tex.math.delims" select="1"></xsl:param>
12114 <refsection><info><title>Description</title></info>
12116 <para>For compatibility with DSSSL based DBTeXMath from Allin Cottrell
12117 you should set this parameter to 0.</para>
12120 <refsection><info><title>Related Parameters</title></info>
12121 <para><parameter>tex.math.in.alt</parameter>,
12122 <parameter>passivetex.extensions</parameter></para>
12125 <refsection><info><title>See Also</title></info>
12126 <para>You can also use the <tag class="xmlpi">dbtex delims</tag> processing
12127 instruction to control whether delimiters are output.</para>
12129 <refsection><info><title>More information</title></info>
12130 <para>For how-to documentation on embedding TeX equations and
12131 generating output from them, see
12132 <link role="tcg" xlink:href="TexMath.html">DBTeXMath</link>.</para>
12136 <refentry version="5.0" id="xep.extensions">
12138 <refentrytitle>xep.extensions</refentrytitle>
12139 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
12142 <refname>xep.extensions</refname>
12143 <refpurpose>Enable XEP extensions?</refpurpose>
12147 <programlisting id="xep.extensions.frag"><xsl:param name="xep.extensions" select="0"></xsl:param></programlisting>
12150 <refsection><info><title>Description</title></info>
12153 <link xlink:href="http://www.renderx.com/">XEP</link>
12154 extensions will be used. XEP extensions consists of PDF bookmarks,
12155 document information and better index processing.
12158 <para>This parameter can also affect which graphics file formats
12159 are supported</para>
12163 </reference><reference id="dbk_ext" xml:base="../fo/param.xml"><title>Stylesheet Extensions</title>
12164 <refentry version="5.0" id="linenumbering.everyNth">
12166 <refentrytitle>linenumbering.everyNth</refentrytitle>
12167 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
12170 <refname>linenumbering.everyNth</refname>
12171 <refpurpose>Indicate which lines should be numbered</refpurpose>
12175 <programlisting id="linenumbering.everyNth.frag">
12176 <xsl:param name="linenumbering.everyNth">5</xsl:param>
12180 <refsection><info><title>Description</title></info>
12182 <para>If line numbering is enabled, everyNth line will be
12183 numbered. Note that numbering is one based, not zero based.
12189 <refentry version="5.0" id="linenumbering.extension">
12191 <refentrytitle>linenumbering.extension</refentrytitle>
12192 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
12195 <refname>linenumbering.extension</refname>
12196 <refpurpose>Enable the line numbering extension</refpurpose>
12200 <programlisting id="linenumbering.extension.frag">
12201 <xsl:param name="linenumbering.extension" select="1"></xsl:param>
12205 <refsection><info><title>Description</title></info>
12207 <para>If non-zero, verbatim environments (<tag>address</tag>, <tag>literallayout</tag>,
12208 <tag>programlisting</tag>, <tag>screen</tag>, <tag>synopsis</tag>) that specify line numbering will
12215 <refentry version="5.0" id="linenumbering.separator">
12217 <refentrytitle>linenumbering.separator</refentrytitle>
12218 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
12221 <refname>linenumbering.separator</refname>
12222 <refpurpose>Specify a separator between line numbers and lines</refpurpose>
12226 <programlisting id="linenumbering.separator.frag">
12227 <xsl:param name="linenumbering.separator"><xsl:text> </xsl:text></xsl:param>
12231 <refsection><info><title>Description</title></info>
12233 <para>The separator is inserted between line numbers and lines in the
12234 verbatim environment. The default value is a single white space.
12235 Note the interaction with <parameter>linenumbering.width</parameter>
12241 <refentry version="5.0" id="linenumbering.width">
12243 <refentrytitle>linenumbering.width</refentrytitle>
12244 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
12247 <refname>linenumbering.width</refname>
12248 <refpurpose>Indicates the width of line numbers</refpurpose>
12252 <programlisting id="linenumbering.width.frag">
12253 <xsl:param name="linenumbering.width">3</xsl:param>
12257 <refsection><info><title>Description</title></info>
12259 <para>If line numbering is enabled, line numbers will appear right
12260 justified in a field "width" characters wide.
12266 <refentry version="5.0" id="tablecolumns.extension">
12268 <refentrytitle>tablecolumns.extension</refentrytitle>
12269 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
12272 <refname>tablecolumns.extension</refname>
12273 <refpurpose>Enable the table columns extension function</refpurpose>
12277 <programlisting id="tablecolumns.extension.frag">
12278 <xsl:param name="tablecolumns.extension" select="1"></xsl:param>
12282 <refsection><info><title>Description</title></info>
12284 <para>The table columns extension function adjusts the widths of table
12285 columns in the HTML result to more accurately reflect the specifications
12292 <refentry version="5.0" id="textinsert.extension">
12294 <refentrytitle>textinsert.extension</refentrytitle>
12295 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
12298 <refname>textinsert.extension</refname>
12299 <refpurpose>Enables the textinsert extension element</refpurpose>
12302 <programlisting id="textinsert.extension.frag">
12303 <xsl:param name="textinsert.extension" select="1"></xsl:param>
12306 <refsection><info><title>Description</title></info>
12307 <para>The textinsert extension element inserts the contents of
12308 a file into the result tree (as text).</para>
12310 <para>To use the textinsert extension element, you must use
12311 either Saxon or Xalan as your XSLT processor (it doesn’t
12312 work with xsltproc), along with either the DocBook Saxon
12313 extensions or DocBook Xalan extensions (for more
12314 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
12315 the <parameter>use.extensions</parameter> and
12316 <parameter>textinsert.extension</parameter> parameters to
12317 <literal>1</literal>.</para>
12318 <para>As an alternative to using the textinsert element,
12319 consider using an Xinclude element with the
12320 <literal>parse="text"</literal> attribute and value
12321 specified, as detailed in <link role="tcg" xlink:href="ExternalCode.html#XIncludeCode">Using XInclude for text inclusions</link>.</para>
12324 <refsection><info><title>See Also</title></info>
12325 <para>You can also use the <tag class="xmlpi">dbhtml-include href</tag> processing
12326 instruction to insert external files — both files containing
12327 plain text and files with markup content (including HTML
12330 <refsection><info><title>More information</title></info>
12331 <para>For how-to documentation on inserting contents of
12332 external code files and other text files into output, see
12333 <link role="tcg" xlink:href="ExternalCode.html">External code files</link>.</para>
12334 <para>For guidelines on inserting contents of
12335 HTML files into output, see <link role="tcg" xlink:href="InsertExtHtml.html">Inserting external HTML code</link>.</para>
12339 <refentry version="5.0" id="textdata.default.encoding">
12341 <refentrytitle>textdata.default.encoding</refentrytitle>
12342 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
12345 <refname>textdata.default.encoding</refname>
12346 <refpurpose>Default encoding of external text files which are included
12347 using textdata element</refpurpose>
12351 <programlisting id="textdata.default.encoding.frag">
12352 <xsl:param name="textdata.default.encoding"></xsl:param>
12356 <refsection><info><title>Description</title></info>
12358 <para>Specifies the encoding of any external text files included using
12359 <tag>textdata</tag> element. This value is used only when you do
12360 not specify encoding by the appropriate attribute
12361 directly on textdata. An empty string is interpreted as the system
12362 default encoding.</para>
12367 <refentry version="5.0" id="use.extensions">
12369 <refentrytitle>use.extensions</refentrytitle>
12370 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
12373 <refname>use.extensions</refname>
12374 <refpurpose>Enable extensions</refpurpose>
12378 <programlisting id="use.extensions.frag">
12379 <xsl:param name="use.extensions" select="0"></xsl:param>
12383 <refsection><info><title>Description</title></info>
12385 <para>If non-zero, extensions may be used. Each extension is
12386 further controlled by its own parameter. But if
12387 <parameter>use.extensions</parameter> is zero, no extensions will
12394 </reference><reference id="labels" xml:base="../fo/param.xml"><title>Automatic labelling</title>
12395 <refentry version="5.0" id="appendix.autolabel">
12397 <refentrytitle>appendix.autolabel</refentrytitle>
12398 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
12399 <refmiscinfo class="other" otherclass="value">0<alt>none</alt></refmiscinfo>
12400 <refmiscinfo class="other" otherclass="value">1<alt>1,2,3...</alt></refmiscinfo>
12401 <refmiscinfo class="other" otherclass="value">A<alt>A,B,C...</alt></refmiscinfo>
12402 <refmiscinfo class="other" otherclass="value">a<alt>a,b,c...</alt></refmiscinfo>
12403 <refmiscinfo class="other" otherclass="value">i<alt>i,ii,iii...</alt></refmiscinfo>
12404 <refmiscinfo class="other" otherclass="value">I<alt>I,II,III...</alt></refmiscinfo>
12407 <refname>appendix.autolabel</refname>
12408 <refpurpose>Specifies the labeling format for Appendix titles</refpurpose>
12412 <programlisting id="appendix.autolabel.frag">
12413 <xsl:param name="appendix.autolabel">A</xsl:param>
12417 <refsection><info><title>Description</title></info>
12419 <para>If non-zero, then appendices will be numbered using the
12420 parameter value as the number format if the value matches one of the
12426 <term>1 or arabic</term>
12428 <para>Arabic numeration (1, 2, 3 ...).</para>
12432 <term>A or upperalpha</term>
12434 <para>Uppercase letter numeration (A, B, C ...).</para>
12438 <term>a or loweralpha</term>
12440 <para>Lowercase letter numeration (a, b, c ...).</para>
12444 <term>I or upperroman</term>
12446 <para>Uppercase roman numeration (I, II, III ...).</para>
12450 <term>i or lowerroman</term>
12452 <para>Lowercase roman letter numeration (i, ii, iii ...).</para>
12457 <para>Any nonzero value other than the above will generate
12458 the default number format (upperalpha).
12464 <refentry version="5.0" id="chapter.autolabel">
12466 <refentrytitle>chapter.autolabel</refentrytitle>
12467 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
12468 <refmiscinfo class="other" otherclass="value">0<alt>none</alt></refmiscinfo>
12469 <refmiscinfo class="other" otherclass="value">1<alt>1,2,3...</alt></refmiscinfo>
12470 <refmiscinfo class="other" otherclass="value">A<alt>A,B,C...</alt></refmiscinfo>
12471 <refmiscinfo class="other" otherclass="value">a<alt>a,b,c...</alt></refmiscinfo>
12472 <refmiscinfo class="other" otherclass="value">i<alt>i,ii,iii...</alt></refmiscinfo>
12473 <refmiscinfo class="other" otherclass="value">I<alt>I,II,III...</alt></refmiscinfo>
12476 <refname>chapter.autolabel</refname>
12477 <refpurpose>Specifies the labeling format for Chapter titles</refpurpose>
12481 <programlisting id="chapter.autolabel.frag">
12482 <xsl:param name="chapter.autolabel" select="1"></xsl:param></programlisting>
12485 <refsection><info><title>Description</title></info>
12487 <para>If non-zero, then chapters will be numbered using the parameter
12488 value as the number format if the value matches one of the following:
12493 <term>1 or arabic</term>
12495 <para>Arabic numeration (1, 2, 3 ...).</para>
12499 <term>A or upperalpha</term>
12501 <para>Uppercase letter numeration (A, B, C ...).</para>
12505 <term>a or loweralpha</term>
12507 <para>Lowercase letter numeration (a, b, c ...).</para>
12511 <term>I or upperroman</term>
12513 <para>Uppercase roman numeration (I, II, III ...).</para>
12517 <term>i or lowerroman</term>
12519 <para>Lowercase roman letter numeration (i, ii, iii ...).</para>
12524 <para>Any nonzero value other than the above will generate
12525 the default number format (arabic).
12531 <refentry version="5.0" id="part.autolabel">
12533 <refentrytitle>part.autolabel</refentrytitle>
12534 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
12535 <refmiscinfo class="other" otherclass="value">0<alt>none</alt></refmiscinfo>
12536 <refmiscinfo class="other" otherclass="value">1<alt>1,2,3...</alt></refmiscinfo>
12537 <refmiscinfo class="other" otherclass="value">A<alt>A,B,C...</alt></refmiscinfo>
12538 <refmiscinfo class="other" otherclass="value">a<alt>a,b,c...</alt></refmiscinfo>
12539 <refmiscinfo class="other" otherclass="value">i<alt>i,ii,iii...</alt></refmiscinfo>
12540 <refmiscinfo class="other" otherclass="value">I<alt>I,II,III...</alt></refmiscinfo>
12543 <refname>part.autolabel</refname>
12544 <refpurpose>Specifies the labeling format for Part titles</refpurpose>
12548 <programlisting id="part.autolabel.frag">
12549 <xsl:param name="part.autolabel">I</xsl:param>
12553 <refsection><info><title>Description</title></info>
12555 <para>If non-zero, then parts will be numbered using the parameter
12556 value as the number format if the value matches one of the following:
12561 <term>1 or arabic</term>
12563 <para>Arabic numeration (1, 2, 3 ...).</para>
12567 <term>A or upperalpha</term>
12569 <para>Uppercase letter numeration (A, B, C ...).</para>
12573 <term>a or loweralpha</term>
12575 <para>Lowercase letter numeration (a, b, c ...).</para>
12579 <term>I or upperroman</term>
12581 <para>Uppercase roman numeration (I, II, III ...).</para>
12585 <term>i or lowerroman</term>
12587 <para>Lowercase roman letter numeration (i, ii, iii ...).</para>
12592 <para>Any nonzero value other than the above will generate
12593 the default number format (upperroman).
12600 <refentry version="5.0" id="reference.autolabel">
12602 <refentrytitle>reference.autolabel</refentrytitle>
12603 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
12604 <refmiscinfo class="other" otherclass="value">0<alt>none</alt></refmiscinfo>
12605 <refmiscinfo class="other" otherclass="value">1<alt>1,2,3...</alt></refmiscinfo>
12606 <refmiscinfo class="other" otherclass="value">A<alt>A,B,C...</alt></refmiscinfo>
12607 <refmiscinfo class="other" otherclass="value">a<alt>a,b,c...</alt></refmiscinfo>
12608 <refmiscinfo class="other" otherclass="value">i<alt>i,ii,iii...</alt></refmiscinfo>
12609 <refmiscinfo class="other" otherclass="value">I<alt>I,II,III...</alt></refmiscinfo>
12612 <refname>reference.autolabel</refname>
12613 <refpurpose>Specifies the labeling format for Reference titles</refpurpose>
12616 <programlisting id="reference.autolabel.frag">
12617 <xsl:param name="reference.autolabel">I</xsl:param>
12620 <refsection><info><title>Description</title></info>
12621 <para>If non-zero, references will be numbered using the parameter
12622 value as the number format if the value matches one of the
12627 <term>1 or arabic</term>
12629 <para>Arabic numeration (1, 2, 3 ...).</para>
12633 <term>A or upperalpha</term>
12635 <para>Uppercase letter numeration (A, B, C ...).</para>
12639 <term>a or loweralpha</term>
12641 <para>Lowercase letter numeration (a, b, c ...).</para>
12645 <term>I or upperroman</term>
12647 <para>Uppercase roman numeration (I, II, III ...).</para>
12651 <term>i or lowerroman</term>
12653 <para>Lowercase roman letter numeration (i, ii, iii ...).</para>
12657 <para>Any non-zero value other than the above will generate
12658 the default number format (upperroman).
12663 <refentry version="5.0" id="preface.autolabel">
12665 <refentrytitle>preface.autolabel</refentrytitle>
12666 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
12667 <refmiscinfo class="other" otherclass="value">0<alt>none</alt></refmiscinfo>
12668 <refmiscinfo class="other" otherclass="value">1<alt>1,2,3...</alt></refmiscinfo>
12669 <refmiscinfo class="other" otherclass="value">A<alt>A,B,C...</alt></refmiscinfo>
12670 <refmiscinfo class="other" otherclass="value">a<alt>a,b,c...</alt></refmiscinfo>
12671 <refmiscinfo class="other" otherclass="value">i<alt>i,ii,iii...</alt></refmiscinfo>
12672 <refmiscinfo class="other" otherclass="value">I<alt>I,II,III...</alt></refmiscinfo>
12675 <refname>preface.autolabel</refname>
12676 <refpurpose>Specifices the labeling format for Preface titles</refpurpose>
12680 <programlisting id="preface.autolabel.frag"><xsl:param name="preface.autolabel" select="0"></xsl:param></programlisting>
12683 <refsection><info><title>Description</title></info>
12685 <para>If non-zero then prefaces will be numbered using the parameter
12686 value as the number format if the value matches one of the following:
12691 <term>1 or arabic</term>
12693 <para>Arabic numeration (1, 2, 3 ...).</para>
12697 <term>A or upperalpha</term>
12699 <para>Uppercase letter numeration (A, B, C ...).</para>
12703 <term>a or loweralpha</term>
12705 <para>Lowercase letter numeration (a, b, c ...).</para>
12709 <term>I or upperroman</term>
12711 <para>Uppercase roman numeration (I, II, III ...).</para>
12715 <term>i or lowerroman</term>
12717 <para>Lowercase roman letter numeration (i, ii, iii ...).</para>
12722 <para>Any nonzero value other than the above will generate
12723 the default number format (arabic).
12730 <refentry version="5.0" id="section.autolabel">
12732 <refentrytitle>section.autolabel</refentrytitle>
12733 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
12736 <refname>section.autolabel</refname>
12737 <refpurpose>Are sections enumerated?</refpurpose>
12741 <programlisting id="section.autolabel.frag"><xsl:param name="section.autolabel" select="0"></xsl:param></programlisting>
12744 <refsection><info><title>Description</title></info>
12746 <para>If true (non-zero), unlabeled sections will be enumerated.
12752 <refentry version="5.0" id="section.autolabel.max.depth">
12754 <refentrytitle>section.autolabel.max.depth</refentrytitle>
12755 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
12758 <refname>section.autolabel.max.depth</refname>
12759 <refpurpose>The deepest level of sections that are numbered.</refpurpose>
12763 <programlisting id="section.autolabel.max.depth.frag">
12764 <xsl:param name="section.autolabel.max.depth">8</xsl:param>
12768 <refsection><info><title>Description</title></info>
12770 <para>When section numbering is turned on by the
12771 <parameter>section.autolabel</parameter> parameter, then this
12772 parameter controls the depth of <tag>section</tag> nesting that is
12773 numbered. Sections nested to a level deeper than this value will not
12780 <refentry version="5.0" id="section.label.includes.component.label">
12782 <refentrytitle>section.label.includes.component.label</refentrytitle>
12783 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
12786 <refname>section.label.includes.component.label</refname>
12787 <refpurpose>Do section labels include the component label?</refpurpose>
12791 <programlisting id="section.label.includes.component.label.frag"><xsl:param name="section.label.includes.component.label" select="0"></xsl:param></programlisting>
12794 <refsection><info><title>Description</title></info>
12796 <para>If non-zero, section labels are prefixed with the label of the
12797 component that contains them.
12803 <refentry version="5.0" id="label.from.part">
12805 <refentrytitle>label.from.part</refentrytitle>
12806 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
12809 <refname>label.from.part</refname>
12810 <refpurpose>Renumber components in each part?</refpurpose>
12814 <programlisting id="label.from.part.frag">
12815 <xsl:param name="label.from.part" select="0"></xsl:param>
12819 <refsection><info><title>Description</title></info>
12821 <para>If <parameter>label.from.part</parameter> is non-zero, then
12822 numbering of components — <tag>preface</tag>,
12823 <tag>chapter</tag>, <tag>appendix</tag>, and
12824 <tag>reference</tag> (when <tag>reference</tag> occurs at the
12825 component level) — is re-started within each
12826 <tag>part</tag>.</para>
12827 <para>If <parameter>label.from.part</parameter> is zero (the
12828 default), numbering of components is <emphasis>not</emphasis>
12829 re-started within each <tag>part</tag>; instead, components are
12830 numbered sequentially throughout each <tag>book</tag>,
12831 regardless of whether or not they occur within <tag>part</tag>
12837 <refentry version="5.0" id="component.label.includes.part.label">
12839 <refentrytitle>component.label.includes.part.label</refentrytitle>
12840 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
12843 <refname>component.label.includes.part.label</refname>
12844 <refpurpose>Do component labels include the part label?</refpurpose>
12848 <programlisting id="component.label.includes.part.label.frag"><xsl:param name="component.label.includes.part.label" select="0"></xsl:param></programlisting>
12851 <refsection><info><title>Description</title></info>
12853 <para>If non-zero, number labels for <tag>chapter</tag>,
12854 <tag>appendix</tag>, and other component elements are prefixed with
12855 the label of the part element that contains them. So you might see
12856 Chapter II.3 instead of Chapter 3. Also, the labels for formal
12857 elements such as <tag>table</tag> and <tag>figure</tag> will include
12858 the part label. If there is no part element container, then no prefix
12862 This feature is most useful when the
12863 <parameter>label.from.part</parameter> parameter is turned on.
12864 In that case, there would be more than one <tag>chapter</tag>
12865 <quote>1</quote>, and the extra part label prefix will identify
12866 each chapter unambiguously.
12872 </reference><reference id="xslt" xml:base="../fo/param.xml"><title>XSLT Processing</title>
12873 <refentry version="5.0" id="rootid">
12875 <refentrytitle>rootid</refentrytitle>
12876 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
12879 <refname>rootid</refname>
12880 <refpurpose>Specify the root element to format</refpurpose>
12884 <programlisting id="rootid.frag">
12885 <xsl:param name="rootid"></xsl:param></programlisting>
12888 <refsection><info><title>Description</title></info>
12890 <para>If <parameter>rootid</parameter> is not empty, it must be the
12891 value of an ID that occurs in the document being formatted. The entire
12892 document will be loaded and parsed, but formatting will begin at the
12893 element identified, rather than at the root. For example, this allows
12894 you to process only <tag>chapter</tag> 4 of a <tag>book</tag>.</para>
12895 <para>Because the entire document is available to the processor, automatic
12896 numbering, cross references, and other dependencies are correctly
12902 </reference><reference id="meta" xml:base="../fo/param.xml"><title>Meta/*Info</title>
12903 <refentry version="5.0" id="make.single.year.ranges">
12905 <refentrytitle>make.single.year.ranges</refentrytitle>
12906 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
12909 <refname>make.single.year.ranges</refname>
12910 <refpurpose>Print single-year ranges (e.g., 1998-1999)</refpurpose>
12914 <programlisting id="make.single.year.ranges.frag">
12915 <xsl:param name="make.single.year.ranges" select="0"></xsl:param></programlisting>
12918 <refsection><info><title>Description</title></info>
12920 <para>If non-zero, year ranges that span a single year will be printed
12921 in range notation (1998-1999) instead of discrete notation
12922 (1998, 1999).</para>
12927 <refentry version="5.0" id="make.year.ranges">
12929 <refentrytitle>make.year.ranges</refentrytitle>
12930 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
12933 <refname>make.year.ranges</refname>
12934 <refpurpose>Collate copyright years into ranges?</refpurpose>
12938 <programlisting id="make.year.ranges.frag"><xsl:param name="make.year.ranges" select="0"></xsl:param></programlisting>
12941 <refsection><info><title>Description</title></info>
12943 <para>If non-zero, multiple copyright <tag>year</tag> elements will be
12944 collated into ranges.
12945 This works only if each year number is put into a separate
12946 year element. The copyright element permits multiple
12947 year elements. If a year element contains a dash or
12948 a comma, then that year element will not be merged into
12955 <refentry version="5.0" id="author.othername.in.middle">
12957 <refentrytitle>author.othername.in.middle</refentrytitle>
12958 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
12961 <refname>author.othername.in.middle</refname>
12962 <refpurpose>Is <tag>othername</tag> in <tag>author</tag> a
12963 middle name?</refpurpose>
12967 <programlisting id="author.othername.in.middle.frag">
12968 <xsl:param name="author.othername.in.middle" select="1"></xsl:param></programlisting>
12971 <refsection><info><title>Description</title></info>
12973 <para>If non-zero, the <tag>othername</tag> of an <tag>author</tag>
12974 appears between the <tag>firstname</tag> and
12975 <tag>surname</tag>. Otherwise, <tag>othername</tag>
12982 </reference><reference id="refentry" xml:base="../fo/param.xml"><title>Reference Pages</title>
12983 <refentry version="5.0" id="funcsynopsis.decoration">
12985 <refentrytitle>funcsynopsis.decoration</refentrytitle>
12986 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
12989 <refname>funcsynopsis.decoration</refname>
12990 <refpurpose>Decorate elements of a <tag>funcsynopsis</tag>?</refpurpose>
12994 <programlisting id="funcsynopsis.decoration.frag">
12995 <xsl:param name="funcsynopsis.decoration" select="1"></xsl:param>
12999 <refsection><info><title>Description</title></info>
13001 <para>If non-zero, elements of the <tag>funcsynopsis</tag> will be
13002 decorated (e.g. rendered as bold or italic text). The decoration is controlled by
13003 templates that can be redefined in a customization layer.
13009 <refentry version="5.0" id="funcsynopsis.style">
13011 <refentrytitle>funcsynopsis.style</refentrytitle>
13012 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
13013 <refmiscinfo class="other" otherclass="value">ansi</refmiscinfo>
13014 <refmiscinfo class="other" otherclass="value">kr</refmiscinfo>
13017 <refname>funcsynopsis.style</refname>
13018 <refpurpose>What style of <tag>funcsynopsis</tag> should be generated?</refpurpose>
13022 <programlisting id="funcsynopsis.style.frag"><xsl:param name="funcsynopsis.style">kr</xsl:param></programlisting>
13025 <refsection><info><title>Description</title></info>
13027 <para>If <parameter>funcsynopsis.style</parameter> is <literal>ansi</literal>,
13028 ANSI-style function synopses are generated for a
13029 <tag>funcsynopsis</tag>, otherwise K&R-style
13030 function synopses are generated.
13036 <refentry version="5.0" id="function.parens">
13038 <refentrytitle>function.parens</refentrytitle>
13039 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
13042 <refname>function.parens</refname>
13043 <refpurpose>Generate parens after a function?</refpurpose>
13047 <programlisting id="function.parens.frag">
13048 <xsl:param name="function.parens" select="0"></xsl:param>
13052 <refsection><info><title>Description</title></info>
13054 <para>If non-zero, the formatting of a <tag>function</tag> element
13055 will include generated parentheses.
13061 <refentry version="5.0" id="refentry.generate.name">
13063 <refentrytitle>refentry.generate.name</refentrytitle>
13064 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
13067 <refname>refentry.generate.name</refname>
13068 <refpurpose>Output NAME header before <tag>refname</tag>s?</refpurpose>
13072 <programlisting id="refentry.generate.name.frag">
13073 <xsl:param name="refentry.generate.name" select="1"></xsl:param>
13077 <refsection><info><title>Description</title></info>
13079 <para>If non-zero, a "NAME" section title is output before the list
13080 of <tag>refname</tag>s. This parameter and
13081 <parameter>refentry.generate.title</parameter> are mutually
13082 exclusive. This means that if you change this parameter to zero, you
13083 should set <parameter>refentry.generate.title</parameter> to non-zero unless
13084 you want get quite strange output.
13090 <refentry version="5.0" id="refentry.generate.title">
13092 <refentrytitle>refentry.generate.title</refentrytitle>
13093 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
13096 <refname>refentry.generate.title</refname>
13097 <refpurpose>Output title before <tag>refname</tag>s?</refpurpose>
13101 <programlisting id="refentry.generate.title.frag">
13102 <xsl:param name="refentry.generate.title" select="0"></xsl:param>
13106 <refsection><info><title>Description</title></info>
13108 <para>If non-zero, the reference page title or first name is
13109 output before the list of <tag>refname</tag>s. This parameter and
13110 <parameter>refentry.generate.name</parameter> are mutually exclusive.
13111 This means that if you change this parameter to non-zero, you
13112 should set <parameter>refentry.generate.name</parameter> to zero unless
13113 you want get quite strange output.</para>
13119 <refentry version="5.0" id="refentry.pagebreak">
13121 <refentrytitle>refentry.pagebreak</refentrytitle>
13122 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
13125 <refname>refentry.pagebreak</refname>
13126 <refpurpose>Start each refentry on a new page</refpurpose>
13130 <programlisting id="refentry.pagebreak.frag"><xsl:param name="refentry.pagebreak" select="1"></xsl:param></programlisting>
13133 <refsection><info><title>Description</title></info>
13135 <para>If non-zero (the default), each <tag>refentry</tag>
13136 element will start on a new page. If zero, a page
13137 break will not be generated between <tag>refentry</tag> elements.
13138 The exception is when the <tag>refentry</tag> elements are children of
13139 a <tag>part</tag> element, in which case the page breaks are always
13140 retained. That is because a <tag>part</tag> element does not generate
13141 a page-sequence for its children, so each <tag>refentry</tag> must
13142 start its own page-sequence.
13148 <refentry version="5.0" id="refentry.title.properties">
13150 <refentrytitle>refentry.title.properties</refentrytitle>
13151 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
13154 <refname>refentry.title.properties</refname>
13155 <refpurpose>Title properties for a refentry title</refpurpose>
13159 <programlisting id="refentry.title.properties.frag">
13160 <xsl:attribute-set name="refentry.title.properties">
13161 <xsl:attribute name="font-family">
13162 <xsl:value-of select="$title.font.family"></xsl:value-of>
13163 </xsl:attribute>
13164 <xsl:attribute name="font-size">18pt</xsl:attribute>
13165 <xsl:attribute name="font-weight">bold</xsl:attribute>
13166 <xsl:attribute name="space-after">1em</xsl:attribute>
13167 <xsl:attribute name="hyphenate">false</xsl:attribute>
13168 <xsl:attribute name="keep-with-next.within-column">always</xsl:attribute>
13169 <xsl:attribute name="space-before.minimum">0.8em</xsl:attribute>
13170 <xsl:attribute name="space-before.optimum">1.0em</xsl:attribute>
13171 <xsl:attribute name="space-before.maximum">1.2em</xsl:attribute>
13172 <xsl:attribute name="space-after.optimum">0.5em</xsl:attribute>
13173 <xsl:attribute name="space-after.minimum">0.4em</xsl:attribute>
13174 <xsl:attribute name="space-after.maximum">0.6em</xsl:attribute>
13175 <xsl:attribute name="start-indent"><xsl:value-of select="$title.margin.left"></xsl:value-of></xsl:attribute>
13176 </xsl:attribute-set>
13180 <refsection><info><title>Description</title></info>
13182 <para>Formatting properties applied to the title generated for the
13183 <tag>refnamediv</tag> part of output for
13184 <tag>refentry</tag> when the value of the
13185 <parameter>refentry.generate.title</parameter> parameter is
13186 non-zero. The font size is supplied by the appropriate <parameter>section.level<replaceable>X</replaceable>.title.properties</parameter>
13187 attribute-set, computed from the location of the
13188 <tag>refentry</tag> in the section hierarchy.</para>
13191 <para>This parameter has no effect on the the title generated for
13192 the <tag>refnamediv</tag> part of output for
13193 <tag>refentry</tag> when the value of the
13194 <parameter>refentry.generate.name</parameter> parameter is
13195 non-zero. By default, that title is formatted with the same
13196 properties as the titles for all other first-level children of
13197 <tag>refentry</tag>.</para>
13203 <refentry version="5.0" id="refentry.xref.manvolnum">
13205 <refentrytitle>refentry.xref.manvolnum</refentrytitle>
13206 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
13209 <refname>refentry.xref.manvolnum</refname>
13210 <refpurpose>Output <tag>manvolnum</tag> as part of
13211 <tag>refentry</tag> cross-reference?</refpurpose>
13215 <programlisting id="refentry.xref.manvolnum.frag">
13216 <xsl:param name="refentry.xref.manvolnum" select="1"></xsl:param>
13220 <refsection><info><title>Description</title></info>
13222 <para>if non-zero, the <tag>manvolnum</tag> is used when cross-referencing
13223 <tag>refentry</tag>s, either with <tag>xref</tag>
13224 or <tag>citerefentry</tag>.
13230 <refentry version="5.0" id="refclass.suppress">
13232 <refentrytitle>refclass.suppress</refentrytitle>
13233 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
13236 <refname>refclass.suppress</refname>
13237 <refpurpose>Suppress display of refclass contents?</refpurpose>
13241 <programlisting id="refclass.suppress.frag">
13242 <xsl:param name="refclass.suppress" select="0"></xsl:param></programlisting>
13245 <refsection><info><title>Description</title></info>
13247 <para>If the value of <parameter>refclass.suppress</parameter> is
13248 non-zero, then display of <tag>refclass</tag> contents is
13249 suppressed in output.</para>
13254 </reference><reference id="tables" xml:base="../fo/param.xml"><title>Tables</title>
13255 <refentry version="5.0" id="default.table.width">
13257 <refentrytitle>default.table.width</refentrytitle>
13258 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
13261 <refname>default.table.width</refname>
13262 <refpurpose>The default width of tables</refpurpose>
13265 <programlisting id="default.table.width.frag">
13266 <xsl:param name="default.table.width"></xsl:param>
13269 <refsection><info><title>Description</title></info>
13270 <para>If non-zero, this value will be used for the
13271 <literal>width</literal> attribute on <tag>table</tag>s that do not specify an
13272 alternate width (with the <tag class="xmlpi">dbhtml table-width</tag> or
13273 <tag class="xmlpi">dbfo table-width</tag> processing instruction).</para>
13277 <refentry version="5.0" id="nominal.table.width">
13279 <refentrytitle>nominal.table.width</refentrytitle>
13280 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
13283 <refname>nominal.table.width</refname>
13284 <refpurpose>The (absolute) nominal width of tables</refpurpose>
13288 <programlisting id="nominal.table.width.frag">
13289 <xsl:param name="nominal.table.width">6in</xsl:param>
13293 <refsection><info><title>Description</title></info>
13295 <para>In order to convert CALS column widths into HTML column widths, it
13296 is sometimes necessary to have an absolute table width to use for conversion
13297 of mixed absolute and relative widths. This value must be an absolute
13298 length (not a percentage).</para>
13303 <refentry version="5.0" id="default.table.frame">
13305 <refentrytitle>default.table.frame</refentrytitle>
13306 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
13309 <refname>default.table.frame</refname>
13310 <refpurpose>The default framing of tables</refpurpose>
13314 <programlisting id="default.table.frame.frag">
13315 <xsl:param name="default.table.frame">all</xsl:param>
13319 <refsection><info><title>Description</title></info>
13321 <para>This value will be used when there is no frame attribute on the
13327 <refentry version="5.0" id="default.table.rules">
13329 <refentrytitle>default.table.rules</refentrytitle>
13330 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
13333 <refname>default.table.rules</refname>
13334 <refpurpose>The default column and row rules for tables using HTML markup</refpurpose>
13338 <programlisting id="default.table.rules.frag">
13339 <xsl:param name="default.table.rules">none</xsl:param>
13343 <refsection><info><title>Description</title></info>
13345 <para>Tables using HTML markup elements can use an attribute
13346 named <tag class="attribute">rules</tag> on the <tag>table</tag> or
13347 <tag>informaltable</tag> element
13348 to specify whether column and row border rules should be
13349 displayed. This parameter lets you specify a global default
13350 style for all HTML tables that don't otherwise have
13351 that attribute.</para>
13352 <para>These are the supported values:</para>
13355 <varlistentry><term>all</term>
13357 <para>Rules will appear between all rows and columns.</para>
13361 <varlistentry><term>rows</term>
13363 <para>Rules will appear between rows only.</para>
13367 <varlistentry><term>cols</term>
13369 <para>Rules will appear between columns only.</para>
13373 <varlistentry><term>groups</term>
13375 <para>Rules will appear between row groups (thead, tfoot, tbody).
13376 No support for rules between column groups yet.
13381 <varlistentry><term>none</term>
13383 <para>No rules. This is the default value.
13390 <para>The border after the last row and the border after
13391 the last column are not affected by
13392 this setting. Those borders are controlled by
13393 the <tag class="attribute">frame</tag> attribute on the table element.
13399 <refentry version="5.0" id="table.cell.padding">
13401 <refentrytitle>table.cell.padding</refentrytitle>
13402 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
13405 <refname>table.cell.padding</refname>
13406 <refpurpose>Specifies the padding of table cells</refpurpose>
13410 <programlisting id="table.cell.padding.frag">
13411 <xsl:attribute-set name="table.cell.padding">
13412 <xsl:attribute name="padding-start">2pt</xsl:attribute>
13413 <xsl:attribute name="padding-end">2pt</xsl:attribute>
13414 <xsl:attribute name="padding-top">2pt</xsl:attribute>
13415 <xsl:attribute name="padding-bottom">2pt</xsl:attribute>
13416 </xsl:attribute-set>
13420 <refsection><info><title>Description</title></info>
13422 <para>Specifies the padding of table cells.</para>
13427 <refentry version="5.0" id="table.frame.border.thickness">
13429 <refentrytitle>table.frame.border.thickness</refentrytitle>
13430 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
13433 <refname>table.frame.border.thickness</refname>
13434 <refpurpose>Specifies the thickness of the frame border</refpurpose>
13438 <programlisting id="table.frame.border.thickness.frag">
13439 <xsl:param name="table.frame.border.thickness">0.5pt</xsl:param>
13443 <refsection><info><title>Description</title></info>
13445 <para>Specifies the thickness of the border on the table's frame.</para>
13450 <refentry version="5.0" id="table.frame.border.style">
13452 <refentrytitle>table.frame.border.style</refentrytitle>
13453 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
13454 <refmiscinfo class="other" otherclass="value">none</refmiscinfo>
13455 <refmiscinfo class="other" otherclass="value">solid</refmiscinfo>
13456 <refmiscinfo class="other" otherclass="value">dotted</refmiscinfo>
13457 <refmiscinfo class="other" otherclass="value">dashed</refmiscinfo>
13458 <refmiscinfo class="other" otherclass="value">double</refmiscinfo>
13459 <refmiscinfo class="other" otherclass="value">groove</refmiscinfo>
13460 <refmiscinfo class="other" otherclass="value">ridge</refmiscinfo>
13461 <refmiscinfo class="other" otherclass="value">inset</refmiscinfo>
13462 <refmiscinfo class="other" otherclass="value">outset</refmiscinfo>
13463 <refmiscinfo class="other" otherclass="value">solid</refmiscinfo>
13466 <refname>table.frame.border.style</refname>
13467 <refpurpose>Specifies the border style of table frames</refpurpose>
13471 <programlisting id="table.frame.border.style.frag">
13472 <xsl:param name="table.frame.border.style">solid</xsl:param>
13476 <refsection><info><title>Description</title></info>
13478 <para>Specifies the border style of table frames.</para>
13483 <refentry version="5.0" id="table.frame.border.color">
13485 <refentrytitle>table.frame.border.color</refentrytitle>
13486 <refmiscinfo class="other" otherclass="datatype">color</refmiscinfo>
13489 <refname>table.frame.border.color</refname>
13490 <refpurpose>Specifies the border color of table frames</refpurpose>
13494 <programlisting id="table.frame.border.color.frag">
13496 <xsl:param name="table.frame.border.color">black</xsl:param>
13500 <refsection><info><title>Description</title></info>
13502 <para>Specifies the border color of table frames.</para>
13507 <refentry version="5.0" id="table.cell.border.thickness">
13509 <refentrytitle>table.cell.border.thickness</refentrytitle>
13510 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
13513 <refname>table.cell.border.thickness</refname>
13514 <refpurpose>Specifies the thickness of table cell borders</refpurpose>
13518 <programlisting id="table.cell.border.thickness.frag">
13519 <xsl:param name="table.cell.border.thickness">0.5pt</xsl:param>
13523 <refsection><info><title>Description</title></info>
13525 <para>If non-zero, specifies the thickness of borders on table
13526 cells. The units are points. See <link xlink:href="http://www.w3.org/TR/CSS21/box.html#border-width-properties">
13530 <para>To control properties of cell borders in HTML output, you must also turn on the
13531 <parameter>table.borders.with.css</parameter> parameter.</para>
13537 <refentry version="5.0" id="table.cell.border.style">
13539 <refentrytitle>table.cell.border.style</refentrytitle>
13540 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
13541 <refmiscinfo class="other" otherclass="value">none</refmiscinfo>
13542 <refmiscinfo class="other" otherclass="value">solid</refmiscinfo>
13543 <refmiscinfo class="other" otherclass="value">dotted</refmiscinfo>
13544 <refmiscinfo class="other" otherclass="value">dashed</refmiscinfo>
13545 <refmiscinfo class="other" otherclass="value">double</refmiscinfo>
13546 <refmiscinfo class="other" otherclass="value">groove</refmiscinfo>
13547 <refmiscinfo class="other" otherclass="value">ridge</refmiscinfo>
13548 <refmiscinfo class="other" otherclass="value">inset</refmiscinfo>
13549 <refmiscinfo class="other" otherclass="value">outset</refmiscinfo>
13550 <refmiscinfo class="other" otherclass="value">solid</refmiscinfo>
13553 <refname>table.cell.border.style</refname>
13554 <refpurpose>Specifies the border style of table cells</refpurpose>
13558 <programlisting id="table.cell.border.style.frag">
13559 <xsl:param name="table.cell.border.style">solid</xsl:param>
13563 <refsection><info><title>Description</title></info>
13565 <para>Specifies the border style of table cells.</para>
13568 <para>To control properties of cell borders in HTML output, you must also turn on the
13569 <parameter>table.borders.with.css</parameter> parameter.</para>
13575 <refentry version="5.0" id="table.cell.border.color">
13577 <refentrytitle>table.cell.border.color</refentrytitle>
13578 <refmiscinfo class="other" otherclass="datatype">color</refmiscinfo>
13581 <refname>table.cell.border.color</refname>
13582 <refpurpose>Specifies the border color of table cells</refpurpose>
13586 <programlisting id="table.cell.border.color.frag">
13588 <xsl:param name="table.cell.border.color">black</xsl:param>
13592 <refsection><info><title>Description</title></info>
13594 <para>Set the color of table cell borders. If non-zero, the value is used
13595 for the border coloration. See <link xlink:href="http://www.w3.org/TR/CSS21/syndata.html#value-def-color">CSS</link>. A
13596 <literal>color</literal> is either a keyword or a numerical RGB specification.
13597 Keywords are aqua, black, blue, fuchsia, gray, green, lime, maroon,
13598 navy, olive, orange, purple, red, silver, teal, white, and
13602 <para>To control properties of cell borders in HTML output, you must also turn on the
13603 <parameter>table.borders.with.css</parameter> parameter.</para>
13609 <refentry version="5.0" id="table.table.properties">
13611 <refentrytitle>table.table.properties</refentrytitle>
13612 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
13615 <refname>table.table.properties</refname>
13616 <refpurpose>Properties associated with a table</refpurpose>
13620 <programlisting id="table.table.properties.frag">
13621 <xsl:attribute-set name="table.table.properties">
13622 <xsl:attribute name="border-before-width.conditionality">retain</xsl:attribute>
13623 <xsl:attribute name="border-collapse">collapse</xsl:attribute>
13624 </xsl:attribute-set>
13628 <refsection><info><title>Description</title></info>
13630 <para>The styling for tables. This parameter should really
13631 have been called <literal>table.properties</literal>, but that parameter
13632 name was inadvertently established for the block-level properties
13633 of the table as a whole.
13636 <para>See also <parameter>table.properties</parameter>.</para>
13641 </reference><reference id="links" xml:base="../fo/param.xml"><title>Linking</title>
13642 <refentry version="5.0" id="current.docid">
13644 <refentrytitle>current.docid</refentrytitle>
13645 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
13648 <refname>current.docid</refname>
13649 <refpurpose>targetdoc identifier for the document being
13650 processed</refpurpose>
13652 <refsynopsisdiv> <programlisting id="current.docid.frag">
13653 <xsl:param name="current.docid"></xsl:param>
13656 <refsection><info><title>Description</title></info>
13658 <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
13659 the targetdoc identifier of the current document, since that
13660 identifier does not appear in the document itself. </para>
13661 <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>
13665 <refentry version="5.0" id="collect.xref.targets">
13667 <refentrytitle>collect.xref.targets</refentrytitle>
13668 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
13669 <refmiscinfo class="other" otherclass="value">no</refmiscinfo>
13670 <refmiscinfo class="other" otherclass="value">yes</refmiscinfo>
13671 <refmiscinfo class="other" otherclass="value">only</refmiscinfo>
13674 <refname>collect.xref.targets</refname>
13675 <refpurpose>Controls whether cross reference data is
13676 collected</refpurpose>
13678 <refsynopsisdiv> <programlisting id="collect.xref.targets.frag">
13679 <xsl:param name="collect.xref.targets">no</xsl:param>
13682 <refsection><info><title>Description</title></info>
13685 In order to resolve olinks efficiently, the stylesheets can
13686 generate an external data file containing information about
13687 all potential cross reference endpoints in a document.
13688 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.
13689 See also <parameter>targets.filename</parameter>.
13694 <refentry version="5.0" id="insert.olink.page.number">
13696 <refentrytitle>insert.olink.page.number</refentrytitle>
13697 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
13698 <refmiscinfo class="other" otherclass="value">no</refmiscinfo>
13699 <refmiscinfo class="other" otherclass="value">yes</refmiscinfo>
13700 <refmiscinfo class="other" otherclass="value">maybe</refmiscinfo>
13703 <refname>insert.olink.page.number</refname>
13704 <refpurpose>Turns page numbers in olinks on and off</refpurpose>
13708 <programlisting id="insert.olink.page.number.frag">
13709 <xsl:param name="insert.olink.page.number">no</xsl:param>
13713 <refsection><info><title>Description</title></info>
13715 <para>The value of this parameter determines if
13716 cross references made between documents with
13717 <tag>olink</tag> will
13718 include page number citations.
13719 In most cases this is only applicable to references in printed output.
13721 <para>The parameter has three possible values.
13726 <listitem><para>No page number references will be generated for olinks.
13731 <listitem><para>Page number references will be generated
13732 for all <tag>olink</tag> references.
13733 The style of page reference may be changed
13734 if an <tag class="attribute">xrefstyle</tag>
13740 <listitem><para>Page number references will not be generated
13741 for an <tag>olink</tag> element unless
13743 <tag class="attribute">xrefstyle</tag>
13744 attribute whose value specifies a page reference.
13748 <para>Olinks that point to targets within the same document
13749 are treated as <tag>xref</tag>s, and controlled by
13750 the <parameter>insert.xref.page.number</parameter> parameter.
13753 <para>Page number references for olinks to
13754 external documents can only be inserted if the
13755 information exists in the olink database.
13756 This means each olink target element
13757 (<tag>div</tag> or <tag>obj</tag>)
13758 must have a <tag class="attribute">page</tag> attribute
13759 whose value is its page number in the target document.
13760 The XSL stylesheets are not able to extract that information
13761 during processing because pages have not yet been created in
13762 XSLT transformation. Only the XSL-FO processor knows what
13763 page each element is placed on.
13764 Therefore some postprocessing must take place to populate
13765 page numbers in the olink database.
13773 <refentry version="5.0" id="insert.olink.pdf.frag">
13775 <refentrytitle>insert.olink.pdf.frag</refentrytitle>
13776 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
13779 <refname>insert.olink.pdf.frag</refname>
13780 <refpurpose>Add fragment identifiers for links into PDF files</refpurpose>
13784 <programlisting id="insert.olink.pdf.frag.frag">
13785 <xsl:param name="insert.olink.pdf.frag" select="0"></xsl:param>
13789 <refsection><info><title>Description</title></info>
13791 <para>The value of this parameter determines whether
13792 the cross reference URIs to PDF documents made with
13793 <tag>olink</tag> will
13794 include fragment identifiers.
13797 <para>When forming a URI to link to a PDF document,
13798 a fragment identifier (typically a '#' followed by an
13799 id value) appended to the PDF filename can be used by
13800 the PDF viewer to open
13801 the PDF file to a location within the document instead of
13803 However, not all PDF files have id
13804 values embedded in them, and not all PDF viewers can
13805 handle fragment identifiers.
13808 <para>If <parameter>insert.olink.pdf.frag</parameter> is set
13809 to a non-zero value, then any olink targeting a
13810 PDF file will have the fragment identifier appended to the URI.
13811 The URI is formed by concatenating the value of the
13812 <parameter>olink.base.uri</parameter> parameter, the
13813 value of the <tag class="attribute">baseuri</tag>
13814 attribute from the <tag class="element">document</tag>
13815 element in the olink database with the matching
13816 <tag class="attribute">targetdoc</tag> value,
13817 and the value of the <tag class="attribute">href</tag>
13818 attribute for the targeted element in the olink database.
13819 The <tag class="attribute">href</tag> attribute
13820 contains the fragment identifier.
13823 <para>If <parameter>insert.olink.pdf.frag</parameter> is set
13824 to zero (the default value), then
13825 the <tag class="attribute">href</tag> attribute
13826 from the olink database
13827 is not appended to PDF olinks, so the fragment identifier is left off.
13828 A PDF olink is any olink for which the
13829 <tag class="attribute">baseuri</tag> attribute
13830 from the matching <tag class="element">document</tag>
13831 element in the olink database ends with '.pdf'.
13832 Any other olinks will still have the fragment identifier added.
13837 <refentry version="5.0" id="olink.base.uri">
13839 <refentrytitle>olink.base.uri</refentrytitle>
13840 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
13843 <refname>olink.base.uri</refname>
13844 <refpurpose>Base URI used in olink hrefs</refpurpose>
13846 <refsynopsisdiv> <programlisting id="olink.base.uri.frag">
13847 <xsl:param name="olink.base.uri"></xsl:param>
13850 <refsection><info><title>Description</title></info>
13852 <para>When cross reference data is collected for resolving olinks, it
13853 may be necessary to prepend a base URI to each target's href. This
13854 parameter lets you set that base URI when cross reference data is
13855 collected. This feature is needed when you want to link to a document
13856 that is processed without chunking. The output filename for such a
13857 document is not known to the XSL stylesheet; the only target
13858 information consists of fragment identifiers such as
13859 <literal>#idref</literal>. To enable the resolution of olinks between
13860 documents, you should pass the name of the HTML output file as the
13861 value of this parameter. Then the hrefs recorded in the cross
13862 reference data collection look like
13863 <literal>outfile.html#idref</literal>, which can be reached as links
13864 from other documents.</para>
13868 <refentry version="5.0" id="olink.debug">
13870 <refentrytitle>olink.debug</refentrytitle>
13871 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
13874 <refname>olink.debug</refname>
13875 <refpurpose>Turn on debugging messages for olinks</refpurpose>
13879 <programlisting id="olink.debug.frag">
13880 <xsl:param name="olink.debug" select="0"></xsl:param>
13884 <refsection><info><title>Description</title></info>
13886 <para>If non-zero, then each olink will generate several
13887 messages about how it is being resolved during processing.
13888 This is useful when an olink does not resolve properly
13889 and the standard error messages are not sufficient to
13893 <para>You may need to read through the olink XSL templates
13894 to understand the context for some of the debug messages.
13900 <refentry version="5.0" id="olink.doctitle">
13902 <refentrytitle>olink.doctitle</refentrytitle>
13903 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
13904 <refmiscinfo class="other" otherclass="value">no</refmiscinfo>
13905 <refmiscinfo class="other" otherclass="value">yes</refmiscinfo>
13906 <refmiscinfo class="other" otherclass="value">maybe</refmiscinfo>
13909 <refname>olink.doctitle</refname>
13910 <refpurpose>show the document title for external olinks?</refpurpose>
13913 <refsynopsisdiv> <programlisting id="olink.doctitle.frag">
13914 <xsl:param name="olink.doctitle">no</xsl:param>
13917 <refsection><info><title>Description</title></info>
13919 <para>When olinks between documents are resolved, the generated text
13920 may not make it clear that the reference is to another document.
13921 It is possible for the stylesheets to append the other document's
13922 title to external olinks. For this to happen, two parameters must
13926 <para>This <parameter>olink.doctitle</parameter> parameter
13927 should be set to either <literal>yes</literal> or <literal>maybe</literal>
13928 to enable this feature.
13932 <para>And you should also set the <parameter>current.docid</parameter>
13933 parameter to the document id for the document currently
13934 being processed for output.
13940 Then if an olink's <literal>targetdoc</literal> id differs from
13941 the <literal>current.docid</literal> value, the stylesheet knows
13942 that it is a reference to another document and can
13943 append the target document's
13944 title to the generated olink text. </para>
13946 <para>The text for the target document's title is copied from the
13947 olink database from the <tag>ttl</tag> element
13948 of the top-level <tag>div</tag> for that document.
13949 If that <tag>ttl</tag> element is missing or empty,
13950 no title is output.
13953 <para>The supported values for <parameter>olink.doctitle</parameter> are:
13957 <term><literal>yes</literal></term>
13960 Always insert the title to the target document if it is not
13961 the current document.
13966 <term><literal>no</literal></term>
13969 Never insert the title to the target document, even if requested
13970 in an <tag class="attribute">xrefstyle</tag> attribute.
13975 <term><literal>maybe</literal></term>
13978 Only insert the title to the target document, if requested
13979 in an <tag class="attribute">xrefstyle</tag> attribute.
13984 <para>An <tag class="attribute">xrefstyle</tag> attribute
13985 may override the global setting for individual olinks.
13986 The following values are supported in an
13987 <tag class="attribute">xrefstyle</tag>
13988 attribute using the <literal>select:</literal> syntax:
13993 <term><literal>docname</literal></term>
13996 Insert the target document name for this olink using the
13997 <literal>docname</literal> gentext template, but only
13998 if the value of <parameter>olink.doctitle</parameter>
13999 is not <literal>no</literal>.
14004 <term><literal>docnamelong</literal></term>
14007 Insert the target document name for this olink using the
14008 <literal>docnamelong</literal> gentext template, but only
14009 if the value of <parameter>olink.doctitle</parameter>
14010 is not <literal>no</literal>.
14015 <term><literal>nodocname</literal></term>
14018 Omit the target document name even if
14019 the value of <parameter>olink.doctitle</parameter>
14020 is <literal>yes</literal>.
14025 <para>Another way of inserting the target document name
14026 for a single olink is to employ an
14027 <tag class="attribute">xrefstyle</tag>
14028 attribute using the <literal>template:</literal> syntax.
14029 The <literal>%o</literal> placeholder (the letter o, not zero)
14031 will be filled in with the target document's title when it is processed.
14032 This will occur regardless of
14033 the value of <parameter>olink.doctitle</parameter>.
14035 <para>Note that prior to version 1.66 of the XSL stylesheets,
14036 the allowed values for this parameter were 0 and 1. Those
14037 values are still supported and mapped to 'no' and 'yes', respectively.
14042 <refentry version="5.0" id="olink.lang.fallback.sequence">
14044 <refentrytitle>olink.lang.fallback.sequence</refentrytitle>
14045 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
14048 <refname>olink.lang.fallback.sequence</refname>
14049 <refpurpose>look up translated documents if olink not found?</refpurpose>
14052 <refsynopsisdiv> <programlisting id="olink.lang.fallback.sequence.frag">
14053 <xsl:param name="olink.lang.fallback.sequence"></xsl:param>
14056 <refsection><info><title>Description</title></info>
14059 <para>This parameter defines a list of lang values
14060 to search among to resolve olinks.
14063 <para>Normally an olink tries to resolve to a document in the same
14064 language as the olink itself. The language of an olink
14065 is determined by its nearest ancestor element with a
14066 <tag class="attribute">lang</tag> attribute, otherwise the
14067 value of the <parameter>l10n.gentext.default.lang</parameter>
14071 <para>An olink database can contain target data for the same
14072 document in multiple languages. Each set of data has the
14073 same value for the <tag>targetdoc</tag> attribute in
14074 the <tag>document</tag> element in the database, but with a
14075 different <tag>lang</tag> attribute value.
14078 <para>When an olink is being resolved, the target is first
14079 sought in the document with the same language as the olink.
14080 If no match is found there, then this parameter is consulted
14081 for additional languages to try.</para>
14083 <para>The <parameter>olink.lang.fallback.sequence</parameter>
14084 must be a whitespace separated list of lang values to
14085 try. The first one with a match in the olink database is used.
14086 The default value is empty.</para>
14088 <para>For example, a document might be written in German
14089 and contain an olink with
14090 <literal>targetdoc="adminguide"</literal>.
14091 When the document is processed, the processor
14092 first looks for a target dataset in the
14093 olink database starting with:</para>
14095 <literallayout><literal><document targetdoc="adminguide" lang="de"></literal>.
14098 <para>If there is no such element, then the
14099 <parameter>olink.lang.fallback.sequence</parameter>
14100 parameter is consulted.
14101 If its value is, for example, <quote>fr en</quote>, then the processor next
14102 looks for <literal>targetdoc="adminguide" lang="fr"</literal>, and
14103 then for <literal>targetdoc="adminguide" lang="en"</literal>.
14104 If there is still no match, it looks for
14105 <literal>targetdoc="adminguide"</literal> with no
14109 <para>This parameter is useful when a set of documents is only
14110 partially translated, or is in the process of being translated.
14111 If a target of an olink has not yet been translated, then this
14112 parameter permits the processor to look for the document in
14113 other languages. This assumes the reader would rather have
14114 a link to a document in a different language than to have
14121 <refentry version="5.0" id="olink.properties">
14123 <refentrytitle>olink.properties</refentrytitle>
14124 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
14127 <refname>olink.properties</refname>
14128 <refpurpose>Properties associated with the cross-reference
14129 text of an olink.</refpurpose>
14133 <programlisting id="olink.properties.frag">
14134 <xsl:attribute-set name="olink.properties">
14135 <xsl:attribute name="show-destination">replace</xsl:attribute>
14136 </xsl:attribute-set>
14140 <refsection><info><title>Description</title></info>
14142 <para>This <literal>attribute set</literal> is applied to the
14143 <literal>fo:basic-link</literal> element of an olink. It is not applied to the
14144 optional page number or optional title of the external
14150 <refentry version="5.0" id="prefer.internal.olink">
14152 <refentrytitle>prefer.internal.olink</refentrytitle>
14153 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
14156 <refname>prefer.internal.olink</refname>
14157 <refpurpose>Prefer a local olink reference to an external reference</refpurpose>
14161 <programlisting id="prefer.internal.olink.frag">
14162 <xsl:param name="prefer.internal.olink" select="0"></xsl:param>
14166 <refsection><info><title>Description</title></info>
14168 <para>If you are re-using XML content modules in multiple documents,
14169 you may want to redirect some of your olinks. This parameter
14170 permits you to redirect an olink to the current document.
14173 <para>For example: you are writing documentation for a product,
14174 which includes 3 manuals: a little installation
14175 booklet (booklet.xml), a user
14176 guide (user.xml), and a reference manual (reference.xml).
14177 All 3 documents begin with the same introduction section (intro.xml) that
14178 contains a reference to the customization section (custom.xml) which is
14179 included in both user.xml and reference.xml documents.
14182 <para>How do you write the link to custom.xml in intro.xml
14183 so that it is interpreted correctly in all 3 documents?</para>
14185 <listitem><para>If you use xref, it will fail in user.xml.</para>
14187 <listitem><para>If you use olink (pointing to reference.xml),
14188 the reference in user.xml
14189 will point to the customization section of the reference manual, while it is
14190 actually available in user.xml.</para>
14194 <para>If you set the <parameter>prefer.internal.olink</parameter>
14195 parameter to a non-zero value, then the processor will
14196 first look in the olink database
14197 for the olink's <tag>targetptr</tag> attribute value
14198 in document matching the <parameter>current.docid</parameter>
14199 parameter value. If it isn't found there, then
14200 it tries the document in the database
14201 with the <tag>targetdoc</tag>
14202 value that matches the olink's <tag>targetdoc</tag>
14206 <para>This feature permits an olink reference to resolve to
14207 the current document if there is an element
14208 with an id matching the olink's <tag>targetptr</tag>
14209 value. The current document's olink data must be
14210 included in the target database for this to work.</para>
14213 <para>There is a potential for incorrect links if
14214 the same <tag>id</tag> attribute value is used for different
14215 content in different documents.
14216 Some of your olinks may be redirected to the current document
14217 when they shouldn't be. It is not possible to control
14218 individual olink instances.</para>
14224 <refentry version="5.0" id="target.database.document">
14226 <refentrytitle>target.database.document</refentrytitle>
14227 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
14230 <refname>target.database.document</refname>
14231 <refpurpose>Name of master database file for resolving
14232 olinks</refpurpose>
14235 <programlisting id="target.database.document.frag">
14236 <xsl:param name="target.database.document">olinkdb.xml</xsl:param>
14239 <refsection><info><title>Description</title></info>
14242 To resolve olinks between documents, the stylesheets use a master
14243 database document that identifies the target datafiles for all the
14244 documents within the scope of the olinks. This parameter value is the
14245 URI of the master document to be read during processing to resolve
14246 olinks. The default value is <filename>olinkdb.xml</filename>.</para>
14248 <para>The data structure of the file is defined in the
14249 <filename>targetdatabase.dtd</filename> DTD. The database file
14250 provides the high level elements to record the identifiers, locations,
14251 and relationships of documents. The cross reference data for
14252 individual documents is generally pulled into the database using
14253 system entity references or XIncludes. See also
14254 <parameter>targets.filename</parameter>. </para> </refsection>
14257 <refentry version="5.0" id="targets.filename">
14259 <refentrytitle>targets.filename</refentrytitle>
14260 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
14263 <refname>targets.filename</refname>
14264 <refpurpose>Name of cross reference targets data file</refpurpose>
14266 <refsynopsisdiv> <programlisting id="targets.filename.frag">
14267 <xsl:param name="targets.filename">target.db</xsl:param>
14270 <refsection><info><title>Description</title></info>
14273 In order to resolve olinks efficiently, the stylesheets can
14274 generate an external data file containing information about
14275 all potential cross reference endpoints in a document.
14276 This parameter lets you change the name of the generated
14277 file from the default name <filename>target.db</filename>.
14278 The name must agree with that used in the target database
14279 used to resolve olinks during processing.
14280 See also <parameter>target.database.document</parameter>.
14285 <refentry version="5.0" id="use.local.olink.style">
14287 <refentrytitle>use.local.olink.style</refentrytitle>
14288 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
14291 <refname>use.local.olink.style</refname>
14292 <refpurpose>Process olinks using xref style of current
14293 document</refpurpose>
14295 <refsynopsisdiv> <programlisting id="use.local.olink.style.frag">
14296 <xsl:param name="use.local.olink.style" select="0"></xsl:param> </programlisting>
14298 <refsection><info><title>Description</title></info>
14300 <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
14301 reference string is formed again from the target title, number, and
14302 element name, using the stylesheet processing the targeting document.
14303 Then olinks will match the xref style in the targeting document
14304 rather than in the target document. If both documents are processed
14305 with the same stylesheet, then the results will be the same.</para>
14309 </reference><reference id="xrefs" xml:base="../fo/param.xml"><title>Cross References</title>
14310 <refentry version="5.0" id="insert.xref.page.number">
14312 <refentrytitle>insert.xref.page.number</refentrytitle>
14313 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
14314 <refmiscinfo class="other" otherclass="value">no</refmiscinfo>
14315 <refmiscinfo class="other" otherclass="value">yes</refmiscinfo>
14316 <refmiscinfo class="other" otherclass="value">maybe</refmiscinfo>
14319 <refname>insert.xref.page.number</refname>
14320 <refpurpose>Turns page numbers in xrefs on and off</refpurpose>
14324 <programlisting id="insert.xref.page.number.frag">
14325 <xsl:param name="insert.xref.page.number">no</xsl:param>
14329 <refsection><info><title>Description</title></info>
14331 <para>The value of this parameter determines if
14332 cross references (<tag>xref</tag>s) in
14333 printed output will
14334 include page number citations.
14335 It has three possible values.
14340 <listitem><para>No page number references will be generated.
14345 <listitem><para>Page number references will be generated
14346 for all <tag>xref</tag> elements.
14347 The style of page reference may be changed
14348 if an <tag class="attribute">xrefstyle</tag>
14354 <listitem><para>Page number references will not be generated
14355 for an <tag>xref</tag> element unless
14357 <tag class="attribute">xrefstyle</tag>
14358 attribute whose value specifies a page reference.
14366 <refentry version="5.0" id="xref.properties">
14368 <refentrytitle>xref.properties</refentrytitle>
14369 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
14372 <refname>xref.properties</refname>
14373 <refpurpose>Properties associated with cross-reference text</refpurpose>
14377 <programlisting id="xref.properties.frag">
14378 <xsl:attribute-set name="xref.properties">
14379 </xsl:attribute-set>
14383 <refsection><info><title>Description</title></info>
14385 <para>This attribute set is used to set properties
14386 on cross reference text.</para>
14391 <refentry version="5.0" id="xref.label-title.separator">
14393 <refentrytitle>xref.label-title.separator</refentrytitle>
14394 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
14397 <refname>xref.label-title.separator</refname>
14398 <refpurpose>Punctuation or space separating label from title in xref</refpurpose>
14402 <programlisting id="xref.label-title.separator.frag"><xsl:param name="xref.label-title.separator">: </xsl:param></programlisting>
14405 <refsection><info><title>Description</title></info>
14408 This parameter allows you to control the punctuation of certain
14409 types of generated cross reference text.
14410 When cross reference text is generated for an
14411 <tag class="element">xref</tag> or
14412 <tag class="element">olink</tag> element
14413 using an <tag class="attribute">xrefstyle</tag> attribute
14414 that makes use of the <literal>select:</literal> feature,
14415 and the selected components include both label and title,
14416 then the value of this parameter is inserted between
14417 label and title in the output.
14423 <refentry version="5.0" id="xref.label-page.separator">
14425 <refentrytitle>xref.label-page.separator</refentrytitle>
14426 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
14429 <refname>xref.label-page.separator</refname>
14430 <refpurpose>Punctuation or space separating label from page number in xref</refpurpose>
14434 <programlisting id="xref.label-page.separator.frag"><xsl:param name="xref.label-page.separator"><xsl:text> </xsl:text></xsl:param></programlisting>
14437 <refsection><info><title>Description</title></info>
14440 This parameter allows you to control the punctuation of certain
14441 types of generated cross reference text.
14442 When cross reference text is generated for an
14443 <tag class="element">xref</tag> or
14444 <tag class="element">olink</tag> element
14445 using an <tag class="attribute">xrefstyle</tag> attribute
14446 that makes use of the <literal>select:</literal> feature,
14447 and the selected components include both label and page
14449 then the value of this parameter is inserted between
14450 label and page number in the output.
14451 If a title is included, then other separators are used.
14457 <refentry version="5.0" id="xref.title-page.separator">
14459 <refentrytitle>xref.title-page.separator</refentrytitle>
14460 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
14463 <refname>xref.title-page.separator</refname>
14464 <refpurpose>Punctuation or space separating title from page number in xref</refpurpose>
14468 <programlisting id="xref.title-page.separator.frag"><xsl:param name="xref.title-page.separator"><xsl:text> </xsl:text></xsl:param></programlisting>
14471 <refsection><info><title>Description</title></info>
14474 This parameter allows you to control the punctuation of certain
14475 types of generated cross reference text.
14476 When cross reference text is generated for an
14477 <tag class="element">xref</tag> or
14478 <tag class="element">olink</tag> element
14479 using an <tag class="attribute">xrefstyle</tag> attribute
14480 that makes use of the <literal>select:</literal> feature,
14481 and the selected components include both title and page number,
14482 then the value of this parameter is inserted between
14483 title and page number in the output.
14489 <refentry version="5.0" id="insert.link.page.number">
14491 <refentrytitle>insert.link.page.number</refentrytitle>
14492 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
14493 <refmiscinfo class="other" otherclass="value">no</refmiscinfo>
14494 <refmiscinfo class="other" otherclass="value">yes</refmiscinfo>
14495 <refmiscinfo class="other" otherclass="value">maybe</refmiscinfo>
14498 <refname>insert.link.page.number</refname>
14499 <refpurpose>Turns page numbers in link elements on and off</refpurpose>
14503 <programlisting id="insert.link.page.number.frag">
14504 <xsl:param name="insert.link.page.number">no</xsl:param>
14508 <refsection><info><title>Description</title></info>
14510 <para>The value of this parameter determines if
14511 cross references using the <tag>link</tag> element in
14512 printed output will
14513 include standard page number citations.
14514 It has three possible values.
14519 <listitem><para>No page number references will be generated.
14524 <listitem><para>Page number references will be generated
14525 for all <tag>link</tag> elements.
14526 The style of page reference may be changed
14527 if an <tag class="attribute">xrefstyle</tag>
14533 <listitem><para>Page number references will not be generated
14534 for a <tag>link</tag> element unless
14536 <tag class="attribute">xrefstyle</tag>
14537 attribute whose value specifies a page reference.
14542 <para>Although the <tag>xrefstyle</tag> attribute
14543 can be used to turn the page reference on or off, it cannot be
14544 used to control the formatting of the page number as it
14545 can in <tag>xref</tag>.
14546 In <tag>link</tag> it will always format with
14547 the style established by the
14548 gentext template with <literal>name="page.citation"</literal>
14549 in the <literal>l:context name="xref"</literal>.
14554 </reference><reference id="lists" xml:base="../fo/param.xml"><title>Lists</title>
14555 <refentry version="5.0" id="compact.list.item.spacing">
14557 <refentrytitle>compact.list.item.spacing</refentrytitle>
14558 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
14561 <refname>compact.list.item.spacing</refname>
14562 <refpurpose>What space do you want between list items (when spacing="compact")?</refpurpose>
14566 <programlisting id="compact.list.item.spacing.frag"><xsl:attribute-set name="compact.list.item.spacing">
14567 <xsl:attribute name="space-before.optimum">0em</xsl:attribute>
14568 <xsl:attribute name="space-before.minimum">0em</xsl:attribute>
14569 <xsl:attribute name="space-before.maximum">0.2em</xsl:attribute>
14570 </xsl:attribute-set></programlisting>
14572 <refsection><info><title>Description</title></info>
14573 <para>Specify what spacing you want between each list item when
14574 <tag class="attribute">spacing</tag> is
14575 <quote><literal>compact</literal></quote>.</para>
14579 <refentry version="5.0" id="itemizedlist.properties">
14581 <refentrytitle>itemizedlist.properties</refentrytitle>
14582 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
14585 <refname>itemizedlist.properties</refname>
14586 <refpurpose>Properties that apply to each list-block generated by itemizedlist.</refpurpose>
14590 <programlisting id="itemizedlist.properties.frag"><xsl:attribute-set name="itemizedlist.properties" use-attribute-sets="list.block.properties">
14591 </xsl:attribute-set></programlisting>
14593 <refsection><info><title>Description</title></info>
14594 <para>Properties that apply to each fo:list-block generated by itemizedlist.</para>
14598 <refentry version="5.0" id="itemizedlist.label.properties">
14600 <refentrytitle>itemizedlist.label.properties</refentrytitle>
14601 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
14604 <refname>itemizedlist.label.properties</refname>
14605 <refpurpose>Properties that apply to each label inside itemized list.</refpurpose>
14609 <programlisting id="itemizedlist.label.properties.frag"><xsl:attribute-set name="itemizedlist.label.properties">
14610 </xsl:attribute-set></programlisting>
14612 <refsection><info><title>Description</title></info>
14613 <para>Properties that apply to each label inside itemized list. E.g.:</para>
14614 <programlisting><xsl:attribute-set name="itemizedlist.label.properties">
14615 <xsl:attribute name="text-align">right</xsl:attribute>
14616 </xsl:attribute-set></programlisting>
14620 <refentry version="5.0" id="itemizedlist.label.width">
14622 <refentrytitle>itemizedlist.label.width</refentrytitle>
14623 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
14626 <refname>itemizedlist.label.width</refname>
14627 <refpurpose>The default width of the label (bullet) in an itemized list.</refpurpose>
14631 <programlisting id="itemizedlist.label.width.frag">
14632 <xsl:param name="itemizedlist.label.width">1.0em</xsl:param>
14636 <refsection><info><title>Description</title></info>
14637 <para>Specifies the default width of the label (usually a bullet or other
14638 symbol) in an itemized list. You can override the default value on any
14639 particular list with the “dbfo” processing instruction using the
14640 “label-width” pseudoattribute.</para>
14644 <refentry version="5.0" id="list.block.properties">
14646 <refentrytitle>list.block.properties</refentrytitle>
14647 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
14650 <refname>list.block.properties</refname>
14651 <refpurpose>Properties that apply to each list-block generated by list.</refpurpose>
14655 <programlisting id="list.block.properties.frag"><xsl:attribute-set name="list.block.properties">
14656 <xsl:attribute name="provisional-label-separation">0.2em</xsl:attribute>
14657 <xsl:attribute name="provisional-distance-between-starts">1.5em</xsl:attribute>
14658 </xsl:attribute-set></programlisting>
14660 <refsection><info><title>Description</title></info>
14661 <para>Properties that apply to each fo:list-block generated by itemizedlist/orderedlist.</para>
14665 <refentry version="5.0" id="list.block.spacing">
14667 <refentrytitle>list.block.spacing</refentrytitle>
14668 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
14671 <refname>list.block.spacing</refname>
14672 <refpurpose>What spacing do you want before and after lists?</refpurpose>
14676 <programlisting id="list.block.spacing.frag"><xsl:attribute-set name="list.block.spacing">
14677 <xsl:attribute name="space-before.optimum">1em</xsl:attribute>
14678 <xsl:attribute name="space-before.minimum">0.8em</xsl:attribute>
14679 <xsl:attribute name="space-before.maximum">1.2em</xsl:attribute>
14680 <xsl:attribute name="space-after.optimum">1em</xsl:attribute>
14681 <xsl:attribute name="space-after.minimum">0.8em</xsl:attribute>
14682 <xsl:attribute name="space-after.maximum">1.2em</xsl:attribute>
14683 </xsl:attribute-set></programlisting>
14685 <refsection><info><title>Description</title></info>
14686 <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>
14690 <refentry version="5.0" id="list.item.spacing">
14692 <refentrytitle>list.item.spacing</refentrytitle>
14693 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
14696 <refname>list.item.spacing</refname>
14697 <refpurpose>What space do you want between list items?</refpurpose>
14701 <programlisting id="list.item.spacing.frag"><xsl:attribute-set name="list.item.spacing">
14702 <xsl:attribute name="space-before.optimum">1em</xsl:attribute>
14703 <xsl:attribute name="space-before.minimum">0.8em</xsl:attribute>
14704 <xsl:attribute name="space-before.maximum">1.2em</xsl:attribute>
14705 </xsl:attribute-set></programlisting>
14707 <refsection><info><title>Description</title></info>
14708 <para>Specify what spacing you want between each list item.</para>
14712 <refentry version="5.0" id="orderedlist.properties">
14714 <refentrytitle>orderedlist.properties</refentrytitle>
14715 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
14718 <refname>orderedlist.properties</refname>
14719 <refpurpose>Properties that apply to each list-block generated by orderedlist.</refpurpose>
14723 <programlisting id="orderedlist.properties.frag"><xsl:attribute-set name="orderedlist.properties" use-attribute-sets="list.block.properties">
14724 <xsl:attribute name="provisional-distance-between-starts">2em</xsl:attribute>
14725 </xsl:attribute-set></programlisting>
14727 <refsection><info><title>Description</title></info>
14728 <para>Properties that apply to each fo:list-block generated by orderedlist.</para>
14732 <refentry version="5.0" id="orderedlist.label.properties">
14734 <refentrytitle>orderedlist.label.properties</refentrytitle>
14735 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
14738 <refname>orderedlist.label.properties</refname>
14739 <refpurpose>Properties that apply to each label inside ordered list.</refpurpose>
14743 <programlisting id="orderedlist.label.properties.frag"><xsl:attribute-set name="orderedlist.label.properties">
14744 </xsl:attribute-set></programlisting>
14746 <refsection><info><title>Description</title></info>
14747 <para>Properties that apply to each label inside ordered list. E.g.:</para>
14748 <programlisting><xsl:attribute-set name="orderedlist.label.properties">
14749 <xsl:attribute name="text-align">right</xsl:attribute>
14750 </xsl:attribute-set></programlisting>
14754 <refentry version="5.0" id="orderedlist.label.width">
14756 <refentrytitle>orderedlist.label.width</refentrytitle>
14757 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
14760 <refname>orderedlist.label.width</refname>
14761 <refpurpose>The default width of the label (number) in an ordered list.</refpurpose>
14765 <programlisting id="orderedlist.label.width.frag">
14766 <xsl:param name="orderedlist.label.width">1.2em</xsl:param>
14770 <refsection><info><title>Description</title></info>
14771 <para>Specifies the default width of the label (usually a number or
14772 sequence of numbers) in an ordered list. You can override the default
14773 value on any particular list with the “dbfo” processing instruction
14774 using the “label-width” pseudoattribute.</para>
14778 <refentry version="5.0" id="variablelist.max.termlength">
14780 <refentrytitle>variablelist.max.termlength</refentrytitle>
14781 <refmiscinfo class="other" otherclass="datatype">number</refmiscinfo>
14784 <refname>variablelist.max.termlength</refname>
14785 <refpurpose>Specifies the longest term in variablelists</refpurpose>
14789 <programlisting id="variablelist.max.termlength.frag">
14790 <xsl:param name="variablelist.max.termlength">24</xsl:param>
14794 <refsection><info><title>Description</title></info>
14796 <para>In variablelists, the <tag>listitem</tag>
14797 is indented to leave room for the
14798 <tag>term</tag> elements. That indent may be computed
14799 if it is not specified with a <tag class="attribute">termlength</tag>
14800 attribute on the <tag>variablelist</tag> element.
14803 The computation counts characters in the
14804 <tag>term</tag> elements in the list
14805 to find the longest term. However, some terms are very long
14806 and would produce extreme indents. This parameter lets you
14807 set a maximum character count. Any terms longer than the maximum
14808 would line wrap. The default value is 24.
14811 The character counts are converted to physical widths
14812 by multiplying by 0.50em. There will be some variability
14813 in how many actual characters fit in the space
14814 since some characters are wider than others.
14820 <refentry version="5.0" id="variablelist.term.separator">
14822 <refentrytitle>variablelist.term.separator</refentrytitle>
14823 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
14826 <refname>variablelist.term.separator</refname>
14827 <refpurpose>Text to separate <tag>term</tag>s within a multi-term
14828 <tag>varlistentry</tag></refpurpose>
14832 <programlisting id="variablelist.term.separator.frag">
14833 <xsl:param name="variablelist.term.separator">, </xsl:param></programlisting>
14836 <refsection><info><title>Description</title></info>
14838 <para>When a <tag>varlistentry</tag> contains multiple <tag>term</tag>
14839 elements, the string specified in the value of the
14840 <parameter>variablelist.term.separator</parameter> parameter is placed
14841 after each <tag>term</tag> except the last.</para>
14844 <para>To generate a line break between multiple <tag>term</tag>s in
14845 a <tag>varlistentry</tag>, set a non-zero value for the
14846 <parameter>variablelist.term.break.after</parameter> parameter. If
14847 you do so, you may also want to set the value of the
14848 <parameter>variablelist.term.separator</parameter> parameter to an
14849 empty string (to suppress rendering of the default comma and space
14850 after each <tag>term</tag>).</para>
14856 <refentry version="5.0" id="variablelist.term.properties">
14858 <refentrytitle>variablelist.term.properties</refentrytitle>
14859 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
14862 <refname>variablelist.term.properties</refname>
14863 <refpurpose>To add properties to the term elements in a variablelist.</refpurpose>
14867 <programlisting id="variablelist.term.properties.frag">
14868 <xsl:attribute-set name="variablelist.term.properties">
14869 </xsl:attribute-set>
14872 <refsection><info><title>Description</title></info>
14873 <para>These properties are added to the block containing a
14874 term in a variablelist.
14875 Use this attribute-set to set
14876 font properties or alignment, for example.</para>
14881 <refentry version="5.0" id="variablelist.term.break.after">
14883 <refentrytitle>variablelist.term.break.after</refentrytitle>
14884 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
14887 <refname>variablelist.term.break.after</refname>
14888 <refpurpose>Generate line break after each <tag>term</tag> within a
14889 multi-term <tag>varlistentry</tag>?</refpurpose>
14893 <programlisting id="variablelist.term.break.after.frag">
14894 <xsl:param name="variablelist.term.break.after">0</xsl:param></programlisting>
14897 <refsection><info><title>Description</title></info>
14899 <para>Set a non-zero value for the
14900 <parameter>variablelist.term.break.after</parameter> parameter to
14901 generate a line break between <tag>term</tag>s in a
14902 multi-term <tag>varlistentry</tag>.</para>
14905 <para>If you set a non-zero value for
14906 <parameter>variablelist.term.break.after</parameter>, you may also
14907 want to set the value of the
14908 <parameter>variablelist.term.separator</parameter> parameter to an
14909 empty string (to suppress rendering of the default comma and space
14910 after each <tag>term</tag>).</para>
14916 </reference><reference id="qa" xml:base="../fo/param.xml"><title>QAndASet</title>
14917 <refentry version="5.0" id="qandadiv.autolabel">
14919 <refentrytitle>qandadiv.autolabel</refentrytitle>
14920 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
14923 <refname>qandadiv.autolabel</refname>
14924 <refpurpose>Are divisions in QAndASets enumerated?</refpurpose>
14928 <programlisting id="qandadiv.autolabel.frag"><xsl:param name="qandadiv.autolabel" select="1"></xsl:param></programlisting>
14931 <refsection><info><title>Description</title></info>
14933 <para>If non-zero, unlabeled qandadivs will be enumerated.
14939 <refentry version="5.0" id="qanda.inherit.numeration">
14941 <refentrytitle>qanda.inherit.numeration</refentrytitle>
14942 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
14945 <refname>qanda.inherit.numeration</refname>
14946 <refpurpose>Does enumeration of QandASet components inherit the numeration of parent elements?</refpurpose>
14950 <programlisting id="qanda.inherit.numeration.frag">
14951 <xsl:param name="qanda.inherit.numeration" select="1"></xsl:param>
14955 <refsection><info><title>Description</title></info>
14957 <para>If non-zero, numbered <tag>qandadiv</tag> elements and
14958 <tag>question</tag> and <tag>answer</tag> inherit the enumeration of
14959 the ancestors of the <tag>qandaset</tag>.
14965 <refentry version="5.0" id="qanda.defaultlabel">
14967 <refentrytitle>qanda.defaultlabel</refentrytitle>
14968 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
14969 <refmiscinfo class="other" otherclass="value">number</refmiscinfo>
14970 <refmiscinfo class="other" otherclass="value">qanda</refmiscinfo>
14971 <refmiscinfo class="other" otherclass="value">none</refmiscinfo>
14974 <refname>qanda.defaultlabel</refname>
14975 <refpurpose>Sets the default for defaultlabel on QandASet.</refpurpose>
14979 <programlisting id="qanda.defaultlabel.frag">
14980 <xsl:param name="qanda.defaultlabel">number</xsl:param>
14984 <refsection><info><title>Description</title></info>
14986 <para>If no <literal>defaultlabel</literal> attribute is specified on
14987 a <tag>qandaset</tag>, this value is used. It is generally one of the legal
14988 values for the defaultlabel attribute (<literal>none</literal>,
14989 <literal>number</literal> or
14990 <literal>qanda</literal>), or one of the additional stylesheet-specific values
14991 (<literal>qnumber</literal> or <literal>qnumberanda</literal>).
14992 The default value is 'number'.
14994 <para>The values are rendered as follows:</para>
14996 <varlistentry><term><literal>qanda</literal></term>
14998 <para><tag>question</tag>s are labeled "Q:" and
14999 <tag>answer</tag>s are labeled "A:". </para>
15003 <varlistentry><term><literal>number</literal></term>
15005 <para>The questions are enumerated and the answers
15006 are not labeled. </para>
15010 <varlistentry><term><literal>qnumber</literal></term>
15012 <para>The questions are labeled "Q:" followed by a number, and answers are not
15014 When sections are numbered, adding a label
15015 to the number distinguishes the question numbers
15016 from the section numbers.
15017 This value is not allowed in the
15018 <tag class="attribute">defaultlabel</tag> attribute
15019 of a <tag>qandaset</tag> element.</para>
15023 <varlistentry><term><literal>qnumberanda</literal></term>
15025 <para>The questions are labeled "Q:" followed by a number, and
15026 the answers are labeled "A:".
15027 When sections are numbered, adding a label
15028 to the number distinguishes the question numbers
15029 from the section numbers.
15030 This value is not allowed in the
15031 <tag class="attribute">defaultlabel</tag> attribute
15032 of a <tag>qandaset</tag> element.</para>
15036 <varlistentry><term><literal>none</literal></term>
15038 <para>No distinguishing label precedes Questions or Answers.
15047 <refentry version="5.0" id="qanda.in.toc">
15049 <refentrytitle>qanda.in.toc</refentrytitle>
15050 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
15053 <refname>qanda.in.toc</refname>
15054 <refpurpose>Should qandaentry questions appear in
15055 the document table of contents?</refpurpose>
15059 <programlisting id="qanda.in.toc.frag"><xsl:param name="qanda.in.toc" select="0"></xsl:param></programlisting>
15062 <refsection><info><title>Description</title></info>
15064 <para>If true (non-zero), then the generated table of contents
15065 for a document will include <tag>qandaset</tag> titles,
15066 <tag>qandadiv</tag> titles,
15067 and <tag>question</tag> elements. The default value (zero) excludes
15070 <para>This parameter does not affect any tables of contents
15071 that may be generated inside a qandaset or qandadiv.
15077 <refentry version="5.0" id="qanda.nested.in.toc">
15079 <refentrytitle>qanda.nested.in.toc</refentrytitle>
15080 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
15083 <refname>qanda.nested.in.toc</refname>
15084 <refpurpose>Should nested answer/qandaentry instances appear in TOC?</refpurpose>
15088 <programlisting id="qanda.nested.in.toc.frag">
15089 <xsl:param name="qanda.nested.in.toc" select="0"></xsl:param>
15093 <refsection><info><title>Description</title></info>
15095 <para>If non-zero, instances of <tag>qandaentry</tag>
15096 that are children of <tag>answer</tag> elements are shown in
15102 </reference><reference id="biblio" xml:base="../fo/param.xml"><title>Bibliography</title>
15103 <refentry version="5.0" id="bibliography.style">
15105 <refentrytitle>bibliography.style</refentrytitle>
15106 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
15107 <refmiscinfo class="other" otherclass="value">normal</refmiscinfo>
15108 <refmiscinfo class="other" otherclass="value">iso690</refmiscinfo>
15111 <refname>bibliography.style</refname>
15112 <refpurpose>Style used for formatting of biblioentries.</refpurpose>
15116 <programlisting id="bibliography.style.frag">
15117 <xsl:param name="bibliography.style">normal</xsl:param>
15121 <refsection><info><title>Description</title></info>
15123 <para>Currently only <literal>normal</literal> and
15124 <literal>iso690</literal> styles are supported.</para>
15126 <para>In order to use ISO690 style to the full extent you might need
15127 to use additional markup described on <link xlink:href="http://wiki.docbook.org/topic/ISO690Bibliography">the
15128 following WiKi page</link>.</para>
15133 <refentry version="5.0" id="biblioentry.item.separator">
15135 <refentrytitle>biblioentry.item.separator</refentrytitle>
15136 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
15139 <refname>biblioentry.item.separator</refname>
15140 <refpurpose>Text to separate bibliography entries</refpurpose>
15144 <programlisting id="biblioentry.item.separator.frag"><xsl:param name="biblioentry.item.separator">. </xsl:param></programlisting>
15147 <refsection><info><title>Description</title></info>
15149 <para>Text to separate bibliography entries
15155 <refentry version="5.0" id="bibliography.collection">
15157 <refentrytitle>bibliography.collection</refentrytitle>
15158 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
15161 <refname>bibliography.collection</refname>
15162 <refpurpose>Name of the bibliography collection file</refpurpose>
15166 <programlisting id="bibliography.collection.frag">
15167 <xsl:param name="bibliography.collection">http://docbook.sourceforge.net/release/bibliography/bibliography.xml</xsl:param>
15172 <refsection><info><title>Description</title></info>
15174 <para>Maintaining bibliography entries across a set of documents is tedious, time
15175 consuming, and error prone. It makes much more sense, usually, to store all of
15176 the bibliography entries in a single place and simply <quote>extract</quote>
15177 the ones you need in each document.</para>
15179 <para>That's the purpose of the
15180 <parameter>bibliography.collection</parameter> parameter. To setup a global
15181 bibliography <quote>database</quote>, follow these steps:</para>
15183 <para>First, create a stand-alone bibliography document that contains all of
15184 the documents that you wish to reference. Make sure that each bibliography
15185 entry (whether you use <tag>biblioentry</tag> or <tag>bibliomixed</tag>)
15188 <para>My global bibliography, <filename>~/bibliography.xml</filename> begins
15192 <programlisting><!DOCTYPE bibliography
15193 PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
15194 "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
15195 <bibliography><title>References</title>
15197 <bibliomixed id="xml-rec"><abbrev>XML 1.0</abbrev>Tim Bray,
15198 Jean Paoli, C. M. Sperberg-McQueen, and Eve Maler, editors.
15199 <citetitle><ulink url="http://www.w3.org/TR/REC-xml">Extensible Markup
15200 Language (XML) 1.0 Second Edition</ulink></citetitle>.
15201 World Wide Web Consortium, 2000.
15202 </bibliomixed>
15204 <bibliomixed id="xml-names"><abbrev>Namespaces</abbrev>Tim Bray,
15206 and Andrew Layman, editors.
15207 <citetitle><ulink url="http://www.w3.org/TR/REC-xml-names/">Namespaces in
15208 XML</ulink></citetitle>.
15209 World Wide Web Consortium, 1999.
15210 </bibliomixed>
15213 </bibliography>
15217 <para>When you create a bibliography in your document, simply
15218 provide <emphasis>empty</emphasis> <tag>bibliomixed</tag>
15219 entries for each document that you wish to cite. Make sure that these
15220 elements have the same ID as the corresponding <quote>real</quote>
15221 entry in your global bibliography.</para>
15223 <para>For example:</para>
15226 <programlisting><bibliography><title>Bibliography</title>
15228 <bibliomixed id="xml-rec"/>
15229 <bibliomixed id="xml-names"/>
15230 <bibliomixed id="DKnuth86">Donald E. Knuth. <citetitle>Computers and
15231 Typesetting: Volume B, TeX: The Program</citetitle>. Addison-Wesley,
15232 1986. ISBN 0-201-13437-3.
15233 </bibliomixed>
15234 <bibliomixed id="relaxng"/>
15236 </bibliography></programlisting>
15239 <para>Note that it's perfectly acceptable to mix entries from your
15240 global bibliography with <quote>normal</quote> entries. You can use
15241 <tag>xref</tag> or other elements to cross-reference your
15242 bibliography entries in exactly the same way you do now.</para>
15244 <para>Finally, when you are ready to format your document, simply set the
15245 <parameter>bibliography.collection</parameter> parameter (in either a
15246 customization layer or directly through your processor's interface) to
15247 point to your global bibliography.</para>
15249 <para>The stylesheets will format the bibliography in your document as if
15250 all of the entries referenced appeared there literally.</para>
15255 <refentry version="5.0" id="bibliography.numbered">
15257 <refentrytitle>bibliography.numbered</refentrytitle>
15258 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
15261 <refname>bibliography.numbered</refname>
15262 <refpurpose>Should bibliography entries be numbered?</refpurpose>
15266 <programlisting id="bibliography.numbered.frag">
15267 <xsl:param name="bibliography.numbered" select="0"></xsl:param>
15271 <refsection><info><title>Description</title></info>
15273 <para>If non-zero bibliography entries will be numbered</para>
15278 <refentry version="5.0" id="biblioentry.properties">
15280 <refentrytitle>biblioentry.properties</refentrytitle>
15281 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
15284 <refname>biblioentry.properties</refname>
15285 <refpurpose>To set the style for biblioentry.</refpurpose>
15289 <programlisting id="biblioentry.properties.frag"><xsl:attribute-set name="biblioentry.properties" use-attribute-sets="normal.para.spacing">
15290 <xsl:attribute name="start-indent">0.5in</xsl:attribute>
15291 <xsl:attribute name="text-indent">-0.5in</xsl:attribute>
15292 </xsl:attribute-set>
15295 <refsection><info><title>Description</title></info>
15296 <para>How do you want biblioentry styled? </para>
15297 <para>Set the font-size, weight, space-above and space-below, indents, etc. to the style required</para>
15302 </reference><reference id="glossary" xml:base="../fo/param.xml"><title>Glossary</title>
15303 <refentry version="5.0" id="glossterm.auto.link">
15305 <refentrytitle>glossterm.auto.link</refentrytitle>
15306 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
15309 <refname>glossterm.auto.link</refname>
15310 <refpurpose>Generate links from glossterm to glossentry automatically?</refpurpose>
15314 <programlisting id="glossterm.auto.link.frag">
15315 <xsl:param name="glossterm.auto.link" select="0"></xsl:param>
15319 <refsection><info><title>Description</title></info>
15321 <para>If non-zero, links from inline <tag>glossterm</tag>s to the corresponding
15322 <tag>glossentry</tag> elements in a <tag>glossary</tag> or <tag>glosslist</tag>
15323 will be automatically generated. This is useful when your glossterms are consistent
15324 and you don't want to add links manually.</para>
15326 <para>The automatic link generation feature is not used on <tag>glossterm</tag> elements
15327 that have a <tag class="attribute">linkend</tag> attribute.</para>
15332 <refentry version="5.0" id="firstterm.only.link">
15334 <refentrytitle>firstterm.only.link</refentrytitle>
15335 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
15338 <refname>firstterm.only.link</refname>
15339 <refpurpose>Does automatic glossterm linking only apply to firstterms?</refpurpose>
15343 <programlisting id="firstterm.only.link.frag">
15344 <xsl:param name="firstterm.only.link" select="0"></xsl:param>
15348 <refsection><info><title>Description</title></info>
15350 <para>If non-zero, only <tag>firstterm</tag>s will be automatically linked
15351 to the glossary. If glossary linking is not enabled, this parameter
15352 has no effect.</para>
15357 <refentry version="5.0" id="glossary.collection">
15359 <refentrytitle>glossary.collection</refentrytitle>
15360 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
15363 <refname>glossary.collection</refname>
15364 <refpurpose>Name of the glossary collection file</refpurpose>
15368 <programlisting id="glossary.collection.frag">
15369 <xsl:param name="glossary.collection"></xsl:param>
15373 <refsection><info><title>Description</title></info>
15375 <para>Glossaries maintained independently across a set of documents
15376 are likely to become inconsistent unless considerable effort is
15377 expended to keep them in sync. It makes much more sense, usually, to
15378 store all of the glossary entries in a single place and simply
15379 <quote>extract</quote> the ones you need in each document.</para>
15381 <para>That's the purpose of the
15382 <parameter>glossary.collection</parameter> parameter. To setup a global
15383 glossary <quote>database</quote>, follow these steps:</para>
15385 <refsection><info><title>Setting Up the Glossary Database</title></info>
15387 <para>First, create a stand-alone glossary document that contains all of
15388 the entries that you wish to reference. Make sure that each glossary
15389 entry has an ID.</para>
15391 <para>Here's an example glossary:</para>
15395 <?xml version="1.0" encoding="utf-8"?>
15396 <!DOCTYPE glossary
15397 PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
15398 "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
15400 <glossaryinfo>
15401 <editor><firstname>Eric</firstname><surname>Raymond</surname></editor>
15402 <title>Jargon File 4.2.3 (abridged)</title>
15403 <releaseinfo>Just some test data</releaseinfo>
15404 </glossaryinfo>
15406 <glossdiv><title>0</title>
15409 <glossterm>0</glossterm>
15411 <para>Numeric zero, as opposed to the letter `O' (the 15th letter of
15412 the English alphabet). In their unmodified forms they look a lot
15413 alike, and various kluges invented to make them visually distinct have
15414 compounded the confusion. If your zero is center-dotted and letter-O
15415 is not, or if letter-O looks almost rectangular but zero looks more
15416 like an American football stood on end (or the reverse), you're
15417 probably looking at a modern character display (though the dotted zero
15418 seems to have originated as an option on IBM 3270 controllers). If
15419 your zero is slashed but letter-O is not, you're probably looking at
15420 an old-style ASCII graphic set descended from the default typewheel on
15421 the venerable ASR-33 Teletype (Scandinavians, for whom /O is a letter,
15422 curse this arrangement). (Interestingly, the slashed zero long
15423 predates computers; Florian Cajori's monumental "A History of
15424 Mathematical Notations" notes that it was used in the twelfth and
15425 thirteenth centuries.) If letter-O has a slash across it and the zero
15426 does not, your display is tuned for a very old convention used at IBM
15427 and a few other early mainframe makers (Scandinavians curse <emphasis>this</emphasis>
15428 arrangement even more, because it means two of their letters collide).
15429 Some Burroughs/Unisys equipment displays a zero with a <emphasis>reversed</emphasis>
15430 slash. Old CDC computers rendered letter O as an unbroken oval and 0
15431 as an oval broken at upper right and lower left. And yet another
15432 convention common on early line printers left zero unornamented but
15433 added a tail or hook to the letter-O so that it resembled an inverted
15434 Q or cursive capital letter-O (this was endorsed by a draft ANSI
15435 standard for how to draw ASCII characters, but the final standard
15436 changed the distinguisher to a tick-mark in the upper-left corner).
15437 Are we sufficiently confused yet?</para>
15439 </glossentry>
15442 <glossterm>1TBS</glossterm>
15444 <para role="accidence">
15445 <phrase role="pronounce"></phrase>
15446 <phrase role="partsofspeach">n</phrase>
15448 <para>The "One True Brace Style"</para>
15449 <glossseealso>indent style</glossseealso>
15451 </glossentry>
15459 </glossary></programlisting>
15464 <refsection><info><title>Marking Up Glossary Terms</title></info>
15466 <para>That takes care of the glossary database, now you have to get the entries
15467 into your document. Unlike bibliography entries, which can be empty, creating
15468 <quote>placeholder</quote> glossary entries would be very tedious. So instead,
15469 support for <parameter>glossary.collection</parameter> relies on implicit linking.</para>
15471 <para>In your source document, simply use <tag>firstterm</tag> and
15472 <tag>glossterm</tag> to identify the terms you wish to have included
15473 in the glossary. The stylesheets assume that you will either set the
15474 <tag class="attribute">baseform</tag> attribute correctly, or that the
15475 content of the element exactly matches a term in your glossary.</para>
15477 <para>If you're using a <parameter>glossary.collection</parameter>, don't
15478 make explicit links on the terms in your document.</para>
15480 <para>So, in your document, you might write things like this:</para>
15483 <programlisting><para>This is dummy text, without any real meaning.
15484 The point is simply to reference glossary terms like <glossterm>0</glossterm>
15485 and the <firstterm baseform="1TBS">One True Brace Style (1TBS)</firstterm>.
15486 The <glossterm>1TBS</glossterm>, as you can probably imagine, is a nearly
15487 religious issue.</para></programlisting>
15490 <para>If you set the <parameter>firstterm.only.link</parameter> parameter,
15491 only the terms marked with <tag>firstterm</tag> will be links.
15492 Otherwise, all the terms will be linked.</para>
15496 <refsection><info><title>Marking Up the Glossary</title></info>
15498 <para>The glossary itself has to be identified for the stylesheets. For lack
15499 of a better choice, the <tag class="attribute">role</tag> is used.
15500 To identify the glossary as the target for automatic processing, set
15501 the role to <quote><literal>auto</literal></quote>. The title of this
15502 glossary (and any other information from the <tag>glossaryinfo</tag>
15503 that's rendered by your stylesheet) will be displayed, but the entries will
15504 come from the database.
15507 <para>Unfortunately, the glossary can't be empty, so you must put in
15508 at least one <tag>glossentry</tag>. The content of this entry
15509 is irrelevant, it will not be rendered:</para>
15512 <programlisting><glossary role="auto">
15514 <glossterm>Irrelevant</glossterm>
15516 <para>If you can see this, the document was processed incorrectly. Use
15517 the <parameter>glossary.collection</parameter> parameter.</para>
15519 </glossentry>
15520 </glossary></programlisting>
15523 <para>What about glossary divisions? If your glossary database has glossary
15524 divisions <emphasis>and</emphasis> your automatic glossary contains at least
15525 one <tag>glossdiv</tag>, the automic glossary will have divisions.
15526 If the <tag>glossdiv</tag> is missing from either location, no divisions
15527 will be rendered.</para>
15529 <para>Glossary entries (and divisions, if appropriate) in the glossary will
15530 occur in precisely the order they occur in your database.</para>
15534 <refsection><info><title>Formatting the Document</title></info>
15536 <para>Finally, when you are ready to format your document, simply set the
15537 <parameter>glossary.collection</parameter> parameter (in either a
15538 customization layer or directly through your processor's interface) to
15539 point to your global glossary.</para>
15541 <para>The stylesheets will format the glossary in your document as if
15542 all of the entries implicilty referenced appeared there literally.</para>
15545 <refsection><info><title>Limitations</title></info>
15547 <para>Glossary cross-references <emphasis>within the glossary</emphasis> are
15548 not supported. For example, this <emphasis>will not</emphasis> work:</para>
15551 <programlisting><glossentry>
15552 <glossterm>gloss-1</glossterm>
15553 <glossdef><para>A description that references <glossterm>gloss-2</glossterm>.</para>
15554 <glossseealso>gloss-2</glossseealso>
15556 </glossentry></programlisting>
15559 <para>If you put glossary cross-references in your glossary that way,
15560 you'll get the cryptic error: <computeroutput>Warning:
15561 glossary.collection specified, but there are 0 automatic
15562 glossaries</computeroutput>.</para>
15564 <para>Instead, you must do two things:</para>
15568 <para>Markup your glossary using <tag>glossseealso</tag>:</para>
15571 <programlisting><glossentry>
15572 <glossterm>gloss-1</glossterm>
15573 <glossdef><para>A description that references <glossterm>gloss-2</glossterm>.</para>
15574 <glossseealso>gloss-2</glossseealso>
15576 </glossentry></programlisting>
15581 <para>Make sure there is at least one <tag>glossterm</tag> reference to
15582 <glossterm>gloss-2</glossterm> <emphasis>in your document</emphasis>. The
15583 easiest way to do that is probably within a <tag>remark</tag> in your
15584 automatic glossary:</para>
15587 <programlisting><glossary role="auto">
15588 <remark>Make sure there's a reference to <glossterm>gloss-2</glossterm>.</remark>
15590 <glossterm>Irrelevant</glossterm>
15592 <para>If you can see this, the document was processed incorrectly. Use
15593 the <parameter>glossary.collection</parameter> parameter.</para>
15595 </glossentry>
15596 </glossary></programlisting>
15605 <refentry version="5.0" id="glossary.as.blocks">
15607 <refentrytitle>glossary.as.blocks</refentrytitle>
15608 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
15611 <refname>glossary.as.blocks</refname>
15612 <refpurpose>Present glossarys using blocks instead of lists?</refpurpose>
15616 <programlisting id="glossary.as.blocks.frag">
15617 <xsl:param name="glossary.as.blocks" select="0"></xsl:param>
15621 <refsection><info><title>Description</title></info>
15623 <para>If non-zero, <tag>glossary</tag>s will be formatted as
15626 <para>If you have long <tag>glossterm</tag>s, proper list
15627 markup in the FO case may produce unattractive lists. By setting this
15628 parameter, you can force the stylesheets to produce block markup
15629 instead of proper lists.</para>
15631 <para>You can override this setting with a processing instruction as the
15632 child of <tag>glossary</tag>: <tag class="xmlpi">dbfo
15633 glossary-presentation="blocks"</tag> or <tag class="xmlpi">dbfo
15634 glossary-presentation="list"</tag></para>
15639 <refentry version="5.0" id="glosslist.as.blocks">
15641 <refentrytitle>glosslist.as.blocks</refentrytitle>
15642 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
15645 <refname>glosslist.as.blocks</refname>
15646 <refpurpose>Use blocks for glosslists?</refpurpose>
15650 <programlisting id="glosslist.as.blocks.frag">
15651 <xsl:param name="glosslist.as.blocks" select="0"></xsl:param>
15655 <refsection><info><title>Description</title></info>
15657 <para>See <parameter>glossary.as.blocks</parameter>.</para>
15662 <refentry version="5.0" id="glossentry.list.item.properties">
15664 <refentrytitle>glossentry.list.item.properties</refentrytitle>
15665 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
15668 <refname>glossentry.list.item.properties</refname>
15669 <refpurpose>To add properties to each glossentry in a list.</refpurpose>
15673 <programlisting id="glossentry.list.item.properties.frag"><xsl:attribute-set name="glossentry.list.item.properties">
15674 <xsl:attribute name="space-before.optimum">1em</xsl:attribute>
15675 <xsl:attribute name="space-before.minimum">0.8em</xsl:attribute>
15676 <xsl:attribute name="space-before.maximum">1.2em</xsl:attribute>
15677 </xsl:attribute-set>
15680 <refsection><info><title>Description</title></info>
15681 <para>These properties are added to the fo:list-item containing a
15682 glossentry in a glossary when the <parameter>glossary.as.blocks</parameter> parameter
15684 Use this attribute-set to set
15685 spacing between entries, for example.</para>
15690 <refentry version="5.0" id="glossterm.block.properties">
15692 <refentrytitle>glossterm.block.properties</refentrytitle>
15693 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
15696 <refname>glossterm.block.properties</refname>
15697 <refpurpose>To add properties to the block of a glossentry's glossterm.</refpurpose>
15701 <programlisting id="glossterm.block.properties.frag"><xsl:attribute-set name="glossterm.block.properties">
15702 <xsl:attribute name="space-before.optimum">1em</xsl:attribute>
15703 <xsl:attribute name="space-before.minimum">0.8em</xsl:attribute>
15704 <xsl:attribute name="space-before.maximum">1.2em</xsl:attribute>
15705 <xsl:attribute name="keep-with-next.within-column">always</xsl:attribute>
15706 <xsl:attribute name="keep-together.within-column">always</xsl:attribute>
15707 </xsl:attribute-set>
15710 <refsection><info><title>Description</title></info>
15711 <para>These properties are added to the block containing a
15712 glossary term in a glossary when the <parameter>glossary.as.blocks</parameter> parameter
15714 Use this attribute-set to set the space above and below,
15716 and any indent for the glossary term.</para>
15721 <refentry version="5.0" id="glossdef.block.properties">
15723 <refentrytitle>glossdef.block.properties</refentrytitle>
15724 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
15727 <refname>glossdef.block.properties</refname>
15728 <refpurpose>To add properties to the block of a glossary definition.</refpurpose>
15732 <programlisting id="glossdef.block.properties.frag"><xsl:attribute-set name="glossdef.block.properties">
15733 <xsl:attribute name="margin-{$direction.align.start}">.25in</xsl:attribute>
15734 </xsl:attribute-set>
15737 <refsection><info><title>Description</title></info>
15738 <para>These properties are added to the block containing a
15739 glossary definition in a glossary when
15740 the <parameter>glossary.as.blocks</parameter> parameter
15742 Use this attribute-set to set the space above and below,
15743 any font properties,
15744 and any indent for the glossary definition.</para>
15749 <refentry version="5.0" id="glossterm.list.properties">
15751 <refentrytitle>glossterm.list.properties</refentrytitle>
15752 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
15755 <refname>glossterm.list.properties</refname>
15756 <refpurpose>To add properties to the glossterm in a list.</refpurpose>
15760 <programlisting id="glossterm.list.properties.frag">
15761 <xsl:attribute-set name="glossterm.list.properties">
15762 </xsl:attribute-set>
15765 <refsection><info><title>Description</title></info>
15766 <para>These properties are added to the block containing a
15767 glossary term in a glossary when the <parameter>glossary.as.blocks</parameter> parameter
15769 Use this attribute-set to set
15770 font properties, for example.</para>
15775 <refentry version="5.0" id="glossdef.list.properties">
15777 <refentrytitle>glossdef.list.properties</refentrytitle>
15778 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
15781 <refname>glossdef.list.properties</refname>
15782 <refpurpose>To add properties to the glossary definition in a list.</refpurpose>
15786 <programlisting id="glossdef.list.properties.frag">
15787 <xsl:attribute-set name="glossdef.list.properties">
15788 </xsl:attribute-set>
15791 <refsection><info><title>Description</title></info>
15792 <para>These properties are added to the block containing a
15793 glossary definition in a glossary when
15794 the <parameter>glossary.as.blocks</parameter> parameter
15796 Use this attribute-set to set font properties, for example.</para>
15801 <refentry version="5.0" id="glossterm.width">
15803 <refentrytitle>glossterm.width</refentrytitle>
15804 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
15807 <refname>glossterm.width</refname>
15808 <refpurpose>Width of glossterm in list presentation mode</refpurpose>
15812 <programlisting id="glossterm.width.frag">
15813 <xsl:param name="glossterm.width">2in</xsl:param>
15817 <refsection><info><title>Description</title></info>
15819 <para>This parameter specifies the width reserved for glossary terms when
15820 a list presentation is used.</para>
15825 <refentry version="5.0" id="glossterm.separation">
15827 <refentrytitle>glossterm.separation</refentrytitle>
15828 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
15831 <refname>glossterm.separation</refname>
15832 <refpurpose>Separation between glossary terms and descriptions in list mode</refpurpose>
15836 <programlisting id="glossterm.separation.frag">
15837 <xsl:param name="glossterm.separation">0.25in</xsl:param>
15841 <refsection><info><title>Description</title></info>
15843 <para>Specifies the miminum horizontal
15844 separation between glossary terms and descriptions when
15845 they are presented side-by-side using lists
15846 when the <parameter>glossary.as.blocks</parameter>
15852 <refentry version="5.0" id="glossentry.show.acronym">
15854 <refentrytitle>glossentry.show.acronym</refentrytitle>
15855 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
15856 <refmiscinfo class="other" otherclass="value">no</refmiscinfo>
15857 <refmiscinfo class="other" otherclass="value">yes</refmiscinfo>
15858 <refmiscinfo class="other" otherclass="value">primary</refmiscinfo>
15861 <refname>glossentry.show.acronym</refname>
15862 <refpurpose>Display <tag>glossentry</tag> acronyms?</refpurpose>
15866 <programlisting id="glossentry.show.acronym.frag">
15867 <xsl:param name="glossentry.show.acronym">no</xsl:param>
15871 <refsection><info><title>Description</title></info>
15873 <para>A setting of <quote>yes</quote> means they should be displayed;
15874 <quote>no</quote> means they shouldn't. If <quote>primary</quote> is used,
15875 then they are shown as the primary text for the entry.</para>
15878 <para>This setting controls both <tag>acronym</tag> and
15879 <tag>abbrev</tag> elements in the <tag>glossentry</tag>.</para>
15885 <refentry version="5.0" id="glossary.sort">
15887 <refentrytitle>glossary.sort</refentrytitle>
15888 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
15891 <refname>glossary.sort</refname>
15892 <refpurpose>Sort glossentry elements?</refpurpose>
15896 <programlisting id="glossary.sort.frag">
15897 <xsl:param name="glossary.sort" select="0"></xsl:param>
15901 <refsection><info><title>Description</title></info>
15903 <para>If non-zero, then the glossentry elements within a
15904 glossary, glossdiv, or glosslist are sorted on the glossterm, using
15905 the current lang setting. If zero (the default), then
15906 glossentry elements are not sorted and are presented
15913 </reference><reference id="misc" xml:base="../fo/param.xml"><title>Miscellaneous</title>
15914 <refentry version="5.0" id="formal.procedures">
15916 <refentrytitle>formal.procedures</refentrytitle>
15917 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
15920 <refname>formal.procedures</refname>
15921 <refpurpose>Selects formal or informal procedures</refpurpose>
15925 <programlisting id="formal.procedures.frag">
15926 <xsl:param name="formal.procedures" select="1"></xsl:param>
15930 <refsection><info><title>Description</title></info>
15932 <para>Formal procedures are numbered and always have a title.
15938 <refentry version="5.0" id="formal.title.placement">
15940 <refentrytitle>formal.title.placement</refentrytitle>
15941 <refmiscinfo class="other" otherclass="datatype">table</refmiscinfo>
15944 <refname>formal.title.placement</refname>
15945 <refpurpose>Specifies where formal object titles should occur</refpurpose>
15949 <programlisting id="formal.title.placement.frag">
15950 <xsl:param name="formal.title.placement">
15961 <refsection><info><title>Description</title></info>
15963 <para>Specifies where formal object titles should occur. For each formal object
15964 type (<tag>figure</tag>,
15965 <tag>example</tag>,
15966 <tag>equation</tag>,
15967 <tag>table</tag>, and <tag>procedure</tag>)
15968 you can specify either the keyword
15969 <quote><literal>before</literal></quote> or
15970 <quote><literal>after</literal></quote>.</para>
15975 <refentry version="5.0" id="runinhead.default.title.end.punct">
15977 <refentrytitle>runinhead.default.title.end.punct</refentrytitle>
15978 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
15981 <refname>runinhead.default.title.end.punct</refname>
15982 <refpurpose>Default punctuation character on a run-in-head</refpurpose>
15986 <programlisting id="runinhead.default.title.end.punct.frag"><xsl:param name="runinhead.default.title.end.punct">.</xsl:param>
15990 <refsection><info><title>Description</title></info>
15992 <para>If non-zero, For a <tag>formalpara</tag>, use the specified
15993 string as the separator between the title and following text. The period is the default value.</para>
15998 <refentry version="5.0" id="runinhead.title.end.punct">
16000 <refentrytitle>runinhead.title.end.punct</refentrytitle>
16001 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
16004 <refname>runinhead.title.end.punct</refname>
16005 <refpurpose>Characters that count as punctuation on a run-in-head</refpurpose>
16009 <programlisting id="runinhead.title.end.punct.frag">
16010 <xsl:param name="runinhead.title.end.punct">.!?:</xsl:param>
16014 <refsection><info><title>Description</title></info>
16016 <para>Specify which characters are to be counted as punctuation. These
16017 characters are checked for a match with the last character of the
16018 title. If no match is found, the
16019 <parameter>runinhead.default.title.end.punct</parameter> contents are
16020 inserted. This is to avoid duplicated punctuation in the output.
16026 <refentry version="5.0" id="show.comments">
16028 <refentrytitle>show.comments</refentrytitle>
16029 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
16032 <refname>show.comments</refname>
16033 <refpurpose>Display <tag>remark</tag> elements?</refpurpose>
16037 <programlisting id="show.comments.frag">
16038 <xsl:param name="show.comments" select="1"></xsl:param>
16042 <refsection><info><title>Description</title></info>
16044 <para>If non-zero, comments will be displayed, otherwise they
16045 are suppressed. Comments here refers to the <tag>remark</tag> element
16046 (which was called <literal>comment</literal> prior to DocBook
16047 4.0), not XML comments (<-- like this -->) which are
16054 <refentry version="5.0" id="punct.honorific">
16056 <refentrytitle>punct.honorific</refentrytitle>
16057 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
16060 <refname>punct.honorific</refname>
16061 <refpurpose>Punctuation after an honorific in a personal name.</refpurpose>
16065 <programlisting id="punct.honorific.frag">
16066 <xsl:param name="punct.honorific">.</xsl:param>
16070 <refsection><info><title>Description</title></info>
16072 <para>This parameter specifies the punctuation that should be added after an
16073 honorific in a personal name.</para>
16078 <refentry version="5.0" id="segmentedlist.as.table">
16080 <refentrytitle>segmentedlist.as.table</refentrytitle>
16081 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
16084 <refname>segmentedlist.as.table</refname>
16085 <refpurpose>Format segmented lists as tables?</refpurpose>
16089 <programlisting id="segmentedlist.as.table.frag">
16090 <xsl:param name="segmentedlist.as.table" select="0"></xsl:param>
16094 <refsection><info><title>Description</title></info>
16096 <para>If non-zero, <tag>segmentedlist</tag>s will be formatted as
16102 <refentry version="5.0" id="variablelist.as.blocks">
16104 <refentrytitle>variablelist.as.blocks</refentrytitle>
16105 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
16108 <refname>variablelist.as.blocks</refname>
16109 <refpurpose>Format <tag>variablelist</tag>s lists as blocks?</refpurpose>
16113 <programlisting id="variablelist.as.blocks.frag">
16114 <xsl:param name="variablelist.as.blocks" select="0"></xsl:param>
16118 <refsection><info><title>Description</title></info>
16120 <para>If non-zero, <tag>variablelist</tag>s will be formatted as
16123 <para>If you have long terms, proper list markup in the FO case may produce
16124 unattractive lists. By setting this parameter, you can force the stylesheets
16125 to produce block markup instead of proper lists.</para>
16127 <para>You can override this setting with a processing instruction as the
16128 child of <tag>variablelist</tag>: <tag class="xmlpi">dbfo
16129 list-presentation="blocks"</tag> or <tag class="xmlpi">dbfo
16130 list-presentation="list"</tag>.</para>
16132 <para>When using <literal>list-presentation="list"</literal>,
16133 you can also control the amount of space used for the <tag>term</tag>s with
16134 the <tag class="xmlpi">dbfo term-width=".25in"</tag> processing instruction,
16135 the <tag class="attribute">termlength</tag> attribute on <tag>variablelist</tag>,
16136 or allow the stylesheets to attempt to calculate the amount of space to leave based on the
16137 number of letters in the longest term.
16140 <programlisting> <variablelist>
16141 <?dbfo list-presentation="list"?>
16142 <?dbfo term-width="1.5in"?>
16143 <?dbhtml list-presentation="table"?>
16144 <?dbhtml term-width="1.5in"?>
16145 <varlistentry>
16146 <term>list</term>
16149 Formatted as a list even if variablelist.as.blocks is set to 1.
16152 </varlistentry>
16153 </variablelist></programlisting>
16160 <refentry version="5.0" id="blockquote.properties">
16162 <refentrytitle>blockquote.properties</refentrytitle>
16163 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
16166 <refname>blockquote.properties</refname>
16167 <refpurpose>To set the style for block quotations.</refpurpose>
16171 <programlisting id="blockquote.properties.frag">
16172 <xsl:attribute-set name="blockquote.properties">
16173 <xsl:attribute name="margin-{$direction.align.start}">0.5in</xsl:attribute>
16174 <xsl:attribute name="margin-{$direction.align.end}">0.5in</xsl:attribute>
16175 <xsl:attribute name="space-after.minimum">0.5em</xsl:attribute>
16176 <xsl:attribute name="space-after.optimum">1em</xsl:attribute>
16177 <xsl:attribute name="space-after.maximum">2em</xsl:attribute>
16178 </xsl:attribute-set>
16182 <refsection><info><title>Description</title></info>
16184 <para>The <parameter>blockquote.properties</parameter> attribute set specifies
16185 the formating properties of block quotations.</para>
16190 <refentry version="5.0" id="ulink.show">
16192 <refentrytitle>ulink.show</refentrytitle>
16193 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
16196 <refname>ulink.show</refname>
16197 <refpurpose>Display URLs after <tag>ulink</tag>s?</refpurpose>
16201 <programlisting id="ulink.show.frag">
16202 <xsl:param name="ulink.show" select="1"></xsl:param>
16206 <refsection><info><title>Description</title></info>
16208 <para>If non-zero, the URL of each <tag>ulink</tag> will
16209 appear after the text of the link. If the text of the link and the URL
16210 are identical, the URL is suppressed. </para>
16212 <para>See also <parameter>ulink.footnotes</parameter>.</para>
16214 <note><para>DocBook 5 does not have an <tag>ulink</tag> element. When processing
16215 DocBoook 5 documents, <parameter>ulink.show</parameter> applies to all inline
16216 elements that are marked up with <tag class="attribute">xlink:href</tag> attributes
16217 that point to external resources.</para>
16223 <refentry version="5.0" id="ulink.footnotes">
16225 <refentrytitle>ulink.footnotes</refentrytitle>
16226 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
16229 <refname>ulink.footnotes</refname>
16230 <refpurpose>Generate footnotes for <tag>ulink</tag>s?</refpurpose>
16234 <programlisting id="ulink.footnotes.frag">
16235 <xsl:param name="ulink.footnotes" select="0"></xsl:param>
16239 <refsection><info><title>Description</title></info>
16241 <para>If non-zero, and if <parameter>ulink.show</parameter> also is non-zero,
16242 the URL of each <tag>ulink</tag> will appear as a footnote.</para>
16244 <note><para>DocBook 5 does not have an <tag>ulink</tag> element. When processing
16245 DocBoook 5 documents, <parameter>ulink.footnotes</parameter> applies to all inline
16246 elements that are marked up with <tag class="attribute">xlink:href</tag> attributes
16247 that point to external resources.</para>
16253 <refentry version="5.0" id="ulink.hyphenate">
16255 <refentrytitle>ulink.hyphenate</refentrytitle>
16256 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
16259 <refname>ulink.hyphenate</refname>
16260 <refpurpose>Allow URLs to be automatically hyphenated</refpurpose>
16264 <programlisting id="ulink.hyphenate.frag">
16265 <xsl:param name="ulink.hyphenate"></xsl:param>
16269 <refsection><info><title>Description</title></info>
16271 <para>If not empty, the specified character (or more generally, content) is
16272 added to URLs after every character included in the string
16273 in the <parameter>ulink.hyphenate.chars</parameter> parameter (default
16274 is <quote>/</quote>). If the character in this parameter is a
16275 Unicode soft hyphen (0x00AD) or Unicode zero-width space (0x200B), some FO
16276 processors will be able to reasonably hyphenate long URLs.</para>
16278 <para>As of 28 Jan 2002, discretionary hyphens are more widely and correctly
16279 supported than zero-width spaces for this purpose.</para>
16284 <refentry version="5.0" id="ulink.hyphenate.chars">
16286 <refentrytitle>ulink.hyphenate.chars</refentrytitle>
16287 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
16290 <refname>ulink.hyphenate.chars</refname>
16291 <refpurpose>List of characters to allow ulink URLs to be automatically hyphenated on</refpurpose>
16295 <programlisting id="ulink.hyphenate.chars.frag">
16296 <xsl:param name="ulink.hyphenate.chars">/</xsl:param>
16300 <refsection><info><title>Description</title></info>
16302 <para>If the <parameter>ulink.hyphenate</parameter> is not empty, then
16303 hyphenation of ulinks is turned on, and any
16304 character contained in this parameter is treated as an allowable
16305 hyphenation point.</para>
16307 <para>The default value is <quote>/</quote>, but the parameter
16308 could be customized
16309 to contain other URL characters, as for example:</para>
16311 <xsl:param name="ulink.hyphenate.chars">:/@&?.#</xsl:param>
16317 <refentry version="5.0" id="shade.verbatim">
16319 <refentrytitle>shade.verbatim</refentrytitle>
16320 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
16323 <refname>shade.verbatim</refname>
16324 <refpurpose>Should verbatim environments be shaded?</refpurpose>
16328 <programlisting id="shade.verbatim.frag"><xsl:param name="shade.verbatim" select="0"></xsl:param></programlisting>
16331 <refsection><info><title>Description</title></info>
16333 <para>In the FO stylesheet, if this parameter is non-zero then the
16334 <property>shade.verbatim.style</property> properties will be applied
16335 to verbatim environments.</para>
16337 <para>In the HTML stylesheet, this parameter is now deprecated. Use
16338 CSS instead.</para>
16343 <refentry version="5.0" id="shade.verbatim.style">
16345 <refentrytitle>shade.verbatim.style</refentrytitle>
16346 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
16349 <refname>shade.verbatim.style</refname>
16350 <refpurpose>Properties that specify the style of shaded verbatim listings</refpurpose>
16354 <programlisting id="shade.verbatim.style.frag">
16356 <xsl:attribute-set name="shade.verbatim.style">
16357 <xsl:attribute name="background-color">#E0E0E0</xsl:attribute>
16358 </xsl:attribute-set>
16362 <refsection><info><title>Description</title></info>
16364 <para>Properties that specify the style of shaded verbatim listings. The
16365 parameters specified (the border and background color) are added to
16366 the styling of the xsl-fo output. A border might be specified as "thin
16367 black solid" for example. See <link xlink:href="http://www.w3.org/TR/2004/WD-xsl11-20041216/#border">xsl-fo</link></para>
16372 <refentry version="5.0" id="hyphenate.verbatim">
16374 <refentrytitle>hyphenate.verbatim</refentrytitle>
16375 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
16378 <refname>hyphenate.verbatim</refname>
16379 <refpurpose>Should verbatim environments be hyphenated on space characters?</refpurpose>
16383 <programlisting id="hyphenate.verbatim.frag"><xsl:param name="hyphenate.verbatim" select="0"></xsl:param></programlisting>
16386 <refsection><info><title>Description</title></info>
16388 <para>If the lines of program listing are too long to fit into one
16389 line it is quite common to split them at space and indicite by hook
16390 arrow that code continues on the next line. You can turn on this
16391 behaviour for <tag>programlisting</tag>,
16392 <tag>screen</tag> and <tag>synopsis</tag> elements by
16393 using this parameter.</para>
16395 <para>Note that you must also enable line wrapping for verbatim environments and
16396 select appropriate hyphenation character (e.g. hook arrow). This can
16397 be done using <parameter>monospace.verbatim.properties</parameter>
16398 attribute set:</para>
16400 <programlisting><xsl:attribute-set name="monospace.verbatim.properties"
16401 use-attribute-sets="verbatim.properties monospace.properties">
16402 <xsl:attribute name="wrap-option">wrap</xsl:attribute>
16403 <xsl:attribute name="hyphenation-character">&#x25BA;</xsl:attribute>
16404 </xsl:attribute-set></programlisting>
16406 <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
16407 selected character is available in the font you are using for verbatim
16408 environments.</para>
16413 <refentry version="5.0" id="hyphenate.verbatim.characters">
16415 <refentrytitle>hyphenate.verbatim.characters</refentrytitle>
16416 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
16419 <refname>hyphenate.verbatim.characters</refname>
16420 <refpurpose>List of characters after which a line break can occur in listings</refpurpose>
16424 <programlisting id="hyphenate.verbatim.characters.frag">
16425 <xsl:param name="hyphenate.verbatim.characters"></xsl:param>
16429 <refsection><info><title>Description</title></info>
16431 <para>If you enable <parameter>hyphenate.verbatim</parameter> line
16432 breaks are allowed only on space characters. If this is not enough for
16433 your document, you can specify list of additional characters after
16434 which line break is allowed in this parameter.</para>
16439 <refentry version="5.0" id="use.svg">
16441 <refentrytitle>use.svg</refentrytitle>
16442 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
16445 <refname>use.svg</refname>
16446 <refpurpose>Allow SVG in the result tree?</refpurpose>
16450 <programlisting id="use.svg.frag">
16451 <xsl:param name="use.svg" select="1"></xsl:param>
16455 <refsection><info><title>Description</title></info>
16457 <para>If non-zero, SVG will be considered an acceptable image format. SVG
16458 is passed through to the result tree, so correct rendering of the resulting
16459 diagram depends on the formatter (FO processor or web browser) that is used
16460 to process the output from the stylesheet.</para>
16465 <refentry version="5.0" id="use.role.as.xrefstyle">
16467 <refentrytitle>use.role.as.xrefstyle</refentrytitle>
16468 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
16471 <refname>use.role.as.xrefstyle</refname>
16472 <refpurpose>Use <tag class="attribute">role</tag> attribute for
16473 <tag class="attribute">xrefstyle</tag> on <tag>xref</tag>?</refpurpose>
16477 <programlisting id="use.role.as.xrefstyle.frag">
16478 <xsl:param name="use.role.as.xrefstyle" select="1"></xsl:param>
16482 <refsection><info><title>Description</title></info>
16484 <para>In DocBook documents that conform to a schema older than V4.3, this parameter allows
16485 <tag class="attribute">role</tag> to serve the purpose of specifying the cross reference style.</para>
16487 <para>If non-zero, the <tag class="attribute">role</tag> attribute on
16488 <tag>xref</tag> will be used to select the cross reference style.
16489 In DocBook V4.3, the <tag class="attribute">xrefstyle</tag> attribute was added for this purpose.
16490 If the <tag class="attribute">xrefstyle</tag> attribute is present,
16491 <tag class="attribute">role</tag> will be ignored, regardless of the setting
16492 of this parameter.</para>
16496 <refsection><info><title>Example</title></info>
16498 <para>The following small stylesheet shows how to configure the
16499 stylesheets to make use of the cross reference style:</para>
16501 <programlisting><?xml version="1.0"?>
16502 <xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
16505 <xsl:import href="../xsl/html/docbook.xsl"/>
16507 <xsl:output method="html"/>
16509 <xsl:param name="local.l10n.xml" select="document('')"/>
16510 <l:i18n xmlns:l="http://docbook.sourceforge.net/xmlns/l10n/1.0">
16511 <l:l10n xmlns:l="http://docbook.sourceforge.net/xmlns/l10n/1.0" language="en">
16512 <l:context name="xref">
16513 <l:template name="chapter" style="title" text="Chapter %n, %t"/>
16514 <l:template name="chapter" text="Chapter %n"/>
16519 </xsl:stylesheet></programlisting>
16521 <para>With this stylesheet, the cross references in the following document:</para>
16523 <programlisting><?xml version="1.0" encoding="utf-8"?>
16524 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
16525 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
16526 <book id="book"><title>Book</title>
16529 <title>Preface</title>
16531 <para>Normal: <xref linkend="ch1"/>.</para>
16532 <para>Title: <xref xrefstyle="title" linkend="ch1"/>.</para>
16536 <chapter id="ch1">
16537 <title>First Chapter</title>
16539 <para>Irrelevant.</para>
16542 </book></programlisting>
16544 <para>will appear as:</para>
16547 <para>Normal: Chapter 1.</para>
16548 <para>Title: Chapter 1, <emphasis>First Chapter</emphasis>.</para>
16554 <refentry version="5.0" id="menuchoice.separator">
16556 <refentrytitle>menuchoice.separator</refentrytitle>
16557 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
16560 <refname>menuchoice.separator</refname>
16561 <refpurpose>Separator between items of a <tag>menuchoice</tag>
16562 other than <tag>guimenuitem</tag> and
16563 <tag>guisubmenu</tag></refpurpose>
16567 <programlisting id="menuchoice.separator.frag">
16568 <xsl:param name="menuchoice.separator">+</xsl:param>
16572 <refsection><info><title>Description</title></info>
16574 <para>Separator used to connect items of a <tag>menuchoice</tag> other
16575 than <tag>guimenuitem</tag> and <tag>guisubmenu</tag>. The latter
16576 elements are linked with <parameter>menuchoice.menu.separator</parameter>.
16582 <refentry version="5.0" id="menuchoice.menu.separator">
16584 <refentrytitle>menuchoice.menu.separator</refentrytitle>
16585 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
16588 <refname>menuchoice.menu.separator</refname>
16589 <refpurpose>Separator between items of a <tag>menuchoice</tag>
16590 with <tag>guimenuitem</tag> or
16591 <tag>guisubmenu</tag></refpurpose>
16595 <programlisting id="menuchoice.menu.separator.frag">
16596 <xsl:param name="menuchoice.menu.separator"> → </xsl:param>
16600 <refsection><info><title>Description</title></info>
16602 <para>Separator used to connect items of a <tag>menuchoice</tag> with
16603 <tag>guimenuitem</tag> or <tag>guisubmenu</tag>. Other elements
16604 are linked with <parameter>menuchoice.separator</parameter>.
16606 <para>The default value is &#x2192;, which is the
16607 &rarr; (right arrow) character entity.
16608 The current FOP (0.20.5) requires setting the font-family
16611 <para>The default value also includes spaces around the arrow,
16612 which will allow a line to break. Replace the spaces with
16613 &#xA0; (nonbreaking space) if you don't want those
16620 <refentry version="5.0" id="default.float.class">
16622 <refentrytitle>default.float.class</refentrytitle>
16623 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
16626 <refname>default.float.class</refname>
16627 <refpurpose>Specifies the default float class</refpurpose>
16631 <programlisting id="default.float.class.frag">
16632 <xsl:param name="default.float.class">
16634 <xsl:when test="contains($stylesheet.result.type,'html')">left</xsl:when>
16635 <xsl:otherwise>before</xsl:otherwise>
16636 </xsl:choose>
16641 <refsection><info><title>Description</title></info>
16643 <para>Selects the direction in which a float should be placed. for
16644 xsl-fo this is before, for html it is left. For Western texts, the
16645 before direction is the top of the page.</para>
16650 <refentry version="5.0" id="footnote.number.format">
16652 <refentrytitle>footnote.number.format</refentrytitle>
16653 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
16654 <refmiscinfo class="other" otherclass="value">1<alt>1,2,3...</alt></refmiscinfo>
16655 <refmiscinfo class="other" otherclass="value">A<alt>A,B,C...</alt></refmiscinfo>
16656 <refmiscinfo class="other" otherclass="value">a<alt>a,b,c...</alt></refmiscinfo>
16657 <refmiscinfo class="other" otherclass="value">i<alt>i,ii,iii...</alt></refmiscinfo>
16658 <refmiscinfo class="other" otherclass="value">I<alt>I,II,III...</alt></refmiscinfo>
16661 <refname>footnote.number.format</refname>
16662 <refpurpose>Identifies the format used for footnote numbers</refpurpose>
16666 <programlisting id="footnote.number.format.frag">
16667 <xsl:param name="footnote.number.format">1</xsl:param>
16671 <refsection><info><title>Description</title></info>
16673 <para>The <parameter>footnote.number.format</parameter> specifies the format
16674 to use for footnote numeration (1, i, I, a, or A).</para>
16679 <refentry version="5.0" id="table.footnote.number.format">
16681 <refentrytitle>table.footnote.number.format</refentrytitle>
16682 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
16683 <refmiscinfo class="other" otherclass="value">1<alt>1,2,3...</alt></refmiscinfo>
16684 <refmiscinfo class="other" otherclass="value">A<alt>A,B,C...</alt></refmiscinfo>
16685 <refmiscinfo class="other" otherclass="value">a<alt>a,b,c...</alt></refmiscinfo>
16686 <refmiscinfo class="other" otherclass="value">i<alt>i,ii,iii...</alt></refmiscinfo>
16687 <refmiscinfo class="other" otherclass="value">I<alt>I,II,III...</alt></refmiscinfo>
16690 <refname>table.footnote.number.format</refname>
16691 <refpurpose>Identifies the format used for footnote numbers in tables</refpurpose>
16695 <programlisting id="table.footnote.number.format.frag">
16696 <xsl:param name="table.footnote.number.format">a</xsl:param>
16700 <refsection><info><title>Description</title></info>
16702 <para>The <parameter>table.footnote.number.format</parameter> specifies the format
16703 to use for footnote numeration (1, i, I, a, or A) in tables.</para>
16708 <refentry version="5.0" id="footnote.number.symbols">
16710 <refentrytitle>footnote.number.symbols</refentrytitle>
16711 <refmiscinfo class="other" otherclass="datatype"/>
16714 <refname>footnote.number.symbols</refname>
16715 <refpurpose>Special characters to use as footnote markers</refpurpose>
16719 <programlisting id="footnote.number.symbols.frag">
16720 <xsl:param name="footnote.number.symbols"></xsl:param>
16724 <refsection><info><title>Description</title></info>
16726 <para>If <parameter>footnote.number.symbols</parameter> is not the empty string,
16727 footnotes will use the characters it contains as footnote symbols. For example,
16728 <quote>*&#x2020;&#x2021;&#x25CA;&#x2720;</quote> will identify
16729 footnotes with <quote>*</quote>, <quote>†</quote>, <quote>‡</quote>,
16730 <quote>◊</quote>, and <quote>✠</quote>. If there are more footnotes
16731 than symbols, the stylesheets will fall back to numbered footnotes using
16732 <parameter>footnote.number.format</parameter>.</para>
16734 <para>The use of symbols for footnotes depends on the ability of your
16735 processor (or browser) to render the symbols you select. Not all systems are
16736 capable of displaying the full range of Unicode characters. If the quoted characters
16737 in the preceding paragraph are not displayed properly, that's a good indicator
16738 that you may have trouble using those symbols for footnotes.</para>
16743 <refentry version="5.0" id="table.footnote.number.symbols">
16745 <refentrytitle>table.footnote.number.symbols</refentrytitle>
16746 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
16749 <refname>table.footnote.number.symbols</refname>
16750 <refpurpose>Special characters to use a footnote markers in tables</refpurpose>
16754 <programlisting id="table.footnote.number.symbols.frag">
16755 <xsl:param name="table.footnote.number.symbols"></xsl:param>
16759 <refsection><info><title>Description</title></info>
16761 <para>If <parameter>table.footnote.number.symbols</parameter> is not the empty string,
16762 table footnotes will use the characters it contains as footnote symbols. For example,
16763 <quote>*&#x2020;&#x2021;&#x25CA;&#x2720;</quote> will identify
16764 footnotes with <quote>*</quote>, <quote>†</quote>, <quote>‡</quote>,
16765 <quote>◊</quote>, and <quote>✠</quote>. If there are more footnotes
16766 than symbols, the stylesheets will fall back to numbered footnotes using
16767 <parameter>table.footnote.number.format</parameter>.</para>
16769 <para>The use of symbols for footnotes depends on the ability of your
16770 processor (or browser) to render the symbols you select. Not all systems are
16771 capable of displaying the full range of Unicode characters. If the quoted characters
16772 in the preceding paragraph are not displayed properly, that's a good indicator
16773 that you may have trouble using those symbols for footnotes.</para>
16778 <refentry version="5.0" id="footnote.properties">
16780 <refentrytitle>footnote.properties</refentrytitle>
16781 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
16784 <refname>footnote.properties</refname>
16785 <refpurpose>Properties applied to each footnote body
16790 <programlisting id="footnote.properties.frag">
16791 <xsl:attribute-set name="footnote.properties">
16792 <xsl:attribute name="font-family"><xsl:value-of select="$body.fontset"></xsl:value-of></xsl:attribute>
16793 <xsl:attribute name="font-size"><xsl:value-of select="$footnote.font.size"></xsl:value-of></xsl:attribute>
16794 <xsl:attribute name="font-weight">normal</xsl:attribute>
16795 <xsl:attribute name="font-style">normal</xsl:attribute>
16796 <xsl:attribute name="text-align"><xsl:value-of select="$alignment"></xsl:value-of></xsl:attribute>
16797 <xsl:attribute name="start-indent">0pt</xsl:attribute>
16798 <xsl:attribute name="text-indent">0pt</xsl:attribute>
16799 <xsl:attribute name="hyphenate"><xsl:value-of select="$hyphenate"></xsl:value-of></xsl:attribute>
16800 <xsl:attribute name="wrap-option">wrap</xsl:attribute>
16801 <xsl:attribute name="linefeed-treatment">treat-as-space</xsl:attribute>
16802 </xsl:attribute-set>
16806 <refsection><info><title>Description</title></info>
16808 <para>This attribute set is applied to the footnote-block
16810 It can be used to set the
16811 font-size, font-family, and other inheritable properties that will be
16812 applied to all footnotes.</para>
16817 <refentry version="5.0" id="table.footnote.properties">
16819 <refentrytitle>table.footnote.properties</refentrytitle>
16820 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
16823 <refname>table.footnote.properties</refname>
16824 <refpurpose>Properties applied to each table footnote body
16829 <programlisting id="table.footnote.properties.frag">
16830 <xsl:attribute-set name="table.footnote.properties">
16831 <xsl:attribute name="font-family"><xsl:value-of select="$body.fontset"></xsl:value-of></xsl:attribute>
16832 <xsl:attribute name="font-size"><xsl:value-of select="$footnote.font.size"></xsl:value-of></xsl:attribute>
16833 <xsl:attribute name="font-weight">normal</xsl:attribute>
16834 <xsl:attribute name="font-style">normal</xsl:attribute>
16835 <xsl:attribute name="space-before">2pt</xsl:attribute>
16836 <xsl:attribute name="text-align"><xsl:value-of select="$alignment"></xsl:value-of></xsl:attribute>
16837 </xsl:attribute-set>
16841 <refsection><info><title>Description</title></info>
16843 <para>This attribute set is applied to the footnote-block
16844 for each table footnote.
16845 It can be used to set the
16846 font-size, font-family, and other inheritable properties that will be
16847 applied to all table footnotes.</para>
16852 <refentry version="5.0" id="footnote.mark.properties">
16854 <refentrytitle>footnote.mark.properties</refentrytitle>
16855 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
16858 <refname>footnote.mark.properties</refname>
16859 <refpurpose>Properties applied to each footnote mark
16864 <programlisting id="footnote.mark.properties.frag">
16865 <xsl:attribute-set name="footnote.mark.properties">
16866 <xsl:attribute name="font-family"><xsl:value-of select="$body.fontset"></xsl:value-of></xsl:attribute>
16867 <xsl:attribute name="font-size">75%</xsl:attribute>
16868 <xsl:attribute name="font-weight">normal</xsl:attribute>
16869 <xsl:attribute name="font-style">normal</xsl:attribute>
16870 </xsl:attribute-set>
16874 <refsection><info><title>Description</title></info>
16876 <para>This attribute set is applied to the footnote mark used
16878 It should contain only inline properties.
16881 <para>The property to make the mark a superscript is contained in the
16882 footnote template itself, because the current version of FOP reports
16883 an error if baseline-shift is used.
16889 <refentry version="5.0" id="footnote.sep.leader.properties">
16891 <refentrytitle>footnote.sep.leader.properties</refentrytitle>
16892 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
16895 <refname>footnote.sep.leader.properties</refname>
16896 <refpurpose>Properties associated with footnote separators</refpurpose>
16900 <programlisting id="footnote.sep.leader.properties.frag">
16901 <xsl:attribute-set name="footnote.sep.leader.properties">
16902 <xsl:attribute name="color">black</xsl:attribute>
16903 <xsl:attribute name="leader-pattern">rule</xsl:attribute>
16904 <xsl:attribute name="leader-length">1in</xsl:attribute>
16905 </xsl:attribute-set>
16909 <refsection><info><title>Description</title></info>
16911 <para>The styling for the rule line that separates the
16912 footnotes from the body text.
16913 These are properties applied to the fo:leader used as
16916 <para>If you want to do more than just set properties on
16917 the leader element, then you can customize the template
16918 named <literal>footnote.separator</literal> in
16919 <filename>fo/pagesetup.xsl</filename>.</para>
16924 <refentry version="5.0" id="xref.with.number.and.title">
16926 <refentrytitle>xref.with.number.and.title</refentrytitle>
16927 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
16930 <refname>xref.with.number.and.title</refname>
16931 <refpurpose>Use number and title in cross references</refpurpose>
16935 <programlisting id="xref.with.number.and.title.frag">
16936 <xsl:param name="xref.with.number.and.title" select="1"></xsl:param>
16940 <refsection><info><title>Description</title></info>
16942 <para>A cross reference may include the number (for example, the number of
16943 an example or figure) and the <tag>title</tag> which is a required child of some
16944 targets. This parameter inserts both the relevant number as well as
16945 the title into the link. </para>
16950 <refentry version="5.0" id="superscript.properties">
16952 <refentrytitle>superscript.properties</refentrytitle>
16953 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
16956 <refname>superscript.properties</refname>
16957 <refpurpose>Properties associated with superscripts</refpurpose>
16961 <programlisting id="superscript.properties.frag">
16962 <xsl:attribute-set name="superscript.properties">
16963 <xsl:attribute name="font-size">75%</xsl:attribute>
16964 </xsl:attribute-set>
16968 <refsection><info><title>Description</title></info>
16970 <para>Specifies styling properties for superscripts.</para>
16975 <refentry version="5.0" id="subscript.properties">
16977 <refentrytitle>subscript.properties</refentrytitle>
16978 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
16981 <refname>subscript.properties</refname>
16982 <refpurpose>Properties associated with subscripts</refpurpose>
16986 <programlisting id="subscript.properties.frag">
16987 <xsl:attribute-set name="subscript.properties">
16988 <xsl:attribute name="font-size">75%</xsl:attribute>
16989 </xsl:attribute-set>
16993 <refsection><info><title>Description</title></info>
16995 <para>Specifies styling properties for subscripts.</para>
17000 <refentry version="5.0" id="pgwide.properties">
17002 <refentrytitle>pgwide.properties</refentrytitle>
17003 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
17006 <refname>pgwide.properties</refname>
17007 <refpurpose>Properties to make a figure or table page wide.
17012 <programlisting id="pgwide.properties.frag">
17013 <xsl:attribute-set name="pgwide.properties">
17014 <xsl:attribute name="start-indent">0pt</xsl:attribute>
17015 </xsl:attribute-set>
17019 <refsection><info><title>Description</title></info>
17021 <para>This attribute set is used to set the properties
17022 that make a figure or table "page wide" in fo output.
17023 It comes into effect when an attribute <literal>pgwide="1"</literal>
17028 By default, it sets <parameter>start-indent</parameter>
17029 to <literal>0pt</literal>.
17030 In a stylesheet that sets the parameter
17031 <parameter>body.start.indent</parameter>
17032 to a non-zero value in order to indent body text,
17033 this attribute set can be used to outdent pgwide
17034 figures to the start margin.
17037 <para>If a document uses a multi-column page layout,
17038 then this attribute set could try setting <parameter>span</parameter>
17039 to a value of <literal>all</literal>. However, this may
17040 not work with some processors because a span property must be on an
17041 fo:block that is a direct child of fo:flow. It may work in
17042 some processors anyway.
17048 <refentry version="5.0" id="highlight.source">
17050 <refentrytitle>highlight.source</refentrytitle>
17051 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
17054 <refname>highlight.source</refname>
17055 <refpurpose>Should the content of <tag>programlisting</tag>
17056 be syntactically highlighted?</refpurpose>
17060 <programlisting id="highlight.source.frag">
17061 <xsl:param name="highlight.source" select="0"></xsl:param>
17065 <refsection><info><title>Description</title></info>
17067 <para>When this parameter is non-zero, the stylesheets will try to do syntax highlighting of the
17068 content of <tag>programlisting</tag> elements. You specify the language for each programlisting
17069 by using the <tag class="attribute">language</tag> attribute. The <parameter>highlight.default.language</parameter>
17070 parameter can be used to specify the language for programlistings without a <tag class="attribute">language</tag>
17071 attribute. Syntax highlighting also works for <tag>screen</tag> and <tag>synopsis</tag> elements.</para>
17073 <para>The actual highlighting work is done by the XSLTHL extension module. This is an external Java library that has to be
17074 downloaded separately (see below).</para>
17077 <para>In order to use this extension, you must</para>
17079 <listitem><para>add <filename>xslthl-2.x.x.jar</filename> to your Java classpath. The latest version is available
17080 from <link xlink:href="http://sourceforge.net/projects/xslthl">the XSLT syntax highlighting project</link>
17081 at SourceForge.</para>
17084 <para>use a customization layer in which you import one of the following stylesheet modules:
17087 <para><filename>html/highlight.xsl</filename>
17091 <para><filename>xhtml/highlight.xsl</filename>
17095 <para><filename>xhtml-1_1/highlight.xsl</filename>
17099 <para><filename>fo/highlight.xsl</filename>
17105 <listitem><para>let either the <literal>xslthl.config</literal> Java system property or the
17106 <parameter>highlight.xslthl.config</parameter> parameter point to the configuration file for syntax
17107 highlighting (using URL syntax). DocBook XSL comes with a ready-to-use configuration file,
17108 <filename>highlighting/xslthl-config.xml</filename>.</para>
17112 <para>The extension works with Saxon 6.5.x and Xalan-J. (Saxon 8.5 or later is also supported, but since it is
17113 an XSLT 2.0 processor it is not guaranteed to work with DocBook XSL in all circumstances.)</para>
17115 <para>The following is an example of a Saxon 6 command adapted for syntax highlighting, to be used on Windows:</para>
17118 <para><command>java -cp c:/Java/saxon.jar;c:/Java/xslthl-2.0.1.jar
17119 -Dxslthl.config=file:///c:/docbook-xsl/highlighting/xslthl-config.xml com.icl.saxon.StyleSheet
17120 -o test.html test.xml myhtml.xsl</command></para>
17126 <refentry version="5.0" id="highlight.xslthl.config">
17128 <refentrytitle>highlight.xslthl.config</refentrytitle>
17129 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
17132 <refname>highlight.xslthl.config</refname>
17133 <refpurpose>Location of XSLTHL configuration file</refpurpose>
17137 <programlisting id="highlight.xslthl.config.frag">
17138 <xsl:param name="highlight.xslthl.config"></xsl:param>
17142 <refsection><info><title>Description</title></info>
17144 <para>This location has precedence over the corresponding Java property.</para>
17149 <refentry version="5.0" id="highlight.default.language">
17151 <refentrytitle>highlight.default.language</refentrytitle>
17152 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
17155 <refname>highlight.default.language</refname>
17156 <refpurpose>Default language of programlisting</refpurpose>
17160 <programlisting id="highlight.default.language.frag">
17161 <xsl:param name="highlight.default.language"></xsl:param>
17165 <refsection><info><title>Description</title></info>
17167 <para>This language is used when there is no language attribute on programlisting.</para>
17172 <refentry version="5.0" id="email.delimiters.enabled">
17174 <refentrytitle>email.delimiters.enabled</refentrytitle>
17175 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
17178 <refname>email.delimiters.enabled</refname>
17179 <refpurpose>Generate delimiters around email addresses?</refpurpose>
17183 <programlisting id="email.delimiters.enabled.frag">
17184 <xsl:param name="email.delimiters.enabled" select="1"></xsl:param>
17188 <refsection><info><title>Description</title></info>
17190 <para>If non-zero, delimiters
17192 <footnote><para>For delimiters, the
17193 stylesheets are currently hard-coded to output angle
17194 brackets.</para></footnote>
17196 are generated around e-mail addresses
17197 (the output of the <tag>email</tag> element).</para>
17202 <refentry version="5.0" id="email.mailto.enabled">
17204 <refentrytitle>email.mailto.enabled</refentrytitle>
17205 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
17208 <refname>email.mailto.enabled</refname>
17209 <refpurpose>Generate mailto: links for email addresses?</refpurpose>
17213 <programlisting id="email.mailto.enabled.frag">
17214 <xsl:param name="email.mailto.enabled" select="0"></xsl:param>
17218 <refsection><info><title>Description</title></info>
17220 <para>If non-zero the generated output for the <tag>email</tag> element
17221 will be a clickable mailto: link that brings up the default mail client
17222 on the system.</para>
17227 <refentry version="5.0" id="section.container.element">
17229 <refentrytitle>section.container.element</refentrytitle>
17230 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
17231 <refmiscinfo class="other" otherclass="value">block</refmiscinfo>
17232 <refmiscinfo class="other" otherclass="value">wrapper</refmiscinfo>
17235 <refname>section.container.element</refname>
17236 <refpurpose>Select XSL-FO element name to contain sections</refpurpose>
17240 <programlisting id="section.container.element.frag">
17241 <xsl:param name="section.container.element">block</xsl:param>
17245 <refsection><info><title>Description</title></info>
17247 <para>Selects the element name for outer container of
17248 each section. The choices are <literal>block</literal> (default)
17249 or <literal>wrapper</literal>.
17250 The <literal>fo:</literal> namespace prefix is added
17251 by the stylesheet to form the full element name.
17254 <para>This element receives the section <literal>id</literal>
17255 attribute and the appropriate section level attribute-set.
17258 <para>Changing this parameter to <literal>wrapper</literal>
17259 is only necessary when producing multi-column output
17260 that contains page-wide spans. Using <literal>fo:wrapper</literal>
17261 avoids the nesting of <literal>fo:block</literal>
17262 elements that prevents spans from working (the standard says
17263 a span must be on a block that is a direct child of
17264 <literal>fo:flow</literal>).
17267 <para>If set to <literal>wrapper</literal>, the
17268 section attribute-sets only support properties
17269 that are inheritable. That's because there is no
17270 block to apply them to. Properties such as
17271 font-family are inheritable, but properties such as
17275 <para>Only some XSL-FO processors need to use this parameter.
17276 The Antenna House processor, for example, will handle
17277 spans in nested blocks without changing the element name.
17278 The RenderX XEP product and FOP follow the XSL-FO standard
17279 and need to use <literal>wrapper</literal>.
17285 <refentry version="5.0" id="monospace.verbatim.font.width">
17287 <refentrytitle>monospace.verbatim.font.width</refentrytitle>
17288 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
17291 <refname>monospace.verbatim.font.width</refname>
17292 <refpurpose>Width of a single monospace font character</refpurpose>
17296 <programlisting id="monospace.verbatim.font.width.frag">
17297 <xsl:param name="monospace.verbatim.font.width">0.60em</xsl:param>
17301 <refsection><info><title>Description</title></info>
17303 <para>Specifies with em units the width of a single character
17304 of the monospace font. The default value is <literal>0.6em</literal>.</para>
17306 <para>This parameter is only used when a <tag>screen</tag>
17307 or <tag>programlisting</tag> element has a
17308 <tag class="attribute">width</tag> attribute, which is
17309 expressed as a plain integer to indicate the maximum character count
17311 To convert this character count to an actual maximum width
17312 measurement, the width of the font characters must be provided.
17313 Different monospace fonts have different character width,
17314 so this parameter should be adjusted to fit the
17315 monospace font being used.
17321 <refentry version="5.0" id="exsl.node.set.available">
17323 <refentrytitle>exsl.node.set.available</refentrytitle>
17324 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
17327 <refname>exsl.node.set.available</refname>
17328 <refpurpose>Is the test function-available('exsl:node-set') true?</refpurpose>
17332 <programlisting id="exsl.node.set.available.frag"><xsl:param name="exsl.node.set.available">
17334 <xsl:when exsl:foo="" test="function-available('exsl:node-set') or contains(system-property('xsl:vendor'), 'Apache Software Foundation')">1</xsl:when>
17335 <xsl:otherwise>0</xsl:otherwise>
17336 </xsl:choose>
17341 <refsection><info><title>Description</title></info>
17344 then the exsl:node-set() function is available to be used in
17346 If zero, then the function is not available.
17347 This param automatically detects the presence of
17348 the function and does not normally need to be set manually.</para>
17350 <para>This param was created to handle a long-standing
17351 bug in the Xalan processor that fails to detect the
17352 function even though it is available.</para>
17357 <refentry version="5.0" id="bookmarks.collapse">
17359 <refentrytitle>bookmarks.collapse</refentrytitle>
17360 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
17363 <refname>bookmarks.collapse</refname>
17364 <refpurpose>Specifies the initial state of bookmarks</refpurpose>
17368 <programlisting id="bookmarks.collapse.frag">
17369 <xsl:param name="bookmarks.collapse" select="1"></xsl:param>
17373 <refsection><info><title>Description</title></info>
17375 <para>If non-zero, the bookmark tree is collapsed so that only the
17376 top-level bookmarks are displayed initially. Otherwise, the whole tree
17377 of bookmarks is displayed.</para>
17379 <para>This parameter currently works with FOP 0.93 or later.</para>
17384 </reference><reference id="graphics" xml:base="../fo/param.xml"><title>Graphics</title>
17385 <refentry version="5.0" id="graphic.default.extension">
17387 <refentrytitle>graphic.default.extension</refentrytitle>
17388 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
17391 <refname>graphic.default.extension</refname>
17392 <refpurpose>Default extension for graphic filenames</refpurpose>
17396 <programlisting id="graphic.default.extension.frag"><xsl:param name="graphic.default.extension"></xsl:param></programlisting>
17399 <refsection><info><title>Description</title></info>
17401 <para>If a <tag>graphic</tag> or <tag>mediaobject</tag>
17402 includes a reference to a filename that does not include an extension,
17403 and the <tag class="attribute">format</tag> attribute is
17404 <emphasis>unspecified</emphasis>, the default extension will be used.
17410 <refentry version="5.0" id="default.image.width">
17412 <refentrytitle>default.image.width</refentrytitle>
17413 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
17416 <refname>default.image.width</refname>
17417 <refpurpose>The default width of images</refpurpose>
17421 <programlisting id="default.image.width.frag">
17422 <xsl:param name="default.image.width"></xsl:param>
17426 <refsection><info><title>Description</title></info>
17428 <para>If specified, this value will be used for the
17429 <tag class="attribute">width</tag> attribute on
17430 images that do not specify any
17431 <link xlink:href="http://docbook.org/tdg/en/html/imagedata.html#viewport.area">viewport
17432 dimensions</link>.</para>
17437 <refentry version="5.0" id="preferred.mediaobject.role">
17439 <refentrytitle>preferred.mediaobject.role</refentrytitle>
17440 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
17443 <refname>preferred.mediaobject.role</refname>
17444 <refpurpose>Select which mediaobject to use based on
17445 this value of an object's <tag class="attribute">role</tag> attribute.
17450 <programlisting id="preferred.mediaobject.role.frag">
17451 <xsl:param name="preferred.mediaobject.role"></xsl:param>
17455 <refsection><info><title>Description</title></info>
17457 <para>A mediaobject may contain several objects such as imageobjects.
17458 If the parameter <parameter>use.role.for.mediaobject</parameter> is
17459 non-zero, then the <literal>role</literal> attribute on
17460 <tag>imageobject</tag>s and other objects within a
17461 <tag>mediaobject</tag> container will be used to select which object
17462 will be used. If one of the objects has a role value that matches the
17463 <parameter>preferred.mediaobject.role</parameter> parameter, then it
17464 has first priority for selection. If more than one has such a role
17465 value, the first one is used.
17468 See the <parameter>use.role.for.mediaobject</parameter> parameter
17469 for the sequence of selection.</para>
17473 <refentry version="5.0" id="use.role.for.mediaobject">
17475 <refentrytitle>use.role.for.mediaobject</refentrytitle>
17476 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
17479 <refname>use.role.for.mediaobject</refname>
17480 <refpurpose>Use <tag class="attribute">role</tag> attribute
17481 value for selecting which of several objects within a mediaobject to use.
17486 <programlisting id="use.role.for.mediaobject.frag">
17487 <xsl:param name="use.role.for.mediaobject" select="1"></xsl:param>
17491 <refsection><info><title>Description</title></info>
17493 <para>If non-zero, the <tag class="attribute">role</tag> attribute on
17494 <tag>imageobject</tag>s or other objects within a <tag>mediaobject</tag> container will be used to select which object will be
17498 The order of selection when then parameter is non-zero is:
17502 <para>If the stylesheet parameter <parameter>preferred.mediaobject.role</parameter> has a value, then the object whose role equals that value is selected.</para>
17505 <para>Else if an object's role attribute has a value of
17506 <literal>html</literal> for HTML processing or
17507 <literal>fo</literal> for FO output, then the first
17508 of such objects is selected.
17512 <para>Else the first suitable object is selected.</para>
17517 <parameter>use.role.for.mediaobject</parameter>
17518 is zero, then role attributes are not considered
17519 and the first suitable object
17520 with or without a role value is used.
17525 <refentry version="5.0" id="ignore.image.scaling">
17527 <refentrytitle>ignore.image.scaling</refentrytitle>
17528 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
17531 <refname>ignore.image.scaling</refname>
17532 <refpurpose>Tell the stylesheets to ignore the author's image scaling attributes</refpurpose>
17536 <programlisting id="ignore.image.scaling.frag">
17537 <xsl:param name="ignore.image.scaling" select="0"></xsl:param>
17541 <refsection><info><title>Description</title></info>
17543 <para>If non-zero, the scaling attributes on graphics and media objects are
17549 <refentry version="5.0" id="img.src.path">
17551 <refentrytitle>img.src.path</refentrytitle>
17552 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
17555 <refname>img.src.path</refname>
17556 <refpurpose>Path to HTML/FO image files</refpurpose>
17560 <programlisting id="img.src.path.frag"><xsl:param name="img.src.path"></xsl:param></programlisting>
17563 <refsection><info><title>Description</title></info>
17565 <para>Add a path prefix to the value of the <tag class="attribute">fileref</tag>
17566 attribute of <tag>graphic</tag>, <tag>inlinegraphic</tag>, and <tag>imagedata</tag> elements. The resulting
17567 compound path is used in the output as the value of the <tag class="attribute">src</tag>
17568 attribute of <tag class="element">img</tag> (HTML) or <tag class="element">external-graphic</tag> (FO).
17572 The path given by <literal>img.src.path</literal> could be relative to the directory where the HTML/FO
17573 files are created, or it could be an absolute URI.
17574 The default value is empty.
17575 Be sure to include a trailing slash if needed.
17578 <para>This prefix is not applied to any filerefs that start
17579 with "/" or contain "//:".
17585 <refentry version="5.0" id="keep.relative.image.uris">
17587 <refentrytitle>keep.relative.image.uris</refentrytitle>
17588 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
17591 <refname>keep.relative.image.uris</refname>
17592 <refpurpose>Should image URIs be resolved against xml:base?</refpurpose>
17596 <programlisting id="keep.relative.image.uris.frag">
17598 <xsl:param name="keep.relative.image.uris" select="0"></xsl:param>
17602 <refsection><info><title>Description</title></info>
17604 <para>If non-zero, relative URIs (in, for example
17605 <literal>fileref</literal> attributes) will be used in the generated
17606 output. Otherwise, the URIs will be made absolute with respect to the
17609 <para>Note that the stylesheets calculate (and use) the absolute form
17610 for some purposes, this only applies to the resulting output.</para>
17615 </reference><reference id="general" xml:base="../fo/param.xml"><title>Pagination and General Styles</title>
17616 <partintro id="margins_partintro">
17617 <section id="margins_intro"><title>Understanding XSL FO Margins</title>
17619 <para>To make sense of the parameters in this section, it's useful to
17620 consider <xref linkend="fig.pagemodel"/>.</para>
17622 <figure id="fig.pagemodel">
17623 <title>Page Model</title>
17624 <mediaobject id="fo-pageregions-image">
17625 <imageobject role="html">
17626 <imagedata fileref="page.png"/>
17628 <imageobject role="fo">
17629 <imagedata fileref="fo/page.png"/>
17631 <textobject><phrase>Figure showing page margins</phrase></textobject>
17633 <para>This figure shows the physical page with the various FO page regions
17639 <para>First, let's consider the regions on the page.</para>
17641 <para>The white region is the physical page. Its dimensions are determined by
17642 the <parameter>page.height</parameter> and <parameter>page.width</parameter>
17645 <para>The yellow region is the region-body. The size and placement of
17646 the region body is constrained by the dimensions labelled in the
17649 <para>The pink region at the top of the page is the region-before. The
17650 darker area inside the region-before is the header text. In XSL, the default
17651 display alignment for a region is <literal>before</literal>, but the
17652 DocBook stylesheets still explicitly make it <literal>before</literal>. That's
17653 why the darker area is at the top.</para>
17655 <para>The pink region at the bottom of the page is the region-after.
17656 The darker area is the footer text. In XSL, the default display
17657 alignment for a region is <literal>before</literal>,
17658 but the DocBook stylesheets explicitly make it
17659 <literal>after</literal>. That's why the darker area is at the bottom.</para>
17661 <para>The dimensions in the figure are:</para>
17663 <orderedlist numeration="upperalpha">
17664 <listitem><para>The page-master margin-top.
17666 <listitem><para>The region-before extent.
17668 <listitem><para>The region-body margin-top.
17670 <listitem><para>The region-after extent.
17672 <listitem><para>The page-master margin-bottom.
17674 <listitem><para>The region-body margin-bottom.
17676 <listitem><para>The sum of the page-master margin-left and the
17677 region-body margin-left. In DocBook, the region-body margin-left is
17678 zero by default, so this is simply the page-master margin-left.
17680 <listitem><para>The sum of the page-master margin-right and the
17681 region-body margin-right. In DocBook, the region-body margin-right is
17682 zero by default, so this is simply the page-master margin-right.
17689 <refentry version="5.0" id="page.height">
17691 <refentrytitle>page.height</refentrytitle>
17692 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
17695 <refname>page.height</refname>
17696 <refpurpose>The height of the physical page</refpurpose>
17700 <programlisting id="page.height.frag"><xsl:param name="page.height">
17702 <xsl:when test="$page.orientation = 'portrait'">
17703 <xsl:value-of select="$page.height.portrait"></xsl:value-of>
17705 <xsl:otherwise>
17706 <xsl:value-of select="$page.width.portrait"></xsl:value-of>
17707 </xsl:otherwise>
17708 </xsl:choose>
17709 </xsl:param></programlisting>
17712 <refsection><info><title>Description</title></info>
17714 <para>The page height is generally calculated from the
17715 <parameter>paper.type</parameter> and
17716 <parameter>page.orientation</parameter> parameters.
17722 <refentry version="5.0" id="page.height.portrait">
17724 <refentrytitle>page.height.portrait</refentrytitle>
17725 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
17728 <refname>page.height.portrait</refname>
17729 <refpurpose>Specify the physical size of the long edge of the page</refpurpose>
17733 <programlisting id="page.height.portrait.frag"><xsl:param name="page.height.portrait">
17735 <xsl:when test="$paper.type = 'A4landscape'">210mm</xsl:when>
17736 <xsl:when test="$paper.type = 'USletter'">11in</xsl:when>
17737 <xsl:when test="$paper.type = 'USlandscape'">8.5in</xsl:when>
17738 <xsl:when test="$paper.type = '4A0'">2378mm</xsl:when>
17739 <xsl:when test="$paper.type = '2A0'">1682mm</xsl:when>
17740 <xsl:when test="$paper.type = 'A0'">1189mm</xsl:when>
17741 <xsl:when test="$paper.type = 'A1'">841mm</xsl:when>
17742 <xsl:when test="$paper.type = 'A2'">594mm</xsl:when>
17743 <xsl:when test="$paper.type = 'A3'">420mm</xsl:when>
17744 <xsl:when test="$paper.type = 'A4'">297mm</xsl:when>
17745 <xsl:when test="$paper.type = 'A5'">210mm</xsl:when>
17746 <xsl:when test="$paper.type = 'A6'">148mm</xsl:when>
17747 <xsl:when test="$paper.type = 'A7'">105mm</xsl:when>
17748 <xsl:when test="$paper.type = 'A8'">74mm</xsl:when>
17749 <xsl:when test="$paper.type = 'A9'">52mm</xsl:when>
17750 <xsl:when test="$paper.type = 'A10'">37mm</xsl:when>
17751 <xsl:when test="$paper.type = 'B0'">1414mm</xsl:when>
17752 <xsl:when test="$paper.type = 'B1'">1000mm</xsl:when>
17753 <xsl:when test="$paper.type = 'B2'">707mm</xsl:when>
17754 <xsl:when test="$paper.type = 'B3'">500mm</xsl:when>
17755 <xsl:when test="$paper.type = 'B4'">353mm</xsl:when>
17756 <xsl:when test="$paper.type = 'B5'">250mm</xsl:when>
17757 <xsl:when test="$paper.type = 'B6'">176mm</xsl:when>
17758 <xsl:when test="$paper.type = 'B7'">125mm</xsl:when>
17759 <xsl:when test="$paper.type = 'B8'">88mm</xsl:when>
17760 <xsl:when test="$paper.type = 'B9'">62mm</xsl:when>
17761 <xsl:when test="$paper.type = 'B10'">44mm</xsl:when>
17762 <xsl:when test="$paper.type = 'C0'">1297mm</xsl:when>
17763 <xsl:when test="$paper.type = 'C1'">917mm</xsl:when>
17764 <xsl:when test="$paper.type = 'C2'">648mm</xsl:when>
17765 <xsl:when test="$paper.type = 'C3'">458mm</xsl:when>
17766 <xsl:when test="$paper.type = 'C4'">324mm</xsl:when>
17767 <xsl:when test="$paper.type = 'C5'">229mm</xsl:when>
17768 <xsl:when test="$paper.type = 'C6'">162mm</xsl:when>
17769 <xsl:when test="$paper.type = 'C7'">114mm</xsl:when>
17770 <xsl:when test="$paper.type = 'C8'">81mm</xsl:when>
17771 <xsl:when test="$paper.type = 'C9'">57mm</xsl:when>
17772 <xsl:when test="$paper.type = 'C10'">40mm</xsl:when>
17773 <xsl:otherwise>11in</xsl:otherwise>
17774 </xsl:choose>
17775 </xsl:param></programlisting>
17778 <refsection><info><title>Description</title></info>
17780 <para>The portrait page height is the length of the long
17781 edge of the physical page.
17787 <refentry version="5.0" id="page.margin.bottom">
17789 <refentrytitle>page.margin.bottom</refentrytitle>
17790 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
17793 <refname>page.margin.bottom</refname>
17794 <refpurpose>The bottom margin of the page</refpurpose>
17798 <programlisting id="page.margin.bottom.frag">
17799 <xsl:param name="page.margin.bottom">0.5in</xsl:param>
17803 <refsection><info><title>Description</title></info>
17805 <para>The bottom page margin is the distance from the bottom of the region-after
17806 to the physical bottom of the page.
17812 <refentry version="5.0" id="page.margin.inner">
17814 <refentrytitle>page.margin.inner</refentrytitle>
17815 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
17818 <refname>page.margin.inner</refname>
17819 <refpurpose>The inner page margin</refpurpose>
17823 <programlisting id="page.margin.inner.frag"><xsl:param name="page.margin.inner">
17825 <xsl:when test="$double.sided != 0">1.25in</xsl:when>
17826 <xsl:otherwise>1in</xsl:otherwise>
17827 </xsl:choose>
17828 </xsl:param></programlisting>
17831 <refsection><info><title>Description</title></info>
17833 <para>The inner page margin is the distance from bound edge of the
17834 page to the first column of text. </para>
17836 <para>The inner page margin is the distance from bound edge of the
17837 page to the outer edge of the first column of text.</para>
17839 <para>In left-to-right text direction,
17840 this is the left margin of recto (front side) pages.
17841 For single-sided output, it is the left margin
17842 of all pages.</para>
17844 <para>In right-to-left text direction,
17845 this is the right margin of recto pages.
17846 For single-sided output, this is the
17847 right margin of all pages.</para>
17850 <para>Current versions (at least as of version 4.13)
17851 of the XEP XSL-FO processor do not
17852 correctly handle these margin settings for documents
17853 with right-to-left text direction.
17854 The workaround in that situation is to reverse
17855 the values for <parameter>page.margin.inner</parameter>
17856 and <parameter>page.margin.outer</parameter>, until
17857 this bug is fixed by RenderX. It does not affect documents
17858 with left-to-right text direction.</para>
17864 <refentry version="5.0" id="page.margin.outer">
17866 <refentrytitle>page.margin.outer</refentrytitle>
17867 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
17870 <refname>page.margin.outer</refname>
17871 <refpurpose>The outer page margin</refpurpose>
17875 <programlisting id="page.margin.outer.frag"><xsl:param name="page.margin.outer">
17877 <xsl:when test="$double.sided != 0">0.75in</xsl:when>
17878 <xsl:otherwise>1in</xsl:otherwise>
17879 </xsl:choose>
17880 </xsl:param></programlisting>
17883 <refsection><info><title>Description</title></info>
17885 <para>The outer page margin is the distance from non-bound edge of the
17886 page to the outer edge of the last column of text.</para>
17888 <para>In left-to-right text direction,
17889 this is the right margin of recto (front side) pages.
17890 For single-sided output, it is the right margin
17891 of all pages.</para>
17893 <para>In right-to-left text direction,
17894 this is the left margin of recto pages.
17895 For single-sided output, this is the
17896 left margin of all pages.</para>
17899 <para>Current versions (at least as of version 4.13)
17900 of the XEP XSL-FO processor do not
17901 correctly handle these margin settings for documents
17902 with right-to-left text direction.
17903 The workaround in that situation is to reverse
17904 the values for <parameter>page.margin.inner</parameter>
17905 and <parameter>page.margin.outer</parameter>, until
17906 this bug is fixed by RenderX. It does not affect documents
17907 with left-to-right text direction.</para>
17913 <refentry version="5.0" id="page.margin.top">
17915 <refentrytitle>page.margin.top</refentrytitle>
17916 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
17919 <refname>page.margin.top</refname>
17920 <refpurpose>The top margin of the page</refpurpose>
17924 <programlisting id="page.margin.top.frag">
17925 <xsl:param name="page.margin.top">0.5in</xsl:param>
17929 <refsection><info><title>Description</title></info>
17931 <para>The top page margin is the distance from the physical top of the
17932 page to the top of the region-before.</para>
17937 <refentry version="5.0" id="page.orientation">
17939 <refentrytitle>page.orientation</refentrytitle>
17940 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
17941 <refmiscinfo class="other" otherclass="value">portrait</refmiscinfo>
17942 <refmiscinfo class="other" otherclass="value">landscape</refmiscinfo>
17945 <refname>page.orientation</refname>
17946 <refpurpose>Select the page orientation</refpurpose>
17950 <programlisting id="page.orientation.frag">
17951 <xsl:param name="page.orientation">portrait</xsl:param>
17955 <refsection><info><title>Description</title></info>
17957 <para> Select one from portrait or landscape.
17958 In portrait orientation, the short edge is horizontal; in
17959 landscape orientation, it is vertical.
17965 <refentry version="5.0" id="page.width">
17967 <refentrytitle>page.width</refentrytitle>
17968 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
17971 <refname>page.width</refname>
17972 <refpurpose>The width of the physical page</refpurpose>
17976 <programlisting id="page.width.frag"><xsl:param name="page.width">
17978 <xsl:when test="$page.orientation = 'portrait'">
17979 <xsl:value-of select="$page.width.portrait"></xsl:value-of>
17981 <xsl:otherwise>
17982 <xsl:value-of select="$page.height.portrait"></xsl:value-of>
17983 </xsl:otherwise>
17984 </xsl:choose>
17985 </xsl:param></programlisting>
17988 <refsection><info><title>Description</title></info>
17990 <para>The page width is generally calculated from the
17991 <parameter>paper.type</parameter> and
17992 <parameter>page.orientation</parameter> parameters.</para>
17997 <refentry version="5.0" id="page.width.portrait">
17999 <refentrytitle>page.width.portrait</refentrytitle>
18000 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
18003 <refname>page.width.portrait</refname>
18004 <refpurpose>Specify the physical size of the short edge of the page</refpurpose>
18008 <programlisting id="page.width.portrait.frag"><xsl:param name="page.width.portrait">
18010 <xsl:when test="$paper.type = 'USletter'">8.5in</xsl:when>
18011 <xsl:when test="$paper.type = '4A0'">1682mm</xsl:when>
18012 <xsl:when test="$paper.type = '2A0'">1189mm</xsl:when>
18013 <xsl:when test="$paper.type = 'A0'">841mm</xsl:when>
18014 <xsl:when test="$paper.type = 'A1'">594mm</xsl:when>
18015 <xsl:when test="$paper.type = 'A2'">420mm</xsl:when>
18016 <xsl:when test="$paper.type = 'A3'">297mm</xsl:when>
18017 <xsl:when test="$paper.type = 'A4'">210mm</xsl:when>
18018 <xsl:when test="$paper.type = 'A5'">148mm</xsl:when>
18019 <xsl:when test="$paper.type = 'A6'">105mm</xsl:when>
18020 <xsl:when test="$paper.type = 'A7'">74mm</xsl:when>
18021 <xsl:when test="$paper.type = 'A8'">52mm</xsl:when>
18022 <xsl:when test="$paper.type = 'A9'">37mm</xsl:when>
18023 <xsl:when test="$paper.type = 'A10'">26mm</xsl:when>
18024 <xsl:when test="$paper.type = 'B0'">1000mm</xsl:when>
18025 <xsl:when test="$paper.type = 'B1'">707mm</xsl:when>
18026 <xsl:when test="$paper.type = 'B2'">500mm</xsl:when>
18027 <xsl:when test="$paper.type = 'B3'">353mm</xsl:when>
18028 <xsl:when test="$paper.type = 'B4'">250mm</xsl:when>
18029 <xsl:when test="$paper.type = 'B5'">176mm</xsl:when>
18030 <xsl:when test="$paper.type = 'B6'">125mm</xsl:when>
18031 <xsl:when test="$paper.type = 'B7'">88mm</xsl:when>
18032 <xsl:when test="$paper.type = 'B8'">62mm</xsl:when>
18033 <xsl:when test="$paper.type = 'B9'">44mm</xsl:when>
18034 <xsl:when test="$paper.type = 'B10'">31mm</xsl:when>
18035 <xsl:when test="$paper.type = 'C0'">917mm</xsl:when>
18036 <xsl:when test="$paper.type = 'C1'">648mm</xsl:when>
18037 <xsl:when test="$paper.type = 'C2'">458mm</xsl:when>
18038 <xsl:when test="$paper.type = 'C3'">324mm</xsl:when>
18039 <xsl:when test="$paper.type = 'C4'">229mm</xsl:when>
18040 <xsl:when test="$paper.type = 'C5'">162mm</xsl:when>
18041 <xsl:when test="$paper.type = 'C6'">114mm</xsl:when>
18042 <xsl:when test="$paper.type = 'C7'">81mm</xsl:when>
18043 <xsl:when test="$paper.type = 'C8'">57mm</xsl:when>
18044 <xsl:when test="$paper.type = 'C9'">40mm</xsl:when>
18045 <xsl:when test="$paper.type = 'C10'">28mm</xsl:when>
18046 <xsl:otherwise>8.5in</xsl:otherwise>
18047 </xsl:choose>
18048 </xsl:param></programlisting>
18051 <refsection><info><title>Description</title></info>
18053 <para>The portrait page width is the length of the short
18054 edge of the physical page.
18060 <refentry version="5.0" id="paper.type">
18062 <refentrytitle>paper.type</refentrytitle>
18063 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
18064 <refmiscinfo class="other" otherclass="list-type">open</refmiscinfo>
18065 <refmiscinfo class="other" otherclass="list-type">open</refmiscinfo>
18066 <refmiscinfo class="other" otherclass="value">USletter<alt>8.5x11in</alt></refmiscinfo>
18067 <refmiscinfo class="other" otherclass="value">USlandscape<alt>11x8.5in</alt></refmiscinfo>
18068 <refmiscinfo class="other" otherclass="value">4A0<alt>2378x1682mm</alt></refmiscinfo>
18069 <refmiscinfo class="other" otherclass="value">2A0<alt>1682x1189mm</alt></refmiscinfo>
18070 <refmiscinfo class="other" otherclass="value">A0<alt>1189x841mm</alt></refmiscinfo>
18071 <refmiscinfo class="other" otherclass="value">A1<alt>841x594mm</alt></refmiscinfo>
18072 <refmiscinfo class="other" otherclass="value">A2<alt>594x420mm</alt></refmiscinfo>
18073 <refmiscinfo class="other" otherclass="value">A3<alt>420x297mm</alt></refmiscinfo>
18074 <refmiscinfo class="other" otherclass="value">A4<alt>297x210mm</alt></refmiscinfo>
18075 <refmiscinfo class="other" otherclass="value">A5<alt>210x148mm</alt></refmiscinfo>
18076 <refmiscinfo class="other" otherclass="value">A6<alt>148x105mm</alt></refmiscinfo>
18077 <refmiscinfo class="other" otherclass="value">A7<alt>105x74mm</alt></refmiscinfo>
18078 <refmiscinfo class="other" otherclass="value">A8<alt>74x52mm</alt></refmiscinfo>
18079 <refmiscinfo class="other" otherclass="value">A9<alt>52x37mm</alt></refmiscinfo>
18080 <refmiscinfo class="other" otherclass="value">A10<alt>37x26mm</alt></refmiscinfo>
18081 <refmiscinfo class="other" otherclass="value">B0<alt>1414x1000mm</alt></refmiscinfo>
18082 <refmiscinfo class="other" otherclass="value">B1<alt>1000x707mm</alt></refmiscinfo>
18083 <refmiscinfo class="other" otherclass="value">B2<alt>707x500mm</alt></refmiscinfo>
18084 <refmiscinfo class="other" otherclass="value">B3<alt>500x353mm</alt></refmiscinfo>
18085 <refmiscinfo class="other" otherclass="value">B4<alt>353x250mm</alt></refmiscinfo>
18086 <refmiscinfo class="other" otherclass="value">B5<alt>250x176mm</alt></refmiscinfo>
18087 <refmiscinfo class="other" otherclass="value">B6<alt>176x125mm</alt></refmiscinfo>
18088 <refmiscinfo class="other" otherclass="value">B7<alt>125x88mm</alt></refmiscinfo>
18089 <refmiscinfo class="other" otherclass="value">B8<alt>88x62mm</alt></refmiscinfo>
18090 <refmiscinfo class="other" otherclass="value">B9<alt>62x44mm</alt></refmiscinfo>
18091 <refmiscinfo class="other" otherclass="value">B10<alt>44x31mm</alt></refmiscinfo>
18092 <refmiscinfo class="other" otherclass="value">C0<alt>1297x917mm</alt></refmiscinfo>
18093 <refmiscinfo class="other" otherclass="value">C1<alt>917x648mm</alt></refmiscinfo>
18094 <refmiscinfo class="other" otherclass="value">C2<alt>648x458mm</alt></refmiscinfo>
18095 <refmiscinfo class="other" otherclass="value">C3<alt>458x324mm</alt></refmiscinfo>
18096 <refmiscinfo class="other" otherclass="value">C4<alt>324x229mm</alt></refmiscinfo>
18097 <refmiscinfo class="other" otherclass="value">C5<alt>229x162mm</alt></refmiscinfo>
18098 <refmiscinfo class="other" otherclass="value">C6<alt>162x114mm</alt></refmiscinfo>
18099 <refmiscinfo class="other" otherclass="value">C7<alt>114x81mm</alt></refmiscinfo>
18100 <refmiscinfo class="other" otherclass="value">C8<alt>81x57mm</alt></refmiscinfo>
18101 <refmiscinfo class="other" otherclass="value">C9<alt>57x40mm</alt></refmiscinfo>
18102 <refmiscinfo class="other" otherclass="value">C10<alt>40x28mm</alt></refmiscinfo>
18105 <refname>paper.type</refname>
18106 <refpurpose>Select the paper type</refpurpose>
18110 <programlisting id="paper.type.frag">
18111 <xsl:param name="paper.type">USletter</xsl:param>
18115 <refsection><info><title>Description</title></info>
18117 <para>The paper type is a convenient way to specify the paper size.
18118 The list of known paper sizes includes USletter and most of the A,
18119 B, and C sizes. See <parameter>page.width.portrait</parameter>, for example.
18127 <refentry version="5.0" id="double.sided">
18129 <refentrytitle>double.sided</refentrytitle>
18130 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
18133 <refname>double.sided</refname>
18134 <refpurpose>Is the document to be printed double sided?</refpurpose>
18138 <programlisting id="double.sided.frag">
18139 <xsl:param name="double.sided" select="0"></xsl:param>
18143 <refsection><info><title>Description</title></info>
18145 <para>Double-sided documents are printed with a slightly wider margin
18146 on the binding edge of the page.
18148 <para>FIXME: The current set of parameters does not take writing direction
18149 into account.</para>
18154 <refentry version="5.0" id="body.margin.bottom">
18156 <refentrytitle>body.margin.bottom</refentrytitle>
18157 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
18160 <refname>body.margin.bottom</refname>
18161 <refpurpose>The bottom margin of the body text</refpurpose>
18165 <programlisting id="body.margin.bottom.frag">
18166 <xsl:param name="body.margin.bottom">0.5in</xsl:param>
18170 <refsection><info><title>Description</title></info>
18172 <para>The body bottom margin is the distance from the last line of text
18173 in the page body to the bottom of the region-after.
18179 <refentry version="5.0" id="body.margin.top">
18181 <refentrytitle>body.margin.top</refentrytitle>
18182 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
18185 <refname>body.margin.top</refname>
18186 <refpurpose>To specify the size of the top margin of a page</refpurpose>
18190 <programlisting id="body.margin.top.frag">
18191 <xsl:param name="body.margin.top">0.5in</xsl:param>
18195 <refsection><info><title>Description</title></info>
18197 <para>The body top margin is the distance from the top of the
18198 region-before to the first line of text in the page body.</para>
18203 <refentry version="5.0" id="body.start.indent">
18205 <refentrytitle>body.start.indent</refentrytitle>
18206 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
18209 <refname>body.start.indent</refname>
18210 <refpurpose>The start-indent for the body text</refpurpose>
18214 <programlisting id="body.start.indent.frag">
18215 <xsl:param name="body.start.indent">
18217 <xsl:when test="$fop.extensions != 0">0pt</xsl:when>
18218 <xsl:when test="$passivetex.extensions != 0">0pt</xsl:when>
18219 <xsl:otherwise>4pc</xsl:otherwise>
18220 </xsl:choose>
18225 <refsection><info><title>Description</title></info>
18227 <para>This parameter provides
18228 the means of indenting the body text relative to
18230 For left-to-right text direction, it indents the left side.
18231 For right-to-left text direction, it indents the right side.
18232 It is used in place of the
18233 <parameter>title.margin.left</parameter> for
18234 all XSL-FO processors except FOP 0.25.
18235 It enables support for side floats to appear
18236 in the indented margin area.
18238 <para>This start-indent property is added to the fo:flow
18239 for certain page sequences. Which page-sequences it is
18240 applied to is determined by the template named
18241 <literal>set.flow.properties</literal>.
18242 By default, that template adds it to the flow
18243 for page-sequences using the <quote>body</quote>
18244 master-reference, as well as appendixes and prefaces.
18246 <para>If this parameter is used, section titles should have
18247 a start-indent value of 0pt if they are to be
18248 outdented relative to the body text.
18251 <para>If you are using FOP, then set this parameter to a zero
18252 width value and set the <parameter>title.margin.left</parameter>
18253 parameter to the negative value of the desired indent.
18256 <para>See also <parameter>body.end.indent</parameter> and
18257 <parameter>title.margin.left</parameter>.
18263 <refentry version="5.0" id="body.end.indent">
18265 <refentrytitle>body.end.indent</refentrytitle>
18266 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
18269 <refname>body.end.indent</refname>
18270 <refpurpose>The end-indent for the body text</refpurpose>
18274 <programlisting id="body.end.indent.frag">
18275 <xsl:param name="body.end.indent">0pt</xsl:param>
18279 <refsection><info><title>Description</title></info>
18281 <para>This end-indent property is added to the fo:flow
18282 for certain page sequences. Which page-sequences it is
18283 applied to is determined by the template named
18284 <literal>set.flow.properties</literal>.
18285 By default, that template adds it to the flow
18286 for page-sequences using the <quote>body</quote>
18287 master-reference, as well as appendixes and prefaces.
18290 <para>See also <parameter>body.start.indent</parameter>.
18296 <refentry version="5.0" id="alignment">
18298 <refentrytitle>alignment</refentrytitle>
18299 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
18300 <refmiscinfo class="other" otherclass="list-type">open</refmiscinfo>
18301 <refmiscinfo class="other" otherclass="value">left</refmiscinfo>
18302 <refmiscinfo class="other" otherclass="value">start</refmiscinfo>
18303 <refmiscinfo class="other" otherclass="value">right</refmiscinfo>
18304 <refmiscinfo class="other" otherclass="value">end</refmiscinfo>
18305 <refmiscinfo class="other" otherclass="value">center</refmiscinfo>
18306 <refmiscinfo class="other" otherclass="value">justify</refmiscinfo>
18309 <refname>alignment</refname>
18310 <refpurpose>Specify the default text alignment</refpurpose>
18314 <programlisting id="alignment.frag"><xsl:param name="alignment">justify</xsl:param></programlisting>
18317 <refsection><info><title>Description</title></info>
18319 <para>The default text alignment is used for most body text.
18321 <literal>left</literal>,
18322 <literal>right</literal>,
18323 <literal>start</literal>,
18324 <literal>end</literal>,
18325 <literal>center</literal>,
18326 <literal>justify</literal>.
18327 The default value is <literal>justify</literal>.
18333 <refentry version="5.0" id="hyphenate">
18335 <refentrytitle>hyphenate</refentrytitle>
18336 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
18337 <refmiscinfo class="other" otherclass="list-type">closed</refmiscinfo>
18338 <refmiscinfo class="other" otherclass="value">true</refmiscinfo>
18339 <refmiscinfo class="other" otherclass="value">false</refmiscinfo>
18342 <refname>hyphenate</refname>
18343 <refpurpose>Specify hyphenation behavior</refpurpose>
18347 <programlisting id="hyphenate.frag"><xsl:param name="hyphenate">true</xsl:param></programlisting>
18350 <refsection><info><title>Description</title></info>
18352 <para>If true, words may be hyphenated. Otherwise, they may not.
18358 <refentry version="5.0" id="line-height">
18360 <refentrytitle>line-height</refentrytitle>
18361 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
18364 <refname>line-height</refname>
18365 <refpurpose>Specify the line-height property</refpurpose>
18369 <programlisting id="line-height.frag">
18370 <xsl:param name="line-height">normal</xsl:param>
18374 <refsection><info><title>Description</title></info>
18376 <para>Sets the line-height property.</para>
18381 <refentry version="5.0" id="column.count.back">
18383 <refentrytitle>column.count.back</refentrytitle>
18384 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
18387 <refname>column.count.back</refname>
18388 <refpurpose>Number of columns on back matter pages</refpurpose>
18392 <programlisting id="column.count.back.frag">
18393 <xsl:param name="column.count.back" select="1"></xsl:param>
18397 <refsection><info><title>Description</title></info>
18399 <para>Number of columns on back matter (appendix, glossary, etc.) pages.</para>
18404 <refentry version="5.0" id="column.count.body">
18406 <refentrytitle>column.count.body</refentrytitle>
18407 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
18410 <refname>column.count.body</refname>
18411 <refpurpose>Number of columns on body pages</refpurpose>
18415 <programlisting id="column.count.body.frag">
18416 <xsl:param name="column.count.body" select="1"></xsl:param>
18420 <refsection><info><title>Description</title></info>
18422 <para>Number of columns on body pages.</para>
18427 <refentry version="5.0" id="column.count.front">
18429 <refentrytitle>column.count.front</refentrytitle>
18430 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
18433 <refname>column.count.front</refname>
18434 <refpurpose>Number of columns on front matter pages</refpurpose>
18438 <programlisting id="column.count.front.frag">
18439 <xsl:param name="column.count.front" select="1"></xsl:param>
18443 <refsection><info><title>Description</title></info>
18445 <para>Number of columns on front matter (dedication, preface, etc.) pages.</para>
18450 <refentry version="5.0" id="column.count.index">
18452 <refentrytitle>column.count.index</refentrytitle>
18453 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
18456 <refname>column.count.index</refname>
18457 <refpurpose>Number of columns on index pages</refpurpose>
18461 <programlisting id="column.count.index.frag">
18462 <xsl:param name="column.count.index">2</xsl:param>
18466 <refsection><info><title>Description</title></info>
18468 <para>Number of columns on index pages.</para>
18473 <refentry version="5.0" id="column.count.lot">
18475 <refentrytitle>column.count.lot</refentrytitle>
18476 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
18479 <refname>column.count.lot</refname>
18480 <refpurpose>Number of columns on a 'List-of-Titles' page</refpurpose>
18484 <programlisting id="column.count.lot.frag">
18485 <xsl:param name="column.count.lot" select="1"></xsl:param>
18489 <refsection><info><title>Description</title></info>
18491 <para>Number of columns on a page sequence containing the Table of Contents,
18492 List of Figures, etc.</para>
18497 <refentry version="5.0" id="column.count.titlepage">
18499 <refentrytitle>column.count.titlepage</refentrytitle>
18500 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
18503 <refname>column.count.titlepage</refname>
18504 <refpurpose>Number of columns on a title page</refpurpose>
18508 <programlisting id="column.count.titlepage.frag">
18509 <xsl:param name="column.count.titlepage" select="1"></xsl:param>
18513 <refsection><info><title>Description</title></info>
18515 <para>Number of columns on a title page</para>
18520 <refentry version="5.0" id="column.gap.back">
18522 <refentrytitle>column.gap.back</refentrytitle>
18523 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
18526 <refname>column.gap.back</refname>
18527 <refpurpose>Gap between columns in back matter</refpurpose>
18531 <programlisting id="column.gap.back.frag">
18532 <xsl:param name="column.gap.back">12pt</xsl:param>
18536 <refsection><info><title>Description</title></info>
18538 <para>Specifies the gap between columns in back matter (if
18539 <parameter>column.count.back</parameter> is greater than one).</para>
18544 <refentry version="5.0" id="column.gap.body">
18546 <refentrytitle>column.gap.body</refentrytitle>
18547 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
18550 <refname>column.gap.body</refname>
18551 <refpurpose>Gap between columns in the body</refpurpose>
18555 <programlisting id="column.gap.body.frag">
18556 <xsl:param name="column.gap.body">12pt</xsl:param>
18560 <refsection><info><title>Description</title></info>
18562 <para>Specifies the gap between columns in body matter (if
18563 <parameter>column.count.body</parameter> is greater than one).</para>
18568 <refentry version="5.0" id="column.gap.front">
18570 <refentrytitle>column.gap.front</refentrytitle>
18571 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
18574 <refname>column.gap.front</refname>
18575 <refpurpose>Gap between columns in the front matter</refpurpose>
18579 <programlisting id="column.gap.front.frag">
18580 <xsl:param name="column.gap.front">12pt</xsl:param>
18584 <refsection><info><title>Description</title></info>
18586 <para>Specifies the gap between columns in front matter (if
18587 <parameter>column.count.front</parameter> is greater than one).</para>
18592 <refentry version="5.0" id="column.gap.index">
18594 <refentrytitle>column.gap.index</refentrytitle>
18595 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
18598 <refname>column.gap.index</refname>
18599 <refpurpose>Gap between columns in the index</refpurpose>
18603 <programlisting id="column.gap.index.frag">
18604 <xsl:param name="column.gap.index">12pt</xsl:param>
18608 <refsection><info><title>Description</title></info>
18610 <para>Specifies the gap between columns in indexes (if
18611 <parameter>column.count.index</parameter> is greater than one).</para>
18616 <refentry version="5.0" id="column.gap.lot">
18618 <refentrytitle>column.gap.lot</refentrytitle>
18619 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
18622 <refname>column.gap.lot</refname>
18623 <refpurpose>Gap between columns on a 'List-of-Titles' page</refpurpose>
18627 <programlisting id="column.gap.lot.frag">
18628 <xsl:param name="column.gap.lot">12pt</xsl:param>
18632 <refsection><info><title>Description</title></info>
18634 <para>Specifies the gap between columns on 'List-of-Titles' pages (if
18635 <parameter>column.count.lot</parameter> is greater than one).</para>
18640 <refentry version="5.0" id="column.gap.titlepage">
18642 <refentrytitle>column.gap.titlepage</refentrytitle>
18643 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
18646 <refname>column.gap.titlepage</refname>
18647 <refpurpose>Gap between columns on title pages</refpurpose>
18651 <programlisting id="column.gap.titlepage.frag">
18652 <xsl:param name="column.gap.titlepage">12pt</xsl:param>
18656 <refsection><info><title>Description</title></info>
18658 <para>Specifies the gap between columns on title pages (if
18659 <parameter>column.count.titlepage</parameter> is greater than one).</para>
18665 <refentry version="5.0" id="region.after.extent">
18667 <refentrytitle>region.after.extent</refentrytitle>
18668 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
18671 <refname>region.after.extent</refname>
18672 <refpurpose>Specifies the height of the footer.</refpurpose>
18676 <programlisting id="region.after.extent.frag">
18677 <xsl:param name="region.after.extent">0.4in</xsl:param>
18681 <refsection><info><title>Description</title></info>
18683 <para>The region after extent is the height of the area where footers
18690 <refentry version="5.0" id="region.before.extent">
18692 <refentrytitle>region.before.extent</refentrytitle>
18693 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
18696 <refname>region.before.extent</refname>
18697 <refpurpose>Specifies the height of the header</refpurpose>
18701 <programlisting id="region.before.extent.frag">
18702 <xsl:param name="region.before.extent">0.4in</xsl:param>
18706 <refsection><info><title>Description</title></info>
18708 <para>The region before extent is the height of the area where headers
18715 <refentry version="5.0" id="default.units">
18717 <refentrytitle>default.units</refentrytitle>
18718 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
18719 <refmiscinfo class="other" otherclass="value">cm</refmiscinfo>
18720 <refmiscinfo class="other" otherclass="value">mm</refmiscinfo>
18721 <refmiscinfo class="other" otherclass="value">in</refmiscinfo>
18722 <refmiscinfo class="other" otherclass="value">pt</refmiscinfo>
18723 <refmiscinfo class="other" otherclass="value">pc</refmiscinfo>
18724 <refmiscinfo class="other" otherclass="value">px</refmiscinfo>
18725 <refmiscinfo class="other" otherclass="value">em</refmiscinfo>
18728 <refname>default.units</refname>
18729 <refpurpose>Default units for an unqualified dimension</refpurpose>
18733 <programlisting id="default.units.frag">
18734 <xsl:param name="default.units">pt</xsl:param>
18738 <refsection><info><title>Description</title></info>
18740 <para>If an unqualified dimension is encountered (for example, in a
18741 graphic width), the <parameter>default.units</parameter> will be used for the
18742 units. Unqualified dimensions are not allowed in XSL Formatting Objects.
18748 <refentry version="5.0" id="normal.para.spacing">
18750 <refentrytitle>normal.para.spacing</refentrytitle>
18751 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
18754 <refname>normal.para.spacing</refname>
18755 <refpurpose>What space do you want between normal paragraphs</refpurpose>
18759 <programlisting id="normal.para.spacing.frag"><xsl:attribute-set name="normal.para.spacing">
18760 <xsl:attribute name="space-before.optimum">1em</xsl:attribute>
18761 <xsl:attribute name="space-before.minimum">0.8em</xsl:attribute>
18762 <xsl:attribute name="space-before.maximum">1.2em</xsl:attribute>
18763 </xsl:attribute-set></programlisting>
18765 <refsection><info><title>Description</title></info>
18766 <para>Specify the spacing required between normal paragraphs</para>
18770 <refentry version="5.0" id="body.font.master">
18772 <refentrytitle>body.font.master</refentrytitle>
18773 <refmiscinfo class="other" otherclass="datatype">number</refmiscinfo>
18776 <refname>body.font.master</refname>
18777 <refpurpose>Specifies the default point size for body text</refpurpose>
18781 <programlisting id="body.font.master.frag">
18782 <xsl:param name="body.font.master">10</xsl:param>
18786 <refsection><info><title>Description</title></info>
18788 <para>The body font size is specified in two parameters
18789 (<parameter>body.font.master</parameter> and <parameter>body.font.size</parameter>)
18790 so that math can be performed on the font size by XSLT.
18796 <refentry version="5.0" id="body.font.size">
18798 <refentrytitle>body.font.size</refentrytitle>
18799 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
18802 <refname>body.font.size</refname>
18803 <refpurpose>Specifies the default font size for body text</refpurpose>
18807 <programlisting id="body.font.size.frag">
18808 <xsl:param name="body.font.size">
18809 <xsl:value-of select="$body.font.master"></xsl:value-of><xsl:text>pt</xsl:text>
18810 </xsl:param></programlisting>
18813 <refsection><info><title>Description</title></info>
18815 <para>The body font size is specified in two parameters
18816 (<parameter>body.font.master</parameter> and <parameter>body.font.size</parameter>)
18817 so that math can be performed on the font size by XSLT.
18823 <refentry version="5.0" id="footnote.font.size">
18825 <refentrytitle>footnote.font.size</refentrytitle>
18826 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
18829 <refname>footnote.font.size</refname>
18830 <refpurpose>The font size for footnotes</refpurpose>
18834 <programlisting id="footnote.font.size.frag"><xsl:param name="footnote.font.size">
18835 <xsl:value-of select="$body.font.master * 0.8"></xsl:value-of><xsl:text>pt</xsl:text>
18836 </xsl:param></programlisting>
18839 <refsection><info><title>Description</title></info>
18841 <para>The footnote font size is used for...footnotes!
18847 <refentry version="5.0" id="title.margin.left">
18849 <refentrytitle>title.margin.left</refentrytitle>
18850 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
18853 <refname>title.margin.left</refname>
18854 <refpurpose>Adjust the left margin for titles</refpurpose>
18858 <programlisting id="title.margin.left.frag">
18859 <xsl:param name="title.margin.left">
18861 <xsl:when test="$fop.extensions != 0">-4pc</xsl:when>
18862 <xsl:when test="$passivetex.extensions != 0">0pt</xsl:when>
18863 <xsl:otherwise>0pt</xsl:otherwise>
18864 </xsl:choose>
18869 <refsection><info><title>Description</title></info>
18871 <para>This parameter provides
18872 the means of adjusting the left margin for titles
18873 when the XSL-FO processor being used is
18874 an old version of FOP (0.25 and earlier).
18875 It is only useful when the <parameter>fop.extensions</parameter>
18878 <para>The left margin of the body region
18879 is calculated to include this space,
18880 and titles are outdented to the left outside
18881 the body region by this amount,
18882 effectively leaving titles at the intended left margin
18883 and the body text indented.
18884 Currently this method is only used for old FOP because
18885 it cannot properly use the <parameter>body.start.indent</parameter>
18889 The default value when the <parameter>fop.extensions</parameter>
18890 parameter is nonzero is -4pc, which means the
18891 body text is indented 4 picas relative to
18893 The default value when the <parameter>fop.extensions</parameter>
18894 parameter equals zero is 0pt, and
18895 the body indent should instead be specified
18896 using the <parameter>body.start.indent</parameter>
18900 If you set the value to zero, be sure to still include
18901 a unit indicator such as <literal>0pt</literal>, or
18902 the FO processor will report errors.
18908 <refentry version="5.0" id="draft.mode">
18910 <refentrytitle>draft.mode</refentrytitle>
18911 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
18912 <refmiscinfo class="other" otherclass="value">no</refmiscinfo>
18913 <refmiscinfo class="other" otherclass="value">yes</refmiscinfo>
18914 <refmiscinfo class="other" otherclass="value">maybe</refmiscinfo>
18917 <refname>draft.mode</refname>
18918 <refpurpose>Select draft mode</refpurpose>
18922 <programlisting id="draft.mode.frag">
18923 <xsl:param name="draft.mode">maybe</xsl:param>
18927 <refsection><info><title>Description</title></info>
18929 <para>Selects draft mode. If <parameter>draft.mode</parameter> is
18930 <quote><literal>yes</literal></quote>, the entire document will be treated
18931 as a draft. If it is <quote><literal>no</literal></quote>, the entire document
18932 will be treated as a final copy. If it is <quote><literal>maybe</literal></quote>,
18933 individual sections will be treated as draft or final independently, depending
18934 on how their <literal>status</literal> attribute is set.
18940 <refentry version="5.0" id="draft.watermark.image">
18942 <refentrytitle>draft.watermark.image</refentrytitle>
18943 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
18946 <refname>draft.watermark.image</refname>
18947 <refpurpose>The URI of the image to be used for draft watermarks</refpurpose>
18951 <programlisting id="draft.watermark.image.frag">
18952 <xsl:param name="draft.watermark.image">http://docbook.sourceforge.net/release/images/draft.png</xsl:param>
18956 <refsection><info><title>Description</title></info>
18958 <para>The image to be used for draft watermarks.</para>
18963 <refentry version="5.0" id="headers.on.blank.pages">
18965 <refentrytitle>headers.on.blank.pages</refentrytitle>
18966 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
18969 <refname>headers.on.blank.pages</refname>
18970 <refpurpose>Put headers on blank pages?</refpurpose>
18974 <programlisting id="headers.on.blank.pages.frag">
18975 <xsl:param name="headers.on.blank.pages" select="1"></xsl:param>
18979 <refsection><info><title>Description</title></info>
18981 <para>If non-zero, headers will be placed on blank pages.</para>
18986 <refentry version="5.0" id="footers.on.blank.pages">
18988 <refentrytitle>footers.on.blank.pages</refentrytitle>
18989 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
18992 <refname>footers.on.blank.pages</refname>
18993 <refpurpose>Put footers on blank pages?</refpurpose>
18997 <programlisting id="footers.on.blank.pages.frag">
18998 <xsl:param name="footers.on.blank.pages" select="1"></xsl:param>
19002 <refsection><info><title>Description</title></info>
19004 <para>If non-zero, footers will be placed on blank pages.</para>
19009 <refentry version="5.0" id="header.rule">
19011 <refentrytitle>header.rule</refentrytitle>
19012 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
19015 <refname>header.rule</refname>
19016 <refpurpose>Rule under headers?</refpurpose>
19020 <programlisting id="header.rule.frag">
19021 <xsl:param name="header.rule" select="1"></xsl:param>
19025 <refsection><info><title>Description</title></info>
19027 <para>If non-zero, a rule will be drawn below the page headers.</para>
19032 <refentry version="5.0" id="footer.rule">
19034 <refentrytitle>footer.rule</refentrytitle>
19035 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
19038 <refname>footer.rule</refname>
19039 <refpurpose>Rule over footers?</refpurpose>
19043 <programlisting id="footer.rule.frag">
19044 <xsl:param name="footer.rule" select="1"></xsl:param>
19048 <refsection><info><title>Description</title></info>
19050 <para>If non-zero, a rule will be drawn above the page footers.</para>
19055 <refentry version="5.0" id="header.column.widths">
19057 <refentrytitle>header.column.widths</refentrytitle>
19058 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
19061 <refname>header.column.widths</refname>
19062 <refpurpose>Specify relative widths of header areas</refpurpose>
19065 <refsynopsisdiv><programlisting id="header.column.widths.frag">
19066 <xsl:param name="header.column.widths">1 1 1</xsl:param>
19067 </programlisting></refsynopsisdiv>
19069 <refsection><info><title>Description</title></info>
19071 <para>Page headers in print output use a three column table
19072 to position text at the left, center, and right side of
19073 the header on the page.
19074 This parameter lets you specify the relative sizes of the
19075 three columns. The default value is
19078 <para>The parameter value must be three numbers, separated
19079 by white space. The first number represents the relative
19080 width of the inside header for
19081 double-sided output. The second number is the relative
19082 width of the center header. The third number is the
19083 relative width of the outside header for
19084 double-sided output.
19086 <para>For single-sided output, the first number is the
19087 relative width of left header for left-to-right
19088 text direction, or the right header for right-to-left
19090 The third number is the
19091 relative width of right header for left-to-right
19092 text direction, or the left header for right-to-left
19093 text direction.</para>
19095 <para>The numbers are used to specify the column widths
19096 for the table that makes up the header area.
19097 In the FO output, this looks like:
19101 <fo:table-column column-number="1"
19102 column-width="proportional-column-width(1)"/>
19106 The <literal>proportional-column-width()</literal>
19107 function computes a column width by dividing its
19108 argument by the total of the arguments for all the columns, and
19109 then multiplying the result by the width of the whole table
19110 (assuming all the column specs use the function).
19111 Its argument can be any positive integer or floating point number.
19112 Zero is an acceptable value, although some FO processors
19113 may warn about it, in which case using a very small number might
19114 be more satisfactory.
19117 <para>For example, the value "1 2 1" means the center
19118 header should have twice the width of the other areas.
19119 A value of "0 0 1" means the entire header area
19120 is reserved for the right (or outside) header text.
19121 Note that to keep the center area centered on
19122 the page, the left and right values must be
19123 the same. A specification like "1 2 3" means the
19124 center area is no longer centered on the page
19125 since the right area is three times the width of the left area.
19131 <refentry version="5.0" id="footer.column.widths">
19133 <refentrytitle>footer.column.widths</refentrytitle>
19134 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
19137 <refname>footer.column.widths</refname>
19138 <refpurpose>Specify relative widths of footer areas</refpurpose>
19141 <refsynopsisdiv><programlisting id="footer.column.widths.frag">
19142 <xsl:param name="footer.column.widths">1 1 1</xsl:param>
19143 </programlisting></refsynopsisdiv>
19145 <refsection><info><title>Description</title></info>
19147 <para>Page footers in print output use a three column table
19148 to position text at the left, center, and right side of
19149 the footer on the page.
19150 This parameter lets you specify the relative sizes of the
19151 three columns. The default value is
19154 <para>The parameter value must be three numbers, separated
19155 by white space. The first number represents the relative
19156 width of the inside footer for
19157 double-sided output. The second number is the relative
19158 width of the center footer. The third number is the
19159 relative width of the outside footer for
19160 double-sided output.
19162 <para>For single-sided output, the first number is the
19163 relative width of left footer for left-to-right
19164 text direction, or the right footer for right-to-left
19166 The third number is the
19167 relative width of right footer for left-to-right
19168 text direction, or the left footer for right-to-left
19169 text direction.</para>
19171 <para>The numbers are used to specify the column widths
19172 for the table that makes up the footer area.
19173 In the FO output, this looks like:
19177 <fo:table-column column-number="1"
19178 column-width="proportional-column-width(1)"/>
19182 The <literal>proportional-column-width()</literal>
19183 function computes a column width by dividing its
19184 argument by the total of the arguments for all the columns, and
19185 then multiplying the result by the width of the whole table
19186 (assuming all the column specs use the function).
19187 Its argument can be any positive integer or floating point number.
19188 Zero is an acceptable value, although some FO processors
19189 may warn about it, in which case using a very small number might
19190 be more satisfactory.
19193 <para>For example, the value "1 2 1" means the center
19194 footer should have twice the width of the other areas.
19195 A value of "0 0 1" means the entire footer area
19196 is reserved for the right (or outside) footer text.
19197 Note that to keep the center area centered on
19198 the page, the left and right values must be
19199 the same. A specification like "1 2 3" means the
19200 center area is no longer centered on the page
19201 since the right area is three times the width of the left area.
19207 <refentry version="5.0" id="header.table.properties">
19209 <refentrytitle>header.table.properties</refentrytitle>
19210 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
19213 <refname>header.table.properties</refname>
19214 <refpurpose>Apply properties to the header layout table</refpurpose>
19218 <programlisting id="header.table.properties.frag">
19219 <xsl:attribute-set name="header.table.properties">
19220 <xsl:attribute name="table-layout">fixed</xsl:attribute>
19221 <xsl:attribute name="width">100%</xsl:attribute>
19222 </xsl:attribute-set>
19226 <refsection><info><title>Description</title></info>
19228 <para>Properties applied to the table that lays out the page header.</para>
19233 <refentry version="5.0" id="header.table.height">
19235 <refentrytitle>header.table.height</refentrytitle>
19236 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
19239 <refname>header.table.height</refname>
19240 <refpurpose>Specify the minimum height of the table containing the running page headers</refpurpose>
19243 <refsynopsisdiv><programlisting id="header.table.height.frag">
19244 <xsl:param name="header.table.height">14pt</xsl:param>
19245 </programlisting></refsynopsisdiv>
19247 <refsection><info><title>Description</title></info>
19249 <para>Page headers in print output use a three column table
19250 to position text at the left, center, and right side of
19251 the header on the page.
19252 This parameter lets you specify the minimum height
19253 of the single row in the table.
19254 Since this specifies only the minimum height,
19255 the table should automatically grow to fit taller content.
19256 The default value is "14pt".</para>
19261 <refentry version="5.0" id="footer.table.properties">
19263 <refentrytitle>footer.table.properties</refentrytitle>
19264 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
19267 <refname>footer.table.properties</refname>
19268 <refpurpose>Apply properties to the footer layout table</refpurpose>
19272 <programlisting id="footer.table.properties.frag">
19273 <xsl:attribute-set name="footer.table.properties">
19274 <xsl:attribute name="table-layout">fixed</xsl:attribute>
19275 <xsl:attribute name="width">100%</xsl:attribute>
19276 </xsl:attribute-set>
19280 <refsection><info><title>Description</title></info>
19282 <para>Properties applied to the table that lays out the page footer.</para>
19287 <refentry version="5.0" id="footer.table.height">
19289 <refentrytitle>footer.table.height</refentrytitle>
19290 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
19293 <refname>footer.table.height</refname>
19294 <refpurpose>Specify the minimum height of the table containing the running page footers</refpurpose>
19297 <refsynopsisdiv><programlisting id="footer.table.height.frag">
19298 <xsl:param name="footer.table.height">14pt</xsl:param>
19299 </programlisting></refsynopsisdiv>
19301 <refsection><info><title>Description</title></info>
19303 <para>Page footers in print output use a three column table
19304 to position text at the left, center, and right side of
19305 the footer on the page.
19306 This parameter lets you specify the minimum height
19307 of the single row in the table.
19308 Since this specifies only the minimum height,
19309 the table should automatically grow to fit taller content.
19310 The default value is "14pt".</para>
19315 <refentry version="5.0" id="header.content.properties">
19317 <refentrytitle>header.content.properties</refentrytitle>
19318 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
19321 <refname>header.content.properties</refname>
19322 <refpurpose>Properties of page header content</refpurpose>
19326 <programlisting id="header.content.properties.frag">
19327 <xsl:attribute-set name="header.content.properties">
19328 <xsl:attribute name="font-family">
19329 <xsl:value-of select="$body.fontset"></xsl:value-of>
19330 </xsl:attribute>
19331 <xsl:attribute name="margin-left">
19332 <xsl:value-of select="$title.margin.left"></xsl:value-of>
19333 </xsl:attribute>
19334 </xsl:attribute-set>
19338 <refsection><info><title>Description</title></info>
19340 <para>Properties of page header content.</para>
19345 <refentry version="5.0" id="footer.content.properties">
19347 <refentrytitle>footer.content.properties</refentrytitle>
19348 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
19351 <refname>footer.content.properties</refname>
19352 <refpurpose>Properties of page footer content</refpurpose>
19356 <programlisting id="footer.content.properties.frag">
19357 <xsl:attribute-set name="footer.content.properties">
19358 <xsl:attribute name="font-family">
19359 <xsl:value-of select="$body.fontset"></xsl:value-of>
19360 </xsl:attribute>
19361 <xsl:attribute name="margin-left">
19362 <xsl:value-of select="$title.margin.left"></xsl:value-of>
19363 </xsl:attribute>
19364 </xsl:attribute-set>
19368 <refsection><info><title>Description</title></info>
19370 <para>Properties of page footer content.</para>
19375 <refentry version="5.0" id="marker.section.level">
19377 <refentrytitle>marker.section.level</refentrytitle>
19378 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
19381 <refname>marker.section.level</refname>
19382 <refpurpose>Control depth of sections shown in running headers or footers</refpurpose>
19386 <programlisting id="marker.section.level.frag">
19387 <xsl:param name="marker.section.level">2</xsl:param>
19391 <refsection><info><title>Description</title></info>
19393 <para>The <parameter>marker.section.level</parameter> parameter
19394 controls the depth of section levels that may be displayed
19395 in running headers and footers. For example, if the value
19396 is 2 (the default), then titles from <tag>sect1</tag> and
19397 <tag>sect2</tag> or equivalent <tag>section</tag>
19398 elements are candidates for use in running headers and
19401 <para>Each candidate title is marked in the FO output with a
19402 <tag><fo:marker marker-class-name="section.head.marker"></tag>
19405 <para>In order for such titles to appear in headers
19406 or footers, the <literal>header.content</literal>
19407 or <literal>footer.content</literal> template
19408 must be customized to retrieve the marker using
19409 an output element such as:
19412 <fo:retrieve-marker retrieve-class-name="section.head.marker"
19413 retrieve-position="first-including-carryover"
19414 retrieve-boundary="page-sequence"/>
19421 </reference><reference id="fonts" xml:base="../fo/param.xml"><title>Font Families</title>
19422 <refentry version="5.0" id="body.font.family">
19424 <refentrytitle>body.font.family</refentrytitle>
19425 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
19426 <refmiscinfo class="other" otherclass="list-type">open</refmiscinfo>
19427 <refmiscinfo class="other" otherclass="value">serif</refmiscinfo>
19428 <refmiscinfo class="other" otherclass="value">sans-serif</refmiscinfo>
19429 <refmiscinfo class="other" otherclass="value">monospace</refmiscinfo>
19432 <refname>body.font.family</refname>
19433 <refpurpose>The default font family for body text</refpurpose>
19437 <programlisting id="body.font.family.frag">
19438 <xsl:param name="body.font.family">serif</xsl:param>
19442 <refsection><info><title>Description</title></info>
19444 <para>The body font family is the default font used for text in the page body.
19450 <refentry version="5.0" id="dingbat.font.family">
19452 <refentrytitle>dingbat.font.family</refentrytitle>
19453 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
19454 <refmiscinfo class="other" otherclass="list-type">open</refmiscinfo>
19455 <refmiscinfo class="other" otherclass="value">serif</refmiscinfo>
19456 <refmiscinfo class="other" otherclass="value">sans-serif</refmiscinfo>
19457 <refmiscinfo class="other" otherclass="value">monospace</refmiscinfo>
19460 <refname>dingbat.font.family</refname>
19461 <refpurpose>The font family for copyright, quotes, and other symbols</refpurpose>
19465 <programlisting id="dingbat.font.family.frag">
19466 <xsl:param name="dingbat.font.family">serif</xsl:param>
19470 <refsection><info><title>Description</title></info>
19472 <para>The dingbat font family is used for dingbats. If it is defined
19473 as the empty string, no font change is effected around dingbats.
19479 <refentry version="5.0" id="monospace.font.family">
19481 <refentrytitle>monospace.font.family</refentrytitle>
19482 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
19485 <refname>monospace.font.family</refname>
19486 <refpurpose>The default font family for monospace environments</refpurpose>
19490 <programlisting id="monospace.font.family.frag">
19491 <xsl:param name="monospace.font.family">monospace</xsl:param>
19495 <refsection><info><title>Description</title></info>
19497 <para>The monospace font family is used for verbatim environments
19498 (program listings, screens, etc.).
19504 <refentry version="5.0" id="sans.font.family">
19506 <refentrytitle>sans.font.family</refentrytitle>
19507 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
19510 <refname>sans.font.family</refname>
19511 <refpurpose>The default sans-serif font family</refpurpose>
19515 <programlisting id="sans.font.family.frag">
19516 <xsl:param name="sans.font.family">sans-serif</xsl:param>
19520 <refsection><info><title>Description</title></info>
19522 <para>The default sans-serif font family. At the present, this isn't
19523 actually used by the stylesheets.
19529 <refentry version="5.0" id="title.font.family">
19531 <refentrytitle>title.font.family</refentrytitle>
19532 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
19533 <refmiscinfo class="other" otherclass="list-type">open</refmiscinfo>
19534 <refmiscinfo class="other" otherclass="value">serif</refmiscinfo>
19535 <refmiscinfo class="other" otherclass="value">sans-serif</refmiscinfo>
19536 <refmiscinfo class="other" otherclass="value">monospace</refmiscinfo>
19539 <refname>title.font.family</refname>
19540 <refpurpose>The default font family for titles</refpurpose>
19544 <programlisting id="title.font.family.frag">
19545 <xsl:param name="title.font.family">sans-serif</xsl:param>
19549 <refsection><info><title>Description</title></info>
19551 <para>The title font family is used for titles (chapter, section, figure,
19558 <refentry version="5.0" id="symbol.font.family">
19560 <refentrytitle>symbol.font.family</refentrytitle>
19561 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
19562 <refmiscinfo class="other" otherclass="list-type">open</refmiscinfo>
19563 <refmiscinfo class="other" otherclass="value">serif</refmiscinfo>
19564 <refmiscinfo class="other" otherclass="value">sans-serif</refmiscinfo>
19565 <refmiscinfo class="other" otherclass="value">monospace</refmiscinfo>
19568 <refname>symbol.font.family</refname>
19569 <refpurpose>The font families to be searched for symbols outside
19570 of the body font</refpurpose>
19574 <programlisting id="symbol.font.family.frag">
19575 <xsl:param name="symbol.font.family">Symbol,ZapfDingbats</xsl:param>
19579 <refsection><info><title>Description</title></info>
19581 <para>A typical body or title font does not contain all
19582 the character glyphs that DocBook supports. This parameter
19583 specifies additional fonts that should be searched for
19584 special characters not in the normal font.
19585 These symbol font names are automatically appended
19586 to the body or title font family name when fonts
19588 <tag class="attribute">font-family</tag>
19589 property in the FO output.
19591 <para>The symbol font names should be entered as a
19592 comma-separated list. The default value is
19593 <literal>Symbol,ZapfDingbats</literal>.
19599 </reference><reference id="propsets" xml:base="../fo/param.xml"><title>Property Sets</title>
19600 <refentry version="5.0" id="formal.object.properties">
19602 <refentrytitle>formal.object.properties</refentrytitle>
19603 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
19606 <refname>formal.object.properties</refname>
19607 <refpurpose>Properties associated with a formal object such as a figure, or other component that has a title</refpurpose>
19611 <programlisting id="formal.object.properties.frag">
19612 <xsl:attribute-set name="formal.object.properties">
19613 <xsl:attribute name="space-before.minimum">0.5em</xsl:attribute>
19614 <xsl:attribute name="space-before.optimum">1em</xsl:attribute>
19615 <xsl:attribute name="space-before.maximum">2em</xsl:attribute>
19616 <xsl:attribute name="space-after.minimum">0.5em</xsl:attribute>
19617 <xsl:attribute name="space-after.optimum">1em</xsl:attribute>
19618 <xsl:attribute name="space-after.maximum">2em</xsl:attribute>
19619 <xsl:attribute name="keep-together.within-column">always</xsl:attribute>
19620 </xsl:attribute-set>
19624 <refsection><info><title>Description</title></info>
19626 <para>The styling for formal objects in docbook. Specify the spacing
19627 before and after the object.</para>
19632 <refentry version="5.0" id="formal.title.properties">
19634 <refentrytitle>formal.title.properties</refentrytitle>
19635 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
19638 <refname>formal.title.properties</refname>
19639 <refpurpose>Style the title element of formal object such as a figure.</refpurpose>
19643 <programlisting id="formal.title.properties.frag">
19644 <xsl:attribute-set name="formal.title.properties" use-attribute-sets="normal.para.spacing">
19645 <xsl:attribute name="font-weight">bold</xsl:attribute>
19646 <xsl:attribute name="font-size">
19647 <xsl:value-of select="$body.font.master * 1.2"></xsl:value-of>
19648 <xsl:text>pt</xsl:text>
19649 </xsl:attribute>
19650 <xsl:attribute name="hyphenate">false</xsl:attribute>
19651 <xsl:attribute name="space-after.minimum">0.4em</xsl:attribute>
19652 <xsl:attribute name="space-after.optimum">0.6em</xsl:attribute>
19653 <xsl:attribute name="space-after.maximum">0.8em</xsl:attribute>
19654 </xsl:attribute-set>
19657 <refsection><info><title>Description</title></info>
19658 <para>Specify how the title should be styled. Specify the font size and weight of the title of the formal object.</para>
19662 <refentry version="5.0" id="informal.object.properties">
19664 <refentrytitle>informal.object.properties</refentrytitle>
19665 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
19668 <refname>informal.object.properties</refname>
19669 <refpurpose>Properties associated with an informal (untitled) object, such as an informalfigure</refpurpose>
19673 <programlisting id="informal.object.properties.frag"><xsl:attribute-set name="informal.object.properties">
19674 <xsl:attribute name="space-before.minimum">0.5em</xsl:attribute>
19675 <xsl:attribute name="space-before.optimum">1em</xsl:attribute>
19676 <xsl:attribute name="space-before.maximum">2em</xsl:attribute>
19677 <xsl:attribute name="space-after.minimum">0.5em</xsl:attribute>
19678 <xsl:attribute name="space-after.optimum">1em</xsl:attribute>
19679 <xsl:attribute name="space-after.maximum">2em</xsl:attribute>
19680 </xsl:attribute-set></programlisting>
19682 <refsection><info><title>Description</title></info>
19683 <para>The styling for informal objects in docbook. Specify the spacing before and after the object.</para>
19687 <refentry version="5.0" id="monospace.properties">
19689 <refentrytitle>monospace.properties</refentrytitle>
19690 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
19693 <refname>monospace.properties</refname>
19694 <refpurpose>Properties of monospaced content</refpurpose>
19698 <programlisting id="monospace.properties.frag">
19699 <xsl:attribute-set name="monospace.properties">
19700 <xsl:attribute name="font-family">
19701 <xsl:value-of select="$monospace.font.family"></xsl:value-of>
19702 </xsl:attribute>
19703 </xsl:attribute-set>
19707 <refsection><info><title>Description</title></info>
19709 <para>Specifies the font name for monospaced output. This property set
19710 used to set the font-size as well, but that doesn't work very well
19711 when different fonts are used (as they are in titles and paragraphs,
19712 for example).</para>
19714 <para>If you want to set the font-size in a customization layer, it's
19715 probably going to be more appropriate to set font-size-adjust, if your
19716 formatter supports it.</para>
19721 <refentry version="5.0" id="verbatim.properties">
19723 <refentrytitle>verbatim.properties</refentrytitle>
19724 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
19727 <refname>verbatim.properties</refname>
19728 <refpurpose>Properties associated with verbatim text</refpurpose>
19732 <programlisting id="verbatim.properties.frag">
19733 <xsl:attribute-set name="verbatim.properties">
19734 <xsl:attribute name="space-before.minimum">0.8em</xsl:attribute>
19735 <xsl:attribute name="space-before.optimum">1em</xsl:attribute>
19736 <xsl:attribute name="space-before.maximum">1.2em</xsl:attribute>
19737 <xsl:attribute name="space-after.minimum">0.8em</xsl:attribute>
19738 <xsl:attribute name="space-after.optimum">1em</xsl:attribute>
19739 <xsl:attribute name="space-after.maximum">1.2em</xsl:attribute>
19740 <xsl:attribute name="hyphenate">false</xsl:attribute>
19741 <xsl:attribute name="wrap-option">no-wrap</xsl:attribute>
19742 <xsl:attribute name="white-space-collapse">false</xsl:attribute>
19743 <xsl:attribute name="white-space-treatment">preserve</xsl:attribute>
19744 <xsl:attribute name="linefeed-treatment">preserve</xsl:attribute>
19745 <xsl:attribute name="text-align">start</xsl:attribute>
19746 </xsl:attribute-set></programlisting>
19749 <refsection><info><title>Description</title></info>
19750 <para>This attribute set is used on all verbatim environments.</para>
19755 <refentry version="5.0" id="monospace.verbatim.properties">
19757 <refentrytitle>monospace.verbatim.properties</refentrytitle>
19758 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
19761 <refname>monospace.verbatim.properties</refname>
19762 <refpurpose>What font and size do you want for monospaced content?</refpurpose>
19766 <programlisting id="monospace.verbatim.properties.frag">
19767 <xsl:attribute-set name="monospace.verbatim.properties" use-attribute-sets="verbatim.properties monospace.properties">
19768 <xsl:attribute name="text-align">start</xsl:attribute>
19769 <xsl:attribute name="wrap-option">no-wrap</xsl:attribute>
19770 </xsl:attribute-set>
19773 <refsection><info><title>Description</title></info>
19774 <para>Specify the font name and size you want for monospaced output</para>
19778 <refentry version="5.0" id="sidebar.properties">
19780 <refentrytitle>sidebar.properties</refentrytitle>
19781 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
19784 <refname>sidebar.properties</refname>
19785 <refpurpose>Attribute set for sidebar properties</refpurpose>
19789 <programlisting id="sidebar.properties.frag">
19790 <xsl:attribute-set name="sidebar.properties" use-attribute-sets="formal.object.properties">
19791 <xsl:attribute name="border-style">solid</xsl:attribute>
19792 <xsl:attribute name="border-width">1pt</xsl:attribute>
19793 <xsl:attribute name="border-color">black</xsl:attribute>
19794 <xsl:attribute name="background-color">#DDDDDD</xsl:attribute>
19795 <xsl:attribute name="padding-start">12pt</xsl:attribute>
19796 <xsl:attribute name="padding-end">12pt</xsl:attribute>
19797 <xsl:attribute name="padding-top">6pt</xsl:attribute>
19798 <xsl:attribute name="padding-bottom">6pt</xsl:attribute>
19799 <xsl:attribute name="margin-{$direction.align.start}">0pt</xsl:attribute>
19800 <xsl:attribute name="margin-{$direction.align.end}">0pt</xsl:attribute>
19802 <xsl:attribute name="margin-top">6pt</xsl:attribute>
19803 <xsl:attribute name="margin-bottom">6pt</xsl:attribute>
19805 </xsl:attribute-set>
19809 <refsection><info><title>Description</title></info>
19811 <para>The styling for sidebars.</para>
19816 <refentry version="5.0" id="sidebar.title.properties">
19818 <refentrytitle>sidebar.title.properties</refentrytitle>
19819 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
19822 <refname>sidebar.title.properties</refname>
19823 <refpurpose>Attribute set for sidebar titles</refpurpose>
19827 <programlisting id="sidebar.title.properties.frag">
19828 <xsl:attribute-set name="sidebar.title.properties">
19829 <xsl:attribute name="font-weight">bold</xsl:attribute>
19830 <xsl:attribute name="hyphenate">false</xsl:attribute>
19831 <xsl:attribute name="text-align">start</xsl:attribute>
19832 <xsl:attribute name="keep-with-next.within-column">always</xsl:attribute>
19833 </xsl:attribute-set>
19837 <refsection><info><title>Description</title></info>
19839 <para>The styling for sidebars titles.</para>
19844 <refentry version="5.0" id="sidebar.float.type">
19846 <refentrytitle>sidebar.float.type</refentrytitle>
19847 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
19848 <refmiscinfo class="other" otherclass="value">none</refmiscinfo>
19849 <refmiscinfo class="other" otherclass="value">before</refmiscinfo>
19850 <refmiscinfo class="other" otherclass="value">left</refmiscinfo>
19851 <refmiscinfo class="other" otherclass="value">start</refmiscinfo>
19852 <refmiscinfo class="other" otherclass="value">right</refmiscinfo>
19853 <refmiscinfo class="other" otherclass="value">end</refmiscinfo>
19854 <refmiscinfo class="other" otherclass="value">inside</refmiscinfo>
19855 <refmiscinfo class="other" otherclass="value">outside</refmiscinfo>
19858 <refname>sidebar.float.type</refname>
19859 <refpurpose>Select type of float for sidebar elements</refpurpose>
19863 <programlisting id="sidebar.float.type.frag">
19864 <xsl:param name="sidebar.float.type">none</xsl:param>
19868 <refsection><info><title>Description</title></info>
19870 <para>Selects the type of float for sidebar elements.
19874 <para>If <parameter>sidebar.float.type</parameter> is
19875 <quote><literal>none</literal></quote>, then
19880 <para>If <parameter>sidebar.float.type</parameter> is
19881 <quote><literal>before</literal></quote>, then
19882 the float appears at the top of the page. On some processors,
19883 that may be the next page rather than the current page.
19888 <para>If <parameter>sidebar.float.type</parameter> is
19889 <quote><literal>left</literal></quote>,
19890 then a left side float is used.
19895 <para>If <parameter>sidebar.float.type</parameter> is
19896 <quote><literal>start</literal></quote>,
19897 then when the text direction is left-to-right a left side float is used.
19898 When the text direction is right-to-left, a right side float is used.
19903 <para>If <parameter>sidebar.float.type</parameter> is
19904 <quote><literal>right</literal></quote>,
19905 then a right side float is used.
19910 <para>If <parameter>sidebar.float.type</parameter> is
19911 <quote><literal>end</literal></quote>,
19912 then when the text direction is left-to-right a right side float is used.
19913 When the text direction is right-to-left, a left side float is used.
19918 <para>If your XSL-FO processor supports floats positioned on the
19919 <quote><literal>inside</literal></quote> or
19920 <quote><literal>outside</literal></quote>
19921 of double-sided pages, then you have those two
19922 options for side floats as well.
19930 <refentry version="5.0" id="sidebar.float.width">
19932 <refentrytitle>sidebar.float.width</refentrytitle>
19933 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
19936 <refname>sidebar.float.width</refname>
19937 <refpurpose>Set the default width for sidebars</refpurpose>
19941 <programlisting id="sidebar.float.width.frag">
19942 <xsl:param name="sidebar.float.width">1in</xsl:param>
19946 <refsection><info><title>Description</title></info>
19948 <para>Sets the default width for sidebars when used as a side float.
19949 The width determines the degree to which the sidebar block intrudes into
19952 <para>If <parameter>sidebar.float.type</parameter> is
19953 <quote><literal>before</literal></quote> or
19954 <quote><literal>none</literal></quote>, then
19955 this parameter is ignored.
19961 <refentry version="5.0" id="margin.note.properties">
19963 <refentrytitle>margin.note.properties</refentrytitle>
19964 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
19967 <refname>margin.note.properties</refname>
19968 <refpurpose>Attribute set for margin.note properties</refpurpose>
19972 <programlisting id="margin.note.properties.frag">
19973 <xsl:attribute-set name="margin.note.properties">
19974 <xsl:attribute name="font-size">90%</xsl:attribute>
19975 <xsl:attribute name="text-align">start</xsl:attribute>
19976 </xsl:attribute-set>
19980 <refsection><info><title>Description</title></info>
19982 <para>The styling for margin notes.
19983 By default, margin notes are not implemented for any
19984 element. A stylesheet customization is needed to make
19985 use of this attribute-set.</para>
19987 <para>You can use a template named <quote>floater</quote>
19988 to create the customization.
19989 That template can create side floats by specifying the
19990 content and characteristics as template parameters.
19993 <para>For example:</para>
19994 <programlisting><xsl:template match="para[@role='marginnote']">
19995 <xsl:call-template name="floater">
19996 <xsl:with-param name="position">
19997 <xsl:value-of select="$margin.note.float.type"/>
19998 </xsl:with-param>
19999 <xsl:with-param name="width">
20000 <xsl:value-of select="$margin.note.width"/>
20001 </xsl:with-param>
20002 <xsl:with-param name="content">
20003 <xsl:apply-imports/>
20004 </xsl:with-param>
20005 </xsl:call-template>
20006 </xsl:template></programlisting>
20011 <refentry version="5.0" id="margin.note.title.properties">
20013 <refentrytitle>margin.note.title.properties</refentrytitle>
20014 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
20017 <refname>margin.note.title.properties</refname>
20018 <refpurpose>Attribute set for margin note titles</refpurpose>
20022 <programlisting id="margin.note.title.properties.frag">
20023 <xsl:attribute-set name="margin.note.title.properties">
20024 <xsl:attribute name="font-weight">bold</xsl:attribute>
20025 <xsl:attribute name="hyphenate">false</xsl:attribute>
20026 <xsl:attribute name="text-align">start</xsl:attribute>
20027 <xsl:attribute name="keep-with-next.within-column">always</xsl:attribute>
20028 </xsl:attribute-set>
20032 <refsection><info><title>Description</title></info>
20034 <para>The styling for margin note titles.</para>
20039 <refentry version="5.0" id="margin.note.float.type">
20041 <refentrytitle>margin.note.float.type</refentrytitle>
20042 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
20043 <refmiscinfo class="other" otherclass="value">none</refmiscinfo>
20044 <refmiscinfo class="other" otherclass="value">before</refmiscinfo>
20045 <refmiscinfo class="other" otherclass="value">left</refmiscinfo>
20046 <refmiscinfo class="other" otherclass="value">start</refmiscinfo>
20047 <refmiscinfo class="other" otherclass="value">right</refmiscinfo>
20048 <refmiscinfo class="other" otherclass="value">end</refmiscinfo>
20049 <refmiscinfo class="other" otherclass="value">inside</refmiscinfo>
20050 <refmiscinfo class="other" otherclass="value">outside</refmiscinfo>
20053 <refname>margin.note.float.type</refname>
20054 <refpurpose>Select type of float for margin note customizations</refpurpose>
20058 <programlisting id="margin.note.float.type.frag">
20059 <xsl:param name="margin.note.float.type">none</xsl:param>
20063 <refsection><info><title>Description</title></info>
20065 <para>Selects the type of float for margin notes.
20066 DocBook does not define a margin note element, so this
20067 feature must be implemented as a customization of the stylesheet.
20068 See <parameter>margin.note.properties</parameter> for
20073 <para>If <parameter>margin.note.float.type</parameter> is
20074 <quote><literal>none</literal></quote>, then
20079 <para>If <parameter>margin.note.float.type</parameter> is
20080 <quote><literal>before</literal></quote>, then
20081 the float appears at the top of the page. On some processors,
20082 that may be the next page rather than the current page.
20086 <para>If <parameter>margin.note.float.type</parameter> is
20087 <quote><literal>left</literal></quote> or
20088 <quote><literal>start</literal></quote>, then
20089 a left side float is used.
20093 <para>If <parameter>margin.note.float.type</parameter> is
20094 <quote><literal>right</literal></quote> or
20095 <quote><literal>end</literal></quote>, then
20096 a right side float is used.
20100 <para>If your XSL-FO processor supports floats positioned on the
20101 <quote><literal>inside</literal></quote> or
20102 <quote><literal>outside</literal></quote>
20103 of double-sided pages, then you have those two
20104 options for side floats as well.
20112 <refentry version="5.0" id="margin.note.width">
20114 <refentrytitle>margin.note.width</refentrytitle>
20115 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
20118 <refname>margin.note.width</refname>
20119 <refpurpose>Set the default width for margin notes</refpurpose>
20123 <programlisting id="margin.note.width.frag">
20124 <xsl:param name="margin.note.width">1in</xsl:param>
20128 <refsection><info><title>Description</title></info>
20130 <para>Sets the default width for margin notes when used as a side
20131 float. The width determines the degree to which the margin note block
20132 intrudes into the text area.
20134 <para>If <parameter>margin.note.float.type</parameter> is
20135 <quote><literal>before</literal></quote> or
20136 <quote><literal>none</literal></quote>, then
20137 this parameter is ignored.
20143 <refentry version="5.0" id="component.title.properties">
20145 <refentrytitle>component.title.properties</refentrytitle>
20146 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
20149 <refname>component.title.properties</refname>
20150 <refpurpose>Properties for component titles</refpurpose>
20154 <programlisting id="component.title.properties.frag">
20155 <xsl:attribute-set name="component.title.properties">
20156 <xsl:attribute name="keep-with-next.within-column">always</xsl:attribute>
20157 <xsl:attribute name="space-before.optimum"><xsl:value-of select="concat($body.font.master, 'pt')"></xsl:value-of></xsl:attribute>
20158 <xsl:attribute name="space-before.minimum"><xsl:value-of select="concat($body.font.master, 'pt * 0.8')"></xsl:value-of></xsl:attribute>
20159 <xsl:attribute name="space-before.maximum"><xsl:value-of select="concat($body.font.master, 'pt * 1.2')"></xsl:value-of></xsl:attribute>
20160 <xsl:attribute name="hyphenate">false</xsl:attribute>
20161 <xsl:attribute name="text-align">
20163 <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>
20164 <xsl:otherwise>start</xsl:otherwise>
20165 </xsl:choose>
20166 </xsl:attribute>
20167 <xsl:attribute name="start-indent"><xsl:value-of select="$title.margin.left"></xsl:value-of></xsl:attribute>
20168 </xsl:attribute-set>
20172 <refsection><info><title>Description</title></info>
20174 <para>The properties common to all component titles.</para>
20179 <refentry version="5.0" id="component.titlepage.properties">
20181 <refentrytitle>component.titlepage.properties</refentrytitle>
20182 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
20185 <refname>component.titlepage.properties</refname>
20186 <refpurpose>Properties for component titlepages</refpurpose>
20190 <programlisting id="component.titlepage.properties.frag">
20191 <xsl:attribute-set name="component.titlepage.properties">
20192 </xsl:attribute-set>
20196 <refsection><info><title>Description</title></info>
20198 <para>The properties that are applied to the outer block containing
20199 all the component title page information.
20200 Its main use is to set a <literal>span="all"</literal>
20201 property on the block that is a direct child of the flow.</para>
20203 <para>This attribute-set also applies to index titlepages. It is empty by default.</para>
20208 <refentry version="5.0" id="section.title.properties">
20210 <refentrytitle>section.title.properties</refentrytitle>
20211 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
20214 <refname>section.title.properties</refname>
20215 <refpurpose>Properties for section titles</refpurpose>
20219 <programlisting id="section.title.properties.frag">
20220 <xsl:attribute-set name="section.title.properties">
20221 <xsl:attribute name="font-family">
20222 <xsl:value-of select="$title.font.family"></xsl:value-of>
20223 </xsl:attribute>
20224 <xsl:attribute name="font-weight">bold</xsl:attribute>
20225 <!-- font size is calculated dynamically by section.heading template -->
20226 <xsl:attribute name="keep-with-next.within-column">always</xsl:attribute>
20227 <xsl:attribute name="space-before.minimum">0.8em</xsl:attribute>
20228 <xsl:attribute name="space-before.optimum">1.0em</xsl:attribute>
20229 <xsl:attribute name="space-before.maximum">1.2em</xsl:attribute>
20230 <xsl:attribute name="text-align">start</xsl:attribute>
20231 <xsl:attribute name="start-indent"><xsl:value-of select="$title.margin.left"></xsl:value-of></xsl:attribute>
20232 </xsl:attribute-set>
20236 <refsection><info><title>Description</title></info>
20238 <para>The properties common to all section titles.</para>
20243 <refentry version="5.0" id="section.title.level1.properties">
20245 <refentrytitle>section.title.level1.properties</refentrytitle>
20246 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
20249 <refname>section.title.level1.properties</refname>
20250 <refpurpose>Properties for level-1 section titles</refpurpose>
20254 <programlisting id="section.title.level1.properties.frag">
20255 <xsl:attribute-set name="section.title.level1.properties">
20256 <xsl:attribute name="font-size">
20257 <xsl:value-of select="$body.font.master * 2.0736"></xsl:value-of>
20258 <xsl:text>pt</xsl:text>
20259 </xsl:attribute>
20260 </xsl:attribute-set>
20264 <refsection><info><title>Description</title></info>
20266 <para>The properties of level-1 section titles.</para>
20272 <refentry version="5.0" id="section.title.level2.properties">
20274 <refentrytitle>section.title.level2.properties</refentrytitle>
20275 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
20278 <refname>section.title.level2.properties</refname>
20279 <refpurpose>Properties for level-2 section titles</refpurpose>
20283 <programlisting id="section.title.level2.properties.frag">
20284 <xsl:attribute-set name="section.title.level2.properties">
20285 <xsl:attribute name="font-size">
20286 <xsl:value-of select="$body.font.master * 1.728"></xsl:value-of>
20287 <xsl:text>pt</xsl:text>
20288 </xsl:attribute>
20289 </xsl:attribute-set>
20293 <refsection><info><title>Description</title></info>
20295 <para>The properties of level-2 section titles.</para>
20300 <refentry version="5.0" id="section.title.level3.properties">
20302 <refentrytitle>section.title.level3.properties</refentrytitle>
20303 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
20306 <refname>section.title.level3.properties</refname>
20307 <refpurpose>Properties for level-3 section titles</refpurpose>
20311 <programlisting id="section.title.level3.properties.frag">
20312 <xsl:attribute-set name="section.title.level3.properties">
20313 <xsl:attribute name="font-size">
20314 <xsl:value-of select="$body.font.master * 1.44"></xsl:value-of>
20315 <xsl:text>pt</xsl:text>
20316 </xsl:attribute>
20317 </xsl:attribute-set>
20321 <refsection><info><title>Description</title></info>
20323 <para>The properties of level-3 section titles.</para>
20328 <refentry version="5.0" id="section.title.level4.properties">
20330 <refentrytitle>section.title.level4.properties</refentrytitle>
20331 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
20334 <refname>section.title.level4.properties</refname>
20335 <refpurpose>Properties for level-4 section titles</refpurpose>
20339 <programlisting id="section.title.level4.properties.frag">
20340 <xsl:attribute-set name="section.title.level4.properties">
20341 <xsl:attribute name="font-size">
20342 <xsl:value-of select="$body.font.master * 1.2"></xsl:value-of>
20343 <xsl:text>pt</xsl:text>
20344 </xsl:attribute>
20345 </xsl:attribute-set>
20349 <refsection><info><title>Description</title></info>
20351 <para>The properties of level-4 section titles.</para>
20356 <refentry version="5.0" id="section.title.level5.properties">
20358 <refentrytitle>section.title.level5.properties</refentrytitle>
20359 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
20362 <refname>section.title.level5.properties</refname>
20363 <refpurpose>Properties for level-5 section titles</refpurpose>
20367 <programlisting id="section.title.level5.properties.frag">
20368 <xsl:attribute-set name="section.title.level5.properties">
20369 <xsl:attribute name="font-size">
20370 <xsl:value-of select="$body.font.master"></xsl:value-of>
20371 <xsl:text>pt</xsl:text>
20372 </xsl:attribute>
20373 </xsl:attribute-set>
20377 <refsection><info><title>Description</title></info>
20379 <para>The properties of level-5 section titles.</para>
20384 <refentry version="5.0" id="section.title.level6.properties">
20386 <refentrytitle>section.title.level6.properties</refentrytitle>
20387 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
20390 <refname>section.title.level6.properties</refname>
20391 <refpurpose>Properties for level-6 section titles</refpurpose>
20395 <programlisting id="section.title.level6.properties.frag">
20396 <xsl:attribute-set name="section.title.level6.properties">
20397 <xsl:attribute name="font-size">
20398 <xsl:value-of select="$body.font.master"></xsl:value-of>
20399 <xsl:text>pt</xsl:text>
20400 </xsl:attribute>
20401 </xsl:attribute-set>
20405 <refsection><info><title>Description</title></info>
20407 <para>The properties of level-6 section titles. This property set is actually
20408 used for all titles below level 5.</para>
20413 <refentry version="5.0" id="section.properties">
20415 <refentrytitle>section.properties</refentrytitle>
20416 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
20419 <refname>section.properties</refname>
20420 <refpurpose>Properties for all section levels</refpurpose>
20424 <programlisting id="section.properties.frag">
20425 <xsl:attribute-set name="section.properties">
20426 </xsl:attribute-set>
20430 <refsection><info><title>Description</title></info>
20432 <para>The properties that apply to the containing
20433 block of all section levels, and therefore apply to
20435 This attribute set is inherited by the
20436 more specific attribute sets such as
20437 <tag>section.level1.properties</tag>.
20438 The default is empty.
20444 <refentry version="5.0" id="section.level1.properties">
20446 <refentrytitle>section.level1.properties</refentrytitle>
20447 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
20450 <refname>section.level1.properties</refname>
20451 <refpurpose>Properties for level-1 sections</refpurpose>
20455 <programlisting id="section.level1.properties.frag">
20456 <xsl:attribute-set name="section.level1.properties" use-attribute-sets="section.properties">
20457 </xsl:attribute-set>
20461 <refsection><info><title>Description</title></info>
20463 <para>The properties that apply to the containing
20464 block of a level-1 section, and therefore apply to
20465 the whole section. This includes <tag>sect1</tag>
20466 elements and <tag>section</tag> elements at level 1.
20469 <para>For example, you could start each level-1 section on
20470 a new page by using:</para>
20471 <programlisting><xsl:attribute-set name="section.level1.properties">
20472 <xsl:attribute name="break-before">page</xsl:attribute>
20473 </xsl:attribute-set>
20476 <para>This attribute set inherits attributes from the
20477 general <tag>section.properties</tag> attribute set.
20483 <refentry version="5.0" id="section.level2.properties">
20485 <refentrytitle>section.level2.properties</refentrytitle>
20486 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
20489 <refname>section.level2.properties</refname>
20490 <refpurpose>Properties for level-2 sections</refpurpose>
20494 <programlisting id="section.level2.properties.frag">
20495 <xsl:attribute-set name="section.level2.properties" use-attribute-sets="section.properties">
20496 </xsl:attribute-set>
20500 <refsection><info><title>Description</title></info>
20502 <para>The properties that apply to the containing
20503 block of a level-2 section, and therefore apply to
20504 the whole section. This includes <tag>sect2</tag>
20505 elements and <tag>section</tag> elements at level 2.
20508 <para>For example, you could start each level-2 section on
20509 a new page by using:</para>
20510 <programlisting><xsl:attribute-set name="section.level2.properties">
20511 <xsl:attribute name="break-before">page</xsl:attribute>
20512 </xsl:attribute-set>
20515 <para>This attribute set inherits attributes from the
20516 general <tag>section.properties</tag> attribute set.
20522 <refentry version="5.0" id="section.level3.properties">
20524 <refentrytitle>section.level3.properties</refentrytitle>
20525 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
20528 <refname>section.level3.properties</refname>
20529 <refpurpose>Properties for level-3 sections</refpurpose>
20533 <programlisting id="section.level3.properties.frag">
20534 <xsl:attribute-set name="section.level3.properties" use-attribute-sets="section.properties">
20535 </xsl:attribute-set>
20539 <refsection><info><title>Description</title></info>
20541 <para>The properties that apply to the containing
20542 block of a level-3 section, and therefore apply to
20543 the whole section. This includes <tag>sect3</tag>
20544 elements and <tag>section</tag> elements at level 3.
20547 <para>For example, you could start each level-3 section on
20548 a new page by using:</para>
20549 <programlisting><xsl:attribute-set name="section.level3.properties">
20550 <xsl:attribute name="break-before">page</xsl:attribute>
20551 </xsl:attribute-set>
20554 <para>This attribute set inherits attributes from the
20555 general <tag>section.properties</tag> attribute set.
20561 <refentry version="5.0" id="section.level4.properties">
20563 <refentrytitle>section.level4.properties</refentrytitle>
20564 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
20567 <refname>section.level4.properties</refname>
20568 <refpurpose>Properties for level-4 sections</refpurpose>
20572 <programlisting id="section.level4.properties.frag">
20573 <xsl:attribute-set name="section.level4.properties" use-attribute-sets="section.properties">
20574 </xsl:attribute-set>
20578 <refsection><info><title>Description</title></info>
20580 <para>The properties that apply to the containing
20581 block of a level-4 section, and therefore apply to
20582 the whole section. This includes <tag>sect4</tag>
20583 elements and <tag>section</tag> elements at level 4.
20586 <para>For example, you could start each level-4 section on
20587 a new page by using:</para>
20588 <programlisting><xsl:attribute-set name="section.level4.properties">
20589 <xsl:attribute name="break-before">page</xsl:attribute>
20590 </xsl:attribute-set>
20593 <para>This attribute set inherits attributes from the
20594 general <tag>section.properties</tag> attribute set.
20600 <refentry version="5.0" id="section.level5.properties">
20602 <refentrytitle>section.level5.properties</refentrytitle>
20603 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
20606 <refname>section.level5.properties</refname>
20607 <refpurpose>Properties for level-5 sections</refpurpose>
20611 <programlisting id="section.level5.properties.frag">
20612 <xsl:attribute-set name="section.level5.properties" use-attribute-sets="section.properties">
20613 </xsl:attribute-set>
20617 <refsection><info><title>Description</title></info>
20619 <para>The properties that apply to the containing
20620 block of a level-5 section, and therefore apply to
20621 the whole section. This includes <tag>sect5</tag>
20622 elements and <tag>section</tag> elements at level 5.
20625 <para>For example, you could start each level-5 section on
20626 a new page by using:</para>
20627 <programlisting><xsl:attribute-set name="section.level5.properties">
20628 <xsl:attribute name="break-before">page</xsl:attribute>
20629 </xsl:attribute-set>
20632 <para>This attribute set inherits attributes from the
20633 general <tag>section.properties</tag> attribute set.
20639 <refentry version="5.0" id="section.level6.properties">
20641 <refentrytitle>section.level6.properties</refentrytitle>
20642 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
20645 <refname>section.level6.properties</refname>
20646 <refpurpose>Properties for level-6 sections</refpurpose>
20650 <programlisting id="section.level6.properties.frag">
20651 <xsl:attribute-set name="section.level6.properties" use-attribute-sets="section.properties">
20652 </xsl:attribute-set>
20656 <refsection><info><title>Description</title></info>
20658 <para>The properties that apply to the containing
20659 block of a level 6 or lower section, and therefore apply to
20660 the whole section. This includes
20661 <tag>section</tag> elements at level 6 and lower.
20664 <para>For example, you could start each level-6 section on
20665 a new page by using:</para>
20666 <programlisting><xsl:attribute-set name="section.level6.properties">
20667 <xsl:attribute name="break-before">page</xsl:attribute>
20668 </xsl:attribute-set>
20671 <para>This attribute set inherits attributes from the
20672 general <tag>section.properties</tag> attribute set.
20678 <refentry version="5.0" id="figure.properties">
20680 <refentrytitle>figure.properties</refentrytitle>
20681 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
20684 <refname>figure.properties</refname>
20685 <refpurpose>Properties associated with a figure</refpurpose>
20689 <programlisting id="figure.properties.frag">
20690 <xsl:attribute-set name="figure.properties" use-attribute-sets="formal.object.properties"></xsl:attribute-set>
20694 <refsection><info><title>Description</title></info>
20696 <para>The styling for figures.</para>
20701 <refentry version="5.0" id="example.properties">
20703 <refentrytitle>example.properties</refentrytitle>
20704 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
20707 <refname>example.properties</refname>
20708 <refpurpose>Properties associated with a example</refpurpose>
20712 <programlisting id="example.properties.frag">
20713 <xsl:attribute-set name="example.properties" use-attribute-sets="formal.object.properties"></xsl:attribute-set>
20717 <refsection><info><title>Description</title></info>
20719 <para>The styling for examples.</para>
20724 <refentry version="5.0" id="equation.properties">
20726 <refentrytitle>equation.properties</refentrytitle>
20727 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
20730 <refname>equation.properties</refname>
20731 <refpurpose>Properties associated with a equation</refpurpose>
20735 <programlisting id="equation.properties.frag">
20736 <xsl:attribute-set name="equation.properties" use-attribute-sets="formal.object.properties"></xsl:attribute-set>
20740 <refsection><info><title>Description</title></info>
20742 <para>The styling for equations.</para>
20747 <refentry version="5.0" id="table.properties">
20749 <refentrytitle>table.properties</refentrytitle>
20750 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
20753 <refname>table.properties</refname>
20754 <refpurpose>Properties associated with the block surrounding a table</refpurpose>
20758 <programlisting id="table.properties.frag">
20759 <xsl:attribute-set name="table.properties" use-attribute-sets="formal.object.properties">
20760 <xsl:attribute name="keep-together.within-column">auto</xsl:attribute>
20761 </xsl:attribute-set>
20765 <refsection><info><title>Description</title></info>
20767 <para>Block styling properties for tables. This parameter should really
20768 have been called <literal>table.block.properties</literal> or something
20769 like that, but we’re leaving it to avoid backwards-compatibility
20772 <para>See also <parameter>table.table.properties</parameter>.</para>
20777 <refentry version="5.0" id="informalfigure.properties">
20779 <refentrytitle>informalfigure.properties</refentrytitle>
20780 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
20783 <refname>informalfigure.properties</refname>
20784 <refpurpose>Properties associated with an informalfigure</refpurpose>
20788 <programlisting id="informalfigure.properties.frag">
20789 <xsl:attribute-set name="informalfigure.properties" use-attribute-sets="informal.object.properties"></xsl:attribute-set>
20793 <refsection><info><title>Description</title></info>
20795 <para>The styling for informalfigures.</para>
20800 <refentry version="5.0" id="informalexample.properties">
20802 <refentrytitle>informalexample.properties</refentrytitle>
20803 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
20806 <refname>informalexample.properties</refname>
20807 <refpurpose>Properties associated with an informalexample</refpurpose>
20811 <programlisting id="informalexample.properties.frag">
20812 <xsl:attribute-set name="informalexample.properties" use-attribute-sets="informal.object.properties"></xsl:attribute-set>
20816 <refsection><info><title>Description</title></info>
20818 <para>The styling for informalexamples.</para>
20823 <refentry version="5.0" id="informalequation.properties">
20825 <refentrytitle>informalequation.properties</refentrytitle>
20826 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
20829 <refname>informalequation.properties</refname>
20830 <refpurpose>Properties associated with an informalequation</refpurpose>
20834 <programlisting id="informalequation.properties.frag">
20835 <xsl:attribute-set name="informalequation.properties" use-attribute-sets="informal.object.properties"></xsl:attribute-set>
20839 <refsection><info><title>Description</title></info>
20841 <para>The styling for informalequations.</para>
20846 <refentry version="5.0" id="informaltable.properties">
20848 <refentrytitle>informaltable.properties</refentrytitle>
20849 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
20852 <refname>informaltable.properties</refname>
20853 <refpurpose>Properties associated with the block surrounding an informaltable</refpurpose>
20857 <programlisting id="informaltable.properties.frag">
20858 <xsl:attribute-set name="informaltable.properties" use-attribute-sets="informal.object.properties"></xsl:attribute-set>
20862 <refsection><info><title>Description</title></info>
20864 <para>Block styling properties for informaltables. This parameter should really
20865 have been called <literal>informaltable.block.properties</literal> or something
20866 like that, but we’re leaving it to avoid backwards-compatibility
20869 <para>See also <parameter>table.table.properties</parameter>.</para>
20874 <refentry version="5.0" id="procedure.properties">
20876 <refentrytitle>procedure.properties</refentrytitle>
20877 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
20880 <refname>procedure.properties</refname>
20881 <refpurpose>Properties associated with a procedure</refpurpose>
20885 <programlisting id="procedure.properties.frag">
20886 <xsl:attribute-set name="procedure.properties" use-attribute-sets="formal.object.properties">
20887 <xsl:attribute name="keep-together.within-column">auto</xsl:attribute>
20888 </xsl:attribute-set>
20892 <refsection><info><title>Description</title></info>
20894 <para>The styling for procedures.</para>
20899 <refentry version="5.0" id="root.properties">
20901 <refentrytitle>root.properties</refentrytitle>
20902 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
20905 <refname>root.properties</refname>
20906 <refpurpose>The properties of the fo:root element</refpurpose>
20910 <programlisting id="root.properties.frag">
20911 <xsl:attribute-set name="root.properties">
20912 <xsl:attribute name="font-family">
20913 <xsl:value-of select="$body.fontset"></xsl:value-of>
20914 </xsl:attribute>
20915 <xsl:attribute name="font-size">
20916 <xsl:value-of select="$body.font.size"></xsl:value-of>
20917 </xsl:attribute>
20918 <xsl:attribute name="text-align">
20919 <xsl:value-of select="$alignment"></xsl:value-of>
20920 </xsl:attribute>
20921 <xsl:attribute name="line-height">
20922 <xsl:value-of select="$line-height"></xsl:value-of>
20923 </xsl:attribute>
20924 <xsl:attribute name="font-selection-strategy">character-by-character</xsl:attribute>
20925 <xsl:attribute name="line-height-shift-adjustment">disregard-shifts</xsl:attribute>
20926 <xsl:attribute name="writing-mode">
20927 <xsl:value-of select="$direction.mode"></xsl:value-of>
20928 </xsl:attribute>
20929 </xsl:attribute-set>
20933 <refsection><info><title>Description</title></info>
20935 <para>This property set is used on the <tag>fo:root</tag> element of
20936 an FO file. It defines a set of default, global parameters.</para>
20941 <refentry version="5.0" id="qanda.title.properties">
20943 <refentrytitle>qanda.title.properties</refentrytitle>
20944 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
20947 <refname>qanda.title.properties</refname>
20948 <refpurpose>Properties for qanda set titles</refpurpose>
20952 <programlisting id="qanda.title.properties.frag">
20953 <xsl:attribute-set name="qanda.title.properties">
20954 <xsl:attribute name="font-family">
20955 <xsl:value-of select="$title.font.family"></xsl:value-of>
20956 </xsl:attribute>
20957 <xsl:attribute name="font-weight">bold</xsl:attribute>
20958 <!-- font size is calculated dynamically by qanda.heading template -->
20959 <xsl:attribute name="keep-with-next.within-column">always</xsl:attribute>
20960 <xsl:attribute name="space-before.minimum">0.8em</xsl:attribute>
20961 <xsl:attribute name="space-before.optimum">1.0em</xsl:attribute>
20962 <xsl:attribute name="space-before.maximum">1.2em</xsl:attribute>
20963 </xsl:attribute-set>
20967 <refsection><info><title>Description</title></info>
20969 <para>The properties common to all qanda set titles.</para>
20974 <refentry version="5.0" id="qanda.title.level1.properties">
20976 <refentrytitle>qanda.title.level1.properties</refentrytitle>
20977 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
20980 <refname>qanda.title.level1.properties</refname>
20981 <refpurpose>Properties for level-1 qanda set titles</refpurpose>
20985 <programlisting id="qanda.title.level1.properties.frag">
20986 <xsl:attribute-set name="qanda.title.level1.properties">
20987 <xsl:attribute name="font-size">
20988 <xsl:value-of select="$body.font.master * 2.0736"></xsl:value-of>
20989 <xsl:text>pt</xsl:text>
20990 </xsl:attribute>
20991 </xsl:attribute-set>
20995 <refsection><info><title>Description</title></info>
20997 <para>The properties of level-1 qanda set titles.</para>
21002 <refentry version="5.0" id="qanda.title.level2.properties">
21004 <refentrytitle>qanda.title.level2.properties</refentrytitle>
21005 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
21008 <refname>qanda.title.level2.properties</refname>
21009 <refpurpose>Properties for level-2 qanda set titles</refpurpose>
21013 <programlisting id="qanda.title.level2.properties.frag">
21014 <xsl:attribute-set name="qanda.title.level2.properties">
21015 <xsl:attribute name="font-size">
21016 <xsl:value-of select="$body.font.master * 1.728"></xsl:value-of>
21017 <xsl:text>pt</xsl:text>
21018 </xsl:attribute>
21019 </xsl:attribute-set>
21023 <refsection><info><title>Description</title></info>
21025 <para>The properties of level-2 qanda set titles.</para>
21030 <refentry version="5.0" id="qanda.title.level3.properties">
21032 <refentrytitle>qanda.title.level3.properties</refentrytitle>
21033 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
21036 <refname>qanda.title.level3.properties</refname>
21037 <refpurpose>Properties for level-3 qanda set titles</refpurpose>
21041 <programlisting id="qanda.title.level3.properties.frag">
21042 <xsl:attribute-set name="qanda.title.level3.properties">
21043 <xsl:attribute name="font-size">
21044 <xsl:value-of select="$body.font.master * 1.44"></xsl:value-of>
21045 <xsl:text>pt</xsl:text>
21046 </xsl:attribute>
21047 </xsl:attribute-set>
21051 <refsection><info><title>Description</title></info>
21053 <para>The properties of level-3 qanda set titles.</para>
21058 <refentry version="5.0" id="qanda.title.level4.properties">
21060 <refentrytitle>qanda.title.level4.properties</refentrytitle>
21061 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
21064 <refname>qanda.title.level4.properties</refname>
21065 <refpurpose>Properties for level-4 qanda set titles</refpurpose>
21069 <programlisting id="qanda.title.level4.properties.frag">
21070 <xsl:attribute-set name="qanda.title.level4.properties">
21071 <xsl:attribute name="font-size">
21072 <xsl:value-of select="$body.font.master * 1.2"></xsl:value-of>
21073 <xsl:text>pt</xsl:text>
21074 </xsl:attribute>
21075 </xsl:attribute-set>
21079 <refsection><info><title>Description</title></info>
21081 <para>The properties of level-4 qanda set titles.</para>
21086 <refentry version="5.0" id="qanda.title.level5.properties">
21088 <refentrytitle>qanda.title.level5.properties</refentrytitle>
21089 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
21092 <refname>qanda.title.level5.properties</refname>
21093 <refpurpose>Properties for level-5 qanda set titles</refpurpose>
21097 <programlisting id="qanda.title.level5.properties.frag">
21098 <xsl:attribute-set name="qanda.title.level5.properties">
21099 <xsl:attribute name="font-size">
21100 <xsl:value-of select="$body.font.master"></xsl:value-of>
21101 <xsl:text>pt</xsl:text>
21102 </xsl:attribute>
21103 </xsl:attribute-set>
21107 <refsection><info><title>Description</title></info>
21109 <para>The properties of level-5 qanda set titles.</para>
21114 <refentry version="5.0" id="qanda.title.level6.properties">
21116 <refentrytitle>qanda.title.level6.properties</refentrytitle>
21117 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
21120 <refname>qanda.title.level6.properties</refname>
21121 <refpurpose>Properties for level-6 qanda set titles</refpurpose>
21125 <programlisting id="qanda.title.level6.properties.frag">
21126 <xsl:attribute-set name="qanda.title.level6.properties">
21127 <xsl:attribute name="font-size">
21128 <xsl:value-of select="$body.font.master"></xsl:value-of>
21129 <xsl:text>pt</xsl:text>
21130 </xsl:attribute>
21131 </xsl:attribute-set>
21135 <refsection><info><title>Description</title></info>
21137 <para>The properties of level-6 qanda set titles.
21138 This property set is actually
21139 used for all titles below level 5.</para>
21144 <refentry version="5.0" id="article.appendix.title.properties">
21146 <refentrytitle>article.appendix.title.properties</refentrytitle>
21147 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
21150 <refname>article.appendix.title.properties</refname>
21151 <refpurpose>Properties for appendix titles that appear in an article</refpurpose>
21155 <programlisting id="article.appendix.title.properties.frag">
21156 <xsl:attribute-set name="article.appendix.title.properties" use-attribute-sets="section.title.properties section.title.level1.properties">
21157 <xsl:attribute name="margin-{$direction.align.start}">
21158 <xsl:value-of select="$title.margin.left"></xsl:value-of>
21159 </xsl:attribute>
21160 </xsl:attribute-set>
21164 <refsection><info><title>Description</title></info>
21166 <para>The properties for the title of an appendix that
21167 appears inside an article. The default is to use
21168 the properties of sect1 titles.</para>
21173 <refentry version="5.0" id="abstract.properties">
21175 <refentrytitle>abstract.properties</refentrytitle>
21176 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
21179 <refname>abstract.properties</refname>
21180 <refpurpose>Properties associated with the block surrounding an abstract</refpurpose>
21184 <programlisting id="abstract.properties.frag">
21185 <xsl:attribute-set name="abstract.properties">
21186 <xsl:attribute name="start-indent">0.0in</xsl:attribute>
21187 <xsl:attribute name="end-indent">0.0in</xsl:attribute>
21188 </xsl:attribute-set>
21192 <refsection><info><title>Description</title></info>
21194 <para>Block styling properties for abstract.</para>
21196 <para>See also <parameter>abstract.title.properties</parameter>.</para>
21201 <refentry version="5.0" id="abstract.title.properties">
21203 <refentrytitle>abstract.title.properties</refentrytitle>
21204 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
21207 <refname>abstract.title.properties</refname>
21208 <refpurpose>Properties for abstract titles</refpurpose>
21212 <programlisting id="abstract.title.properties.frag">
21213 <xsl:attribute-set name="abstract.title.properties">
21214 <xsl:attribute name="font-family"><xsl:value-of select="$title.fontset"></xsl:value-of></xsl:attribute>
21215 <xsl:attribute name="font-weight">bold</xsl:attribute>
21216 <xsl:attribute name="keep-with-next.within-column">always</xsl:attribute>
21217 <xsl:attribute name="keep-with-next.within-column">always</xsl:attribute>
21218 <xsl:attribute name="space-before.optimum"><xsl:value-of select="concat($body.font.master, 'pt')"></xsl:value-of></xsl:attribute>
21219 <xsl:attribute name="space-before.minimum"><xsl:value-of select="concat($body.font.master, 'pt * 0.8')"></xsl:value-of></xsl:attribute>
21220 <xsl:attribute name="space-before.maximum"><xsl:value-of select="concat($body.font.master, 'pt * 1.2')"></xsl:value-of></xsl:attribute>
21221 <xsl:attribute name="hyphenate">false</xsl:attribute>
21222 <xsl:attribute name="text-align">center</xsl:attribute>
21223 </xsl:attribute-set>
21227 <refsection><info><title>Description</title></info>
21229 <para>The properties for abstract titles.</para>
21231 <para>See also <parameter>abstract.properties</parameter>.</para>
21236 <refentry version="5.0" id="index.page.number.properties">
21238 <refentrytitle>index.page.number.properties</refentrytitle>
21239 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
21242 <refname>index.page.number.properties</refname>
21243 <refpurpose>Properties associated with index page numbers</refpurpose>
21247 <programlisting id="index.page.number.properties.frag">
21248 <xsl:attribute-set name="index.page.number.properties">
21249 </xsl:attribute-set>
21253 <refsection><info><title>Description</title></info>
21255 <para>Properties associated with page numbers in indexes.
21256 Changing color to indicate the page number is a link is
21263 <refentry version="5.0" id="revhistory.table.properties">
21265 <refentrytitle>revhistory.table.properties</refentrytitle>
21266 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
21269 <refname>revhistory.table.properties</refname>
21270 <refpurpose>The properties of table used for formatting revhistory</refpurpose>
21274 <programlisting id="revhistory.table.properties.frag">
21275 <xsl:attribute-set name="revhistory.table.properties">
21276 </xsl:attribute-set>
21280 <refsection><info><title>Description</title></info>
21282 <para>This property set defines appearance of revhistory table.</para>
21287 <refentry version="5.0" id="revhistory.table.cell.properties">
21289 <refentrytitle>revhistory.table.cell.properties</refentrytitle>
21290 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
21293 <refname>revhistory.table.cell.properties</refname>
21294 <refpurpose>The properties of table cells used for formatting revhistory</refpurpose>
21298 <programlisting id="revhistory.table.cell.properties.frag">
21299 <xsl:attribute-set name="revhistory.table.cell.properties">
21300 </xsl:attribute-set>
21304 <refsection><info><title>Description</title></info>
21306 <para>This property set defines appearance of individual cells in revhistory table.</para>
21311 <refentry version="5.0" id="revhistory.title.properties">
21313 <refentrytitle>revhistory.title.properties</refentrytitle>
21314 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
21317 <refname>revhistory.title.properties</refname>
21318 <refpurpose>The properties of revhistory title</refpurpose>
21322 <programlisting id="revhistory.title.properties.frag">
21323 <xsl:attribute-set name="revhistory.title.properties">
21324 </xsl:attribute-set>
21328 <refsection><info><title>Description</title></info>
21330 <para>This property set defines appearance of revhistory title.</para>
21335 </reference><reference id="profiling" xml:base="../fo/param.xml"><title>Profiling</title>
21336 <partintro id="profiling_partintro">
21337 <para>The following parameters can be used for attribute-based
21338 profiling of your document. For more information about profiling, see
21339 <link role="tcg" xlink:href="Profiling.html">Profiling (conditional text)</link>.</para>
21341 <refentry version="5.0" id="profile.arch">
21343 <refentrytitle>profile.arch</refentrytitle>
21344 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
21347 <refname>profile.arch</refname>
21348 <refpurpose>Target profile for <tag class="attribute">arch</tag>
21349 attribute</refpurpose>
21353 <programlisting id="profile.arch.frag">
21354 <xsl:param name="profile.arch"></xsl:param>
21359 <refsection><info><title>Description</title></info>
21361 <para>The value of this parameter specifies profiles which should be
21362 included in the output. You can specify multiple profiles by
21363 separating them by semicolon. You can change separator character by
21364 <parameter>profile.separator</parameter>
21367 <para>This parameter has effect only when you are using profiling
21368 stylesheets (<filename>profile-docbook.xsl</filename>,
21369 <filename>profile-chunk.xsl</filename>, …) instead of normal
21370 ones (<filename>docbook.xsl</filename>,
21371 <filename>chunk.xsl</filename>, …).</para>
21376 <refentry version="5.0" id="profile.audience">
21378 <refentrytitle>profile.audience</refentrytitle>
21379 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
21382 <refname>profile.audience</refname>
21383 <refpurpose>Target profile for <tag class="attribute">audience</tag>
21384 attribute</refpurpose>
21388 <programlisting id="profile.audience.frag">
21389 <xsl:param name="profile.audience"></xsl:param>
21393 <refsection><info><title>Description</title></info>
21395 <para>Value of this parameter specifies profiles which should be
21396 included in the output. You can specify multiple profiles by
21397 separating them by semicolon. You can change separator character by
21398 <parameter>profile.separator</parameter>
21401 <para>This parameter has effect only when you are using profiling
21402 stylesheets (<filename>profile-docbook.xsl</filename>,
21403 <filename>profile-chunk.xsl</filename>, …) instead of normal
21404 ones (<filename>docbook.xsl</filename>,
21405 <filename>chunk.xsl</filename>, …).</para>
21410 <refentry version="5.0" id="profile.condition">
21412 <refentrytitle>profile.condition</refentrytitle>
21413 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
21416 <refname>profile.condition</refname>
21417 <refpurpose>Target profile for <tag class="attribute">condition</tag>
21418 attribute</refpurpose>
21422 <programlisting id="profile.condition.frag">
21423 <xsl:param name="profile.condition"></xsl:param>
21427 <refsection><info><title>Description</title></info>
21429 <para>The value of this parameter specifies profiles which should be
21430 included in the output. You can specify multiple profiles by
21431 separating them by semicolon. You can change separator character by
21432 <parameter>profile.separator</parameter>
21435 <para>This parameter has effect only when you are using profiling
21436 stylesheets (<filename>profile-docbook.xsl</filename>,
21437 <filename>profile-chunk.xsl</filename>, …) instead of normal
21438 ones (<filename>docbook.xsl</filename>,
21439 <filename>chunk.xsl</filename>, …).</para>
21444 <refentry version="5.0" id="profile.conformance">
21446 <refentrytitle>profile.conformance</refentrytitle>
21447 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
21450 <refname>profile.conformance</refname>
21451 <refpurpose>Target profile for <tag class="attribute">conformance</tag>
21452 attribute</refpurpose>
21456 <programlisting id="profile.conformance.frag">
21457 <xsl:param name="profile.conformance"></xsl:param>
21461 <refsection><info><title>Description</title></info>
21463 <para>The value of this parameter specifies profiles which should be
21464 included in the output. You can specify multiple profiles by
21465 separating them by semicolon. You can change separator character by
21466 <parameter>profile.separator</parameter>
21469 <para>This parameter has effect only when you are using profiling
21470 stylesheets (<filename>profile-docbook.xsl</filename>,
21471 <filename>profile-chunk.xsl</filename>, …) instead of normal
21472 ones (<filename>docbook.xsl</filename>,
21473 <filename>chunk.xsl</filename>, …).</para>
21478 <refentry version="5.0" id="profile.lang">
21480 <refentrytitle>profile.lang</refentrytitle>
21481 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
21484 <refname>profile.lang</refname>
21485 <refpurpose>Target profile for <tag class="attribute">lang</tag>
21486 attribute</refpurpose>
21490 <programlisting id="profile.lang.frag">
21491 <xsl:param name="profile.lang"></xsl:param>
21495 <refsection><info><title>Description</title></info>
21497 <para>The value of this parameter specifies profiles which should be
21498 included in the output. You can specify multiple profiles by
21499 separating them by semicolon. You can change separator character by
21500 <parameter>profile.separator</parameter>
21503 <para>This parameter has effect only when you are using profiling
21504 stylesheets (<filename>profile-docbook.xsl</filename>,
21505 <filename>profile-chunk.xsl</filename>, …) instead of normal
21506 ones (<filename>docbook.xsl</filename>,
21507 <filename>chunk.xsl</filename>, …).</para>
21512 <refentry version="5.0" id="profile.os">
21514 <refentrytitle>profile.os</refentrytitle>
21515 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
21518 <refname>profile.os</refname>
21519 <refpurpose>Target profile for <tag class="attribute">os</tag>
21520 attribute</refpurpose>
21524 <programlisting id="profile.os.frag">
21525 <xsl:param name="profile.os"></xsl:param>
21529 <refsection><info><title>Description</title></info>
21531 <para>The value of this parameter specifies profiles which should be
21532 included in the output. You can specify multiple profiles by
21533 separating them by semicolon. You can change separator character by
21534 <parameter>profile.separator</parameter>
21537 <para>This parameter has effect only when you are using profiling
21538 stylesheets (<filename>profile-docbook.xsl</filename>,
21539 <filename>profile-chunk.xsl</filename>, …) instead of normal
21540 ones (<filename>docbook.xsl</filename>,
21541 <filename>chunk.xsl</filename>, …).</para>
21546 <refentry version="5.0" id="profile.revision">
21548 <refentrytitle>profile.revision</refentrytitle>
21549 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
21552 <refname>profile.revision</refname>
21553 <refpurpose>Target profile for <tag class="attribute">revision</tag>
21554 attribute</refpurpose>
21558 <programlisting id="profile.revision.frag">
21559 <xsl:param name="profile.revision"></xsl:param>
21563 <refsection><info><title>Description</title></info>
21565 <para>The value of this parameter specifies profiles which should be
21566 included in the output. You can specify multiple profiles by
21567 separating them by semicolon. You can change separator character by
21568 <parameter>profile.separator</parameter>
21571 <para>This parameter has effect only when you are using profiling
21572 stylesheets (<filename>profile-docbook.xsl</filename>,
21573 <filename>profile-chunk.xsl</filename>, …) instead of normal
21574 ones (<filename>docbook.xsl</filename>,
21575 <filename>chunk.xsl</filename>, …).</para>
21580 <refentry version="5.0" id="profile.revisionflag">
21582 <refentrytitle>profile.revisionflag</refentrytitle>
21583 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
21586 <refname>profile.revisionflag</refname>
21587 <refpurpose>Target profile for <tag class="attribute">revisionflag</tag>
21588 attribute</refpurpose>
21592 <programlisting id="profile.revisionflag.frag">
21593 <xsl:param name="profile.revisionflag"></xsl:param>
21597 <refsection><info><title>Description</title></info>
21599 <para>The value of this parameter specifies profiles which should be
21600 included in the output. You can specify multiple profiles by
21601 separating them by semicolon. You can change separator character by
21602 <parameter>profile.separator</parameter>
21605 <para>This parameter has effect only when you are using profiling
21606 stylesheets (<filename>profile-docbook.xsl</filename>,
21607 <filename>profile-chunk.xsl</filename>, …) instead of normal
21608 ones (<filename>docbook.xsl</filename>,
21609 <filename>chunk.xsl</filename>, …).</para>
21614 <refentry version="5.0" id="profile.role">
21616 <refentrytitle>profile.role</refentrytitle>
21617 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
21620 <refname>profile.role</refname>
21621 <refpurpose>Target profile for <tag class="attribute">role</tag>
21622 attribute</refpurpose>
21626 <programlisting id="profile.role.frag">
21627 <xsl:param name="profile.role"></xsl:param>
21631 <refsection><info><title>Description</title></info>
21633 <para>The value of this parameter specifies profiles which should be
21634 included in the output. You can specify multiple profiles by
21635 separating them by semicolon. You can change separator character by
21636 <parameter>profile.separator</parameter>
21639 <para>This parameter has effect only when you are using profiling
21640 stylesheets (<filename>profile-docbook.xsl</filename>,
21641 <filename>profile-chunk.xsl</filename>, …) instead of normal
21642 ones (<filename>docbook.xsl</filename>,
21643 <filename>chunk.xsl</filename>, …).</para>
21646 <para>Note that <tag class="attribute">role</tag> is often
21647 used for other purposes than profiling. For example it is commonly
21648 used to get emphasize in bold font:</para>
21650 <programlisting><emphasis role="bold">very important</emphasis></programlisting>
21652 <para>If you are using <tag class="attribute">role</tag> for
21653 these purposes do not forget to add values like <literal>bold</literal> to
21654 value of this parameter. If you forgot you will get document with
21655 small pieces missing which are very hard to track.</para>
21657 <para>For this reason it is not recommended to use <tag class="attribute">role</tag> attribute for profiling. You should
21658 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>
21664 <refentry version="5.0" id="profile.security">
21666 <refentrytitle>profile.security</refentrytitle>
21667 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
21670 <refname>profile.security</refname>
21671 <refpurpose>Target profile for <tag class="attribute">security</tag>
21672 attribute</refpurpose>
21676 <programlisting id="profile.security.frag">
21677 <xsl:param name="profile.security"></xsl:param>
21681 <refsection><info><title>Description</title></info>
21683 <para>The value of this parameter specifies profiles which should be
21684 included in the output. You can specify multiple profiles by
21685 separating them by semicolon. You can change separator character by
21686 <parameter>profile.separator</parameter>
21689 <para>This parameter has effect only when you are using profiling
21690 stylesheets (<filename>profile-docbook.xsl</filename>,
21691 <filename>profile-chunk.xsl</filename>, …) instead of normal
21692 ones (<filename>docbook.xsl</filename>,
21693 <filename>chunk.xsl</filename>, …).</para>
21698 <refentry version="5.0" id="profile.status">
21700 <refentrytitle>profile.status</refentrytitle>
21701 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
21704 <refname>profile.status</refname>
21705 <refpurpose>Target profile for <tag class="attribute">status</tag>
21706 attribute</refpurpose>
21710 <programlisting id="profile.status.frag">
21711 <xsl:param name="profile.status"></xsl:param>
21715 <refsection><info><title>Description</title></info>
21717 <para>The value of this parameter specifies profiles which should be
21718 included in the output. You can specify multiple profiles by
21719 separating them by semicolon. You can change separator character by
21720 <parameter>profile.separator</parameter>
21723 <para>This parameter has effect only when you are using profiling
21724 stylesheets (<filename>profile-docbook.xsl</filename>,
21725 <filename>profile-chunk.xsl</filename>, …) instead of normal
21726 ones (<filename>docbook.xsl</filename>,
21727 <filename>chunk.xsl</filename>, …).</para>
21732 <refentry version="5.0" id="profile.userlevel">
21734 <refentrytitle>profile.userlevel</refentrytitle>
21735 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
21738 <refname>profile.userlevel</refname>
21739 <refpurpose>Target profile for <tag class="attribute">userlevel</tag>
21740 attribute</refpurpose>
21744 <programlisting id="profile.userlevel.frag">
21745 <xsl:param name="profile.userlevel"></xsl:param>
21749 <refsection><info><title>Description</title></info>
21751 <para>The value of this parameter specifies profiles which should be
21752 included in the output. You can specify multiple profiles by
21753 separating them by semicolon. You can change separator character by
21754 <parameter>profile.separator</parameter>
21757 <para>This parameter has effect only when you are using profiling
21758 stylesheets (<filename>profile-docbook.xsl</filename>,
21759 <filename>profile-chunk.xsl</filename>, …) instead of normal
21760 ones (<filename>docbook.xsl</filename>,
21761 <filename>chunk.xsl</filename>, …).</para>
21766 <refentry version="5.0" id="profile.vendor">
21768 <refentrytitle>profile.vendor</refentrytitle>
21769 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
21772 <refname>profile.vendor</refname>
21773 <refpurpose>Target profile for <tag class="attribute">vendor</tag>
21774 attribute</refpurpose>
21778 <programlisting id="profile.vendor.frag">
21779 <xsl:param name="profile.vendor"></xsl:param>
21783 <refsection><info><title>Description</title></info>
21785 <para>The value of this parameter specifies profiles which should be
21786 included in the output. You can specify multiple profiles by
21787 separating them by semicolon. You can change separator character by
21788 <parameter>profile.separator</parameter>
21791 <para>This parameter has effect only when you are using profiling
21792 stylesheets (<filename>profile-docbook.xsl</filename>,
21793 <filename>profile-chunk.xsl</filename>, …) instead of normal
21794 ones (<filename>docbook.xsl</filename>,
21795 <filename>chunk.xsl</filename>, …).</para>
21800 <refentry version="5.0" id="profile.wordsize">
21802 <refentrytitle>profile.wordsize</refentrytitle>
21803 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
21806 <refname>profile.wordsize</refname>
21807 <refpurpose>Target profile for <tag class="attribute">wordsize</tag>
21808 attribute</refpurpose>
21812 <programlisting id="profile.wordsize.frag">
21813 <xsl:param name="profile.wordsize"></xsl:param>
21817 <refsection><info><title>Description</title></info>
21819 <para>The value of this parameter specifies profiles which should be
21820 included in the output. You can specify multiple profiles by
21821 separating them by semicolon. You can change separator character by
21822 <parameter>profile.separator</parameter>
21825 <para>This parameter has effect only when you are using profiling
21826 stylesheets (<filename>profile-docbook.xsl</filename>,
21827 <filename>profile-chunk.xsl</filename>, …) instead of normal
21828 ones (<filename>docbook.xsl</filename>,
21829 <filename>chunk.xsl</filename>, …).</para>
21834 <refentry version="5.0" id="profile.attribute">
21836 <refentrytitle>profile.attribute</refentrytitle>
21837 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
21840 <refname>profile.attribute</refname>
21841 <refpurpose>Name of user-specified profiling attribute</refpurpose>
21845 <programlisting id="profile.attribute.frag">
21846 <xsl:param name="profile.attribute"></xsl:param>
21850 <refsection><info><title>Description</title></info>
21852 <para>This parameter is used in conjuction with
21853 <parameter>profile.value</parameter>.</para>
21855 <para>This parameter has effect only when you are using profiling
21856 stylesheets (<filename>profile-docbook.xsl</filename>,
21857 <filename>profile-chunk.xsl</filename>, …) instead of normal
21858 ones (<filename>docbook.xsl</filename>,
21859 <filename>chunk.xsl</filename>, …).</para>
21864 <refentry version="5.0" id="profile.value">
21866 <refentrytitle>profile.value</refentrytitle>
21867 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
21870 <refname>profile.value</refname>
21871 <refpurpose>Target profile for user-specified attribute</refpurpose>
21875 <programlisting id="profile.value.frag">
21876 <xsl:param name="profile.value"></xsl:param>
21880 <refsection><info><title>Description</title></info>
21882 <para>When you are using this parameter you must also specify name of
21883 profiling attribute with parameter
21884 <parameter>profile.attribute</parameter>.</para>
21886 <para>The value of this parameter specifies profiles which should be
21887 included in the output. You can specify multiple profiles by
21888 separating them by semicolon. You can change separator character by
21889 <parameter>profile.separator</parameter>
21892 <para>This parameter has effect only when you are using profiling
21893 stylesheets (<filename>profile-docbook.xsl</filename>,
21894 <filename>profile-chunk.xsl</filename>, …) instead of normal
21895 ones (<filename>docbook.xsl</filename>,
21896 <filename>chunk.xsl</filename>, …).</para>
21901 <refentry version="5.0" id="profile.separator">
21903 <refentrytitle>profile.separator</refentrytitle>
21904 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
21907 <refname>profile.separator</refname>
21908 <refpurpose>Separator character for compound profile values</refpurpose>
21912 <programlisting id="profile.separator.frag">
21913 <xsl:param name="profile.separator">;</xsl:param>
21917 <refsection><info><title>Description</title></info>
21919 <para>Separator character used for compound profile values. See <parameter>profile.arch</parameter></para>
21924 </reference><reference id="l10n" xml:base="../fo/param.xml"><title>Localization</title>
21925 <refentry version="5.0" id="l10n.gentext.language">
21927 <refentrytitle>l10n.gentext.language</refentrytitle>
21928 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
21931 <refname>l10n.gentext.language</refname>
21932 <refpurpose>Sets the gentext language</refpurpose>
21936 <programlisting id="l10n.gentext.language.frag">
21937 <xsl:param name="l10n.gentext.language"></xsl:param>
21941 <refsection><info><title>Description</title></info>
21943 <para>If this parameter is set to any value other than the empty string, its
21944 value will be used as the value for the language when generating text. Setting
21945 <parameter>l10n.gentext.language</parameter> overrides any settings within the
21946 document being formatted.</para>
21948 <para>It's much more likely that you might want to set the
21949 <parameter>l10n.gentext.default.language</parameter> parameter.</para>
21954 <refentry version="5.0" id="l10n.gentext.default.language">
21956 <refentrytitle>l10n.gentext.default.language</refentrytitle>
21957 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
21960 <refname>l10n.gentext.default.language</refname>
21961 <refpurpose>Sets the default language for generated text</refpurpose>
21965 <programlisting id="l10n.gentext.default.language.frag">
21966 <xsl:param name="l10n.gentext.default.language">en</xsl:param>
21970 <refsection><info><title>Description</title></info>
21972 <para>The value of the <parameter>l10n.gentext.default.language</parameter>
21973 parameter is used as the language for generated text if no setting is provided
21974 in the source document.</para>
21979 <refentry version="5.0" id="l10n.gentext.use.xref.language">
21981 <refentrytitle>l10n.gentext.use.xref.language</refentrytitle>
21982 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
21985 <refname>l10n.gentext.use.xref.language</refname>
21986 <refpurpose>Use the language of target when generating cross-reference text?</refpurpose>
21990 <programlisting id="l10n.gentext.use.xref.language.frag">
21991 <xsl:param name="l10n.gentext.use.xref.language" select="0"></xsl:param>
21995 <refsection><info><title>Description</title></info>
21997 <para>If non-zero, the language of the target will be used when
21998 generating cross reference text. Usually, the <quote>current</quote>
21999 language is used when generating text (that is, the language of the
22000 element that contains the cross-reference element). But setting this parameter
22001 allows the language of the element <emphasis>pointed to</emphasis> to control
22002 the generated text.</para>
22004 <para>Consider the following example:</para>
22007 <programlisting><para lang="en">See also <xref linkend="chap3"/>.</para>
22011 <para>Suppose that Chapter 3 happens to be written in German.
22012 If <parameter>l10n.gentext.use.xref.language</parameter> is non-zero, the
22013 resulting text will be something like this:</para>
22016 <para>See also Kapital 3.</para>
22019 <para>Where the more traditional rendering would be:</para>
22022 <para>See also Chapter 3.</para>
22028 <refentry version="5.0" id="l10n.lang.value.rfc.compliant">
22030 <refentrytitle>l10n.lang.value.rfc.compliant</refentrytitle>
22031 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
22034 <refname>l10n.lang.value.rfc.compliant</refname>
22035 <refpurpose>Make value of lang attribute RFC compliant?</refpurpose>
22039 <programlisting id="l10n.lang.value.rfc.compliant.frag">
22040 <xsl:param name="l10n.lang.value.rfc.compliant" select="1"></xsl:param>
22044 <refsection><info><title>Description</title></info>
22046 <para>If non-zero, ensure that the values for all <tag class="attribute">lang</tag> attributes in HTML output are RFC
22047 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:
22049 <blockquote><para>[RFC1766] defines and explains the language codes
22050 that must be used in HTML documents.</para>
22051 <para>Briefly, language codes consist of a primary code and a possibly
22052 empty series of subcodes:
22054 <literallayout class="monospaced">language-code = primary-code ( "-" subcode )*</literallayout>
22056 <para>And in RFC 1766, <link xlink:href="http://www.ietf.org/rfc/rfc1766.txt">Tags for the Identification
22057 of Languages</link>, the EBNF for "language tag" is given as:
22059 <literallayout class="monospaced">Language-Tag = Primary-tag *( "-" Subtag )
22060 Primary-tag = 1*8ALPHA
22061 Subtag = 1*8ALPHA</literallayout>
22064 </para></footnote>.
22066 by taking any underscore characters in any <tag class="attribute">lang</tag> values found in source documents, and
22067 replacing them with hyphen characters in output HTML files. For
22068 example, <literal>zh_CN</literal> in a source document becomes
22069 <literal>zh-CN</literal> in the HTML output form that source.
22072 <para>This parameter does not cause any case change in <tag class="attribute">lang</tag> values, because RFC 1766
22073 explicitly states that all "language tags" (as it calls them) "are
22074 to be treated as case insensitive".</para>
22081 <refentry version="5.0" id="writing.mode">
22083 <refentrytitle>writing.mode</refentrytitle>
22084 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
22087 <refname>writing.mode</refname>
22088 <refpurpose>Direction of text flow based on locale</refpurpose>
22092 <programlisting id="writing.mode.frag">
22093 <xsl:param name="writing.mode">
22094 <xsl:call-template name="gentext">
22095 <xsl:with-param name="key">writing-mode</xsl:with-param>
22096 <xsl:with-param name="lang">
22097 <xsl:call-template name="l10n.language">
22098 <xsl:with-param name="target" select="/*[1]"></xsl:with-param>
22099 </xsl:call-template>
22100 </xsl:with-param>
22101 </xsl:call-template>
22106 <refsection><info><title>Description</title></info>
22108 <para>Sets direction of text flow and text alignment based on locale.
22109 The value is normally taken from the gentext file for the
22110 lang attribute of the document's root element, using the
22111 key name 'writing-mode' to look it up in the gentext file.
22112 But the param can also be
22113 set on the command line to override that gentext value.
22115 <para>Accepted values are:
22120 <para>Left-to-right text flow in each line, lines stack top to bottom.</para>
22126 <para>Right-to-left text flow in each line, lines stack top to bottom.</para>
22132 <para>Top-to-bottom text flow in each vertical line, lines stack right to left.
22133 Supported by only a few XSL-FO processors. Not supported in HTML output.</para>
22139 <para>Shorthand for lr-tb.</para>
22145 <para>Shorthand for rl-tb.</para>
22151 <para>Shorthand for tb-rl.</para>
22160 </reference><reference id="ebnf" xml:base="../fo/param.xml"><title>EBNF</title>
22161 <refentry version="5.0" id="ebnf.assignment">
22163 <refentrytitle>ebnf.assignment</refentrytitle>
22164 <refmiscinfo class="other" otherclass="datatype">rtf</refmiscinfo>
22167 <refname>ebnf.assignment</refname>
22168 <refpurpose>The EBNF production assignment operator</refpurpose>
22172 <programlisting id="ebnf.assignment.frag">
22174 <xsl:param name="ebnf.assignment">
22175 <fo:inline font-family="{$monospace.font.family}">
22176 <xsl:text>::=</xsl:text>
22182 <refsection><info><title>Description</title></info>
22184 <para>The <parameter>ebnf.assignment</parameter> parameter determines what
22185 text is used to show <quote>assignment</quote> in <tag>production</tag>s
22186 in <tag>productionset</tag>s.</para>
22188 <para>While <quote><literal>::=</literal></quote> is common, so are several
22189 other operators.</para>
22194 <refentry version="5.0" id="ebnf.statement.terminator">
22196 <refentrytitle>ebnf.statement.terminator</refentrytitle>
22197 <refmiscinfo class="other" otherclass="datatype">rtf</refmiscinfo>
22200 <refname>ebnf.statement.terminator</refname>
22201 <refpurpose>Punctuation that ends an EBNF statement.</refpurpose>
22205 <programlisting id="ebnf.statement.terminator.frag">
22207 <xsl:param name="ebnf.statement.terminator"></xsl:param>
22211 <refsection><info><title>Description</title></info>
22213 <para>The <parameter>ebnf.statement.terminator</parameter> parameter determines what
22214 text is used to terminate each <tag>production</tag>
22215 in <tag>productionset</tag>.</para>
22217 <para>Some notations end each statement with a period.</para>
22222 </reference><reference id="prepress" xml:base="../fo/param.xml"><title>Prepress</title>
22223 <refentry version="5.0" id="crop.marks">
22225 <refentrytitle>crop.marks</refentrytitle>
22226 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
22229 <refname>crop.marks</refname>
22230 <refpurpose>Output crop marks?</refpurpose>
22234 <programlisting id="crop.marks.frag">
22235 <xsl:param name="crop.marks" select="0"></xsl:param>
22239 <refsection><info><title>Description</title></info>
22241 <para>If non-zero, crop marks will be added to each page. Currently this
22242 works only with XEP if you have <parameter>xep.extensions</parameter> set.</para>
22247 <refentry version="5.0" id="crop.mark.width">
22249 <refentrytitle>crop.mark.width</refentrytitle>
22250 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
22253 <refname>crop.mark.width</refname>
22254 <refpurpose>Width of crop marks.</refpurpose>
22258 <programlisting id="crop.mark.width.frag">
22259 <xsl:param name="crop.mark.width">0.5pt</xsl:param>
22263 <refsection><info><title>Description</title></info>
22265 <para>Width of crop marks. Crop marks are controlled by
22266 <parameter>crop.marks</parameter> parameter.</para>
22271 <refentry version="5.0" id="crop.mark.offset">
22273 <refentrytitle>crop.mark.offset</refentrytitle>
22274 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
22277 <refname>crop.mark.offset</refname>
22278 <refpurpose>Length of crop marks.</refpurpose>
22282 <programlisting id="crop.mark.offset.frag">
22283 <xsl:param name="crop.mark.offset">24pt</xsl:param>
22287 <refsection><info><title>Description</title></info>
22289 <para>Length of crop marks. Crop marks are controlled by
22290 <parameter>crop.marks</parameter> parameter.</para>
22295 <refentry version="5.0" id="crop.mark.bleed">
22297 <refentrytitle>crop.mark.bleed</refentrytitle>
22298 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
22301 <refname>crop.mark.bleed</refname>
22302 <refpurpose>Length of invisible part of crop marks.</refpurpose>
22306 <programlisting id="crop.mark.bleed.frag">
22307 <xsl:param name="crop.mark.bleed">6pt</xsl:param>
22311 <refsection><info><title>Description</title></info>
22313 <para>Length of invisible part of crop marks. Crop marks are controlled by
22314 <parameter>crop.marks</parameter> parameter.</para>
22321 <part id="manpages">
22322 <?dbhtml dir="manpages"?>
22323 <?dbhtml filename="index.html"?>
22324 <title xml:base="../manpages/param.xml">Manpages Parameter Reference</title>
22325 <partintro id="manintro">
22327 <para xml:base="../manpages/param.xml">This is reference documentation for all user-configurable
22328 parameters in the DocBook XSL "manpages" stylesheet (for
22329 generating groff/nroff output). Note that the manpages
22330 stylesheet is a customization layer of the DocBook XSL HTML
22331 stylesheet. Therefore, you can also use a number of <link xlink:href="../html/">HTML stylesheet parameters</link>
22332 to control manpages output (in addition to the
22333 manpages-specific parameters listed in this section).</para>
22336 <reference id="general" xml:base="../manpages/param.xml">
22337 <title>Hyphenation, justification, and breaking</title>
22338 <refentry version="5.0" id="man.hyphenate">
22340 <refentrytitle>man.hyphenate</refentrytitle>
22341 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
22344 <refname>man.hyphenate</refname>
22345 <refpurpose>Enable hyphenation?</refpurpose>
22349 <programlisting id="man.hyphenate.frag">
22350 <xsl:param name="man.hyphenate">0</xsl:param></programlisting>
22353 <refsection><info><title>Description</title></info>
22355 <para>If non-zero, hyphenation is enabled.</para>
22358 <para>The default value for this parameter is zero because groff is
22359 not particularly smart about how it does hyphenation; it can end up
22360 hyphenating a lot of things that you don't want hyphenated. To
22361 mitigate that, the default behavior of the stylesheets is to suppress
22362 hyphenation of computer inlines, filenames, and URLs. (You can
22363 override the default behavior by setting non-zero values for the
22364 <parameter>man.hyphenate.urls</parameter>,
22365 <parameter>man.hyphenate.filenames</parameter>, and
22366 <parameter>man.hyphenate.computer.inlines</parameter> parameters.) But
22367 the best way is still to just globally disable hyphenation, as the
22368 stylesheets do by default.</para>
22370 <para>The only good reason to enabled hyphenation is if you have also
22371 enabled justification (which is disabled by default). The reason is
22372 that justified text can look very bad unless you also hyphenate it; to
22373 quote the <quote>Hypenation</quote> node from the groff info page:
22376 <para><emphasis>Since the odds are not great for finding a set of
22377 words, for every output line, which fit nicely on a line without
22378 inserting excessive amounts of space between words, 'gtroff'
22379 hyphenates words so that it can justify lines without inserting too
22380 much space between words.</emphasis></para>
22383 So, if you set a non-zero value for the
22384 <parameter>man.justify</parameter> parameter (to enable
22385 justification), then you should probably also set a non-zero value for
22386 <parameter>man.hyphenate</parameter> (to enable hyphenation).</para>
22393 <refentry version="5.0" id="man.hyphenate.urls">
22395 <refentrytitle>man.hyphenate.urls</refentrytitle>
22396 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
22399 <refname>man.hyphenate.urls</refname>
22400 <refpurpose>Hyphenate URLs?</refpurpose>
22404 <programlisting id="man.hyphenate.urls.frag">
22405 <xsl:param name="man.hyphenate.urls">0</xsl:param></programlisting>
22408 <refsection><info><title>Description</title></info>
22410 <para>If zero (the default), hyphenation is suppressed for output of
22411 the <tag>ulink</tag> <tag class="attribute">url</tag> attribute.</para>
22414 <para>If hyphenation is already turned off globally (that is, if
22415 <parameter>man.hyphenate</parameter> is zero, setting
22416 <parameter>man.hyphenate.urls</parameter> is not necessary.</para>
22419 <para>If <parameter>man.hyphenate.urls</parameter> is non-zero, URLs
22420 will not be treated specially and are subject to hyphenation just like
22421 other words.</para>
22424 <para>If you are thinking about setting a non-zero value for
22425 <parameter>man.hyphenate.urls</parameter> in order to make long
22426 URLs break across lines, you'd probably be better off
22427 experimenting with setting the
22428 <parameter>man.break.after.slash</parameter> parameter first. That
22429 will cause long URLs to be broken after slashes.</para>
22435 <refentry version="5.0" id="man.hyphenate.filenames">
22437 <refentrytitle>man.hyphenate.filenames</refentrytitle>
22438 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
22441 <refname>man.hyphenate.filenames</refname>
22442 <refpurpose>Hyphenate filenames?</refpurpose>
22446 <programlisting id="man.hyphenate.filenames.frag">
22447 <xsl:param name="man.hyphenate.filenames">0</xsl:param></programlisting>
22450 <refsection><info><title>Description</title></info>
22452 <para>If zero (the default), hyphenation is suppressed for
22453 <tag>filename</tag> output.</para>
22456 <para>If hyphenation is already turned off globally (that is, if
22457 <parameter>man.hyphenate</parameter> is zero, setting
22458 <parameter>man.hyphenate.filenames</parameter> is not
22462 <para>If <parameter>man.hyphenate.filenames</parameter> is non-zero,
22463 filenames will not be treated specially and are subject to hyphenation
22464 just like other words.</para>
22467 <para>If you are thinking about setting a non-zero value for
22468 <parameter>man.hyphenate.filenames</parameter> in order to make long
22469 filenames/pathnames break across lines, you'd probably be better off
22470 experimenting with setting the
22471 <parameter>man.break.after.slash</parameter> parameter first. That
22472 will cause long pathnames to be broken after slashes.</para>
22478 <refentry version="5.0" id="man.hyphenate.computer.inlines">
22480 <refentrytitle>man.hyphenate.computer.inlines</refentrytitle>
22481 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
22484 <refname>man.hyphenate.computer.inlines</refname>
22485 <refpurpose>Hyphenate computer inlines?</refpurpose>
22489 <programlisting id="man.hyphenate.computer.inlines.frag">
22490 <xsl:param name="man.hyphenate.computer.inlines">0</xsl:param></programlisting>
22493 <refsection><info><title>Description</title></info>
22495 <para>If zero (the default), hyphenation is suppressed for
22496 <quote>computer inlines</quote> such as environment variables,
22497 constants, etc. This parameter current affects output of the following
22499 <simplelist type="inline">
22501 <member><tag>classname</tag></member>
22502 <member><tag>constant</tag></member>
22503 <member><tag>envar</tag></member>
22504 <member><tag>errorcode</tag></member>
22505 <member><tag>option</tag></member>
22506 <member><tag>replaceable</tag></member>
22507 <member><tag>userinput</tag></member>
22508 <member><tag>type</tag></member>
22509 <member><tag>varname</tag></member>
22514 <para>If hyphenation is already turned off globally (that is, if
22515 <parameter>man.hyphenate</parameter> is zero, setting the
22516 <parameter>man.hyphenate.computer.inlines</parameter> is not
22520 <para>If <parameter>man.hyphenate.computer.inlines</parameter> is
22521 non-zero, computer inlines will not be treated specially and will be
22522 hyphenated like other words when needed.</para>
22527 <refentry version="5.0" id="man.justify">
22529 <refentrytitle>man.justify</refentrytitle>
22530 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
22533 <refname>man.justify</refname>
22534 <refpurpose>Justify text to both right and left margins?</refpurpose>
22538 <programlisting id="man.justify.frag">
22539 <xsl:param name="man.justify">0</xsl:param></programlisting>
22542 <refsection><info><title>Description</title></info>
22544 <para>If non-zero, text is justified to both the right and left
22545 margins (or, in roff terminology, "adjusted and filled" to both the
22546 right and left margins). If zero (the default), text is adjusted to
22547 the left margin only -- producing what is traditionally called
22548 "ragged-right" text.</para>
22551 <para>The default value for this parameter is zero because justified
22552 text looks good only when it is also hyphenated. Without hyphenation,
22553 excessive amounts of space often end up getting between words, in
22554 order to "pad" lines out to align on the right margin.</para>
22556 <para>The problem is that groff is not particularly smart about how it
22557 does hyphenation; it can end up hyphenating a lot of things that you
22558 don't want hyphenated. So, disabling both justification and
22559 hyphenation ensures that hyphens won't get inserted where you don't
22560 want to them, and you don't end up with lines containing excessive
22561 amounts of space between words.</para>
22563 <para>However, if do you decide to set a non-zero value for the
22564 <parameter>man.justify</parameter> parameter (to enable
22565 justification), then you should probably also set a non-zero value for
22566 <parameter>man.hyphenate</parameter> (to enable hyphenation).</para>
22568 <para>Yes, these default settings run counter to how most existing man
22569 pages are formatted. But there are some notable exceptions, such as
22570 the <literal>perl</literal> man pages.</para>
22575 <refentry version="5.0" id="man.break.after.slash">
22577 <refentrytitle>man.break.after.slash</refentrytitle>
22578 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
22581 <refname>man.break.after.slash</refname>
22582 <refpurpose>Enable line-breaking after slashes?</refpurpose>
22586 <programlisting id="man.break.after.slash.frag">
22587 <xsl:param name="man.break.after.slash">0</xsl:param></programlisting>
22590 <refsection><info><title>Description</title></info>
22592 <para>If non-zero, line-breaking after slashes is enabled. This is
22593 mainly useful for causing long URLs or pathnames/filenames to be
22594 broken up or "wrapped" across lines (though it also has the side
22595 effect of sometimes causing relatively short URLs and pathnames to be
22596 broken up across lines too).</para>
22598 <para>If zero (the default), line-breaking after slashes is
22599 disabled. In that case, strings containing slashes (for example, URLs
22600 or filenames) are not broken across lines, even if they exceed the
22601 maximum column widith.</para>
22604 <para>If you set a non-zero value for this parameter, check your
22605 man-page output carefuly afterwards, in order to make sure that the
22606 setting has not introduced an excessive amount of breaking-up of URLs
22607 or pathnames. If your content contains mostly short URLs or
22608 pathnames, setting a non-zero value for
22609 <parameter>man.break.after.slash</parameter> will probably result in
22610 in a significant number of relatively short URLs and pathnames being
22611 broken across lines, which is probably not what you want.</para>
22617 </reference><reference id="indent" xml:base="../manpages/param.xml">
22618 <title>Indentation</title>
22619 <refentry version="5.0" id="man.indent.width">
22621 <refentrytitle>man.indent.width</refentrytitle>
22622 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
22625 <refname>man.indent.width</refname>
22626 <refpurpose>Specifies width used for adjusted indents</refpurpose>
22630 <programlisting id="man.indent.width.frag">
22631 <xsl:param name="man.indent.width">4</xsl:param>
22635 <refsection><info><title>Description</title></info>
22636 <para>The <parameter>man.indent.width</parameter> parameter specifies
22637 the width used for adjusted indents. The value of
22638 <parameter>man.indent.width</parameter> is used for indenting of
22639 lists, verbatims, headings, and elsewhere, depending on whether the
22640 values of certain <literal>man.indent.*</literal> boolean parameters
22641 are non-zero.</para>
22643 <para>The value of <parameter>man.indent.width</parameter> should
22644 include a valid roff measurement unit (for example,
22645 <literal>n</literal> or <literal>u</literal>). The default value of
22646 <literal>4n</literal> specifies a 4-en width; when viewed on a
22647 console, that amounts to the width of four characters. For details
22648 about roff measurment units, see the <literal>Measurements</literal>
22649 node in the groff info page.</para>
22654 <refentry version="5.0" id="man.indent.refsect">
22656 <refentrytitle>man.indent.refsect</refentrytitle>
22657 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
22660 <refname>man.indent.refsect</refname>
22661 <refpurpose>Adjust indentation of refsect* and refsection?</refpurpose>
22665 <programlisting id="man.indent.refsect.frag">
22666 <xsl:param name="man.indent.refsect" select="0"></xsl:param></programlisting>
22669 <refsection><info><title>Description</title></info>
22671 <para>If the value of <parameter>man.indent.refsect</parameter> is
22672 non-zero, the width of the left margin for
22673 <tag>refsect1</tag>, <tag>refsect2</tag> and
22674 <tag>refsect3</tag> contents and titles (and first-level,
22675 second-level, and third-level nested
22676 <tag>refsection</tag>instances) is adjusted by the value of
22677 the <parameter>man.indent.width</parameter> parameter. With
22678 <parameter>man.indent.width</parameter> set to its default value of
22679 <literal>3n</literal>, the main results are that:
22683 <para>contents of <tag>refsect1</tag> are output with a
22684 left margin of three characters instead the roff default of seven
22685 or eight characters</para>
22688 <para>contents of <tag>refsect2</tag> are displayed in
22689 console output with a left margin of six characters instead the of
22690 the roff default of seven characters</para>
22693 <para> the contents of <tag>refsect3</tag> and nested
22694 <tag>refsection</tag> instances are adjusted
22695 accordingly.</para>
22699 If instead the value of <parameter>man.indent.refsect</parameter> is
22700 zero, no margin adjustment is done for <literal>refsect*</literal>
22704 <para>If your content is primarly comprised of
22705 <tag>refsect1</tag> and <tag>refsect2</tag> content
22706 (or the <tag>refsection</tag> equivalent) – with few or
22707 no <tag>refsect3</tag> or lower nested sections , you may be
22708 able to “conserve” space in your output by setting
22709 <parameter>man.indent.refsect</parameter> to a non-zero value. Doing
22710 so will “squeeze” the left margin in such as way as to provide an
22711 additional four characters of “room” per line in
22712 <tag>refsect1</tag> output. That extra room may be useful
22713 if, for example, you have many verbatim sections with long lines in
22720 <refentry version="5.0" id="man.indent.blurbs">
22722 <refentrytitle>man.indent.blurbs</refentrytitle>
22723 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
22726 <refname>man.indent.blurbs</refname>
22727 <refpurpose>Adjust indentation of blurbs?</refpurpose>
22731 <programlisting id="man.indent.blurbs.frag">
22732 <xsl:param name="man.indent.blurbs" select="1"></xsl:param></programlisting>
22735 <refsection><info><title>Description</title></info>
22737 <para>If the value of <parameter>man.indent.blurbs</parameter> is
22738 non-zero, the width of the left margin for
22739 <tag>authorblurb</tag>, <tag>personblurb</tag>, and
22740 <tag>contrib</tag> output is set to the value of the
22741 <parameter>man.indent.width</parameter> parameter
22742 (<literal>3n</literal> by default). If instead the value of
22743 <parameter>man.indent.blurbs</parameter> is zero, the built-in roff
22744 default width (<literal>7.2n</literal>) is used.</para>
22749 <refentry version="5.0" id="man.indent.lists">
22751 <refentrytitle>man.indent.lists</refentrytitle>
22752 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
22755 <refname>man.indent.lists</refname>
22756 <refpurpose>Adjust indentation of lists?</refpurpose>
22760 <programlisting id="man.indent.lists.frag">
22761 <xsl:param name="man.indent.lists" select="1"></xsl:param></programlisting>
22764 <refsection><info><title>Description</title></info>
22766 <para>If the value of <parameter>man.indent.lists</parameter> is
22767 non-zero, the width of the left margin for list items in
22768 <tag>itemizedlist</tag>,
22769 <tag>orderedlist</tag>,
22770 <tag>variablelist</tag> output (and output of some other
22771 lists) is set to the value of the
22772 <parameter>man.indent.width</parameter> parameter
22773 (<literal>4n</literal> by default). If instead the value of
22774 <parameter>man.indent.lists</parameter> is zero, the built-in roff
22775 default width (<literal>7.2n</literal>) is used.</para>
22780 <refentry version="5.0" id="man.indent.verbatims">
22782 <refentrytitle>man.indent.verbatims</refentrytitle>
22783 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
22786 <refname>man.indent.verbatims</refname>
22787 <refpurpose>Adjust indentation of verbatims?</refpurpose>
22791 <programlisting id="man.indent.verbatims.frag">
22792 <xsl:param name="man.indent.verbatims" select="1"></xsl:param></programlisting>
22795 <refsection><info><title>Description</title></info>
22797 <para>If the value of <parameter>man.indent.verbatims</parameter> is
22798 non-zero, the width of the left margin for output of verbatim
22799 environments (<tag>programlisting</tag>,
22800 <tag>screen</tag>, and so on) is set to the value of the
22801 <parameter>man.indent.width</parameter> parameter
22802 (<literal>3n</literal> by default). If instead the value of
22803 <parameter>man.indent.verbatims</parameter> is zero, the built-in roff
22804 default width (<literal>7.2n</literal>) is used.</para>
22809 </reference><reference id="fonts" xml:base="../manpages/param.xml">
22810 <title>Fonts</title>
22811 <refentry version="5.0" id="man.font.funcprototype">
22813 <refentrytitle>man.font.funcprototype</refentrytitle>
22814 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
22817 <refname>man.font.funcprototype</refname>
22818 <refpurpose>Specifies font for funcprototype output</refpurpose>
22822 <programlisting id="man.font.funcprototype.frag">
22823 <xsl:param name="man.font.funcprototype">BI</xsl:param>
22827 <refsection><info><title>Description</title></info>
22829 <para>The <parameter>man.font.funcprototype</parameter> parameter
22830 specifies the font for <tag>funcprototype</tag> output. It
22831 should be a valid roff font name, such as <literal>BI</literal> or
22832 <literal>B</literal>.</para>
22837 <refentry version="5.0" id="man.font.funcsynopsisinfo">
22839 <refentrytitle>man.font.funcsynopsisinfo</refentrytitle>
22840 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
22843 <refname>man.font.funcsynopsisinfo</refname>
22844 <refpurpose>Specifies font for funcsynopsisinfo output</refpurpose>
22848 <programlisting id="man.font.funcsynopsisinfo.frag">
22849 <xsl:param name="man.font.funcsynopsisinfo">B</xsl:param>
22853 <refsection><info><title>Description</title></info>
22855 <para>The <parameter>man.font.funcsynopsisinfo</parameter> parameter
22856 specifies the font for <tag>funcsynopsisinfo</tag> output. It
22857 should be a valid roff font name, such as <literal>B</literal> or
22858 <literal>I</literal>.</para>
22863 <refentry version="5.0" id="man.font.links">
22865 <refentrytitle>man.font.links</refentrytitle>
22866 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
22869 <refname>man.font.links</refname>
22870 <refpurpose>Specifies font for links</refpurpose>
22874 <programlisting id="man.font.links.frag">
22875 <xsl:param name="man.font.links">B</xsl:param>
22879 <refsection><info><title>Description</title></info>
22881 <para>The <parameter>man.font.links</parameter> parameter
22882 specifies the font for output of links (<tag>ulink</tag> instances
22883 and any instances of any element with an <tag class="attribute">xlink:href</tag> attribute).</para>
22885 <para>The value of <parameter>man.font.links</parameter> must be
22886 either <literal>B</literal> or <literal>I</literal>, or empty. If
22887 the value is empty, no font formatting is applied to links.</para>
22889 <para>If you set <parameter>man.endnotes.are.numbered</parameter> and/or
22890 <parameter>man.endnotes.list.enabled</parameter> to zero (disabled), then
22891 you should probably also set an empty value for
22892 <parameter>man.font.links</parameter>. But if
22893 <parameter>man.endnotes.are.numbered</parameter> is non-zero (enabled),
22894 you should probably keep
22895 <parameter>man.font.links</parameter> set to
22896 <literal>B</literal> or <literal>I</literal><footnote><para>The
22897 main purpose of applying a font format to links in most output
22898 formats it to indicate that the formatted text is
22899 “clickable”; given that links rendered in man pages are
22900 not “real” hyperlinks that users can click on, it might
22901 seem like there is never a good reason to have font formatting for
22902 link contents in man output.</para>
22903 <para>In fact, if you suppress the
22904 display of inline link references (by setting
22905 <parameter>man.endnotes.are.numbered</parameter> to zero), there is no
22906 good reason to apply font formatting to links. However, if
22907 <parameter>man.endnotes.are.numbered</parameter> is non-zero, having
22908 font formatting for links (arguably) serves a purpose: It provides
22909 “context” information about exactly what part of the text
22910 is being “annotated” by the link. Depending on how you
22911 mark up your content, that context information may or may not
22912 have value.</para></footnote>.</para>
22915 <refsection><info><title>Related Parameters</title></info>
22916 <para><parameter>man.endnotes.list.enabled</parameter>,
22917 <parameter>man.endnotes.are.numbered</parameter></para>
22922 <refentry version="5.0" id="man.font.table.headings">
22924 <refentrytitle>man.font.table.headings</refentrytitle>
22925 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
22928 <refname>man.font.table.headings</refname>
22929 <refpurpose>Specifies font for table headings</refpurpose>
22933 <programlisting id="man.font.table.headings.frag">
22934 <xsl:param name="man.font.table.headings">B</xsl:param>
22938 <refsection><info><title>Description</title></info>
22940 <para>The <parameter>man.font.table.headings</parameter> parameter
22941 specifies the font for <tag>table</tag> headings. It should be
22942 a valid roff font, such as <literal>B</literal> or
22943 <literal>I</literal>.</para>
22948 <refentry version="5.0" id="man.font.table.title">
22950 <refentrytitle>man.font.table.title</refentrytitle>
22951 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
22954 <refname>man.font.table.title</refname>
22955 <refpurpose>Specifies font for table headings</refpurpose>
22959 <programlisting id="man.font.table.title.frag">
22960 <xsl:param name="man.font.table.title">B</xsl:param>
22964 <refsection><info><title>Description</title></info>
22966 <para>The <parameter>man.font.table.title</parameter> parameter
22967 specifies the font for <tag>table</tag> titles. It should be
22968 a valid roff font, such as <literal>B</literal> or
22969 <literal>I</literal>.</para>
22974 </reference><reference id="synopsis" xml:base="../manpages/param.xml">
22975 <title>SYNOPSIS section</title>
22976 <refentry version="5.0" id="man.funcsynopsis.style">
22978 <refentrytitle>man.funcsynopsis.style</refentrytitle>
22979 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
22980 <refmiscinfo class="other" otherclass="value">ansi</refmiscinfo>
22981 <refmiscinfo class="other" otherclass="value">kr</refmiscinfo>
22984 <refname>man.funcsynopsis.style</refname>
22985 <refpurpose>What style of <tag>funcsynopsis</tag> should be generated?</refpurpose>
22988 <programlisting id="man.funcsynopsis.style.frag"><xsl:param name="man.funcsynopsis.style">ansi</xsl:param></programlisting>
22990 <refsection><info><title>Description</title></info>
22991 <para>If <parameter>man.funcsynopsis.style</parameter> is
22992 <literal>ansi</literal>, ANSI-style function synopses are
22993 generated for a <tag>funcsynopsis</tag>, otherwise K&R-style
22994 function synopses are generated.</para>
22998 </reference><reference id="authors" xml:base="../manpages/param.xml">
22999 <title>AUTHORS and COPYRIGHT sections</title>
23000 <refentry version="5.0" id="man.authors.section.enabled">
23002 <refentrytitle>man.authors.section.enabled</refentrytitle>
23003 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
23006 <refname>man.authors.section.enabled</refname>
23007 <refpurpose>Display auto-generated AUTHORS section?</refpurpose>
23010 <programlisting id="man.authors.section.enabled.frag">
23011 <xsl:param name="man.authors.section.enabled">1</xsl:param>
23014 <refsection><info><title>Description</title></info>
23016 <para>If the value of
23017 <parameter>man.authors.section.enabled</parameter> is non-zero
23018 (the default), then an <literal>AUTHORS</literal> section is
23019 generated near the end of each man page. The output of the
23020 <literal>AUTHORS</literal> section is assembled from any
23021 <tag>author</tag>, <tag>editor</tag>, and <tag>othercredit</tag>
23022 metadata found in the contents of the child <tag>info</tag> or
23023 <tag>refentryinfo</tag> (if any) of the <tag>refentry</tag>
23024 itself, or from any <tag>author</tag>, <tag>editor</tag>, and
23025 <tag>othercredit</tag> metadata that may appear in <tag>info</tag>
23026 contents of any ancestors of the <tag>refentry</tag>.</para>
23028 <para>If the value of
23029 <parameter>man.authors.section.enabled</parameter> is zero, the
23030 the auto-generated <literal>AUTHORS</literal> section is
23033 <para>Set the value of
23034 <parameter>man.authors.section.enabled</parameter> to zero if
23035 you want to have a manually created <literal>AUTHORS</literal>
23036 section in your source, and you want it to appear in output
23037 instead of the auto-generated <literal>AUTHORS</literal>
23042 <refentry version="5.0" id="man.copyright.section.enabled">
23044 <refentrytitle>man.copyright.section.enabled</refentrytitle>
23045 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
23048 <refname>man.copyright.section.enabled</refname>
23049 <refpurpose>Display auto-generated COPYRIGHT section?</refpurpose>
23052 <programlisting id="man.copyright.section.enabled.frag">
23053 <xsl:param name="man.copyright.section.enabled">1</xsl:param>
23056 <refsection><info><title>Description</title></info>
23058 <para>If the value of
23059 <parameter>man.copyright.section.enabled</parameter> is non-zero
23060 (the default), then a <literal>COPYRIGHT</literal> section is
23061 generated near the end of each man page. The output of the
23062 <literal>COPYRIGHT</literal> section is assembled from any
23063 <tag>copyright</tag> and <tag>legalnotice</tag> metadata found in
23064 the contents of the child <tag>info</tag> or
23065 <tag>refentryinfo</tag> (if any) of the <tag>refentry</tag>
23066 itself, or from any <tag>copyright</tag> and
23067 <tag>legalnotice</tag> metadata that may appear in <tag>info</tag>
23068 contents of any ancestors of the <tag>refentry</tag>.</para>
23070 <para>If the value of
23071 <parameter>man.copyright.section.enabled</parameter> is zero, the
23072 the auto-generated <literal>COPYRIGHT</literal> section is
23075 <para>Set the value of
23076 <parameter>man.copyright.section.enabled</parameter> to zero if
23077 you want to have a manually created <literal>COPYRIGHT</literal>
23078 section in your source, and you want it to appear in output
23079 instead of the auto-generated <literal>COPYRIGHT</literal>
23084 </reference><reference id="endnotes" xml:base="../manpages/param.xml">
23085 <title>Endnotes and link handling</title>
23086 <refentry version="5.0" id="man.endnotes.list.enabled">
23088 <refentrytitle>man.endnotes.list.enabled</refentrytitle>
23089 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
23092 <refname>man.endnotes.list.enabled</refname>
23093 <refpurpose>Display endnotes list at end of man page?</refpurpose>
23097 <programlisting id="man.endnotes.list.enabled.frag">
23098 <xsl:param name="man.endnotes.list.enabled">1</xsl:param>
23102 <refsection><info><title>Description</title></info>
23104 <para>If the value of <parameter>man.endnotes.list.enabled</parameter> is
23105 non-zero (the default), then an endnotes list is added to the end of
23106 the output man page.</para>
23108 <para>If the value of <parameter>man.endnotes.list.enabled</parameter> is
23109 zero, the list is suppressed — unless link numbering is enabled (that
23110 is, if <parameter>man.endnotes.are.numbered</parameter> is non-zero), in
23111 which case, that setting overrides the
23112 <parameter>man.endnotes.list.enabled</parameter> setting, and the
23113 endnotes list is still displayed. The reason is that inline
23114 numbering of notesources associated with endnotes only makes sense
23115 if a (numbered) list of endnotes is also generated.</para>
23119 <parameter>man.endnotes.list.enabled</parameter> at its default
23120 (non-zero) value ensures that no “out of line” information (such
23121 as the URLs for hyperlinks and images) gets lost in your
23122 man-page output. It just gets “rearranged”.</para>
23123 <para>So if you’re thinking about disabling endnotes listing by
23124 setting the value of
23125 <parameter>man.endnotes.list.enabled</parameter> to zero:
23126 Before you do so, first take some time to carefully consider
23127 the information needs and experiences of your users. The “out
23128 of line” information has value even if the presentation of it
23129 in text output is not as interactive as it may be in other
23130 output formats.</para>
23131 <para>As far as the specific case of URLs: Even though the URLs
23132 displayed in text output may not be “real” (clickable)
23133 hyperlinks, many X terminals have convenience features for
23134 recognizing URLs and can, for example, present users with
23135 an options to open a URL in a browser with the user clicks on
23136 the URL is a terminal window. And short of those, users with X
23137 terminals can always manually cut and paste the URLs into a web
23139 <para>Also, note that various “man to html” tools, such as the
23140 widely used <command><link xlink:href="http://users.actrix.gen.nz/michael/vhman2html.html">man2html</link></command> (<literal>VH-Man2html</literal>)
23141 application, automatically mark up URLs with <literal>a@href</literal> markup
23142 during conversion — resulting in “real” hyperlinks in HTML
23143 output from those tools.</para>
23146 <para>To “turn off” numbering of endnotes in the
23147 endnotes list, set <parameter>man.endnotes.are.numbered</parameter>
23148 to zero. The endnotes list will
23149 still be displayed; it will just be displayed without the
23150 numbers<footnote><para>It can still make sense to have
23151 the list of endnotes displayed even if you have endnotes numbering turned
23152 off. In that case, your endnotes list basically becomes a “list
23153 of references” without any association with specific text in
23154 your document. This is probably the best option if you find the inline
23155 endnotes numbering obtrusive. Your users will still have access to all the “out of line”
23156 such as URLs for hyperlinks.</para></footnote>
23159 <para>The default heading for the endnotes list is
23160 <literal>NOTES</literal>. To change that, set a non-empty
23161 value for the <parameter>man.endnotes.list.heading</parameter>
23164 <para>In the case of notesources that are links: Along with the
23165 URL for each link, the endnotes list includes the contents of the
23166 link. The list thus includes only non-empty<footnote>
23168 <para>A “non-empty” link is one that looks like
23169 this:<literallayout class="monospaced"> <ulink url="http://docbook.sf.net/snapshot/xsl/doc/manpages/">manpages</ulink></literallayout>
23170 an “empty link” is on that looks like this:<literallayout class="monospaced"> <ulink url="http://docbook.sf.net/snapshot/xsl/doc/manpages/"/></literallayout>
23171 </para></footnote> links.
23173 Empty links are never included, and never numbered. They are simply
23174 displayed inline, without any numbering.</para>
23176 <para>In addition, if there are multiple instances of links in a
23177 <tag>refentry</tag> that have the same URL, the URL is listed only
23178 once. The contents listed for that link in the endnotes list are
23179 the contents of the first link which has that URL.</para>
23181 <para>If you disable endnotes listing, you should probably also set
23182 <parameter>man.links.are.underlined</parameter> to zero (to disable
23183 link underlining).</para>
23187 <refentry version="5.0" id="man.endnotes.list.heading">
23189 <refentrytitle>man.endnotes.list.heading</refentrytitle>
23190 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
23193 <refname>man.endnotes.list.heading</refname>
23194 <refpurpose>Specifies an alternate name for endnotes list</refpurpose>
23198 <programlisting id="man.endnotes.list.heading.frag">
23199 <xsl:param name="man.endnotes.list.heading"></xsl:param>
23203 <refsection><info><title>Description</title></info>
23205 <para>If the value of the
23206 <parameter>man.endnotes.are.numbered</parameter> parameter
23207 and/or the <parameter>man.endnotes.list.enabled</parameter>
23208 parameter is non-zero (the defaults for both are non-zero), a
23209 numbered list of endnotes is generated near the end of each man
23210 page. The default heading for the list of endnotes is the
23211 equivalent of the English word <literal>NOTES</literal> in
23212 the current locale. To cause an alternate heading to be displayed,
23213 set a non-empty value for the
23214 <parameter>man.endnotes.list.heading</parameter> parameter —
23215 for example, <literal>REFERENCES</literal>.</para>
23219 <refentry version="5.0" id="man.endnotes.are.numbered">
23221 <refentrytitle>man.endnotes.are.numbered</refentrytitle>
23222 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
23225 <refname>man.endnotes.are.numbered</refname>
23226 <refpurpose>Number endnotes?</refpurpose>
23230 <programlisting id="man.endnotes.are.numbered.frag">
23231 <xsl:param name="man.endnotes.are.numbered">1</xsl:param>
23235 <refsection><info><title>Description</title></info>
23237 <para>If the value of <parameter>man.endnotes.are.numbered</parameter> is
23238 non-zero (the default), then for each non-empty<footnote>
23239 <para>A “non-empty” notesource is one that looks like
23240 this:<literallayout class="monospaced"> <ulink url="http://docbook.sf.net/snapshot/xsl/doc/manpages/">manpages</ulink></literallayout>
23241 an “empty” notesource is on that looks like this:<literallayout class="monospaced"> <ulink url="http://docbook.sf.net/snapshot/xsl/doc/manpages/"/></literallayout>
23242 </para></footnote> “notesource”:
23246 <para>a number (in square brackets) is displayed inline after the
23247 rendered inline contents (if any) of the notesource</para>
23250 <para>the contents of the notesource are included in a
23251 numbered list of endnotes that is generated at the end of
23252 each man page; the number for each endnote corresponds to
23253 the inline number for the notesource with which it is
23257 The default heading for the list of endnotes is
23258 <literal>NOTES</literal>. To output a different heading, set a value
23259 for the <parameter>man.endnotes.section.heading</parameter>
23263 <para>The endnotes list is also displayed (but without
23264 numbers) if the value of
23265 <parameter>man.endnotes.list.enabled</parameter> is
23270 <para>If the value of <parameter>man.endnotes.are.numbered</parameter> is
23271 zero, numbering of endnotess is suppressed; only inline
23272 contents (if any) of the notesource are displayed inline.
23274 <para>If you are thinking about disabling endnote numbering by setting
23275 the value of <parameter>man.endnotes.are.numbered</parameter> to zero,
23276 before you do so, first take some time to carefully
23277 consider the information needs and experiences of your users. The
23278 square-bracketed numbers displayed inline after notesources may seem
23279 obstrusive and aesthetically unpleasing<footnote><para>As far as notesources that are links, ytou might
23280 think it would be better to just display URLs for non-empty
23281 links inline, after their content, rather than displaying
23282 square-bracketed numbers all over the place. But it's not better. In
23283 fact, it's not even practical, because many (most) URLs for links
23284 are too long to be displayed inline. They end up overflowing the
23285 right margin. You can set a non-zero value for
23286 <parameter>man.break.after.slash</parameter> parameter to deal with
23287 that, but it could be argued that what you end up with is at least
23288 as ugly, and definitely more obstrusive, then having short
23289 square-bracketed numbers displayed inline.</para></footnote>,
23291 but in a text-only output format, the
23292 numbered-notesources/endnotes-listing mechanism is the only
23293 practical way to handle this kind of content.</para>
23295 <para>Also, users of “text based” browsers such as
23296 <command>lynx</command> will already be accustomed to seeing inline
23297 numbers for links. And various "man to html" applications, such as
23298 the widely used <command><link xlink:href="http://users.actrix.gen.nz/michael/vhman2html.html">man2html</link></command> (<literal>VH-Man2html</literal>)
23299 application, can automatically turn URLs into "real" HTML hyperlinks
23300 in output. So leaving <parameter>man.endnotes.are.numbered</parameter>
23301 at its default (non-zero) value ensures that no information is
23302 lost in your man-page output. It just gets
23303 “rearranged”.</para>
23306 <para>The handling of empty links is not affected by this
23307 parameter. Empty links are handled simply by displaying their URLs
23308 inline. Empty links are never auto-numbered.</para>
23310 <para>If you disable endnotes numbering, you should probably also set
23311 <parameter>man.font.links</parameter> to an empty value (to
23312 disable font formatting for links.</para>
23315 <refsection><info><title>Related Parameters</title></info>
23316 <para><parameter>man.endnotes.list.enabled</parameter>,
23317 <parameter>man.font.links</parameter></para>
23321 <refentry version="5.0" id="man.base.url.for.relative.links">
23323 <refentrytitle>man.base.url.for.relative.links</refentrytitle>
23324 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
23327 <refname>man.base.url.for.relative.links</refname>
23328 <refpurpose>Specifies a base URL for relative links</refpurpose>
23332 <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>
23335 <refsection><info><title>Description</title></info>
23337 <para>For any “notesource” listed in the auto-generated
23338 “NOTES” section of output man pages (which is generated when
23340 <parameter>man.endnotes.list.enabled</parameter> parameter
23341 is non-zero), if the notesource is a link source with a
23342 relative URI, the URI is displayed in output with the value
23344 <parameter>man.base.url.for.relative.links</parameter>
23345 parameter prepended to the value of the link URI.</para>
23348 <para>A link source is an notesource that references an
23352 <para>a <tag>ulink</tag> element with a <tag class="attribute">url</tag> attribute</para>
23355 <para>any element with an <tag class="attribute">xlink:href</tag> attribute</para>
23358 <para>an <tag>imagedata</tag>, <tag>audiodata</tag>, or
23359 <tag>videodata</tag> element</para>
23365 <para>If you use relative URIs in link sources in your DocBook
23366 <tag>refentry</tag> source, and you leave
23367 <parameter>man.base.url.for.relative.links</parameter>
23368 unset, the relative links will appear “as is” in the “Notes”
23369 section of any man-page output generated from your source.
23370 That’s probably not what you want, because such relative
23371 links are only usable in the context of HTML output. So, to
23372 make the links meaningful and usable in the context of
23373 man-page output, set a value for
23374 <parameter>man.base.url.for.relative.links</parameter> that
23375 points to the online version of HTML output generated from
23376 your DocBook <tag>refentry</tag> source. For
23378 <programlisting><xsl:param name="man.base.url.for.relative.links"
23379 >http://www.kernel.org/pub/software/scm/git/docs/</xsl:param></programlisting>
23384 <refsection><info><title>Related Parameters</title></info>
23385 <para><parameter>man.endnotes.list.enabled</parameter></para>
23390 </reference><reference id="lists" xml:base="../manpages/param.xml">
23391 <title>Lists</title>
23392 <refentry version="5.0" id="man.segtitle.suppress">
23394 <refentrytitle>man.segtitle.suppress</refentrytitle>
23395 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
23398 <refname>man.segtitle.suppress</refname>
23399 <refpurpose>Suppress display of segtitle contents?</refpurpose>
23403 <programlisting id="man.segtitle.suppress.frag">
23404 <xsl:param name="man.segtitle.suppress" select="0"></xsl:param></programlisting>
23407 <refsection><info><title>Description</title></info>
23409 <para>If the value of <parameter>man.segtitle.suppress</parameter> is
23410 non-zero, then display of <tag>segtitle</tag> contents is
23411 suppressed in output.</para>
23416 </reference><reference id="charmap" xml:base="../manpages/param.xml">
23417 <title>Character/string substitution</title>
23418 <refentry version="5.0" id="man.charmap.enabled">
23420 <refentrytitle>man.charmap.enabled</refentrytitle>
23421 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
23424 <refname>man.charmap.enabled</refname>
23425 <refpurpose>Apply character map before final output?</refpurpose>
23429 <programlisting id="man.charmap.enabled.frag">
23430 <xsl:param name="man.charmap.enabled" select="1"></xsl:param>
23434 <refsection><info><title>Description</title></info>
23436 <para>If the value of the <parameter>man.charmap.enabled</parameter>
23437 parameter is non-zero, a "character map" is used to substitute certain
23438 Unicode symbols and special characters with appropriate roff/groff
23439 equivalents, just before writing each man-page file to the
23440 filesystem. If instead the value of
23441 <parameter>man.charmap.enabled</parameter> is zero, Unicode characters
23442 are passed through "as is".</para>
23444 <refsection><info><title>Details</title></info>
23446 <para>For converting certain Unicode symbols and special characters in
23447 UTF-8 or UTF-16 encoded XML source to appropriate groff/roff
23448 equivalents in man-page output, the DocBook XSL Stylesheets
23449 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
23450 map</link> format as detailed in the XSLT 2.0 specification. The map
23451 contains more than 800 character mappings and can be considered the
23452 standard roff character map for the distribution.</para>
23454 <para>You can use the <parameter>man.charmap.uri</parameter>
23455 parameter to specify a URI for the location for an alternate roff
23456 character map to use in place of the standard roff character map
23457 provided in the distribution.</para>
23459 <para>You can also use a subset of a character map. For details,
23460 see the <parameter>man.charmap.use.subset</parameter>,
23461 <parameter>man.charmap.subset.profile</parameter>, and
23462 <parameter>man.charmap.subset.profile.english</parameter>
23469 <refentry version="5.0" id="man.charmap.uri">
23471 <refentrytitle>man.charmap.uri</refentrytitle>
23472 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
23475 <refname>man.charmap.uri</refname>
23476 <refpurpose>URI for custom roff character map</refpurpose>
23480 <programlisting id="man.charmap.uri.frag">
23481 <xsl:param name="man.charmap.uri"></xsl:param>
23485 <refsection><info><title>Description</title></info>
23487 <para>For converting certain Unicode symbols and special characters in
23488 UTF-8 or UTF-16 encoded XML source to appropriate groff/roff
23489 equivalents in man-page output, the DocBook XSL Stylesheets
23490 distribution includes an <link xlink:href="http://www.w3.org/TR/xslt20/#character-maps">XSLT character
23491 map</link>. That character map can be considered the standard roff
23492 character map for the distribution.</para>
23494 <para>If the value of the <parameter>man.charmap.uri</parameter>
23495 parameter is non-empty, that value is used as the URI for the location
23496 for an alternate roff character map to use in place of the standard
23497 roff character map provided in the distribution.</para>
23500 <para>Do not set a value for <parameter>man.charmap.uri</parameter>
23501 unless you have a custom roff character map that differs from the
23502 standard one provided in the distribution.</para>
23507 <refentry version="5.0" id="man.charmap.use.subset">
23509 <refentrytitle>man.charmap.use.subset</refentrytitle>
23510 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
23513 <refname>man.charmap.use.subset</refname>
23514 <refpurpose>Use subset of character map instead of full map?</refpurpose>
23518 <programlisting id="man.charmap.use.subset.frag">
23519 <xsl:param name="man.charmap.use.subset" select="1"></xsl:param>
23523 <refsection><info><title>Description</title></info>
23525 <para>If the value of the
23526 <parameter>man.charmap.use.subset</parameter> parameter is non-zero,
23527 a subset of the roff character map is used instead of the full roff
23528 character map. The profile of the subset used is determined either
23529 by the value of the
23530 <parameter>man.charmap.subset.profile</parameter>
23531 parameter (if the source is not in English) or the
23532 <parameter>man.charmap.subset.profile.english</parameter>
23533 parameter (if the source is in English).</para>
23536 <para>You may want to experiment with setting a non-zero value of
23537 <parameter>man.charmap.use.subset</parameter>, so that the full
23538 character map is used. Depending on which XSLT engine you run,
23539 setting a non-zero value for
23540 <parameter>man.charmap.use.subset</parameter> may significantly
23541 increase the time needed to process your documents. Or it may
23542 not. For example, if you set it and run it with xsltproc, it seems
23543 to dramatically increase processing time; on the other hand, if you
23544 set it and run it with Saxon, it does not seem to increase
23545 processing time nearly as much.</para>
23547 <para>If processing time is not a important concern and/or you can
23548 tolerate the increase in processing time imposed by using the full
23549 character map, set <parameter>man.charmap.use.subset</parameter> to
23553 <refsection><info><title>Details</title></info>
23555 <para>For converting certain Unicode symbols and special characters in
23556 UTF-8 or UTF-16 encoded XML source to appropriate groff/roff
23557 equivalents in man-page output, the DocBook XSL Stylesheets
23558 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
23559 map</link> format as detailed in the XSLT 2.0 specification. The map
23560 contains more than 800 character mappings and can be considered the
23561 standard roff character map for the distribution.</para>
23564 <para>You can use the <parameter>man.charmap.uri</parameter>
23565 parameter to specify a URI for the location for an alternate roff
23566 character map to use in place of the standard roff character map
23567 provided in the distribution.</para>
23570 <para>Because it is not terrifically efficient to use the standard
23571 800-character character map in full -- and for most (or all) users,
23572 never necessary to use it in full -- the DocBook XSL Stylesheets
23573 support a mechanism for using, within any given character map, a
23574 subset of character mappings instead of the full set. You can use the
23575 <parameter>man.charmap.subset.profile</parameter> or
23576 <parameter>man.charmap.subset.profile.english</parameter>
23577 parameter to tune the profile of that subset to use.</para>
23583 <refentry version="5.0" id="man.charmap.subset.profile">
23585 <refentrytitle>man.charmap.subset.profile</refentrytitle>
23586 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
23589 <refname>man.charmap.subset.profile</refname>
23590 <refpurpose>Profile of character map subset</refpurpose>
23594 <programlisting id="man.charmap.subset.profile.frag">
23595 <xsl:param name="man.charmap.subset.profile">
23596 @*[local-name() = 'block'] = 'Miscellaneous Technical' or
23597 (@*[local-name() = 'block'] = 'C1 Controls And Latin-1 Supplement (Latin-1 Supplement)' and
23598 (@*[local-name() = 'class'] = 'symbols' or
23599 @*[local-name() = 'class'] = 'letters')
23601 @*[local-name() = 'block'] = 'Latin Extended-A'
23603 (@*[local-name() = 'block'] = 'General Punctuation' and
23604 (@*[local-name() = 'class'] = 'spaces' or
23605 @*[local-name() = 'class'] = 'dashes' or
23606 @*[local-name() = 'class'] = 'quotes' or
23607 @*[local-name() = 'class'] = 'bullets'
23610 @*[local-name() = 'name'] = 'HORIZONTAL ELLIPSIS' or
23611 @*[local-name() = 'name'] = 'WORD JOINER' or
23612 @*[local-name() = 'name'] = 'SERVICE MARK' or
23613 @*[local-name() = 'name'] = 'TRADE MARK SIGN' or
23614 @*[local-name() = 'name'] = 'ZERO WIDTH NO-BREAK SPACE'
23619 <refsection><info><title>Description</title></info>
23621 <para>If the value of the
23622 <parameter>man.charmap.use.subset</parameter> parameter is non-zero,
23623 and your DocBook source is not written in English (that
23624 is, if the <tag class="attribute">lang</tag> or <tag class="attribute">xml:lang</tag> attribute on the root element
23625 in your DocBook source or on the first <tag>refentry</tag>
23626 element in your source has a value other than
23627 <literal>en</literal>), then the character-map subset specified
23628 by the <parameter>man.charmap.subset.profile</parameter>
23629 parameter is used instead of the full roff character map.</para>
23631 <para>Otherwise, if the <tag class="attribute">lang</tag> or <tag class="attribute">xml:lang</tag> attribute on the root
23632 element in your DocBook
23633 source or on the first <tag>refentry</tag> element in your source
23634 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
23635 subset specified by the
23636 <parameter>man.charmap.subset.profile.english</parameter>
23637 parameter is used instead of
23638 <parameter>man.charmap.subset.profile</parameter>.</para>
23640 <para>The difference between the two subsets is that
23641 <parameter>man.charmap.subset.profile</parameter> provides
23642 mappings for characters in Western European languages that are
23643 not part of the Roman (English) alphabet (ASCII character set).</para>
23645 <para>The value of <parameter>man.charmap.subset.profile</parameter>
23646 is a string representing an XPath expression that matches attribute
23647 names and values for <tag namespace="http://docbook.sf.net/xmlns/unichar/1.0">output-character</tag>
23648 elements in the character map.</para>
23650 <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:
23653 <term>character</term>
23655 <simpara>a raw Unicode character or numeric Unicode
23656 character-entity value (either in decimal or hex); all
23657 characters have this attribute</simpara>
23663 <simpara>a standard full/long ISO/Unicode character name (e.g.,
23664 "OHM SIGN"); all characters have this attribute</simpara>
23670 <simpara>a standard Unicode "block" name (e.g., "General
23671 Punctuation"); all characters have this attribute. For the full
23672 list of Unicode block names supported in the standard roff
23673 character map, see <xref linkend="BlocksAndClasses"/>.</simpara>
23679 <simpara>a class of characters (e.g., "spaces"). Not all
23680 characters have this attribute; currently, it is used only with
23681 certain characters within the "C1 Controls And Latin-1
23682 Supplement" and "General Punctuation" blocks. For details, see
23683 <xref linkend="BlocksAndClasses"/>.</simpara>
23687 <term>entity</term>
23689 <simpara>an ISO entity name (e.g., "ohm"); not all characters
23690 have this attribute, because not all characters have ISO entity
23691 names; for example, of the 800 or so characters in the standard
23692 roff character map included in the distribution, only around 300
23693 have ISO entity names.
23698 <term>string</term>
23700 <simpara>a string representing an roff/groff escape-code (with
23701 "@esc@" used in place of the backslash), or a simple ASCII
23702 string; all characters in the roff character map have this
23703 attribute</simpara>
23708 <para>The value of <parameter>man.charmap.subset.profile</parameter>
23709 is evaluated as an XPath expression at run-time to select a portion of
23710 the roff character map to use. You can tune the subset used by adding
23711 or removing parts. For example, if you need to use a wide range of
23712 mathematical operators in a document, and you want to have them
23713 converted into roff markup properly, you might add the following:
23715 <literallayout class="monospaced"> @*[local-name() = 'block'] ='MathematicalOperators' </literallayout>
23717 That will cause a additional set of around 67 additional "math"
23718 characters to be converted into roff markup. </para>
23721 <para>Depending on which XSLT engine you use, either the EXSLT
23722 <function>dyn:evaluate</function> extension function (for xsltproc or
23723 Xalan) or <function>saxon:evaluate</function> extension function (for
23724 Saxon) are used to dynamically evaluate the value of
23725 <parameter>man.charmap.subset.profile</parameter> at run-time. If you
23726 don't use xsltproc, Saxon, Xalan -- or some other XSLT engine that
23727 supports <function>dyn:evaluate</function> -- you must either set the
23728 value of the <parameter>man.charmap.use.subset</parameter> parameter
23729 to zero and process your documents using the full character map
23730 instead, or set the value of the
23731 <parameter>man.charmap.enabled</parameter> parameter to zero instead
23732 (so that character-map processing is disabled completely.</para>
23735 <para>An alternative to using
23736 <parameter>man.charmap.subset.profile</parameter> is to create your
23737 own custom character map, and set the value of
23738 <parameter>man.charmap.uri</parameter> to the URI/filename for
23739 that. If you use a custom character map, you will probably want to
23740 include in it just the characters you want to use, and so you will
23741 most likely also want to set the value of
23742 <parameter>man.charmap.use.subset</parameter> to zero.</para>
23743 <para>You can create a
23744 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
23745 then adding to, changing, and/or deleting from that.</para>
23748 <para>If you author your DocBook XML source in UTF-8 or UTF-16
23749 encoding and aren't sure what OSes or environments your man-page
23750 output might end up being viewed on, and not sure what version of
23751 nroff/groff those environments might have, you should be careful about
23752 what Unicode symbols and special characters you use in your source and
23753 what parts you add to the value of
23754 <parameter>man.charmap.subset.profile</parameter>.</para>
23755 <para>Many of the escape codes used are specific to groff and using
23756 them may not provide the expected output on an OS or environment that
23757 uses nroff instead of groff.</para>
23758 <para>On the other hand, if you intend for your man-page output to be
23759 viewed only on modern systems (for example, GNU/Linux systems, FreeBSD
23760 systems, or Cygwin environments) that have a good, up-to-date groff,
23761 then you can safely include a wide range of Unicode symbols and
23762 special characters in your UTF-8 or UTF-16 encoded DocBook XML source
23763 and add any of the supported Unicode block names to the value of
23764 <parameter>man.charmap.subset.profile</parameter>.</para>
23768 <para>For other details, see the documentation for the
23769 <parameter>man.charmap.use.subset</parameter> parameter.</para>
23771 <refsection id="BlocksAndClasses"><info><title>Supported Unicode block names and "class" values</title></info>
23774 <para>Below is the full list of Unicode block names and "class"
23775 values supported in the standard roff stylesheet provided in the
23776 distribution, along with a description of which codepoints from the
23777 Unicode range corresponding to that block name or block/class
23778 combination are supported.</para>
23782 <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)
23783 <itemizedlist><info><title>class values</title></info>
23786 <para>symbols</para>
23789 <para>letters</para>
23791 </itemizedlist></para>
23794 <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>
23797 <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>
23800 <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>
23803 <para><link xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&id=General%20Punctuation">General Punctuation</link> (x2000 to x206f, partial)
23804 <itemizedlist><info><title>class values</title></info>
23807 <para><link xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&start=8192&end=8203">spaces</link></para>
23810 <para><link xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&start=8208&end=8213">dashes</link></para>
23813 <para>quotes</para>
23816 <para>daggers</para>
23819 <para>bullets</para>
23822 <para>leaders</para>
23825 <para>primes</para>
23831 <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>
23834 <para><link xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&id=Currency%20Symbols">Currency Symbols</link> (x20a0 to x20b1)</para>
23837 <para><link xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&id=Letterlike%20Symbols">Letterlike Symbols</link> (x2100 to x214b)</para>
23840 <para><link xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&id=Number%20Forms">Number Forms</link> (x2150 to x218f)</para>
23843 <para><link xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&id=Arrows">Arrows</link> (x2190 to x21ff, partial)</para>
23846 <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>
23849 <para><link xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&id=Control%20Pictures">Control Pictures</link> (x2400 to x243f)</para>
23852 <para><link xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&id=Enclosed%20Alphanumerics">Enclosed Alphanumerics</link> (x2460 to x24ff)</para>
23855 <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>
23858 <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>
23861 <para><link xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&id=Dingbats">Dingbats</link> (x2700 to x27be, partial)</para>
23864 <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>
23871 <refentry version="5.0" id="man.charmap.subset.profile.english">
23873 <refentrytitle>man.charmap.subset.profile.english</refentrytitle>
23874 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
23877 <refname>man.charmap.subset.profile.english</refname>
23878 <refpurpose>Profile of character map subset</refpurpose>
23882 <programlisting id="man.charmap.subset.profile.english.frag">
23883 <xsl:param name="man.charmap.subset.profile.english">
23884 @*[local-name() = 'block'] = 'Miscellaneous Technical' or
23885 (@*[local-name() = 'block'] = 'C1 Controls And Latin-1 Supplement (Latin-1 Supplement)' and
23886 @*[local-name() = 'class'] = 'symbols')
23888 (@*[local-name() = 'block'] = 'General Punctuation' and
23889 (@*[local-name() = 'class'] = 'spaces' or
23890 @*[local-name() = 'class'] = 'dashes' or
23891 @*[local-name() = 'class'] = 'quotes' or
23892 @*[local-name() = 'class'] = 'bullets'
23895 @*[local-name() = 'name'] = 'HORIZONTAL ELLIPSIS' or
23896 @*[local-name() = 'name'] = 'WORD JOINER' or
23897 @*[local-name() = 'name'] = 'SERVICE MARK' or
23898 @*[local-name() = 'name'] = 'TRADE MARK SIGN' or
23899 @*[local-name() = 'name'] = 'ZERO WIDTH NO-BREAK SPACE'
23904 <refsection><info><title>Description</title></info>
23906 <para>If the value of the
23907 <parameter>man.charmap.use.subset</parameter> parameter is
23908 non-zero, and your DocBook source is written in English (that
23909 is, if its <tag class="attribute">lang</tag> or <tag class="attribute">xml:lang</tag> attribute on the root element
23910 in your DocBook source or on the first <tag>refentry</tag>
23911 element in your source has the value <literal>en</literal> or if
23912 it has no <tag class="attribute">lang</tag> or <tag class="attribute">xml:lang</tag> attribute), then the
23913 character-map subset specified by the
23914 <parameter>man.charmap.subset.profile.english</parameter>
23915 parameter is used instead of the full roff character map.</para>
23917 <para>Otherwise, if the <tag class="attribute">lang</tag> or <tag class="attribute">xml:lang</tag> attribute
23918 on the root element in your DocBook source or on the first
23919 <tag>refentry</tag> element in your source has a value other
23920 than <literal>en</literal>, then the character-map subset
23922 <parameter>man.charmap.subset.profile</parameter> parameter is
23924 <parameter>man.charmap.subset.profile.english</parameter>.</para>
23926 <para>The difference between the two subsets is that
23927 <parameter>man.charmap.subset.profile</parameter> provides
23928 mappings for characters in Western European languages that are
23929 not part of the Roman (English) alphabet (ASCII character set).</para>
23931 <para>The value of <parameter>man.charmap.subset.profile.english</parameter>
23932 is a string representing an XPath expression that matches attribute
23933 names and values for <tag namespace="http://docbook.sf.net/xmlns/unichar/1.0">output-character</tag> elements in the character map.</para>
23935 <para>For other details, see the documentation for the
23936 <parameter>man.charmap.subset.profile.english</parameter> and
23937 <parameter>man.charmap.use.subset</parameter> parameters.</para>
23942 <refentry version="5.0" id="man.string.subst.map.local.pre">
23944 <refentrytitle>man.string.subst.map.local.pre</refentrytitle>
23945 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
23948 <refname>man.string.subst.map.local.pre</refname>
23949 <refpurpose>Specifies “local” string substitutions</refpurpose>
23953 <programlisting id="man.string.subst.map.local.pre.frag">
23954 <xsl:param name="man.string.subst.map.local.pre"></xsl:param>
23958 <refsection><info><title>Description</title></info>
23960 <para>Use the <parameter>man.string.subst.map.local.pre</parameter>
23961 parameter to specify any “local” string substitutions to perform over
23962 the entire roff source for each man page <emphasis>before</emphasis>
23963 performing the string substitutions specified by the <parameter>man.string.subst.map</parameter> parameter.</para>
23965 <para>For details about the format of this parameter, see the
23966 documentation for the <parameter>man.string.subst.map</parameter>
23972 <refentry version="5.0" id="man.string.subst.map">
23974 <refentrytitle>man.string.subst.map</refentrytitle>
23975 <refmiscinfo class="other" otherclass="datatype">rtf</refmiscinfo>
23978 <refname>man.string.subst.map</refname>
23979 <refpurpose>Specifies a set of string substitutions</refpurpose>
23983 <programlisting id="man.string.subst.map.frag">
23984 <xsl:param name="man.string.subst.map">
23986 <!-- * remove no-break marker at beginning of line (stylesheet artifact) -->
23987 <ss:substitution oldstring="▒▀" newstring="▒"></ss:substitution>
23988 <!-- * replace U+2580 no-break marker (stylesheet-added) w/ no-break space -->
23989 <ss:substitution oldstring="▀" newstring="\ "></ss:substitution>
23991 <!-- ==================================================================== -->
23993 <!-- * squeeze multiple newlines before a roff request -->
23994 <ss:substitution oldstring="
23997 ."></ss:substitution>
23998 <!-- * remove any .sp instances that directly precede a .PP -->
23999 <ss:substitution oldstring=".sp
24000 .PP" newstring=".PP"></ss:substitution>
24001 <!-- * remove any .sp instances that directly follow a .PP -->
24002 <ss:substitution oldstring=".sp
24003 .sp" newstring=".sp"></ss:substitution>
24004 <!-- * squeeze multiple .sp instances into a single .sp-->
24005 <ss:substitution oldstring=".PP
24006 .sp" newstring=".PP"></ss:substitution>
24007 <!-- * squeeze multiple newlines after start of no-fill (verbatim) env. -->
24008 <ss:substitution oldstring=".nf
24011 "></ss:substitution>
24012 <!-- * squeeze multiple newlines after REstoring margin -->
24013 <ss:substitution oldstring=".RE
24016 "></ss:substitution>
24017 <!-- * U+2591 is a marker we add before and after every Parameter in -->
24018 <!-- * Funcprototype output -->
24019 <ss:substitution oldstring="░" newstring=" "></ss:substitution>
24020 <!-- * U+2592 is a marker we add for the newline before output of <sbr>; -->
24021 <ss:substitution oldstring="▒" newstring="
24022 "></ss:substitution>
24024 <!-- * Now deal with some other characters that are added by the -->
24025 <!-- * stylesheets during processing. -->
24027 <!-- * bullet -->
24028 <ss:substitution oldstring="•" newstring="\(bu"></ss:substitution>
24029 <!-- * left double quote -->
24030 <ss:substitution oldstring="“" newstring="\(lq"></ss:substitution>
24031 <!-- * right double quote -->
24032 <ss:substitution oldstring="”" newstring="\(rq"></ss:substitution>
24033 <!-- * left single quote -->
24034 <ss:substitution oldstring="‘" newstring="\(oq"></ss:substitution>
24035 <!-- * right single quote -->
24036 <ss:substitution oldstring="’" newstring="\(cq"></ss:substitution>
24037 <!-- * copyright sign -->
24038 <ss:substitution oldstring="©" newstring="\(co"></ss:substitution>
24039 <!-- * registered sign -->
24040 <ss:substitution oldstring="®" newstring="\(rg"></ss:substitution>
24041 <!-- * ...servicemark... -->
24042 <!-- * There is no groff equivalent for it. -->
24043 <ss:substitution oldstring="℠" newstring="(SM)"></ss:substitution>
24044 <!-- * ...trademark... -->
24045 <!-- * We don't do "\(tm" because for console output, -->
24046 <!-- * groff just renders that as "tm"; that is: -->
24048 <!-- * Product&#x2122; -> Producttm -->
24050 <!-- * So we just make it to "(TM)" instead; thus: -->
24052 <!-- * Product&#x2122; -> Product(TM) -->
24053 <ss:substitution oldstring="™" newstring="(TM)"></ss:substitution>
24059 <refsection><info><title>Description</title></info>
24061 <para>The <parameter>man.string.subst.map</parameter> parameter
24062 contains <link linkend="map">a map</link> that specifies a set of
24063 string substitutions to perform over the entire roff source for each
24064 man page, either just before generating final man-page output (that
24065 is, before writing man-page files to disk) or, if the value of the
24066 <parameter>man.charmap.enabled</parameter> parameter is non-zero,
24067 before applying the roff character map.</para>
24069 <para>You can use <parameter>man.string.subst.map</parameter> as a
24070 “lightweight” character map to perform “essential” substitutions --
24071 that is, substitutions that are <emphasis>always</emphasis> performed,
24072 even if the value of the <parameter>man.charmap.enabled</parameter>
24073 parameter is zero. For example, you can use it to replace quotation
24074 marks or other special characters that are generated by the DocBook
24075 XSL stylesheets for a particular locale setting (as opposed to those
24076 characters that are actually in source XML documents), or to replace
24077 any special characters that may be automatically generated by a
24078 particular customization of the DocBook XSL stylesheets.</para>
24081 <para>Do you not change value of the
24082 <parameter>man.string.subst.map</parameter> parameter unless you are
24083 sure what you are doing. First consider adding your
24084 string-substitution mappings to either or both of the following
24088 <term><parameter>man.string.subst.map.local.pre</parameter></term>
24089 <listitem><para>applied before
24090 <parameter>man.string.subst.map</parameter></para></listitem>
24093 <term><parameter>man.string.subst.map.local.post</parameter></term>
24094 <listitem><para>applied after
24095 <parameter>man.string.subst.map</parameter></para></listitem>
24098 By default, both of those parameters contain no
24099 string substitutions. They are intended as a means for you to
24100 specify your own local string-substitution mappings.</para>
24102 <para>If you remove any of default mappings from the value of the
24103 <parameter>man.string.subst.map</parameter> parameter, you are
24104 likely to end up with broken output. And be very careful about adding
24105 anything to it; it’s used for doing string substitution over the
24106 entire roff source of each man page – it causes target strings to be
24107 replaced in roff requests and escapes, not just in the visible
24108 contents of the page.</para>
24112 <refsection id="map">
24114 <title>Contents of the substitution map</title>
24116 <para>The string-substitution map contains one or more
24117 <tag>ss:substitution</tag> elements, each of which has two
24121 <term>oldstring</term>
24123 <simpara>string to replace</simpara>
24127 <term>newstring</term>
24129 <simpara>string with which to replace <tag class="attribute">oldstring</tag></simpara>
24133 It may also include XML comments (that is, delimited with
24134 "<literal><!--</literal>" and "<literal>--></literal>").
24141 <refentry version="5.0" id="man.string.subst.map.local.post">
24143 <refentrytitle>man.string.subst.map.local.post</refentrytitle>
24144 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
24147 <refname>man.string.subst.map.local.post</refname>
24148 <refpurpose>Specifies “local” string substitutions</refpurpose>
24152 <programlisting id="man.string.subst.map.local.post.frag">
24153 <xsl:param name="man.string.subst.map.local.post"></xsl:param>
24157 <refsection><info><title>Description</title></info>
24159 <para>Use the <parameter>man.string.subst.map.local.post</parameter>
24160 parameter to specify any “local” string substitutions to perform over
24161 the entire roff source for each man page <emphasis>after</emphasis>
24162 performing the string substitutions specified by the <parameter>man.string.subst.map</parameter> parameter.</para>
24164 <para>For details about the format of this parameter, see the
24165 documentation for the <parameter>man.string.subst.map</parameter>
24171 </reference><reference id="refmeta" xml:base="../manpages/param.xml">
24172 <title>Refentry metadata gathering</title>
24173 <refentry version="5.0" id="refentry.meta.get.quietly">
24175 <refentrytitle>refentry.meta.get.quietly</refentrytitle>
24176 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
24179 <refname>refentry.meta.get.quietly</refname>
24180 <refpurpose>Suppress notes and warnings when gathering refentry metadata?</refpurpose>
24184 <programlisting id="refentry.meta.get.quietly.frag">
24185 <xsl:param name="refentry.meta.get.quietly" select="0"></xsl:param>
24189 <refsection><info><title>Description</title></info>
24191 <para>If zero (the default), notes and warnings about “missing” markup
24192 are generated during gathering of refentry metadata. If non-zero, the
24193 metadata is gathered “quietly” -- that is, the notes and warnings are
24197 <para>If you are processing a large amount of <tag>refentry</tag>
24198 content, you may be able to speed up processing significantly by
24199 setting a non-zero value for
24200 <parameter>refentry.meta.get.quietly</parameter>.</para>
24206 <refentry version="5.0" id="refentry.date.profile">
24208 <refentrytitle>refentry.date.profile</refentrytitle>
24209 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
24212 <refname>refentry.date.profile</refname>
24213 <refpurpose>Specifies profile for refentry "date" data</refpurpose>
24217 <programlisting id="refentry.date.profile.frag">
24218 <xsl:param name="refentry.date.profile">
24219 (($info[//date])[last()]/date)[1]|
24220 (($info[//pubdate])[last()]/pubdate)[1]
24225 <refsection><info><title>Description</title></info>
24227 <para>The value of <parameter>refentry.date.profile</parameter> is a
24228 string representing an XPath expression. It is evaluated at run-time
24229 and used only if <parameter>refentry.date.profile.enabled</parameter>
24230 is non-zero. Otherwise, the <tag>refentry</tag> metadata-gathering
24231 logic "hard coded" into the stylesheets is used.</para>
24233 <para> The <literal>man(7)</literal> man page describes this content
24234 as "the date of the last revision". In man pages, it is the content
24235 that is usually displayed in the center footer.</para>
24240 <refentry version="5.0" id="refentry.date.profile.enabled">
24242 <refentrytitle>refentry.date.profile.enabled</refentrytitle>
24243 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
24246 <refname>refentry.date.profile.enabled</refname>
24247 <refpurpose>Enable refentry "date" profiling?</refpurpose>
24251 <programlisting id="refentry.date.profile.enabled.frag">
24252 <xsl:param name="refentry.date.profile.enabled">0</xsl:param></programlisting>
24255 <refsection><info><title>Description</title></info>
24257 <para>If the value of
24258 <parameter>refentry.date.profile.enabled</parameter> is non-zero, then
24259 during <tag>refentry</tag> metadata gathering, the info profile
24260 specified by the customizable
24261 <parameter>refentry.date.profile</parameter> parameter is used.</para>
24263 <para>If instead the value of
24264 <parameter>refentry.date.profile.enabled</parameter> is zero (the
24265 default), then "hard coded" logic within the DocBook XSL stylesheets
24266 is used for gathering <tag>refentry</tag> "date" data.</para>
24268 <para>If you find that the default <tag>refentry</tag>
24269 metadata-gathering behavior is causing incorrect "date" data to show
24270 up in your output, then consider setting a non-zero value for
24271 <parameter>refentry.date.profile.enabled</parameter> and adjusting the
24272 value of <parameter>refentry.date.profile</parameter> to cause correct
24273 data to be gathered. </para>
24275 <para>Note that the terms "source" and "date" have special meanings in
24276 this context. For details, see the documentation for the
24277 <parameter>refentry.date.profile</parameter> parameter.</para>
24282 <refentry version="5.0" id="refentry.manual.profile">
24284 <refentrytitle>refentry.manual.profile</refentrytitle>
24285 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
24288 <refname>refentry.manual.profile</refname>
24289 <refpurpose>Specifies profile for refentry "manual" data</refpurpose>
24293 <programlisting id="refentry.manual.profile.frag">
24294 <xsl:param name="refentry.manual.profile">
24295 (($info[//title])[last()]/title)[1]|
24301 <refsection><info><title>Description</title></info>
24303 <para>The value of <parameter>refentry.manual.profile</parameter> is
24304 a string representing an XPath expression. It is evaluated at
24305 run-time and used only if
24306 <parameter>refentry.manual.profile.enabled</parameter> is
24307 non-zero. Otherwise, the <tag>refentry</tag> metadata-gathering logic
24308 "hard coded" into the stylesheets is used.</para>
24310 <para>In man pages, this content is usually displayed in the middle of
24311 the header of the page. The <literal>man(7)</literal> man page
24312 describes this as "the title of the manual (e.g., <citetitle>Linux
24313 Programmer's Manual</citetitle>)". Here are some examples from
24314 existing man pages:
24317 <para><citetitle>dpkg utilities</citetitle>
24318 (<command>dpkg-name</command>)</para>
24321 <para><citetitle>User Contributed Perl Documentation</citetitle>
24322 (<command>GET</command>)</para>
24325 <para><citetitle>GNU Development Tools</citetitle>
24326 (<command>ld</command>)</para>
24329 <para><citetitle>Emperor Norton Utilities</citetitle>
24330 (<command>ddate</command>)</para>
24333 <para><citetitle>Debian GNU/Linux manual</citetitle>
24334 (<command>faked</command>)</para>
24337 <para><citetitle>GIMP Manual Pages</citetitle>
24338 (<command>gimp</command>)</para>
24341 <para><citetitle>KDOC Documentation System</citetitle>
24342 (<command>qt2kdoc</command>)</para>
24350 <refentry version="5.0" id="refentry.manual.profile.enabled">
24352 <refentrytitle>refentry.manual.profile.enabled</refentrytitle>
24353 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
24356 <refname>refentry.manual.profile.enabled</refname>
24357 <refpurpose>Enable refentry "manual" profiling?</refpurpose>
24361 <programlisting id="refentry.manual.profile.enabled.frag">
24362 <xsl:param name="refentry.manual.profile.enabled">0</xsl:param></programlisting>
24365 <refsection><info><title>Description</title></info>
24367 <para>If the value of
24368 <parameter>refentry.manual.profile.enabled</parameter> is
24369 non-zero, then during <tag>refentry</tag> metadata gathering, the info
24370 profile specified by the customizable
24371 <parameter>refentry.manual.profile</parameter> parameter is
24374 <para>If instead the value of
24375 <parameter>refentry.manual.profile.enabled</parameter> is zero (the
24376 default), then "hard coded" logic within the DocBook XSL stylesheets
24377 is used for gathering <tag>refentry</tag> "manual" data.</para>
24379 <para>If you find that the default <tag>refentry</tag>
24380 metadata-gathering behavior is causing incorrect "manual" data to show
24381 up in your output, then consider setting a non-zero value for
24382 <parameter>refentry.manual.profile.enabled</parameter> and adjusting
24383 the value of <parameter>refentry.manual.profile</parameter> to cause
24384 correct data to be gathered. </para>
24386 <para>Note that the term "manual" has a special meanings in this
24387 context. For details, see the documentation for the
24388 <parameter>refentry.manual.profile</parameter> parameter.</para>
24393 <refentry version="5.0" id="refentry.source.name.suppress">
24395 <refentrytitle>refentry.source.name.suppress</refentrytitle>
24396 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
24399 <refname>refentry.source.name.suppress</refname>
24400 <refpurpose>Suppress "name" part of refentry "source" contents?</refpurpose>
24404 <programlisting id="refentry.source.name.suppress.frag">
24405 <xsl:param name="refentry.source.name.suppress">0</xsl:param></programlisting>
24408 <refsection><info><title>Description</title></info>
24410 <para>If the value of
24411 <parameter>refentry.source.name.suppress</parameter> is non-zero, then
24412 during <tag>refentry</tag> metadata gathering, no "source name" data
24413 is added to the <tag>refentry</tag> "source" contents. Instead (unless
24414 <parameter>refentry.version.suppress</parameter> is also non-zero),
24415 only "version" data is added to the "source" contents.</para>
24417 <para>If you find that the <tag>refentry</tag> metadata gathering
24418 mechanism is causing unwanted "source name" data to show up in your
24419 output -- for example, in the footer (or possibly header) of a man
24420 page -- then you might consider setting a non-zero value for
24421 <parameter>refentry.source.name.suppress</parameter>.</para>
24423 <para>Note that the terms "source", "source name", and "version" have
24424 special meanings in this context. For details, see the documentation
24425 for the <parameter>refentry.source.name.profile</parameter>
24431 <refentry version="5.0" id="refentry.source.name.profile">
24433 <refentrytitle>refentry.source.name.profile</refentrytitle>
24434 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
24437 <refname>refentry.source.name.profile</refname>
24438 <refpurpose>Specifies profile for refentry "source name" data</refpurpose>
24442 <programlisting id="refentry.source.name.profile.frag">
24443 <xsl:param name="refentry.source.name.profile">
24444 (($info[//productname])[last()]/productname)[1]|
24445 (($info[//corpname])[last()]/corpname)[1]|
24446 (($info[//corpcredit])[last()]/corpcredit)[1]|
24447 (($info[//corpauthor])[last()]/corpauthor)[1]|
24448 (($info[//orgname])[last()]/orgname)[1]|
24449 (($info[//publishername])[last()]/publishername)[1]
24454 <refsection><info><title>Description</title></info>
24456 <para>The value of <parameter>refentry.source.name.profile</parameter>
24457 is a string representing an XPath expression. It is evaluated at
24458 run-time and used only if
24459 <parameter>refentry.source.name.profile.enabled</parameter> is
24460 non-zero. Otherwise, the <tag>refentry</tag> metadata-gathering logic
24461 "hard coded" into the stylesheets is used.</para>
24463 <para>A "source name" is one part of a (potentially) two-part
24464 <replaceable>Name</replaceable> <replaceable>Version</replaceable>
24465 "source" field. In man pages, it is usually displayed in the left
24466 footer of the page. It typically indicates the software system or
24467 product that the item documented in the man page belongs to. The
24468 <literal>man(7)</literal> man page describes it as "the source of
24469 the command", and provides the following examples:
24472 <para>For binaries, use something like: GNU, NET-2, SLS
24473 Distribution, MCC Distribution.</para>
24476 <para>For system calls, use the version of the kernel that you
24477 are currently looking at: Linux 0.99.11.</para>
24480 <para>For library calls, use the source of the function: GNU, BSD
24481 4.3, Linux DLL 4.4.1.</para>
24486 <para>In practice, there are many pages that simply have a Version
24487 number in the "source" field. So, it looks like what we have is a
24489 <replaceable>Name</replaceable> <replaceable>Version</replaceable>,
24495 <para>product name (e.g., BSD) or org. name (e.g., GNU)</para>
24499 <term>Version</term>
24501 <para>version number</para>
24505 Each part is optional. If the <replaceable>Name</replaceable> is a
24506 product name, then the <replaceable>Version</replaceable> is probably
24507 the version of the product. Or there may be no
24508 <replaceable>Name</replaceable>, in which case, if there is a
24509 <replaceable>Version</replaceable>, it is probably the version
24510 of the item itself, not the product it is part of. Or, if the
24511 <replaceable>Name</replaceable> is an organization name, then there
24512 probably will be no <replaceable>Version</replaceable>.</para>
24516 <refentry version="5.0" id="refentry.source.name.profile.enabled">
24518 <refentrytitle>refentry.source.name.profile.enabled</refentrytitle>
24519 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
24522 <refname>refentry.source.name.profile.enabled</refname>
24523 <refpurpose>Enable refentry "source name" profiling?</refpurpose>
24527 <programlisting id="refentry.source.name.profile.enabled.frag">
24528 <xsl:param name="refentry.source.name.profile.enabled">0</xsl:param></programlisting>
24531 <refsection><info><title>Description</title></info>
24533 <para>If the value of
24534 <parameter>refentry.source.name.profile.enabled</parameter> is
24535 non-zero, then during <tag>refentry</tag> metadata gathering, the info
24536 profile specified by the customizable
24537 <parameter>refentry.source.name.profile</parameter> parameter is
24540 <para>If instead the value of
24541 <parameter>refentry.source.name.profile.enabled</parameter> is zero (the
24542 default), then "hard coded" logic within the DocBook XSL stylesheets
24543 is used for gathering <tag>refentry</tag> "source name" data.</para>
24545 <para>If you find that the default <tag>refentry</tag>
24546 metadata-gathering behavior is causing incorrect "source name" data to
24547 show up in your output, then consider setting a non-zero value for
24548 <parameter>refentry.source.name.profile.enabled</parameter> and
24549 adjusting the value of
24550 <parameter>refentry.source.name.profile</parameter> to cause correct
24551 data to be gathered. </para>
24553 <para>Note that the terms "source" and "source name" have special
24554 meanings in this context. For details, see the documentation for the
24555 <parameter>refentry.source.name.profile</parameter> parameter.</para>
24560 <refentry version="5.0" id="refentry.version.suppress">
24562 <refentrytitle>refentry.version.suppress</refentrytitle>
24563 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
24566 <refname>refentry.version.suppress</refname>
24567 <refpurpose>Suppress "version" part of refentry "source" contents?</refpurpose>
24571 <programlisting id="refentry.version.suppress.frag">
24572 <xsl:param name="refentry.version.suppress">0</xsl:param></programlisting>
24575 <refsection><info><title>Description</title></info>
24577 <para>If the value of <parameter>refentry.version.suppress</parameter>
24578 is non-zero, then during <tag>refentry</tag> metadata gathering, no
24579 "version" data is added to the <tag>refentry</tag> "source"
24580 contents. Instead (unless
24581 <parameter>refentry.source.name.suppress</parameter> is also
24582 non-zero), only "source name" data is added to the "source"
24585 <para>If you find that the <tag>refentry</tag> metadata gathering
24586 mechanism is causing unwanted "version" data to show up in your output
24587 -- for example, in the footer (or possibly header) of a man page --
24588 then you might consider setting a non-zero value for
24589 <parameter>refentry.version.suppress</parameter>.</para>
24591 <para>Note that the terms "source", "source name", and "version" have
24592 special meanings in this context. For details, see the documentation
24593 for the <parameter>refentry.source.name.profile</parameter>
24599 <refentry version="5.0" id="refentry.version.profile">
24601 <refentrytitle>refentry.version.profile</refentrytitle>
24602 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
24605 <refname>refentry.version.profile</refname>
24606 <refpurpose>Specifies profile for refentry "version" data</refpurpose>
24610 <programlisting id="refentry.version.profile.frag">
24611 <xsl:param name="refentry.version.profile">
24612 (($info[//productnumber])[last()]/productnumber)[1]|
24613 (($info[//edition])[last()]/edition)[1]|
24614 (($info[//releaseinfo])[last()]/releaseinfo)[1]
24619 <refsection><info><title>Description</title></info>
24621 <para>The value of <parameter>refentry.version.profile</parameter> is
24622 a string representing an XPath expression. It is evaluated at
24623 run-time and used only if
24624 <parameter>refentry.version.profile.enabled</parameter> is
24625 non-zero. Otherwise, the <tag>refentry</tag> metadata-gathering logic
24626 "hard coded" into the stylesheets is used.</para>
24628 <para>A "source.name" is one part of a (potentially) two-part
24629 <replaceable>Name</replaceable> <replaceable>Version</replaceable>
24630 "source" field. For more details, see the documentation for the
24631 <parameter>refentry.source.name.profile</parameter> parameter.</para>
24636 <refentry version="5.0" id="refentry.version.profile.enabled">
24638 <refentrytitle>refentry.version.profile.enabled</refentrytitle>
24639 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
24642 <refname>refentry.version.profile.enabled</refname>
24643 <refpurpose>Enable refentry "version" profiling?</refpurpose>
24647 <programlisting id="refentry.version.profile.enabled.frag">
24648 <xsl:param name="refentry.version.profile.enabled">0</xsl:param></programlisting>
24651 <refsection><info><title>Description</title></info>
24653 <para>If the value of
24654 <parameter>refentry.version.profile.enabled</parameter> is
24655 non-zero, then during <tag>refentry</tag> metadata gathering, the info
24656 profile specified by the customizable
24657 <parameter>refentry.version.profile</parameter> parameter is
24660 <para>If instead the value of
24661 <parameter>refentry.version.profile.enabled</parameter> is zero (the
24662 default), then "hard coded" logic within the DocBook XSL stylesheets
24663 is used for gathering <tag>refentry</tag> "version" data.</para>
24665 <para>If you find that the default <tag>refentry</tag>
24666 metadata-gathering behavior is causing incorrect "version" data to show
24667 up in your output, then consider setting a non-zero value for
24668 <parameter>refentry.version.profile.enabled</parameter> and adjusting
24669 the value of <parameter>refentry.version.profile</parameter> to cause
24670 correct data to be gathered. </para>
24672 <para>Note that the terms "source" and "version" have special
24673 meanings in this context. For details, see the documentation for the
24674 <parameter>refentry.version.profile</parameter> parameter.</para>
24679 <refentry version="5.0" id="refentry.manual.fallback.profile">
24681 <refentrytitle>refentry.manual.fallback.profile</refentrytitle>
24682 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
24685 <refname>refentry.manual.fallback.profile</refname>
24686 <refpurpose>Specifies profile of "fallback" for refentry "manual" data</refpurpose>
24690 <programlisting id="refentry.manual.fallback.profile.frag">
24691 <xsl:param name="refentry.manual.fallback.profile">
24692 refmeta/refmiscinfo[not(@class = 'date')][1]/node()</xsl:param>
24696 <refsection><info><title>Description</title></info>
24699 <parameter>refentry.manual.fallback.profile</parameter> is a string
24700 representing an XPath expression. It is evaluated at run-time and
24701 used only if no "manual" data can be found by other means (that is,
24702 either using the <tag>refentry</tag> metadata-gathering logic "hard
24703 coded" in the stylesheets, or the value of
24704 <parameter>refentry.manual.profile</parameter>, if it is
24708 <para>Depending on which XSLT engine you run, either the EXSLT
24709 <function>dyn:evaluate</function> extension function (for xsltproc or
24710 Xalan) or <function>saxon:evaluate</function> extension function (for
24711 Saxon) are used to dynamically evaluate the value of
24712 <parameter>refentry.manual.fallback.profile</parameter> at
24713 run-time. If you don't use xsltproc, Saxon, Xalan -- or some other
24714 XSLT engine that supports <function>dyn:evaluate</function> -- you
24715 must manually disable fallback processing by setting an empty value
24716 for the <parameter>refentry.manual.fallback.profile</parameter>
24723 <refentry version="5.0" id="refentry.source.fallback.profile">
24725 <refentrytitle>refentry.source.fallback.profile</refentrytitle>
24726 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
24729 <refname>refentry.source.fallback.profile</refname>
24730 <refpurpose>Specifies profile of "fallback" for refentry "source" data</refpurpose>
24734 <programlisting id="refentry.source.fallback.profile.frag">
24735 <xsl:param name="refentry.source.fallback.profile">
24736 refmeta/refmiscinfo[not(@class = 'date')][1]/node()</xsl:param>
24740 <refsection><info><title>Description</title></info>
24743 <parameter>refentry.source.fallback.profile</parameter> is a string
24744 representing an XPath expression. It is evaluated at run-time and used
24745 only if no "source" data can be found by other means (that is, either
24746 using the <tag>refentry</tag> metadata-gathering logic "hard coded" in
24747 the stylesheets, or the value of the
24748 <parameter>refentry.source.name.profile</parameter> and
24749 <parameter>refentry.version.profile</parameter> parameters, if those
24750 are enabled).</para>
24753 <para>Depending on which XSLT engine you run, either the EXSLT
24754 <function>dyn:evaluate</function> extension function (for xsltproc or
24755 Xalan) or <function>saxon:evaluate</function> extension function (for
24756 Saxon) are used to dynamically evaluate the value of
24757 <parameter>refentry.source.fallback.profile</parameter> at
24758 run-time. If you don't use xsltproc, Saxon, Xalan -- or some other
24759 XSLT engine that supports <function>dyn:evaluate</function> -- you
24760 must manually disable fallback processing by setting an empty value
24761 for the <parameter>refentry.source.fallback.profile</parameter>
24768 </reference><reference id="th" xml:base="../manpages/param.xml">
24769 <title>Page header/footer</title>
24770 <refentry version="5.0" id="man.th.extra1.suppress">
24772 <refentrytitle>man.th.extra1.suppress</refentrytitle>
24773 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
24776 <refname>man.th.extra1.suppress</refname>
24777 <refpurpose>Suppress extra1 part of header/footer?</refpurpose>
24781 <programlisting id="man.th.extra1.suppress.frag">
24782 <xsl:param name="man.th.extra1.suppress">0</xsl:param></programlisting>
24785 <refsection><info><title>Description</title></info>
24787 <para>If the value of <parameter>man.th.extra1.suppress</parameter> is
24788 non-zero, then the <literal>extra1</literal> part of the
24789 <literal>.TH</literal> title line header/footer is suppressed.</para>
24791 <para>The content of the <literal>extra1</literal> field is almost
24792 always displayed in the center footer of the page and is, universally,
24798 <refentry version="5.0" id="man.th.extra2.suppress">
24800 <refentrytitle>man.th.extra2.suppress</refentrytitle>
24801 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
24804 <refname>man.th.extra2.suppress</refname>
24805 <refpurpose>Suppress extra2 part of header/footer?</refpurpose>
24809 <programlisting id="man.th.extra2.suppress.frag">
24810 <xsl:param name="man.th.extra2.suppress">0</xsl:param></programlisting>
24813 <refsection><info><title>Description</title></info>
24815 <para>If the value of <parameter>man.th.extra2.suppress</parameter> is
24816 non-zero, then the <literal>extra2</literal> part of the
24817 <literal>.TH</literal> title line header/footer is suppressed.</para>
24819 <para>The content of the <literal>extra2</literal> field is usually
24820 displayed in the left footer of the page and is typically "source"
24821 data, often in the form
24822 <replaceable>Name</replaceable> <replaceable>Version</replaceable>;
24823 for example, "GTK+ 1.2" (from the <literal>gtk-options(7)</literal>
24827 <para>You can use the
24828 <parameter>refentry.source.name.suppress</parameter> and
24829 <parameter>refentry.version.suppress</parameter> parameters to
24830 independently suppress the <replaceable>Name</replaceable> and
24831 <replaceable>Version</replaceable> parts of the
24832 <literal>extra2</literal> field.</para>
24838 <refentry version="5.0" id="man.th.extra3.suppress">
24840 <refentrytitle>man.th.extra3.suppress</refentrytitle>
24841 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
24844 <refname>man.th.extra3.suppress</refname>
24845 <refpurpose>Suppress extra3 part of header/footer?</refpurpose>
24849 <programlisting id="man.th.extra3.suppress.frag">
24850 <xsl:param name="man.th.extra3.suppress">0</xsl:param></programlisting>
24853 <refsection><info><title>Description</title></info>
24855 <para>If the value of <parameter>man.th.extra3.suppress</parameter> is
24856 non-zero, then the <literal>extra3</literal> part of the
24857 <literal>.TH</literal> title line header/footer is
24860 <para>The content of the <literal>extra3</literal> field is usually
24861 displayed in the middle header of the page and is typically a "manual
24862 name"; for example, "GTK+ User's Manual" (from the
24863 <literal>gtk-options(7)</literal> man page).</para>
24868 <refentry version="5.0" id="man.th.title.max.length">
24870 <refentrytitle>man.th.title.max.length</refentrytitle>
24871 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
24874 <refname>man.th.title.max.length</refname>
24875 <refpurpose>Maximum length of title in header/footer</refpurpose>
24879 <programlisting id="man.th.title.max.length.frag">
24880 <xsl:param name="man.th.title.max.length">20</xsl:param>
24884 <refsection><info><title>Description</title></info>
24886 <para>Specifies the maximum permitted length of the title part of the
24887 man-page <literal>.TH</literal> title line header/footer. If the title
24888 exceeds the maxiumum specified, it is truncated down to the maximum
24889 permitted length.</para>
24891 <refsection><info><title>Details</title></info>
24894 <para>Every man page generated using the DocBook stylesheets has a
24895 title line, specified using the <literal>TH</literal> roff
24896 macro. Within that title line, there is always, at a minimum, a title,
24897 followed by a section value (representing a man "section" -- usually
24898 just a number).</para>
24900 <para>The title and section are displayed, together, in the visible
24901 header of each page. Where in the header they are displayed depends on
24902 OS the man page is viewed on, and on what version of nroff/groff/man
24903 is used for viewing the page. But, at a minimum and across all
24904 systems, the title and section are displayed on the right-hand column
24905 of the header. On many systems -- those with a modern groff, including
24906 Linux systems -- they are displayed twice: both in the left and right
24907 columns of the header.</para>
24909 <para>So if the length of the title exceeds a certain percentage of
24910 the column width in which the page is viewed, the left and right
24911 titles can end up overlapping, making them unreadable, or breaking to
24912 another line, which doesn't look particularly good.</para>
24914 <para>So the stylesheets provide the
24915 <parameter>man.th.title.max.length</parameter> parameter as a means
24916 for truncating titles that exceed the maximum length that can be
24917 viewing properly in a page header.</para>
24919 <para>The default value is reasonable but somewhat arbitrary. If you
24920 have pages with long titles, you may want to experiment with changing
24921 the value in order to achieve the correct aesthetic results.</para>
24927 <refentry version="5.0" id="man.th.extra2.max.length">
24929 <refentrytitle>man.th.extra2.max.length</refentrytitle>
24930 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
24933 <refname>man.th.extra2.max.length</refname>
24934 <refpurpose>Maximum length of extra2 in header/footer</refpurpose>
24938 <programlisting id="man.th.extra2.max.length.frag">
24939 <xsl:param name="man.th.extra2.max.length">30</xsl:param>
24943 <refsection><info><title>Description</title></info>
24945 <para>Specifies the maximum permitted length of the
24946 <literal>extra2</literal> part of the man-page part of the
24947 <literal>.TH</literal> title line header/footer. If the
24948 <literal>extra2</literal> content exceeds the maxiumum specified, it
24949 is truncated down to the maximum permitted length.</para>
24951 <para>The content of the <literal>extra2</literal> field is usually
24952 displayed in the left footer of the page and is typically "source"
24953 data indicating the software system or product that the item
24954 documented in the man page belongs to, often in the form
24955 <replaceable>Name</replaceable> <replaceable>Version</replaceable>;
24956 for example, "GTK+ 1.2" (from the <literal>gtk-options(7)</literal>
24959 <para>The default value for this parameter is reasonable but somewhat
24960 arbitrary. If you are processing pages with long "source" information,
24961 you may want to experiment with changing the value in order to achieve
24962 the correct aesthetic results.</para>
24966 <refentry version="5.0" id="man.th.extra3.max.length">
24968 <refentrytitle>man.th.extra3.max.length</refentrytitle>
24969 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
24972 <refname>man.th.extra3.max.length</refname>
24973 <refpurpose>Maximum length of extra3 in header/footer</refpurpose>
24977 <programlisting id="man.th.extra3.max.length.frag">
24978 <xsl:param name="man.th.extra3.max.length">30</xsl:param>
24982 <refsection><info><title>Description</title></info>
24984 <para>Specifies the maximum permitted length of the
24985 <literal>extra3</literal> part of the man-page <literal>.TH</literal>
24986 title line header/footer. If the <literal>extra3</literal> content
24987 exceeds the maxiumum specified, it is truncated down to the maximum
24988 permitted length.</para>
24990 <para>The content of the <literal>extra3</literal> field is usually
24991 displayed in the middle header of the page and is typically a "manual
24992 name"; for example, "GTK+ User's Manual" (from the
24993 <literal>gtk-options(7)</literal> man page).</para>
24995 <para>The default value for this parameter is reasonable but somewhat
24996 arbitrary. If you are processing pages with long "manual names" -- or
24997 especially if you are processing pages that have both long "title"
24998 parts (command/function, etc. names) <emphasis>and</emphasis> long
24999 manual names -- you may want to experiment with changing the value in
25000 order to achieve the correct aesthetic results.</para>
25004 </reference><reference id="output" xml:base="../manpages/param.xml">
25005 <title>Output</title>
25006 <refentry version="5.0" id="man.output.manifest.enabled">
25008 <refentrytitle>man.output.manifest.enabled</refentrytitle>
25009 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
25012 <refname>man.output.manifest.enabled</refname>
25013 <refpurpose>Generate a manifest file?</refpurpose>
25017 <programlisting id="man.output.manifest.enabled.frag"><xsl:param name="man.output.manifest.enabled" select="0"></xsl:param></programlisting>
25020 <refsection><info><title>Description</title></info>
25022 <para>If non-zero, a list of filenames for man pages generated by
25023 the stylesheet transformation is written to the file named by the
25024 <parameter>man.output.manifest.filename</parameter> parameter.</para>
25029 <refentry version="5.0" id="man.output.manifest.filename">
25031 <refentrytitle>man.output.manifest.filename</refentrytitle>
25032 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
25035 <refname>man.output.manifest.filename</refname>
25036 <refpurpose>Name of manifest file</refpurpose>
25040 <programlisting id="man.output.manifest.filename.frag"><xsl:param name="man.output.manifest.filename">MAN.MANIFEST</xsl:param></programlisting>
25043 <refsection><info><title>Description</title></info>
25045 <para>The <parameter>man.output.manifest.filename</parameter> parameter
25046 specifies the name of the file to which the manpages manifest file
25047 is written (if the value of the
25048 <parameter>man.output.manifest.enabled</parameter> parameter is
25054 <refentry version="5.0" id="man.output.in.separate.dir">
25056 <refentrytitle>man.output.in.separate.dir</refentrytitle>
25057 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
25060 <refname>man.output.in.separate.dir</refname>
25061 <refpurpose>Output man-page files in separate output directory?</refpurpose>
25065 <programlisting id="man.output.in.separate.dir.frag">
25066 <xsl:param name="man.output.in.separate.dir" select="0"></xsl:param>
25070 <refsection><info><title>Description</title></info>
25072 <para>If the value of <literal>man.output.in.separate.dir</literal>
25073 parameter is non-zero, man-page files are output in a separate
25074 directory, specified by the <parameter>man.output.base.dir</parameter>
25075 parameter; otherwise, if the value of
25076 <literal>man.output.in.separate.dir</literal> is zero, man-page files
25077 are not output in a separate directory.</para>
25082 <refentry version="5.0" id="man.output.lang.in.name.enabled">
25084 <refentrytitle>man.output.lang.in.name.enabled</refentrytitle>
25085 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
25088 <refname>man.output.lang.in.name.enabled</refname>
25089 <refpurpose>Include $LANG value in man-page filename/pathname?</refpurpose>
25093 <programlisting id="man.output.lang.in.name.enabled.frag">
25094 <xsl:param name="man.output.lang.in.name.enabled" select="0"></xsl:param>
25098 <refsection><info><title>Description</title></info>
25100 <para>The <parameter>man.output.lang.in.name.enabled</parameter>
25101 parameter specifies whether a <literal>$lang</literal> value is
25102 included in man-page filenames and pathnames.</para>
25104 <para>If the value of
25105 <parameter>man.output.lang.in.name.enabled</parameter> is non-zero,
25106 man-page files are output with the <literal>$lang</literal> value
25107 included in their filenames or pathnames as follows;
25111 <para>if <parameter>man.output.subdirs.enabled</parameter> is
25112 non-zero, each file is output to, e.g., a
25113 <filename>man/<replaceable>$lang</replaceable>/man8/foo.8</filename>
25117 <para>if <parameter>man.output.subdirs.enabled</parameter> is
25118 zero, each file is output with a
25119 <literal>foo.<replaceable>$lang</replaceable>.8</literal>
25128 <refentry version="5.0" id="man.output.base.dir">
25130 <refentrytitle>man.output.base.dir</refentrytitle>
25131 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
25134 <refname>man.output.base.dir</refname>
25135 <refpurpose>Specifies separate output directory</refpurpose>
25139 <programlisting id="man.output.base.dir.frag"><xsl:param name="man.output.base.dir">man/</xsl:param></programlisting>
25142 <refsection><info><title>Description</title></info>
25144 <para>The <parameter>man.output.base.dir</parameter> parameter
25145 specifies the base directory into which man-page files are output. The
25146 <parameter>man.output.subdirs.enabled</parameter> parameter controls
25147 whether the files are output in subdirectories within the base
25151 <para>The values of the <parameter>man.output.base.dir</parameter>
25152 and <parameter>man.output.subdirs.enabled</parameter> parameters are
25153 used only if the value of
25154 <parameter>man.output.in.separate.dir</parameter> parameter is
25155 non-zero. If the value of the
25156 <parameter>man.output.in.separate.dir</parameter> is zero, man-page
25157 files are not output in a separate directory.</para>
25163 <refentry version="5.0" id="man.output.subdirs.enabled">
25165 <refentrytitle>man.output.subdirs.enabled</refentrytitle>
25166 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
25169 <refname>man.output.subdirs.enabled</refname>
25170 <refpurpose>Output man-page files in subdirectories within base output directory?</refpurpose>
25174 <programlisting id="man.output.subdirs.enabled.frag">
25175 <xsl:param name="man.output.subdirs.enabled" select="1"></xsl:param>
25179 <refsection><info><title>Description</title></info>
25181 <para>The <parameter>man.output.subdirs.enabled</parameter> parameter
25182 controls whether man-pages files are output in subdirectories within
25183 the base directory specified by the directory specified by the
25184 <parameter>man.output.base.dir</parameter> parameter.</para>
25187 <para>The values of the <parameter>man.output.base.dir</parameter>
25188 and <parameter>man.output.subdirs.enabled</parameter> parameters are
25189 used only if the value of
25190 <parameter>man.output.in.separate.dir</parameter> parameter is
25191 non-zero. If the value of the
25192 <parameter>man.output.in.separate.dir</parameter> is zero, man-page
25193 files are not output in a separate directory.</para>
25199 <refentry version="5.0" id="man.output.quietly">
25201 <refentrytitle>man.output.quietly</refentrytitle>
25202 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
25205 <refname>man.output.quietly</refname>
25206 <refpurpose>Suppress filename messages emitted when generating output?</refpurpose>
25210 <programlisting id="man.output.quietly.frag">
25211 <xsl:param name="man.output.quietly" select="0"></xsl:param>
25215 <refsection><info><title>Description</title></info>
25217 <para>If zero (the default), for each man-page file created, a message
25218 with the name of the file is emitted. If non-zero, the files are
25219 output "quietly" -- that is, the filename messages are
25223 <para>If you are processing a large amount of <tag>refentry</tag>
25224 content, you may be able to speed up processing significantly by
25225 setting a non-zero value for
25226 <parameter>man.output.quietly</parameter>.</para>
25232 <refentry version="5.0" id="man.output.encoding">
25234 <refentrytitle>man.output.encoding</refentrytitle>
25235 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
25238 <refname>man.output.encoding</refname>
25239 <refpurpose>Encoding used for man-page output</refpurpose>
25243 <programlisting id="man.output.encoding.frag">
25244 <xsl:param name="man.output.encoding">UTF-8</xsl:param>
25248 <refsection><info><title>Description</title></info>
25250 <para>This parameter specifies the encoding to use for files generated
25251 by the manpages stylesheet. Not all processors support specification
25252 of this parameter.</para>
25255 <para>If the value of the <parameter>man.charmap.enabled</parameter>
25256 parameter is non-zero (the default), keeping the
25257 <parameter>man.output.encoding</parameter> parameter at its default
25258 value (<literal>UTF-8</literal>) or setting it to
25259 <literal>UTF-16</literal> <emphasis role="bold">does not cause your
25260 man pages to be output in raw UTF-8 or UTF-16</emphasis> -- because
25261 any Unicode characters for which matches are found in the enabled
25262 character map will be replaced with roff escape sequences before the
25263 final man-page files are generated.</para>
25265 <para>So if you want to generate "real" UTF-8 man pages, without any
25266 character substitution being performed on your content, you need to
25267 set <parameter>man.charmap.enabled</parameter> to zero (which will
25268 completely disable character-map processing). </para>
25270 <para>You may also need to set
25271 <parameter>man.charmap.enabled</parameter> to zero if you want to
25272 output man pages in an encoding other than <literal>UTF-8</literal>
25273 or <literal>UTF-16</literal>. Character-map processing is based on
25274 Unicode character values and may not work with other output
25281 <refentry version="5.0" id="man.output.better.ps.enabled">
25283 <refentrytitle>man.output.better.ps.enabled</refentrytitle>
25284 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
25287 <refname>man.output.better.ps.enabled</refname>
25288 <refpurpose>Enable enhanced print/PostScript output?</refpurpose>
25291 <programlisting id="man.output.better.ps.enabled.frag">
25292 <xsl:param name="man.output.better.ps.enabled">0</xsl:param>
25295 <refsection><info><title>Description</title></info>
25297 <para>If the value of the
25298 <parameter>man.output.better.ps.enabled</parameter> parameter is
25299 non-zero, certain markup is embedded in each generated man page
25300 such that PostScript output from the <command>man -Tps</command>
25301 command for that page will include a number of enhancements
25302 designed to improve the quality of that output.</para>
25304 <para>If <parameter>man.output.better.ps.enabled</parameter> is
25305 zero (the default), no such markup is embedded in generated man
25306 pages, and no enhancements are included in the PostScript
25307 output generated from those man pages by the <command>man
25308 -Tps</command> command.</para>
25311 <para>The enhancements provided by this parameter rely on
25312 features that are specific to groff (GNU troff) and that are
25313 not part of “classic” AT&T troff or any of its
25314 derivatives. Therefore, any man pages you generate with this
25315 parameter enabled will be readable only on systems on which
25316 the groff (GNU troff) program is installed, such as GNU/Linux
25317 systems. The pages <emphasis role="bold">will not not be
25318 readable on systems on with the classic troff (AT&T
25319 troff) command is installed</emphasis>.</para>
25322 <para>The value of this parameter only affects PostScript output
25323 generated from the <command>man</command> command. It has no
25324 effect on output generated using the FO backend.</para>
25327 <para>You can generate PostScript output for any man page by
25328 running the following command:</para>
25329 <programlisting> man <replaceable>FOO</replaceable> -Tps > <replaceable>FOO</replaceable>.ps</programlisting>
25330 <para>You can then generate PDF output by running the following
25332 <programlisting> ps2pdf <replaceable>FOO</replaceable>.ps</programlisting>
25338 </reference><reference id="other" xml:base="../manpages/param.xml">
25339 <title>Other</title>
25340 <refentry version="5.0" id="man.table.footnotes.divider">
25342 <refentrytitle>man.table.footnotes.divider</refentrytitle>
25343 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
25346 <refname>man.table.footnotes.divider</refname>
25347 <refpurpose>Specifies divider string that appears before table footnotes</refpurpose>
25351 <programlisting id="man.table.footnotes.divider.frag">
25352 <xsl:param name="man.table.footnotes.divider">----</xsl:param>
25356 <refsection><info><title>Description</title></info>
25358 <para>In each table that contains footenotes, the string specified by
25359 the <parameter>man.table.footnotes.divider</parameter> parameter is
25360 output before the list of footnotes for the table.</para>
25365 <refentry version="5.0" id="man.subheading.divider.enabled">
25367 <refentrytitle>man.subheading.divider.enabled</refentrytitle>
25368 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
25371 <refname>man.subheading.divider.enabled</refname>
25372 <refpurpose>Add divider comment to roff source before/after subheadings?</refpurpose>
25376 <programlisting id="man.subheading.divider.enabled.frag">
25377 <xsl:param name="man.subheading.divider.enabled">0</xsl:param>
25381 <refsection><info><title>Description</title></info>
25383 <para>If the value of the
25384 <parameter>man.subheading.divider.enabled</parameter> parameter is
25385 non-zero, the contents of the
25386 <parameter>man.subheading.divider</parameter> parameter are used to
25387 add a "divider" before and after subheadings in the roff
25388 output. <emphasis role="bold">The divider is not visisble in the
25389 rendered man page</emphasis>; it is added as a comment, in the source,
25390 simply for the purpose of increasing reability of the source.</para>
25392 <para>If <parameter>man.subheading.divider.enabled</parameter> is zero
25393 (the default), the subheading divider is suppressed.</para>
25398 <refentry version="5.0" id="man.subheading.divider">
25400 <refentrytitle>man.subheading.divider</refentrytitle>
25401 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
25404 <refname>man.subheading.divider</refname>
25405 <refpurpose>Specifies string to use as divider comment before/after subheadings</refpurpose>
25409 <programlisting id="man.subheading.divider.frag">
25410 <xsl:param name="man.subheading.divider">========================================================================</xsl:param>
25414 <refsection><info><title>Description</title></info>
25416 <para>If the value of the
25417 <parameter>man.subheading.divider.enabled</parameter> parameter is
25418 non-zero, the contents of the
25419 <parameter>man.subheading.divider</parameter> parameter are used to
25420 add a "divider" before and after subheadings in the roff
25421 output. <emphasis role="bold">The divider is not visisble in the
25422 rendered man page</emphasis>; it is added as a comment, in the source,
25423 simply for the purpose of increasing reability of the source.</para>
25425 <para>If <parameter>man.subheading.divider.enabled</parameter> is zero
25426 (the default), the subheading divider is suppressed.</para>
25433 <part id="roundtrip">
25434 <?dbhtml dir="roundtrip"?>
25435 <?dbhtml filename="index.html"?>
25436 <title xml:base="../roundtrip/param.xml">Roundtrip Parameter Reference</title>
25437 <partintro id="roundtripintro">
25439 <para xml:base="../roundtrip/param.xml">This is reference documentation for all user-configurable
25440 parameters in the DocBook “Roundtrip” Stylesheets (for
25441 transforming DocBook to WordML, OpenDocument, and Apple Pages,
25442 and for converting from those formats back to DocBook).</para>
25447 <refentry version="5.0" id="wordml.template" xml:base="../roundtrip/param.xml">
25449 <refentrytitle>wordml.template</refentrytitle>
25450 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
25453 <refname>wordml.template</refname>
25454 <refpurpose>Specify the template WordML document</refpurpose>
25458 <programlisting id="wordml.template.frag">
25459 <xsl:param name="wordml.template"></xsl:param>
25463 <refsection><info><title>Description</title></info>
25465 <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>
25467 <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>
25472 <refentry version="5.0" id="pages.template" xml:base="../roundtrip/param.xml">
25474 <refentrytitle>pages.template</refentrytitle>
25475 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
25478 <refname>pages.template</refname>
25479 <refpurpose>Specify the template Pages document</refpurpose>
25483 <programlisting id="pages.template.frag">
25484 <xsl:param name="pages.template"></xsl:param>
25488 <refsection><info><title>Description</title></info>
25490 <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>
25492 <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>
25499 <part id="slides"><title>Slides Parameter Reference</title>
25500 <?dbhtml dir="slides"?>
25501 <?dbhtml filename="index.html"?>
25502 <partintro id="slidesintro">
25503 <para>This is reference documentation for all
25504 user-configurable parameters in the DocBook XSL Slides
25505 stylesheets (for generating HTML and PDF slide
25506 presentations).</para>
25508 <para>The Slides stylesheet for HTML output is a
25509 customization layer of the DocBook XSL HTML
25510 stylesheet; the Slides stylesheet for FO output is a
25511 customization layer of the DocBook XSL FO stylesheet.
25512 Therefore, in addition to the slides-specific
25513 parameters listed in this section, you can also use a
25514 number of <link xlink:href="../html">HTML stylesheet
25515 parameters</link> and <link xlink:href="../fo">FO
25516 stylesheet parameters</link> to control Slides
25520 <reference id="html" xml:base="../slides/html/param.xml">
25521 <title>HTML: General Parameters</title>
25522 <refentry version="5.0" id="keyboard.nav">
25524 <refentrytitle>keyboard.nav</refentrytitle>
25525 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
25528 <refname>keyboard.nav</refname>
25529 <refpurpose>Enable keyboard navigation?</refpurpose>
25533 <programlisting id="keyboard.nav.frag">
25534 <xsl:param name="keyboard.nav" select="1"></xsl:param>
25538 <refsection><info><title>Description</title></info>
25540 <para>If non-zero, JavaScript is added to the slides to enable keyboard
25541 navigation. Pressing 'n', space, or return moves forward; pressing 'p' moves
25547 <refentry version="5.0" id="css.stylesheet">
25549 <refentrytitle>css.stylesheet</refentrytitle>
25550 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
25553 <refname>css.stylesheet</refname>
25554 <refpurpose>CSS stylesheet for slides</refpurpose>
25558 <programlisting id="css.stylesheet.frag">
25559 <xsl:param name="css.stylesheet">slides.css</xsl:param>
25563 <refsection><info><title>Description</title></info>
25565 <para>Identifies the CSS stylesheet used by all the slides. This parameter
25566 can be set in the source document with the <?dbhtml?> pseudo-attribute
25567 <literal>css-stylesheet</literal>.</para>
25572 <refentry version="5.0" id="css.stylesheet.dir">
25574 <refentrytitle>css.stylesheet.dir</refentrytitle>
25575 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
25578 <refname>css.stylesheet.dir</refname>
25579 <refpurpose>Default directory for CSS stylesheets</refpurpose>
25583 <programlisting id="css.stylesheet.dir.frag">
25584 <xsl:param name="css.stylesheet.dir"></xsl:param>
25588 <refsection><info><title>Description</title></info>
25590 <para>Identifies the default directory for the CSS stylesheet
25591 generated on all the slides. This parameter can be set in the source
25592 document with the <?dbhtml?> pseudo-attribute
25593 <literal>css-stylesheet-dir</literal>.</para>
25595 <para>If non-empty, this value is prepended to each of the stylesheets.
25601 <refentry version="5.0" id="titlefoil.html">
25603 <refentrytitle>titlefoil.html</refentrytitle>
25604 <refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo>
25607 <refname>titlefoil.html</refname>
25608 <refpurpose>Name of title foil HTML file</refpurpose>
25612 <programlisting id="titlefoil.html.frag">
25613 <xsl:param name="titlefoil.html" select="concat('index', $html.ext)"></xsl:param>
25617 <refsection><info><title>Description</title></info>
25619 <para>Sets the filename used for the slides titlepage.</para>
25624 <refentry version="5.0" id="toc.html">
25626 <refentrytitle>toc.html</refentrytitle>
25627 <refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo>
25630 <refname>toc.html</refname>
25631 <refpurpose>Name of ToC HTML file</refpurpose>
25635 <programlisting id="toc.html.frag">
25636 <xsl:param name="toc.html" select="concat('toc', $html.ext)"></xsl:param>
25640 <refsection><info><title>Description</title></info>
25642 <para>Sets the filename used for the table of contents page.</para>
25647 <refentry version="5.0" id="foilgroup.toc">
25649 <refentrytitle>foilgroup.toc</refentrytitle>
25650 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
25653 <refname>foilgroup.toc</refname>
25654 <refpurpose>Put ToC on foilgroup pages?</refpurpose>
25658 <programlisting id="foilgroup.toc.frag">
25659 <xsl:param name="foilgroup.toc" select="1"></xsl:param>
25663 <refsection><info><title>Description</title></info>
25665 <para>If non-zero, a ToC will be placed on foilgroup pages (after any
25672 <refentry version="5.0" id="output.indent">
25674 <refentrytitle>output.indent</refentrytitle>
25675 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
25676 <refmiscinfo class="other" otherclass="value">no</refmiscinfo>
25677 <refmiscinfo class="other" otherclass="value">yes</refmiscinfo>
25680 <refname>output.indent</refname>
25681 <refpurpose>Indent output?</refpurpose>
25685 <programlisting id="output.indent.frag">
25686 <xsl:param name="output.indent">no</xsl:param>
25690 <refsection><info><title>Description</title></info>
25692 <para>Specifies the setting of the <parameter>indent</parameter>
25693 parameter on the HTML slides. For more information, see the discussion
25694 of the <tag>xsl:output</tag> element in the XSLT specification.</para>
25695 <para>Select from <literal>yes</literal> or <literal>no</literal>.</para>
25700 <refentry version="5.0" id="overlay">
25702 <refentrytitle>overlay</refentrytitle>
25703 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
25706 <refname>overlay</refname>
25707 <refpurpose>Overlay footer navigation?</refpurpose>
25711 <programlisting id="overlay.frag">
25712 <xsl:param name="overlay" select="0"></xsl:param>
25716 <refsection><info><title>Description</title></info>
25718 <para>If non-zero, JavaScript is added to the slides to make the
25719 bottom navigation appear at the bottom of each page. This option and
25720 <link linkend="multiframe">multiframe</link> are mutually exclusive.</para>
25722 <para>If this parameter is zero, the bottom navigation simply appears
25723 below the content of each slide.</para>
25728 <refentry version="5.0" id="show.foil.number">
25730 <refentrytitle>show.foil.number</refentrytitle>
25731 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
25734 <refname>show.foil.number</refname>
25735 <refpurpose>Show foil number on each foil?</refpurpose>
25739 <programlisting id="show.foil.number.frag">
25740 <xsl:param name="show.foil.number" select="0"></xsl:param>
25744 <refsection><info><title>Description</title></info>
25746 <para>If non-zero, on each slide there will be its number. Currently
25747 not supported in all output formats.</para>
25752 </reference><reference id="frames" xml:base="../slides/html/param.xml">
25753 <title>HTML: Frames Parameters</title>
25754 <refentry version="5.0" id="nav.separator">
25756 <refentrytitle>nav.separator</refentrytitle>
25757 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
25760 <refname>nav.separator</refname>
25761 <refpurpose>Output separator between navigation and body?</refpurpose>
25765 <programlisting id="nav.separator.frag">
25766 <xsl:param name="nav.separator" select="1"></xsl:param>
25770 <refsection><info><title>Description</title></info>
25772 <para>If non-zero, a separator (<literal><HR></literal>) is
25773 added between the navigation links and the content of each slide.</para>
25778 <refentry version="5.0" id="toc.row.height">
25780 <refentrytitle>toc.row.height</refentrytitle>
25781 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
25784 <refname>toc.row.height</refname>
25785 <refpurpose>Height of ToC rows in dynamic ToCs</refpurpose>
25789 <programlisting id="toc.row.height.frag">
25790 <xsl:param name="toc.row.height">22</xsl:param>
25794 <refsection><info><title>Description</title></info>
25796 <para>This parameter specifies the height of each row in the table of
25797 contents. This is only applicable if a <link linkend="dynamic.toc">dynamic ToC</link> is used. You may want to
25798 adjust this parameter for optimal appearance with the font and image
25799 sizes selected by your <link linkend="css.stylesheet">CSS
25806 <refentry version="5.0" id="toc.bg.color">
25808 <refentrytitle>toc.bg.color</refentrytitle>
25809 <refmiscinfo class="other" otherclass="datatype">color</refmiscinfo>
25812 <refname>toc.bg.color</refname>
25813 <refpurpose>Background color for ToC frame</refpurpose>
25817 <programlisting id="toc.bg.color.frag">
25818 <xsl:param name="toc.bg.color">#FFFFFF</xsl:param>
25822 <refsection><info><title>Description</title></info>
25824 <para>Specifies the background color used in the ToC frame.</para>
25829 <refentry version="5.0" id="body.bg.color">
25831 <refentrytitle>body.bg.color</refentrytitle>
25832 <refmiscinfo class="other" otherclass="datatype">color</refmiscinfo>
25835 <refname>body.bg.color</refname>
25836 <refpurpose>Background color for body frame</refpurpose>
25840 <programlisting id="body.bg.color.frag">
25841 <xsl:param name="body.bg.color">#FFFFFF</xsl:param>
25845 <refsection><info><title>Description</title></info>
25847 <para>Specifies the background color used in the body column of
25848 tabular slides.</para>
25853 <refentry version="5.0" id="toc.width">
25855 <refentrytitle>toc.width</refentrytitle>
25856 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
25859 <refname>toc.width</refname>
25860 <refpurpose>Width of ToC frame</refpurpose>
25864 <programlisting id="toc.width.frag">
25865 <xsl:param name="toc.width">250</xsl:param>
25866 <!-- Presumably in pixels? -->
25870 <refsection><info><title>Description</title></info>
25872 <para>Specifies the width of the ToC frame in pixels.</para>
25877 <refentry version="5.0" id="toc.hide.show">
25879 <refentrytitle>toc.hide.show</refentrytitle>
25880 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
25883 <refname>toc.hide.show</refname>
25884 <refpurpose>Enable hide/show button for ToC frame</refpurpose>
25888 <programlisting id="toc.hide.show.frag">
25889 <xsl:param name="toc.hide.show" select="0"></xsl:param>
25893 <refsection><info><title>Description</title></info>
25895 <para>If non-zero, JavaScript (and an additional icon, see
25896 <link linkend="hidetoc.image">hidetoc.image</link> and
25897 <link linkend="hidetoc.image">showtoc.image</link>) is added to each slide
25898 to allow the ToC panel to be <quote>toggled</quote> on each panel.</para>
25900 <note><para>There is a bug in Mozilla 1.0 (at least as of CR3) that causes
25901 the browser to reload the titlepage when this feature is used.</para></note>
25906 <refentry version="5.0" id="dynamic.toc">
25908 <refentrytitle>dynamic.toc</refentrytitle>
25909 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
25912 <refname>dynamic.toc</refname>
25913 <refpurpose>Dynamic ToCs?</refpurpose>
25917 <programlisting id="dynamic.toc.frag">
25918 <xsl:param name="dynamic.toc" select="0"></xsl:param>
25922 <refsection><info><title>Description</title></info>
25924 <para>If non-zero, JavaScript is used to make the ToC panel <quote>dynamic</quote>.
25925 In a dynamic ToC, each section in the ToC can be expanded and collapsed by
25926 clicking on the appropriate image.</para>
25931 <refentry version="5.0" id="active.toc">
25933 <refentrytitle>active.toc</refentrytitle>
25934 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
25937 <refname>active.toc</refname>
25938 <refpurpose>Active ToCs?</refpurpose>
25942 <programlisting id="active.toc.frag">
25943 <xsl:param name="active.toc" select="0"></xsl:param>
25947 <refsection><info><title>Description</title></info>
25949 <para>If non-zero, JavaScript is used to keep the ToC and the current slide
25950 <quote>in sync</quote>. That is, each time the slide changes, the corresponding
25951 ToC entry will be underlined.</para>
25956 <refentry version="5.0" id="overlay.logo">
25958 <refentrytitle>overlay.logo</refentrytitle>
25959 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
25962 <refname>overlay.logo</refname>
25963 <refpurpose>Logo to overlay on ToC frame</refpurpose>
25967 <programlisting id="overlay.logo.frag">
25968 <xsl:param name="overlay.logo">http://docbook.sourceforge.net/release/buttons/slides-1.png</xsl:param>
25972 <refsection><info><title>Description</title></info>
25974 <para>If this URI is non-empty, JavaScript is used to overlay the
25975 specified image on the ToC frame.</para>
25980 <refentry version="5.0" id="multiframe">
25982 <refentrytitle>multiframe</refentrytitle>
25983 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
25986 <refname>multiframe</refname>
25987 <refpurpose>Use multiple frames for slide bodies?</refpurpose>
25991 <programlisting id="multiframe.frag">
25992 <xsl:param name="multiframe" select="0"></xsl:param>
25996 <refsection><info><title>Description</title></info>
25998 <para>If non-zero, multiple frames are used for the body of each
25999 slide. This is one way of forcing the slide navigation elements to
26000 appear in constant locations. The other way is with <link linkend="overlay">overlays</link>. The <link linkend="overlay"><parameter>overlay</parameter></link> and
26001 <parameter>multiframe</parameter> parameters are mutually
26007 <refentry version="5.0" id="multiframe.top.bgcolor">
26009 <refentrytitle>multiframe.top.bgcolor</refentrytitle>
26010 <refmiscinfo class="other" otherclass="datatype">color</refmiscinfo>
26013 <refname>multiframe.top.bgcolor</refname>
26014 <refpurpose>Background color for top navigation frame</refpurpose>
26018 <programlisting id="multiframe.top.bgcolor.frag">
26019 <xsl:param name="multiframe.top.bgcolor">white</xsl:param>
26023 <refsection><info><title>Description</title></info>
26025 <para>Specifies the background color of the top navigation frame when
26026 <link linkend="multiframe">multiframe</link> is enabled.</para>
26031 <refentry version="5.0" id="multiframe.bottom.bgcolor">
26033 <refentrytitle>multiframe.bottom.bgcolor</refentrytitle>
26034 <refmiscinfo class="other" otherclass="datatype">color</refmiscinfo>
26037 <refname>multiframe.bottom.bgcolor</refname>
26038 <refpurpose>Background color for bottom navigation frame</refpurpose>
26042 <programlisting id="multiframe.bottom.bgcolor.frag">
26043 <xsl:param name="multiframe.bottom.bgcolor">white</xsl:param>
26047 <refsection><info><title>Description</title></info>
26049 <para>Specifies the background color of the bottom navigation frame when
26050 <link linkend="multiframe">multiframe</link> is enabled.</para>
26055 <refentry version="5.0" id="multiframe.navigation.height">
26057 <refentrytitle>multiframe.navigation.height</refentrytitle>
26058 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
26061 <refname>multiframe.navigation.height</refname>
26062 <refpurpose>Height of navigation frames</refpurpose>
26066 <programlisting id="multiframe.navigation.height.frag">
26067 <xsl:param name="multiframe.navigation.height">40</xsl:param>
26071 <refsection><info><title>Description</title></info>
26073 <para>Specifies the height of the navigation frames in pixels when
26074 <link linkend="multiframe">multiframe</link> is enabled.</para>
26079 </reference><reference id="graphics" xml:base="../slides/html/param.xml">
26080 <title>HTML: Graphics Parameters</title>
26081 <refentry version="5.0" id="graphics.dir">
26083 <refentrytitle>graphics.dir</refentrytitle>
26084 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
26087 <refname>graphics.dir</refname>
26088 <refpurpose>Graphics directory</refpurpose>
26092 <programlisting id="graphics.dir.frag">
26093 <xsl:param name="graphics.dir"></xsl:param>
26097 <refsection><info><title>Description</title></info>
26099 <para>Identifies the graphics directory for the navigation components
26100 generated on all the slides. This parameter can be set in the source
26101 document with the <?dbhtml?> pseudo-attribute
26102 <literal>graphics-dir</literal>.</para>
26104 <para>If non-empty, this value is prepended to each of the graphic
26105 image paths.</para>
26110 <refentry version="5.0" id="bullet.image">
26112 <refentrytitle>bullet.image</refentrytitle>
26113 <refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo>
26116 <refname>bullet.image</refname>
26117 <refpurpose>Bullet image</refpurpose>
26121 <programlisting id="bullet.image.frag">
26122 <xsl:param name="bullet.image">toc/bullet.png</xsl:param>
26126 <refsection><info><title>Description</title></info>
26128 <para>Specifies the filename of the bullet image used for foils in the
26134 <refentry version="5.0" id="next.image">
26136 <refentrytitle>next.image</refentrytitle>
26137 <refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo>
26140 <refname>next.image</refname>
26141 <refpurpose>Right-arrow image</refpurpose>
26145 <programlisting id="next.image.frag">
26146 <xsl:param name="next.image">active/nav-next.png</xsl:param>
26150 <refsection><info><title>Description</title></info>
26152 <para>Specifies the filename of the right-pointing navigation arrow.</para>
26157 <refentry version="5.0" id="prev.image">
26159 <refentrytitle>prev.image</refentrytitle>
26160 <refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo>
26163 <refname>prev.image</refname>
26164 <refpurpose>Left-arrow image</refpurpose>
26168 <programlisting id="prev.image.frag">
26169 <xsl:param name="prev.image">active/nav-prev.png</xsl:param>
26173 <refsection><info><title>Description</title></info>
26175 <para>Specifies the filename of the left-pointing navigation arrow.</para>
26180 <refentry version="5.0" id="up.image">
26182 <refentrytitle>up.image</refentrytitle>
26183 <refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo>
26186 <refname>up.image</refname>
26187 <refpurpose>Up-arrow image</refpurpose>
26191 <programlisting id="up.image.frag">
26192 <xsl:param name="up.image">active/nav-up.png</xsl:param>
26196 <refsection><info><title>Description</title></info>
26198 <para>Specifies the filename of the upward-pointing navigation arrow.</para>
26203 <refentry version="5.0" id="home.image">
26205 <refentrytitle>home.image</refentrytitle>
26206 <refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo>
26209 <refname>home.image</refname>
26210 <refpurpose>Home image</refpurpose>
26214 <programlisting id="home.image.frag">
26215 <xsl:param name="home.image">active/nav-home.png</xsl:param>
26219 <refsection><info><title>Description</title></info>
26221 <para>Specifies the filename of the home navigation icon.</para>
26226 <refentry version="5.0" id="toc.image">
26228 <refentrytitle>toc.image</refentrytitle>
26229 <refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo>
26232 <refname>toc.image</refname>
26233 <refpurpose>ToC image</refpurpose>
26237 <programlisting id="toc.image.frag">
26238 <xsl:param name="toc.image">active/nav-toc.png</xsl:param>
26242 <refsection><info><title>Description</title></info>
26244 <para>Specifies the filename of the ToC navigation icon.</para>
26250 <refentry version="5.0" id="no.next.image">
26252 <refentrytitle>no.next.image</refentrytitle>
26253 <refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo>
26256 <refname>no.next.image</refname>
26257 <refpurpose>Inactive right-arrow image</refpurpose>
26261 <programlisting id="no.next.image.frag">
26262 <xsl:param name="no.next.image">inactive/nav-next.png</xsl:param>
26266 <refsection><info><title>Description</title></info>
26268 <para>Specifies the filename of the inactive right-pointing navigation arrow.</para>
26273 <refentry version="5.0" id="no.prev.image">
26275 <refentrytitle>no.prev.image</refentrytitle>
26276 <refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo>
26279 <refname>no.prev.image</refname>
26280 <refpurpose>Inactive left-arrow image</refpurpose>
26284 <programlisting id="no.prev.image.frag">
26285 <xsl:param name="no.prev.image">inactive/nav-prev.png</xsl:param>
26289 <refsection><info><title>Description</title></info>
26291 <para>Specifies the filename of the inactive left-pointing navigation arrow.</para>
26296 <refentry version="5.0" id="no.up.image">
26298 <refentrytitle>no.up.image</refentrytitle>
26299 <refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo>
26302 <refname>no.up.image</refname>
26303 <refpurpose>Inactive up-arrow image</refpurpose>
26307 <programlisting id="no.up.image.frag">
26308 <xsl:param name="no.up.image">inactive/nav-up.png</xsl:param>
26312 <refsection><info><title>Description</title></info>
26314 <para>Specifies the filename of the inactive upward-pointing navigation arrow.</para>
26319 <refentry version="5.0" id="no.home.image">
26321 <refentrytitle>no.home.image</refentrytitle>
26322 <refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo>
26325 <refname>no.home.image</refname>
26326 <refpurpose>Inactive home image</refpurpose>
26330 <programlisting id="no.home.image.frag">
26331 <xsl:param name="no.home.image">inactive/nav-home.png</xsl:param>
26335 <refsection><info><title>Description</title></info>
26337 <para>Specifies the filename of the inactive home navigation icon.</para>
26342 <refentry version="5.0" id="no.toc.image">
26344 <refentrytitle>no.toc.image</refentrytitle>
26345 <refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo>
26348 <refname>no.toc.image</refname>
26349 <refpurpose>Inactive ToC image</refpurpose>
26353 <programlisting id="no.toc.image.frag">
26354 <xsl:param name="no.toc.image">inactive/nav-toc.png</xsl:param>
26358 <refsection><info><title>Description</title></info>
26360 <para>Specifies the filename of the inactive ToC navigation icon.</para>
26366 <refentry version="5.0" id="plus.image">
26368 <refentrytitle>plus.image</refentrytitle>
26369 <refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo>
26372 <refname>plus.image</refname>
26373 <refpurpose>Plus image</refpurpose>
26377 <programlisting id="plus.image.frag">
26378 <xsl:param name="plus.image">toc/closed.png</xsl:param>
26382 <refsection><info><title>Description</title></info>
26384 <para>Specifies the filename of the <quote>plus</quote> image; the image used in a
26385 <link linkend="dynamic.toc">dynamic ToC</link> to indicate that a section
26386 can be expanded.</para>
26391 <refentry version="5.0" id="minus.image">
26393 <refentrytitle>minus.image</refentrytitle>
26394 <refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo>
26397 <refname>minus.image</refname>
26398 <refpurpose>Minus image</refpurpose>
26402 <programlisting id="minus.image.frag">
26403 <xsl:param name="minus.image">toc/open.png</xsl:param>
26407 <refsection><info><title>Description</title></info>
26409 <para>Specifies the filename of the <quote>minus</quote> image; the image used in a
26410 <link linkend="dynamic.toc">dynamic ToC</link> to indicate that a section
26411 can be collapsed.</para>
26416 <refentry version="5.0" id="hidetoc.image">
26418 <refentrytitle>hidetoc.image</refentrytitle>
26419 <refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo>
26422 <refname>hidetoc.image</refname>
26423 <refpurpose>Hide ToC image</refpurpose>
26427 <programlisting id="hidetoc.image.frag">
26428 <xsl:param name="hidetoc.image">hidetoc.gif</xsl:param>
26432 <refsection><info><title>Description</title></info>
26434 <para>Specifies the filename of the <quote>hide ToC</quote> image. This is used
26435 when the <link linkend="toc.hide.show">ToC hide/show</link> parameter is
26441 <refentry version="5.0" id="showtoc.image">
26443 <refentrytitle>showtoc.image</refentrytitle>
26444 <refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo>
26447 <refname>showtoc.image</refname>
26448 <refpurpose>Show ToC image</refpurpose>
26452 <programlisting id="showtoc.image.frag">
26453 <xsl:param name="showtoc.image">showtoc.gif</xsl:param>
26457 <refsection><info><title>Description</title></info>
26459 <para>Specifies the filename of the <quote>show ToC</quote> image. This is used
26460 when the <link linkend="toc.hide.show">ToC hide/show</link> parameter is
26466 </reference><reference id="javascript" xml:base="../slides/html/param.xml">
26467 <title>HTML: JavaScript Parameters</title>
26468 <refentry version="5.0" id="script.dir">
26470 <refentrytitle>script.dir</refentrytitle>
26471 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
26474 <refname>script.dir</refname>
26475 <refpurpose>Script directory</refpurpose>
26479 <programlisting id="script.dir.frag">
26480 <xsl:param name="script.dir"></xsl:param>
26484 <refsection><info><title>Description</title></info>
26486 <para>Identifies the JavaScript source directory for the slides.
26487 This parameter can be set in the source
26488 document with the <?dbhtml?> pseudo-attribute
26489 <literal>script-dir</literal>.</para>
26491 <para>If non-empty, this value is prepended to each of the JavaScript files.
26497 <refentry version="5.0" id="ua.js">
26499 <refentrytitle>ua.js</refentrytitle>
26500 <refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo>
26503 <refname>ua.js</refname>
26504 <refpurpose>UA JavaScript file</refpurpose>
26508 <programlisting id="ua.js.frag">
26509 <xsl:param name="ua.js">ua.js</xsl:param>
26513 <refsection><info><title>Description</title></info>
26515 <para>Specifies the filename of the UA JavaScript file. It's unlikely
26516 that you will ever need to change this parameter.</para>
26521 <refentry version="5.0" id="xbDOM.js">
26523 <refentrytitle>xbDOM.js</refentrytitle>
26524 <refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo>
26527 <refname>xbDOM.js</refname>
26528 <refpurpose>xbDOM JavaScript file</refpurpose>
26532 <programlisting id="xbDOM.js.frag">
26533 <xsl:param name="xbDOM.js">xbDOM.js</xsl:param>
26537 <refsection><info><title>Description</title></info>
26539 <para>Specifies the filename of the xbDOM JavaScript file. It's unlikely
26540 that you will ever need to change this parameter.</para>
26545 <refentry version="5.0" id="xbStyle.js">
26547 <refentrytitle>xbStyle.js</refentrytitle>
26548 <refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo>
26551 <refname>xbStyle.js</refname>
26552 <refpurpose>xbStyle JavaScript file</refpurpose>
26556 <programlisting id="xbStyle.js.frag">
26557 <xsl:param name="xbStyle.js">xbStyle.js</xsl:param>
26561 <refsection><info><title>Description</title></info>
26563 <para>Specifies the filename of the xbStyle JavaScript file. It's unlikely
26564 that you will ever need to change this parameter.</para>
26569 <refentry version="5.0" id="xbLibrary.js">
26571 <refentrytitle>xbLibrary.js</refentrytitle>
26572 <refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo>
26575 <refname>xbLibrary.js</refname>
26576 <refpurpose>xbLibrary JavaScript file</refpurpose>
26580 <programlisting id="xbLibrary.js.frag">
26581 <xsl:param name="xbLibrary.js">xbLibrary.js</xsl:param>
26585 <refsection><info><title>Description</title></info>
26587 <para>Specifies the filename of the xbLibrary JavaScript file. It's unlikely
26588 that you will ever need to change this parameter.</para>
26593 <refentry version="5.0" id="xbCollapsibleLists.js">
26595 <refentrytitle>xbCollapsibleLists.js</refentrytitle>
26596 <refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo>
26599 <refname>xbCollapsibleLists.js</refname>
26600 <refpurpose>xbCollapsibleLists JavaScript file</refpurpose>
26604 <programlisting id="xbCollapsibleLists.js.frag">
26605 <xsl:param name="xbCollapsibleLists.js">xbCollapsibleLists.js</xsl:param>
26609 <refsection><info><title>Description</title></info>
26611 <para>Specifies the filename of the xbCollapsibleLists JavaScript file. It's unlikely
26612 that you will ever need to change this parameter.</para>
26617 <refentry version="5.0" id="overlay.js">
26619 <refentrytitle>overlay.js</refentrytitle>
26620 <refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo>
26623 <refname>overlay.js</refname>
26624 <refpurpose>Overlay JavaScript file</refpurpose>
26628 <programlisting id="overlay.js.frag">
26629 <xsl:param name="overlay.js">overlay.js</xsl:param>
26633 <refsection><info><title>Description</title></info>
26635 <para>Specifies the filename of the overlay JavaScript file. It's unlikely
26636 that you will ever need to change this parameter.</para>
26641 <refentry version="5.0" id="slides.js">
26643 <refentrytitle>slides.js</refentrytitle>
26644 <refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo>
26647 <refname>slides.js</refname>
26648 <refpurpose>Slides overlay file</refpurpose>
26652 <programlisting id="slides.js.frag">
26653 <xsl:param name="slides.js">slides.js</xsl:param>
26657 <refsection><info><title>Description</title></info>
26659 <para>Specifies the filename of the slides JavaScript file. It's unlikely
26660 that you will ever need to change this parameter.</para>
26665 </reference><reference id="l10n" xml:base="../slides/html/param.xml">
26666 <title>HTML: Localization Parameters</title>
26667 <refentry version="5.0" id="text.home">
26669 <refentrytitle>text.home</refentrytitle>
26670 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
26673 <refname>text.home</refname>
26674 <refpurpose>Home</refpurpose>
26678 <programlisting id="text.home.frag">
26679 <xsl:param name="text.home">Home</xsl:param>
26683 <refsection><info><title>Description</title></info>
26685 <para>FIXME:</para>
26690 <refentry version="5.0" id="text.toc">
26692 <refentrytitle>text.toc</refentrytitle>
26693 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
26696 <refname>text.toc</refname>
26697 <refpurpose>FIXME:</refpurpose>
26701 <programlisting id="text.toc.frag">
26702 <xsl:param name="text.toc">ToC</xsl:param>
26706 <refsection><info><title>Description</title></info>
26708 <para>FIXME:</para>
26713 <refentry version="5.0" id="text.prev">
26715 <refentrytitle>text.prev</refentrytitle>
26716 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
26719 <refname>text.prev</refname>
26720 <refpurpose>FIXME:</refpurpose>
26724 <programlisting id="text.prev.frag">
26725 <xsl:param name="text.prev">Prev</xsl:param>
26729 <refsection><info><title>Description</title></info>
26731 <para>FIXME:</para>
26736 <refentry version="5.0" id="text.up">
26738 <refentrytitle>text.up</refentrytitle>
26739 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
26742 <refname>text.up</refname>
26743 <refpurpose>FIXME:</refpurpose>
26747 <programlisting id="text.up.frag">
26748 <xsl:param name="text.up">Up</xsl:param>
26752 <refsection><info><title>Description</title></info>
26754 <para>FIXME:</para>
26759 <refentry version="5.0" id="text.next">
26761 <refentrytitle>text.next</refentrytitle>
26762 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
26765 <refname>text.next</refname>
26766 <refpurpose>FIXME:</refpurpose>
26770 <programlisting id="text.next.frag">
26771 <xsl:param name="text.next">Next</xsl:param>
26775 <refsection><info><title>Description</title></info>
26777 <para>FIXME:</para>
26785 <reference id="fo" xml:base="../slides/fo/param.xml">
26786 <title>FO: General Params</title>
26787 <refentry version="5.0" id="slide.title.font.family">
26789 <refentrytitle>slide.title.font.family</refentrytitle>
26790 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
26791 <refmiscinfo class="other" otherclass="list-type">open</refmiscinfo>
26792 <refmiscinfo class="other" otherclass="value">serif</refmiscinfo>
26793 <refmiscinfo class="other" otherclass="value">sans-serif</refmiscinfo>
26794 <refmiscinfo class="other" otherclass="value">monospace</refmiscinfo>
26797 <refname>slide.title.font.family</refname>
26798 <refpurpose>Specifies font family to use for slide titles</refpurpose>
26802 <programlisting id="slide.title.font.family.frag">
26803 <xsl:param name="slide.title.font.family">Helvetica</xsl:param>
26807 <refsection><info><title>Description</title></info>
26809 <para>Specifies the font family to use for slides titles.</para>
26814 <refentry version="5.0" id="slide.font.family">
26816 <refentrytitle>slide.font.family</refentrytitle>
26817 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
26818 <refmiscinfo class="other" otherclass="list-type">open</refmiscinfo>
26819 <refmiscinfo class="other" otherclass="value">serif</refmiscinfo>
26820 <refmiscinfo class="other" otherclass="value">sans-serif</refmiscinfo>
26821 <refmiscinfo class="other" otherclass="value">monospace</refmiscinfo>
26824 <refname>slide.font.family</refname>
26825 <refpurpose>Specifies font family to use for slide bodies</refpurpose>
26829 <programlisting id="slide.font.family.frag">
26830 <xsl:param name="slide.font.family">Helvetica</xsl:param>
26834 <refsection><info><title>Description</title></info>
26836 <para>Specifies the font family to use for slides bodies.</para>
26841 <refentry version="5.0" id="foil.title.master">
26843 <refentrytitle>foil.title.master</refentrytitle>
26844 <refmiscinfo class="other" otherclass="datatype">number</refmiscinfo>
26847 <refname>foil.title.master</refname>
26848 <refpurpose>Specifies unitless font size to use for foil titles</refpurpose>
26852 <programlisting id="foil.title.master.frag">
26853 <xsl:param name="foil.title.master">36</xsl:param>
26854 <!-- Inconsistant use of point size? -->
26858 <refsection><info><title>Description</title></info>
26860 <para>Specifies a unitless font size to use for foil titles; used in
26861 combination with the <parameter>foil.title.size</parameter>
26866 <refentry version="5.0" id="foil.title.size">
26868 <refentrytitle>foil.title.size</refentrytitle>
26869 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
26872 <refname>foil.title.size</refname>
26873 <refpurpose>Specifies font size to use for foil titles, including units</refpurpose>
26877 <programlisting id="foil.title.size.frag">
26878 <xsl:param name="foil.title.size">
26879 <xsl:value-of select="$foil.title.master"></xsl:value-of><xsl:text>pt</xsl:text>
26884 <refsection><info><title>Description</title></info>
26886 <para>This parameter combines the value of the
26887 <parameter>foil.title.master</parameter> parameter with a unit
26888 specification. The default unit is <literal>pt</literal>
26894 </reference><reference id="propsets" xml:base="../slides/fo/param.xml">
26895 <title>FO: Property Sets</title>
26896 <refentry version="5.0" id="slides.properties">
26898 <refentrytitle>slides.properties</refentrytitle>
26899 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
26902 <refname>slides.properties</refname>
26903 <refpurpose>Specifies properties for all slides</refpurpose>
26907 <programlisting id="slides.properties.frag">
26908 <xsl:attribute-set name="slides.properties">
26909 <xsl:attribute name="font-family">
26910 <xsl:value-of select="$slide.font.family"></xsl:value-of>
26911 </xsl:attribute>
26912 </xsl:attribute-set>
26916 <refsection><info><title>Description</title></info>
26918 <para>This parameter specifies properties that are applied to all slides.</para>
26923 <refentry version="5.0" id="foilgroup.properties">
26925 <refentrytitle>foilgroup.properties</refentrytitle>
26926 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
26929 <refname>foilgroup.properties</refname>
26930 <refpurpose>Specifies properties for all foilgroups</refpurpose>
26934 <programlisting id="foilgroup.properties.frag">
26935 <xsl:attribute-set name="foilgroup.properties">
26936 <xsl:attribute name="font-family">
26937 <xsl:value-of select="$slide.font.family"></xsl:value-of>
26938 </xsl:attribute>
26939 </xsl:attribute-set>
26943 <refsection><info><title>Description</title></info>
26945 <para>This parameter specifies properties that are applied to all foilgroups.</para>
26950 <refentry version="5.0" id="foil.subtitle.properties">
26952 <refentrytitle>foil.subtitle.properties</refentrytitle>
26953 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
26956 <refname>foil.subtitle.properties</refname>
26957 <refpurpose>Specifies properties for all foil subtitles</refpurpose>
26961 <programlisting id="foil.subtitle.properties.frag">
26962 <xsl:attribute-set name="foil.subtitle.properties">
26963 <xsl:attribute name="font-family">
26964 <xsl:value-of select="$slide.title.font.family"></xsl:value-of>
26965 </xsl:attribute>
26966 <xsl:attribute name="text-align">center</xsl:attribute>
26967 <xsl:attribute name="font-size">
26968 <xsl:value-of select="$foil.title.master * 0.8"></xsl:value-of><xsl:text>pt</xsl:text>
26969 </xsl:attribute>
26970 <xsl:attribute name="space-after">12pt</xsl:attribute>
26971 </xsl:attribute-set>
26975 <refsection><info><title>Description</title></info>
26977 <para>This parameter specifies properties that are applied to all foil subtitles.</para>
26982 <refentry version="5.0" id="foil.properties">
26984 <refentrytitle>foil.properties</refentrytitle>
26985 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
26988 <refname>foil.properties</refname>
26989 <refpurpose>Specifies properties for all foils</refpurpose>
26993 <programlisting id="foil.properties.frag">
26994 <xsl:attribute-set name="foil.properties">
26995 <xsl:attribute name="font-family">
26996 <xsl:value-of select="$slide.font.family"></xsl:value-of>
26997 </xsl:attribute>
26998 <xsl:attribute name="margin-{$direction.align.start}">1in</xsl:attribute>
26999 <xsl:attribute name="margin-{$direction.align.end}">1in</xsl:attribute>
27000 <xsl:attribute name="font-size">
27001 <xsl:value-of select="$body.font.size"></xsl:value-of>
27002 </xsl:attribute>
27003 <xsl:attribute name="font-weight">bold</xsl:attribute>
27004 </xsl:attribute-set>
27008 <refsection><info><title>Description</title></info>
27010 <para>This parameter specifies properties that are applied to all foils.</para>
27015 <refentry version="5.0" id="speakernote.properties">
27017 <refentrytitle>speakernote.properties</refentrytitle>
27018 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
27021 <refname>speakernote.properties</refname>
27022 <refpurpose>Specifies properties for all speakernotes</refpurpose>
27026 <programlisting id="speakernote.properties.frag">
27027 <xsl:attribute-set name="speakernote.properties">
27028 <xsl:attribute name="font-family">Times Roman</xsl:attribute>
27029 <xsl:attribute name="font-style">italic</xsl:attribute>
27030 <xsl:attribute name="font-size">12pt</xsl:attribute>
27031 <xsl:attribute name="font-weight">normal</xsl:attribute>
27032 </xsl:attribute-set>
27036 <refsection><info><title>Description</title></info>
27038 <para>This parameter specifies properties that are applied to all speakernotes.</para>
27043 <refentry version="5.0" id="running.foot.properties">
27045 <refentrytitle>running.foot.properties</refentrytitle>
27046 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
27049 <refname>running.foot.properties</refname>
27050 <refpurpose>Specifies properties for running foot on each slide</refpurpose>
27054 <programlisting id="running.foot.properties.frag">
27055 <xsl:attribute-set name="running.foot.properties">
27056 <xsl:attribute name="font-family">
27057 <xsl:value-of select="$slide.font.family"></xsl:value-of>
27058 </xsl:attribute>
27059 <xsl:attribute name="font-size">14pt</xsl:attribute>
27060 <xsl:attribute name="color">#9F9F9F</xsl:attribute>
27061 </xsl:attribute-set>
27065 <refsection><info><title>Description</title></info>
27067 <para>This parameter specifies properties that are applied to the
27068 running foot area of each slide.</para>
27075 <part id="website">
27076 <?dbhtml dir="website"?>
27077 <?dbhtml filename="index.html"?>
27078 <title xml:base="../website/param.xml">Website Parameter Reference</title>
27079 <partintro id="websiteintro">
27081 <para xml:base="../website/param.xml">This is reference documentation for all user-configurable
27082 parameters in the DocBook XSL Website stylesheet (for
27083 generating websites from DocBook XML sources). Note that the
27084 Website stylesheet is a customization layer of the DocBook XSL
27085 HTML stylesheet. Therefore, in addition to the
27086 Website-specific parameters listed in this section, you can
27087 also use a number of <link xlink:href="../html/">HTML
27088 stylesheet parameters</link> to control Website output.</para>
27091 <reference id="general" xml:base="../website/param.xml">
27092 <title>General Parameters</title>
27093 <refentry version="5.0" id="autolayout-file">
27095 <refentrytitle>autolayout-file</refentrytitle>
27096 <refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo>
27099 <refname>autolayout-file</refname>
27100 <refpurpose>Identifies the autolayout.xml file</refpurpose>
27104 <programlisting id="autolayout-file.frag">
27105 <xsl:param name="autolayout-file">autolayout.xml</xsl:param>
27109 <refsection><info><title>Description</title></info>
27110 <para>When the source pages are spread over several directories, this
27111 parameter can be set (for example, from the command line of a batch-mode
27112 XSLT processor) to indicate the location of the autolayout.xml file.</para>
27113 <para>FIXME: for browser-based use, there needs to be a PI for this...
27118 <refentry version="5.0" id="body.attributes">
27120 <refentrytitle>body.attributes</refentrytitle>
27121 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
27124 <refname>body.attributes</refname>
27125 <refpurpose>DEPRECATED</refpurpose>
27129 <programlisting id="body.attributes.frag">
27130 <xsl:attribute-set name="body.attributes">
27131 <xsl:attribute name="bgcolor">white</xsl:attribute>
27132 <xsl:attribute name="text">black</xsl:attribute>
27133 <xsl:attribute name="link">#0000FF</xsl:attribute>
27134 <xsl:attribute name="vlink">#840084</xsl:attribute>
27135 <xsl:attribute name="alink">#0000FF</xsl:attribute>
27136 </xsl:attribute-set>
27140 <refsection><info><title>Description</title></info>
27141 <para>DEPRECATED</para>
27145 <refentry version="5.0" id="currentpage.marker">
27147 <refentrytitle>currentpage.marker</refentrytitle>
27148 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
27151 <refname>currentpage.marker</refname>
27152 <refpurpose>The text symbol used to mark the current page</refpurpose>
27156 <programlisting id="currentpage.marker.frag">
27157 <xsl:param name="currentpage.marker">@</xsl:param>
27161 <refsection><info><title>Description</title></info>
27162 <para>Character to use as identifying the current page in </para>
27166 <refentry version="5.0" id="dry-run">
27168 <refentrytitle>dry-run</refentrytitle>
27169 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
27172 <refname>dry-run</refname>
27173 <refpurpose>Indicates that no files should be produced</refpurpose>
27176 <programlisting id="dry-run.frag">
27177 <xsl:param name="dry-run" select="0"></xsl:param>
27180 <refsection><info><title>Description</title></info>
27181 <para>When using the XSLT processor to manage dependencies and construct
27182 the website, this parameter can be used to suppress the generation of
27183 new and updated files. Effectively, this allows you to see what the
27184 stylesheet would do, without actually making any changes.</para>
27185 <para>Only applies when XSLT-based chunking is being used.</para>
27189 <refentry version="5.0" id="feedback.href">
27191 <refentrytitle>feedback.href</refentrytitle>
27192 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
27195 <refname>feedback.href</refname>
27196 <refpurpose>HREF (URI) for feedback link</refpurpose>
27200 <programlisting id="feedback.href.frag">
27201 <xsl:param name="feedback.href"></xsl:param>
27205 <refsection><info><title>Description</title></info>
27206 <para>The <varname>feedback.href</varname> value is used as the value
27207 for the <tag class="attribute">href</tag> attribute on the feedback
27208 link. If <varname>feedback.href</varname>
27209 is empty, no feedback link is generated.</para>
27213 <refentry version="5.0" id="feedback.link.text">
27215 <refentrytitle>feedback.link.text</refentrytitle>
27216 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
27219 <refname>feedback.link.text</refname>
27220 <refpurpose>The text of the feedback link</refpurpose>
27224 <programlisting id="feedback.link.text.frag">
27225 <xsl:param name="feedback.link.text">Feedback</xsl:param>
27229 <refsection><info><title>Description</title></info>
27230 <para>The contents of this variable is used as the text of the feedback
27231 link if <varname>feedback.href</varname> is not empty. If
27232 <varname>feedback.href</varname> is empty, no feedback link is
27237 <refentry version="5.0" id="feedback.with.ids">
27239 <refentrytitle>feedback.with.ids</refentrytitle>
27240 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
27243 <refname>feedback.with.ids</refname>
27244 <refpurpose>Toggle use of IDs in feedback</refpurpose>
27248 <programlisting id="feedback.with.ids.frag">
27249 <xsl:param name="feedback.with.ids" select="0"></xsl:param>
27253 <refsection><info><title>Description</title></info>
27254 <para>If <varname>feedback.with.ids</varname> is non-zero, the ID of the
27255 current page will be added to the feedback link. This can be used, for
27256 example, if the <varname>feedback.href</varname> is a CGI script.</para>
27260 <refentry version="5.0" id="filename-prefix">
27262 <refentrytitle>filename-prefix</refentrytitle>
27263 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
27266 <refname>filename-prefix</refname>
27267 <refpurpose>Prefix added to all filenames</refpurpose>
27271 <programlisting id="filename-prefix.frag">
27272 <xsl:param name="filename-prefix"></xsl:param>
27276 <refsection><info><title>Description</title></info>
27277 <para>To produce the <quote>text-only</quote> (that is, non-tabular) layout
27278 of a website simultaneously with the tabular layout, the filenames have to
27279 be distinguished. That's accomplished by adding the
27280 <varname>filename-prefix</varname> to the front of each filename.</para>
27284 <refentry version="5.0" id="footer.hr">
27286 <refentrytitle>footer.hr</refentrytitle>
27287 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
27290 <refname>footer.hr</refname>
27291 <refpurpose>Toggle <HR> before footer</refpurpose>
27295 <programlisting id="footer.hr.frag">
27296 <xsl:param name="footer.hr" select="1"></xsl:param>
27300 <refsection><info><title>Description</title></info>
27301 <para>If non-zero, an <HR> is generated at the bottom of each web page,
27302 before the footer.</para>
27306 <refentry version="5.0" id="header.hr">
27308 <refentrytitle>header.hr</refentrytitle>
27309 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
27312 <refname>header.hr</refname>
27313 <refpurpose>Toggle <HR> after header</refpurpose>
27317 <programlisting id="header.hr.frag">
27318 <xsl:param name="header.hr" select="1"></xsl:param>
27322 <refsection><info><title>Description</title></info>
27323 <para>If non-zero, an <HR> is generated at the bottom of each web page,
27324 before the footer.</para>
27328 <refentry version="5.0" id="output-root">
27330 <refentrytitle>output-root</refentrytitle>
27331 <refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo>
27334 <refname>output-root</refname>
27335 <refpurpose>Specifies the root directory of the website</refpurpose>
27339 <programlisting id="output-root.frag">
27340 <xsl:param name="output-root">.</xsl:param>
27344 <refsection><info><title>Description</title></info>
27345 <para>When using the XSLT processor to manage dependencies and construct
27346 the website, this parameter can be used to indicate the root directory
27347 where the resulting pages are placed.</para>
27348 <para>Only applies when XSLT-based chunking is being used.</para>
27352 <refentry version="5.0" id="rebuild-all">
27354 <refentrytitle>rebuild-all</refentrytitle>
27355 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
27358 <refname>rebuild-all</refname>
27359 <refpurpose>Indicates that all files should be produced</refpurpose>
27363 <programlisting id="rebuild-all.frag">
27364 <xsl:param name="rebuild-all" select="0"></xsl:param>
27368 <refsection><info><title>Description</title></info>
27369 <para>When using the XSLT processor to manage dependencies and construct
27370 the website, this parameter can be used to regenerate the whole website,
27371 updating even pages that don't appear to need to be updated.</para>
27372 <para>The dependency extension only looks at the source documents. So
27373 if you change something in the stylesheet, for example, that has a global
27374 effect, you can use this parameter to force the stylesheet to rebuild the
27377 <para>Only applies when XSLT-based chunking is being used.</para>
27381 <refentry version="5.0" id="sequential.links">
27383 <refentrytitle>sequential.links</refentrytitle>
27384 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
27387 <refname>sequential.links</refname>
27388 <refpurpose>Make sequentional links?</refpurpose>
27392 <programlisting id="sequential.links.frag">
27393 <xsl:param name="sequential.links" select="0"></xsl:param>
27397 <refsection><info><title>Description</title></info>
27402 <refentry version="5.0" id="suppress.homepage.title">
27404 <refentrytitle>suppress.homepage.title</refentrytitle>
27405 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
27408 <refname>suppress.homepage.title</refname>
27409 <refpurpose>Suppress title on homepage?</refpurpose>
27413 <programlisting id="suppress.homepage.title.frag">
27414 <xsl:param name="suppress.homepage.title" select="1"></xsl:param>
27418 <refsection><info><title>Description</title></info>
27419 <para>FIXME:If non-zero, the title on the homepage is suppressed?</para>
27423 <refentry version="5.0" id="table.spacer.image">
27425 <refentrytitle>table.spacer.image</refentrytitle>
27426 <refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo>
27429 <refname>table.spacer.image</refname>
27430 <refpurpose>Invisible pixel for tabular accessibility</refpurpose>
27434 <programlisting id="table.spacer.image.frag">
27435 <xsl:param name="table.spacer.image">graphics/spacer.gif</xsl:param>
27439 <refsection><info><title>Description</title></info>
27440 <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
27441 website presentation.</para>
27445 </reference><reference id="nav" xml:base="../website/param.xml">
27446 <title>Navigation Parameters</title>
27447 <refentry version="5.0" id="banner.before.navigation">
27449 <refentrytitle>banner.before.navigation</refentrytitle>
27450 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
27453 <refname>banner.before.navigation</refname>
27454 <refpurpose>Put banner before navigation?</refpurpose>
27458 <programlisting id="banner.before.navigation.frag">
27459 <xsl:param name="banner.before.navigation" select="1"></xsl:param>
27463 <refsection><info><title>Description</title></info>
27468 <refentry version="5.0" id="navbgcolor">
27470 <refentrytitle>navbgcolor</refentrytitle>
27471 <refmiscinfo class="other" otherclass="datatype">color</refmiscinfo>
27474 <refname>navbgcolor</refname>
27475 <refpurpose>The background color of the navigation TOC</refpurpose>
27479 <programlisting id="navbgcolor.frag">
27480 <xsl:param name="navbgcolor">#4080FF</xsl:param>
27484 <refsection><info><title>Description</title></info>
27485 <para>The background color of the navigation TOC.</para>
27486 <para>Only applies with the tabular presentation is being used.</para>
27490 <refentry version="5.0" id="navbodywidth">
27492 <refentrytitle>navbodywidth</refentrytitle>
27493 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
27496 <refname>navbodywidth</refname>
27497 <refpurpose>Specifies the width of the navigation table body</refpurpose>
27501 <programlisting id="navbodywidth.frag">
27502 <xsl:param name="navbodywidth"></xsl:param>
27506 <refsection><info><title>Description</title></info>
27507 <para>The width of the body column.</para>
27508 <para>Only applies with the tabular presentation is being used.</para>
27512 <refentry version="5.0" id="nav.table.summary">
27514 <refentrytitle>nav.table.summary</refentrytitle>
27515 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
27518 <refname>nav.table.summary</refname>
27519 <refpurpose>HTML Table summary attribute value for navigation tables</refpurpose>
27523 <programlisting id="nav.table.summary.frag">
27524 <xsl:param name="nav.table.summary">Navigation</xsl:param>
27528 <refsection><info><title>Description</title></info>
27529 <para>The value of this parameter is used as the value of the table
27530 summary attribute for the navigation table.</para>
27531 <para>Only applies with the tabular presentation is being used.</para>
27535 <refentry version="5.0" id="navtocwidth">
27537 <refentrytitle>navtocwidth</refentrytitle>
27538 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
27541 <refname>navtocwidth</refname>
27542 <refpurpose>Specifies the width of the navigation table TOC</refpurpose>
27546 <programlisting id="navtocwidth.frag">
27547 <xsl:param name="navtocwidth">220</xsl:param>
27551 <refsection><info><title>Description</title></info>
27552 <para>The width, in pixels, of the navigation column.</para>
27553 <para>Only applies with the tabular presentation is being used.</para>
27557 <refentry version="5.0" id="textbgcolor">
27559 <refentrytitle>textbgcolor</refentrytitle>
27560 <refmiscinfo class="other" otherclass="datatype">color</refmiscinfo>
27563 <refname>textbgcolor</refname>
27564 <refpurpose>The background color of the table body</refpurpose>
27568 <programlisting id="textbgcolor.frag">
27569 <xsl:param name="textbgcolor">white</xsl:param>
27573 <refsection><info><title>Description</title></info>
27574 <para>The background color of the table body.</para>
27575 <para>Only applies with the tabular presentation is being used.</para>
27579 </reference><reference id="toc" xml:base="../website/param.xml">
27580 <title>ToC Parameters</title>
27581 <refentry version="5.0" id="toc.blank.graphic">
27583 <refentrytitle>toc.blank.graphic</refentrytitle>
27584 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
27587 <refname>toc.blank.graphic</refname>
27588 <refpurpose>Use graphic for "blanks" in TOC?</refpurpose>
27592 <programlisting id="toc.blank.graphic.frag">
27593 <xsl:param name="toc.blank.graphic" select="1"></xsl:param>
27597 <refsection><info><title>Description</title></info>
27598 <para>If non-zero, "blanks" in the the TOC will be accomplished
27599 with the graphic identified by <varname>toc.spacer.image</varname>.
27601 <para>Only applies with the tabular presentation is being used.</para>
27605 <refentry version="5.0" id="toc.blank.image">
27607 <refentrytitle>toc.blank.image</refentrytitle>
27608 <refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo>
27611 <refname>toc.blank.image</refname>
27612 <refpurpose>The image for "blanks" in the TOC</refpurpose>
27616 <programlisting id="toc.blank.image.frag">
27617 <xsl:param name="toc.blank.image">graphics/blank.gif</xsl:param>
27621 <refsection><info><title>Description</title></info>
27622 <para>If <varname>toc.blank.graphic</varname> is non-zero, this image
27623 will be used to for "blanks" in the TOC.</para>
27624 <para>Only applies with the tabular presentation is being used.</para>
27628 <refentry version="5.0" id="toc.blank.text">
27630 <refentrytitle>toc.blank.text</refentrytitle>
27631 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
27634 <refname>toc.blank.text</refname>
27635 <refpurpose>The text for "blanks" in the TOC</refpurpose>
27639 <programlisting id="toc.blank.text.frag">
27640 <xsl:param name="toc.blank.text">   </xsl:param>
27644 <refsection><info><title>Description</title></info>
27645 <para>If <varname>toc.blank.graphic</varname> is zero, this text string
27646 will be used for "blanks" in the TOC.</para>
27647 <para>Only applies with the tabular presentation is being used.</para>
27651 <refentry version="5.0" id="toc.pointer.graphic">
27653 <refentrytitle>toc.pointer.graphic</refentrytitle>
27654 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
27657 <refname>toc.pointer.graphic</refname>
27658 <refpurpose>Use graphic for TOC pointer?</refpurpose>
27662 <programlisting id="toc.pointer.graphic.frag">
27663 <xsl:param name="toc.pointer.graphic" select="1"></xsl:param>
27667 <refsection><info><title>Description</title></info>
27668 <para>If non-zero, the "pointer" in the TOC will be displayed
27669 with the graphic identified by <varname>toc.pointer.image</varname>.
27671 <para>Only applies with the tabular presentation is being used.</para>
27675 <refentry version="5.0" id="toc.pointer.image">
27677 <refentrytitle>toc.pointer.image</refentrytitle>
27678 <refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo>
27681 <refname>toc.pointer.image</refname>
27682 <refpurpose>The image for the "pointer" in the TOC</refpurpose>
27686 <programlisting id="toc.pointer.image.frag">
27687 <xsl:param name="toc.pointer.image">graphics/arrow.gif</xsl:param>
27691 <refsection><info><title>Description</title></info>
27692 <para>If <varname>toc.pointer.graphic</varname> is non-zero, this image
27693 will be used for the "pointer" in the TOC.</para>
27694 <para>Only applies with the tabular presentation is being used.</para>
27698 <refentry version="5.0" id="toc.pointer.text">
27700 <refentrytitle>toc.pointer.text</refentrytitle>
27701 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
27704 <refname>toc.pointer.text</refname>
27705 <refpurpose>The text for the "pointer" in the TOC</refpurpose>
27709 <programlisting id="toc.pointer.text.frag">
27710 <xsl:param name="toc.pointer.text"> > </xsl:param>
27714 <refsection><info><title>Description</title></info>
27715 <para>If <varname>toc.pointer.graphic</varname> is zero, this text string
27716 will be used to display the "pointer" in the TOC.</para>
27717 <para>Only applies with the tabular presentation is being used.</para>
27721 <refentry version="5.0" id="toc.spacer.graphic">
27723 <refentrytitle>toc.spacer.graphic</refentrytitle>
27724 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
27727 <refname>toc.spacer.graphic</refname>
27728 <refpurpose>Use graphic for TOC spacer?</refpurpose>
27732 <programlisting id="toc.spacer.graphic.frag">
27733 <xsl:param name="toc.spacer.graphic" select="1"></xsl:param>
27737 <refsection><info><title>Description</title></info>
27738 <para>If non-zero, the indentation in the TOC will be accomplished
27739 with the graphic identified by <varname>toc.spacer.image</varname>.
27741 <para>Only applies with the tabular presentation is being used.</para>
27745 <refentry version="5.0" id="toc.spacer.image">
27747 <refentrytitle>toc.spacer.image</refentrytitle>
27748 <refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo>
27751 <refname>toc.spacer.image</refname>
27752 <refpurpose>The image for spacing the TOC</refpurpose>
27756 <programlisting id="toc.spacer.image.frag">
27757 <xsl:param name="toc.spacer.image">graphics/blank.gif</xsl:param>
27761 <refsection><info><title>Description</title></info>
27762 <para>If <varname>toc.spacer.graphic</varname> is non-zero, this image
27763 will be used to indent the TOC.</para>
27764 <para>Only applies with the tabular presentation is being used.</para>
27768 <refentry version="5.0" id="toc.spacer.text">
27770 <refentrytitle>toc.spacer.text</refentrytitle>
27771 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
27774 <refname>toc.spacer.text</refname>
27775 <refpurpose>The text for spacing the TOC</refpurpose>
27779 <programlisting id="toc.spacer.text.frag">
27780 <xsl:param name="toc.spacer.text">   </xsl:param>
27784 <refsection><info><title>Description</title></info>
27785 <para>If <varname>toc.spacer.graphic</varname> is zero, this text string
27786 will be used to indent the TOC.</para>
27787 <para>Only applies with the tabular presentation is being used.</para>
27794 <book id="pi"><title>DocBook XSL Stylesheets User Reference: PIs</title>
27795 <?dbhtml dir="pi"?>
27796 <?dbhtml filename="index.html"?>
27799 <para>This is generated reference documentation for all
27800 user-specifiable processing instructions in the DocBook
27803 <para>You add these PIs at particular points in a document to
27804 cause specific “exceptions” to formatting/output behavior. To
27805 make global changes in formatting/output behavior across an
27806 entire document, it’s better to do it by setting an
27807 appropriate stylesheet parameter (if there is one).</para>
27812 <part id="pi-html">
27813 <info xml:base="../html/pi.xml"><title>HTML Processing Instruction Reference</title>
27814 <releaseinfo role="meta">
27815 $Id: pi.xsl 8394 2009-04-02 20:31:30Z mzjn $
27818 <partintro id="partintro" xml:base="../html/pi.xml">
27819 <title>Introduction</title>
27821 <para>This is generated reference documentation for all
27822 user-specifiable processing instructions (PIs) in the DocBook
27823 XSL stylesheets for HTML output.
27826 <para>You add these PIs at particular points in a document to
27827 cause specific “exceptions” to formatting/output behavior. To
27828 make global changes in formatting/output behavior across an
27829 entire document, it’s better to do it by setting an
27830 appropriate stylesheet parameter (if there is one).</para>
27837 <refentry id="dbhtml_background-color" xml:base="../html/pi.xml">
27839 <refname>dbhtml_background-color</refname>
27840 <refpurpose>Sets background color for an image</refpurpose>
27844 <synopsis><tag class="xmlpi">dbhtml background-color="<replaceable>color</replaceable>"</tag></synopsis>
27847 <refsect1><title>Description</title>
27849 <para>Use the <tag class="xmlpi">dbhtml background-color</tag> PI before or
27850 after an image (<tag>graphic</tag>, <tag>inlinegraphic</tag>,
27851 <tag>imagedata</tag>, or <tag>videodata</tag> element) as a
27852 sibling to the element, to set a background color for the
27855 </refsect1><refsect1><title>Parameters</title>
27858 <varlistentry><term>background-color="<replaceable>color</replaceable>"</term>
27861 <para>An HTML color value</para>
27867 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
27869 <para><link role="tcg" xlink:href="BGcolor.html">Background color</link></para>
27871 </refsect1></refentry>
27873 <refentry id="dbhtml_bgcolor" xml:base="../html/pi.xml">
27875 <refname>dbhtml_bgcolor</refname>
27876 <refpurpose>Sets background color on a CALS table row or table cell</refpurpose>
27880 <synopsis><tag class="xmlpi">dbhtml bgcolor="<replaceable>color</replaceable>"</tag></synopsis>
27883 <refsect1><title>Description</title>
27885 <para>Use the <tag class="xmlpi">dbhtml bgcolor</tag> PI as child of a CALS table row
27886 or cell to set a background color for that table row or cell.</para>
27888 </refsect1><refsect1><title>Parameters</title>
27891 <varlistentry><term>bgcolor="<replaceable>color</replaceable>"</term>
27894 <para>An HTML color value</para>
27900 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
27902 <para><link role="tcg" xlink:href="BGtableColor.html#CellBGColor">Cell background color</link></para>
27904 </refsect1></refentry>
27906 <refentry id="dbhtml_cellpadding" xml:base="../html/pi.xml">
27908 <refname>dbhtml_cellpadding</refname>
27909 <refpurpose>Specifies cellpadding in CALS table or qandaset output</refpurpose>
27913 <synopsis><tag class="xmlpi">dbhtml cellpadding="<replaceable>number</replaceable>"</tag></synopsis>
27916 <refsect1><title>Description</title>
27918 <para>Use the <tag class="xmlpi">dbhtml cellpadding</tag> PI as a child of a
27919 CALS <tag>table</tag> or <tag>qandaset</tag> to specify the value
27920 for the HTML <literal>cellpadding</literal> attribute in the
27921 output HTML table.</para>
27923 </refsect1><refsect1><title>Parameters</title>
27926 <varlistentry><term>cellpadding="<replaceable>number</replaceable>"</term>
27929 <para>Specifies the cellpadding</para>
27935 </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
27937 <para><parameter>html.cellpadding</parameter></para>
27939 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
27941 <para><link role="tcg" xlink:href="CellSpacing.html">Cell spacing and cell padding</link>,
27942 <link role="tcg" xlink:href="QandAformat.html">Q and A formatting</link></para>
27944 </refsect1></refentry>
27946 <refentry id="dbhtml_cellspacing" xml:base="../html/pi.xml">
27948 <refname>dbhtml_cellspacing</refname>
27949 <refpurpose>Specifies cellspacing in CALS table or qandaset output</refpurpose>
27953 <synopsis><tag class="xmlpi">dbhtml cellspacing="<replaceable>number</replaceable>"</tag></synopsis>
27956 <refsect1><title>Description</title>
27958 <para>Use the <tag class="xmlpi">dbhtml cellspacing</tag> PI as a child of a
27959 CALS <tag>table</tag> or <tag>qandaset</tag> to specify the value
27960 for the HTML <literal>cellspacing</literal> attribute in the
27961 output HTML table.</para>
27963 </refsect1><refsect1><title>Parameters</title>
27966 <varlistentry><term>cellspacing="<replaceable>number</replaceable>"</term>
27969 <para>Specifies the cellspacing</para>
27975 </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
27977 <para><parameter>html.cellspacing</parameter></para>
27979 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
27981 <para><link role="tcg" xlink:href="CellSpacing.html">Cell spacing and cell padding</link>,
27982 <link role="tcg" xlink:href="QandAformat.html">Q and A formatting</link></para>
27984 </refsect1></refentry>
27986 <refentry id="dbhtml_class" xml:base="../html/pi.xml">
27988 <refname>dbhtml_class</refname>
27989 <refpurpose>Set value of the class attribute for a CALS table row</refpurpose>
27993 <synopsis><tag class="xmlpi">dbhtml class="<replaceable>name</replaceable>"</tag></synopsis>
27996 <refsect1><title>Description</title>
27998 <para>Use the <tag class="xmlpi">dbhtml class</tag> PI as a child of a
27999 <tag>row</tag> to specify a <literal>class</literal>
28000 attribute and value in the HTML output for that row.</para>
28002 </refsect1><refsect1><title>Parameters</title>
28005 <varlistentry><term>class="<replaceable>name</replaceable>"</term>
28008 <para>Specifies the class name</para>
28014 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
28016 <para><link role="tcg" xlink:href="CSSTableCells.html">Table styles in HTML output</link></para>
28018 </refsect1></refentry>
28020 <refentry id="dbhtml_dir" xml:base="../html/pi.xml">
28022 <refname>dbhtml_dir</refname>
28023 <refpurpose>Specifies a directory name in which to write files</refpurpose>
28027 <synopsis><tag class="xmlpi">dbhtml dir="<replaceable>path</replaceable>"</tag></synopsis>
28030 <refsect1><title>Description</title>
28032 <para>When chunking output, use the <tag class="xmlpi">dbhtml dir</tag> PI
28033 as a child of a chunk source to cause the output of that
28034 chunk to be written to the specified directory; also, use it
28035 as a child of a <tag>mediaobject</tag> to specify a
28036 directory into which any long-description files for that
28037 <tag>mediaobject</tag> will be written.</para>
28039 </refsect1><refsect1><title>Parameters</title>
28042 <varlistentry><term>dir="<replaceable>path</replaceable>"</term>
28045 <para>Specifies the pathname for the directory</para>
28051 </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
28053 <para><parameter>base.dir</parameter></para>
28055 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
28057 <para><link role="tcg" xlink:href="Chunking.html#dbhtmlDirPI">dbhtml dir processing instruction</link></para>
28059 </refsect1></refentry>
28061 <refentry id="dbhtml_filename" xml:base="../html/pi.xml">
28063 <refname>dbhtml_filename</refname>
28064 <refpurpose>Specifies a filename for a chunk</refpurpose>
28068 <synopsis><tag class="xmlpi">dbhtml filename="<replaceable>filename</replaceable>"</tag></synopsis>
28071 <refsect1><title>Description</title>
28073 <para>When chunking output, use the <tag class="xmlpi">dbhtml filename</tag>
28074 PI as a child of a chunk source to specify a filename for
28075 the output file for that chunk.</para>
28077 </refsect1><refsect1><title>Parameters</title>
28080 <varlistentry><term>filename="<replaceable>path</replaceable>"</term>
28083 <para>Specifies the filename for the file</para>
28089 </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
28091 <para><parameter>use.id.as.filename</parameter></para>
28093 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
28095 <para><link role="tcg" xlink:href="Chunking.html#DbhtmlFilenames">dbhtml filenames</link></para>
28097 </refsect1></refentry>
28099 <refentry id="dbhtml_funcsynopsis-style" xml:base="../html/pi.xml">
28101 <refname>dbhtml_funcsynopsis-style</refname>
28102 <refpurpose>Specifies presentation style for a funcsynopsis</refpurpose>
28106 <synopsis><tag class="xmlpi">dbhtml funcsynopsis-style="kr"|"ansi"</tag></synopsis>
28109 <refsect1><title>Description</title>
28111 <para>Use the <tag class="xmlpi">dbhtml funcsynopsis-style</tag> PI as a child of
28112 a <tag>funcsynopsis</tag> or anywhere within a funcsynopsis
28113 to control the presentation style for output of all
28114 <tag>funcprototype</tag> instances within that funcsynopsis.</para>
28116 </refsect1><refsect1><title>Parameters</title>
28119 <varlistentry><term>funcsynopsis-style="kr"</term>
28122 <para>Displays <tag>funcprototype</tag> output in K&R style</para>
28126 <varlistentry><term>funcsynopsis-style="ansi"</term>
28129 <para>Displays <tag>funcprototype</tag> output in ANSI style</para>
28135 </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
28137 <para><parameter>funcsynopsis.style</parameter></para>
28139 </refsect1></refentry>
28141 <refentry id="dbhtml_img.src.path" xml:base="../html/pi.xml">
28143 <refname>dbhtml_img.src.path</refname>
28144 <refpurpose>Specifies a path to the location of an image file</refpurpose>
28148 <synopsis><tag class="xmlpi">dbhtml img.src.path="<replaceable>path</replaceable>"</tag></synopsis>
28151 <refsect1><title>Description</title>
28153 <para>Use the <tag class="xmlpi">dbhtml img.src.path</tag> PI before or
28154 after an image (<tag>graphic</tag>,
28155 <tag>inlinegraphic</tag>, <tag>imagedata</tag>, or
28156 <tag>videodata</tag> element) as a sibling to the element,
28157 to specify a path to the location of the image; in HTML
28158 output, the value specified for the
28159 <code>img.src.path</code> attribute is prepended to the
28162 </refsect1><refsect1><title>Parameters</title>
28165 <varlistentry><term>img.src.path="<replaceable>path</replaceable>"</term>
28168 <para>Specifies the pathname to prepend to the name of the image file</para>
28174 </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
28176 <para><parameter>img.src.path</parameter></para>
28178 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
28180 <para><link role="tcg" xlink:href="GraphicsLocations.html#UsingFileref">Using fileref</link></para>
28182 </refsect1></refentry>
28184 <refentry id="dbhtml_label-width" xml:base="../html/pi.xml">
28186 <refname>dbhtml_label-width</refname>
28187 <refpurpose>Specifies the label width for a qandaset</refpurpose>
28191 <synopsis><tag class="xmlpi">dbhtml label-width="<replaceable>width</replaceable>"</tag></synopsis>
28194 <refsect1><title>Description</title>
28196 <para>Use the <tag class="xmlpi">dbhtml label-width</tag> PI as a child of a
28197 <tag>qandaset</tag> to specify the width of labels.</para>
28199 </refsect1><refsect1><title>Parameters</title>
28202 <varlistentry><term>label-width="<replaceable>width</replaceable>"</term>
28205 <para>Specifies the label width (including units)</para>
28211 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
28213 <para><link role="tcg" xlink:href="QandAformat.html">Q and A formatting</link></para>
28215 </refsect1></refentry>
28217 <refentry id="dbhtml_linenumbering.everyNth" xml:base="../html/pi.xml">
28219 <refname>dbhtml_linenumbering.everyNth</refname>
28220 <refpurpose>Specifies interval for line numbers in verbatims</refpurpose>
28224 <synopsis><tag class="xmlpi">dbhtml linenumbering.everyNth="<replaceable>N</replaceable>"</tag></synopsis>
28227 <refsect1><title>Description</title>
28229 <para>Use the <tag class="xmlpi">dbhtml linenumbering.everyNth</tag> PI as a child
28230 of a “verbatim” element – <tag>programlisting</tag>,
28231 <tag>screen</tag>, <tag>synopsis</tag> — to specify
28232 the interval at which lines are numbered.</para>
28234 </refsect1><refsect1><title>Parameters</title>
28237 <varlistentry><term>linenumbering.everyNth="<replaceable>N</replaceable>"</term>
28240 <para>Specifies numbering interval; a number is output
28241 before every <replaceable>N</replaceable>th line</para>
28247 </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
28249 <para><parameter>linenumbering.everyNth</parameter></para>
28251 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
28253 <para><link role="tcg" xlink:href="AnnotateListing.html#LineNumbering">Line numbering</link></para>
28255 </refsect1></refentry>
28257 <refentry id="dbhtml_linenumbering.separator" xml:base="../html/pi.xml">
28259 <refname>dbhtml_linenumbering.separator</refname>
28260 <refpurpose>Specifies separator text for line numbers in verbatims</refpurpose>
28264 <synopsis><tag class="xmlpi">dbhtml linenumbering.separator="<replaceable>text</replaceable>"</tag></synopsis>
28267 <refsect1><title>Description</title>
28269 <para>Use the <tag class="xmlpi">dbhtml linenumbering.separator</tag> PI as a child
28270 of a “verbatim” element – <tag>programlisting</tag>,
28271 <tag>screen</tag>, <tag>synopsis</tag> — to specify
28272 the separator text output between the line numbers and content.</para>
28274 </refsect1><refsect1><title>Parameters</title>
28277 <varlistentry><term>linenumbering.separator="<replaceable>text</replaceable>"</term>
28280 <para>Specifies the text (zero or more characters)</para>
28286 </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
28288 <para><parameter>linenumbering.separator</parameter></para>
28290 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
28292 <para><link role="tcg" xlink:href="AnnotateListing.html#LineNumbering">Line numbering</link></para>
28294 </refsect1></refentry>
28296 <refentry id="dbhtml_linenumbering.width" xml:base="../html/pi.xml">
28298 <refname>dbhtml_linenumbering.width</refname>
28299 <refpurpose>Specifies width for line numbers in verbatims</refpurpose>
28303 <synopsis><tag class="xmlpi">dbhtml linenumbering.width="<replaceable>width</replaceable>"</tag></synopsis>
28306 <refsect1><title>Description</title>
28308 <para>Use the <tag class="xmlpi">dbhtml linenumbering.width</tag> PI as a child
28309 of a “verbatim” element – <tag>programlisting</tag>,
28310 <tag>screen</tag>, <tag>synopsis</tag> — to specify
28311 the width set aside for line numbers.</para>
28313 </refsect1><refsect1><title>Parameters</title>
28316 <varlistentry><term>linenumbering.width="<replaceable>width</replaceable>"</term>
28319 <para>Specifies the width (inluding units)</para>
28325 </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
28327 <para><parameter>linenumbering.width</parameter></para>
28329 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
28331 <para><link role="tcg" xlink:href="AnnotateListing.html#LineNumbering">Line numbering</link></para>
28333 </refsect1></refentry>
28335 <refentry id="dbhtml_list-presentation" xml:base="../html/pi.xml">
28337 <refname>dbhtml_list-presentation</refname>
28338 <refpurpose>Specifies presentation style for a variablelist or
28339 segmentedlist</refpurpose>
28343 <synopsis><tag class="xmlpi">dbhtml list-presentation="list"|"table"</tag></synopsis>
28346 <refsect1><title>Description</title>
28348 <para>Use the <tag class="xmlpi">dbhtml list-presentation</tag> PI as a child of
28349 a <tag>variablelist</tag> or <tag>segmentedlist</tag> to
28350 control the presentation style for the list (to cause it, for
28351 example, to be displayed as a table).</para>
28353 </refsect1><refsect1><title>Parameters</title>
28356 <varlistentry><term>list-presentation="list"</term>
28359 <para>Displays the list as a list</para>
28363 <varlistentry><term>list-presentation="table"</term>
28366 <para>Displays the list as a table</para>
28372 </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
28377 <para><parameter>variablelist.as.table</parameter></para>
28382 <para><parameter>segmentedlist.as.table</parameter></para>
28387 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
28389 <para><link role="tcg" xlink:href="Variablelists.html#VarListFormatting">Variable list formatting in HTML</link></para>
28391 </refsect1></refentry>
28393 <refentry id="dbhtml_list-width" xml:base="../html/pi.xml">
28395 <refname>dbhtml_list-width</refname>
28396 <refpurpose>Specifies the width of a variablelist or simplelist</refpurpose>
28400 <synopsis><tag class="xmlpi">dbhtml list-width="<replaceable>width</replaceable>"</tag></synopsis>
28403 <refsect1><title>Description</title>
28405 <para>Use the <tag class="xmlpi">dbhtml list-width</tag> PI as a child of a
28406 <tag>variablelist</tag> or a <tag>simplelist</tag> presented
28407 as a table, to specify the output width.</para>
28409 </refsect1><refsect1><title>Parameters</title>
28412 <varlistentry><term>list-width="<replaceable>width</replaceable>"</term>
28415 <para>Specifies the output width (including units)</para>
28421 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
28423 <para><link role="tcg" xlink:href="Variablelists.html#VarListFormatting">Variable list formatting in HTML</link></para>
28425 </refsect1></refentry>
28427 <refentry id="dbhtml_row-height" xml:base="../html/pi.xml">
28429 <refname>dbhtml_row-height</refname>
28430 <refpurpose>Specifies the height for a CALS table row</refpurpose>
28434 <synopsis><tag class="xmlpi">dbhtml row-height="<replaceable>height</replaceable>"</tag></synopsis>
28437 <refsect1><title>Description</title>
28439 <para>Use the <tag class="xmlpi">dbhtml row-height</tag> PI as a child of a
28440 <tag>row</tag> to specify the height of the row.</para>
28442 </refsect1><refsect1><title>Parameters</title>
28445 <varlistentry><term>row-height="<replaceable>height</replaceable>"</term>
28448 <para>Specifies the row height (including units)</para>
28454 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
28456 <para><link role="tcg" xlink:href="RowHeight.html">Row height</link></para>
28458 </refsect1></refentry>
28460 <refentry id="dbhtml_start" xml:base="../html/pi.xml">
28462 <refname>dbhtml_start</refname>
28463 <refpurpose>(obsolete) Sets the starting number on an ordered list</refpurpose>
28467 <synopsis><tag class="xmlpi">dbhtml start="<replaceable>character</replaceable>"</tag></synopsis>
28470 <refsect1><title>Description</title>
28472 <para><emphasis>This PI is obsolete</emphasis>. The intent of
28473 this PI was to provide a means for setting a specific starting
28474 number for an ordered list. Instead of this PI, set a value
28475 for the <literal>override</literal> attribute on the first
28476 <tag>listitem</tag> in the list; that will have the same
28477 effect as what this PI was intended for.</para>
28479 </refsect1><refsect1><title>Parameters</title>
28482 <varlistentry><term>start="<replaceable>character</replaceable>"</term>
28485 <para>Specifies the character to use as the starting
28486 number; use 0-9, a-z, A-Z, or lowercase or uppercase
28487 Roman numerals</para>
28493 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
28495 <para><link role="tcg" xlink:href="Orderedlists.html#ListStartNum">List starting number</link></para>
28497 </refsect1></refentry>
28499 <refentry id="dbhtml_stop-chunking" xml:base="../html/pi.xml">
28501 <refname>dbhtml_stop-chunking</refname>
28502 <refpurpose>Do not chunk any descendants of this element.</refpurpose>
28506 <synopsis><tag class="xmlpi">dbhtml stop-chunking</tag></synopsis>
28509 <refsect1><title>Description</title>
28511 <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:
28512 <programlisting><section>
28513 <title>Configuring pencil</title>
28514 <?dbhtml stop-chunking?>
28518 </section></programlisting>
28521 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
28523 <para><link role="tcg" xlink:href="Chunking.html">Chunking into multiple HTML files</link></para>
28525 </refsect1></refentry>
28527 <refentry id="dbhtml_table-summary" xml:base="../html/pi.xml">
28529 <refname>dbhtml_table-summary</refname>
28530 <refpurpose>Specifies summary for CALS table, variablelist, segmentedlist, or qandaset output</refpurpose>
28534 <synopsis><tag class="xmlpi">dbhtml table-summary="<replaceable>text</replaceable>"</tag></synopsis>
28537 <refsect1><title>Description</title>
28539 <para>Use the <tag class="xmlpi">dbhtml table-summary</tag> PI as a child of
28540 a CALS <tag>table</tag>, <tag>variablelist</tag>,
28541 <tag>segmentedlist</tag>, or <tag>qandaset</tag> to specify
28542 the text for the HTML <literal>summary</literal> attribute
28543 in the output HTML table.</para>
28545 </refsect1><refsect1><title>Parameters</title>
28548 <varlistentry><term>table-summary="<replaceable>text</replaceable>"</term>
28551 <para>Specifies the summary text (zero or more characters)</para>
28557 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
28559 <para><link role="tcg" xlink:href="Variablelists.html#VarListFormatting">Variable list formatting in HTML</link>,
28560 <link role="tcg" xlink:href="TableSummary.html">Table summary text</link></para>
28562 </refsect1></refentry>
28564 <refentry id="dbhtml_table-width" xml:base="../html/pi.xml">
28566 <refname>dbhtml_table-width</refname>
28567 <refpurpose>Specifies the width for a CALS table</refpurpose>
28571 <synopsis><tag class="xmlpi">dbhtml table-width="<replaceable>width</replaceable>"</tag></synopsis>
28574 <refsect1><title>Description</title>
28576 <para>Use the <tag class="xmlpi">dbhtml table-width</tag> PI as a child of a
28577 CALS <tag>table</tag> to specify the width of the table in
28580 </refsect1><refsect1><title>Parameters</title>
28583 <varlistentry><term>table-width="<replaceable>width</replaceable>"</term>
28586 <para>Specifies the table width (including units or as a percentage)</para>
28592 </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
28594 <para><parameter>default.table.width</parameter></para>
28596 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
28598 <para><link role="tcg" xlink:href="Tables.html#TableWidth">Table width</link></para>
28600 </refsect1></refentry>
28602 <refentry id="dbhtml_term-presentation" xml:base="../html/pi.xml">
28604 <refname>dbhtml_term-presentation</refname>
28605 <refpurpose>Sets character formatting for terms in a variablelist</refpurpose>
28609 <synopsis><tag class="xmlpi">dbhtml term-presentation="bold"|"italic"|"bold-italic"</tag></synopsis>
28612 <refsect1><title>Description</title>
28614 <para>Use the <tag class="xmlpi">dbhtml term-presentation</tag> PI as a child
28615 of a <tag>variablelist</tag> to set character formatting for
28616 the <tag>term</tag> output of the list.</para>
28618 </refsect1><refsect1><title>Parameters</title>
28621 <varlistentry><term>term-presentation="<replaceable>bold</replaceable>"</term>
28624 <para>Specifies that terms are displayed in bold</para>
28628 <varlistentry><term>term-presentation="<replaceable>italic</replaceable>"</term>
28631 <para>Specifies that terms are displayed in italic</para>
28635 <varlistentry><term>term-presentation="<replaceable>bold-italic</replaceable>"</term>
28638 <para>Specifies that terms are displayed in bold-italic</para>
28644 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
28646 <para><link role="tcg" xlink:href="Variablelists.html#VarListFormatting">Variable list formatting in HTML</link></para>
28648 </refsect1></refentry>
28650 <refentry id="dbhtml_term-separator" xml:base="../html/pi.xml">
28652 <refname>dbhtml_term-separator</refname>
28653 <refpurpose>Specifies separator text among terms in a varlistentry</refpurpose>
28657 <synopsis><tag class="xmlpi">dbhtml term-separator="<replaceable>text</replaceable>"</tag></synopsis>
28660 <refsect1><title>Description</title>
28662 <para>Use the <tag class="xmlpi">dbhtml term-separator</tag> PI as a child
28663 of a <tag>variablelist</tag> to specify the separator text
28664 among <tag>term</tag> instances.</para>
28666 </refsect1><refsect1><title>Parameters</title>
28669 <varlistentry><term>term-separator="<replaceable>text</replaceable>"</term>
28672 <para>Specifies the text (zero or more characters)</para>
28678 </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
28680 <para><parameter>variablelist.term.separator</parameter></para>
28682 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
28684 <para><link role="tcg" xlink:href="Variablelists.html#VarListFormatting">Variable list formatting in HTML</link></para>
28686 </refsect1></refentry>
28688 <refentry id="dbhtml_term-width" xml:base="../html/pi.xml">
28690 <refname>dbhtml_term-width</refname>
28691 <refpurpose>Specifies the term width for a variablelist</refpurpose>
28695 <synopsis><tag class="xmlpi">dbhtml term-width="<replaceable>width</replaceable>"</tag></synopsis>
28698 <refsect1><title>Description</title>
28700 <para>Use the <tag class="xmlpi">dbhtml term-width</tag> PI as a child of a
28701 <tag>variablelist</tag> to specify the width for
28702 <tag>term</tag> output.</para>
28704 </refsect1><refsect1><title>Parameters</title>
28707 <varlistentry><term>term-width="<replaceable>width</replaceable>"</term>
28710 <para>Specifies the term width (including units)</para>
28716 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
28718 <para><link role="tcg" xlink:href="Variablelists.html#VarListFormatting">Variable list formatting in HTML</link></para>
28720 </refsect1></refentry>
28722 <refentry id="dbhtml_toc" xml:base="../html/pi.xml">
28724 <refname>dbhtml_toc</refname>
28725 <refpurpose>Specifies whether a TOC should be generated for a qandaset</refpurpose>
28729 <synopsis><tag class="xmlpi">dbhtml toc="0"|"1"</tag></synopsis>
28732 <refsect1><title>Description</title>
28734 <para>Use the <tag class="xmlpi">dbhtml toc</tag> PI as a child of a
28735 <tag>qandaset</tag> to specify whether a table of contents
28736 (TOC) is generated for the <tag>qandaset</tag>.</para>
28738 </refsect1><refsect1><title>Parameters</title>
28741 <varlistentry><term>toc="0"</term>
28744 <para>If zero, no TOC is generated</para>
28748 <varlistentry><term>toc="1"</term>
28751 <para>If <code>1</code> (or any non-zero value),
28752 a TOC is generated</para>
28758 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
28760 <para><link role="tcg" xlink:href="QandAtoc.html">Q and A list of questions</link>,
28761 <link role="tcg" xlink:href="QandAformat.html">Q and A formatting</link></para>
28763 </refsect1></refentry>
28765 <refentry id="dbcmdlist" xml:base="../html/pi.xml">
28767 <refname>dbcmdlist</refname>
28768 <refpurpose>Generates a hyperlinked list of commands</refpurpose>
28772 <synopsis><tag class="xmlpi">dbcmdlist</tag></synopsis>
28775 <refsect1><title>Description</title>
28777 <para>Use the <tag class="xmlpi">dbcmdlist</tag> PI as the child of any
28778 element (for example, <tag>refsynopsisdiv</tag>) containing multiple
28779 <tag>cmdsynopsis</tag> instances; a hyperlinked navigational
28780 “command list” will be generated at the top of output for that
28781 element, enabling users to quickly jump
28782 to each command synopsis.</para>
28784 </refsect1><refsect1><title>Parameters</title>
28786 <para>[No parameters]</para>
28788 </refsect1></refentry>
28790 <refentry id="dbfunclist" xml:base="../html/pi.xml">
28792 <refname>dbfunclist</refname>
28793 <refpurpose>Generates a hyperlinked list of functions</refpurpose>
28797 <synopsis><tag class="xmlpi">dbfunclist</tag></synopsis>
28800 <refsect1><title>Description</title>
28802 <para>Use the <tag class="xmlpi">dbfunclist</tag> PI as the child of any
28803 element (for example, <tag>refsynopsisdiv</tag>) containing multiple
28804 <tag>funcsynopsis</tag> instances; a hyperlinked
28805 navigational “function list” will be generated at the top of
28806 output for that element, enabling users to quickly
28807 jump to to each function synopsis.</para>
28809 </refsect1><refsect1><title>Parameters</title>
28811 <para>[No parameters]</para>
28813 </refsect1></refentry>
28815 <refentry id="dbhtml-include_href" xml:base="../html/pi.xml">
28817 <refname>dbhtml-include_href</refname>
28818 <refpurpose>Copies an external well-formed HTML/XML file into current doc</refpurpose>
28822 <synopsis><tag class="xmlpi">dbhtml-include href="<replaceable>URI</replaceable>"</tag></synopsis>
28825 <refsect1><title>Description</title>
28827 <para>Use the <tag class="xmlpi">dbhtml-include href</tag> PI anywhere in a
28828 document to cause the contents of the file referenced by the
28829 <code>href</code> pseudo-attribute to be copied/inserted “as
28830 is” into your HTML output at the point in document order
28831 where the PI occurs in the source.</para>
28835 <para>The referenced file may contain plain text (as long as
28836 it is “wrapped” in an <tag>html</tag> element — see the
28837 note below) or markup in any arbitrary vocabulary,
28838 including HTML — but it must conform to XML
28839 well-formedness constraints (because the feature in XSLT
28840 1.0 for opening external files, the
28841 <function>document()</function> function, can only handle
28842 files that meet XML well-formedness constraints).</para>
28845 <para>Among other things, XML well-formedness constraints
28846 require a document to have <emphasis>a single root
28847 element</emphasis>. So if the content you want to
28848 include is plain text or is markup that does
28849 <emphasis>not</emphasis> have a single root element,
28850 <emphasis role="strong">wrap the content in an
28851 <tag>html</tag> element</emphasis>. The stylesheets will
28852 strip out that surrounding <tag>html</tag> “wrapper” when
28853 they find it, leaving just the content you want to
28857 </refsect1><refsect1><title>Parameters</title>
28860 <varlistentry><term>href="<replaceable>URI</replaceable>"</term>
28863 <para>Specifies the URI for the file to include; the URI
28864 can be, for example, a remote <literal>http:</literal>
28865 URI, or a local filesystem <literal>file:</literal>
28872 </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
28874 <para><parameter>textinsert.extension</parameter></para>
28876 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
28878 <para><link role="tcg" xlink:href="InsertExtHtml.html">Inserting external HTML code</link>,
28879 <link role="tcg" xlink:href="ExternalCode.html">External code files</link></para>
28881 </refsect1></refentry>
28883 <refentry id="dbhh" xml:base="../html/pi.xml">
28885 <refname>dbhh</refname>
28886 <refpurpose>Sets topic name and topic id for context-sensitive HTML Help</refpurpose>
28890 <synopsis><tag class="xmlpi">dbhh topicname="<replaceable>name</replaceable>" topicid="<replaceable>id</replaceable>"</tag></synopsis>
28893 <refsect1><title>Description</title>
28895 <para>Use the <tag class="xmlpi">dbhh</tag> PI as a child of components
28896 that should be used as targets for context-sensitive help requests.</para>
28898 </refsect1><refsect1><title>Parameters</title>
28901 <varlistentry><term>topicname="<replaceable>name</replaceable>"</term>
28904 <para>Specifies a unique string constant that identifies a help topic</para>
28908 <varlistentry><term>topicid="<replaceable>id</replaceable>"</term>
28911 <para>Specifies a unique integer value for the <literal>topicname</literal> string</para>
28917 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
28919 <para><link role="tcg" xlink:href="HtmlHelp.html#HHContextHelp">Context-sensitive help</link></para>
28921 </refsect1></refentry>
28925 <info xml:base="../fo/pi.xml"><title>FO Processing Instruction Reference</title>
28926 <releaseinfo role="meta">
28927 $Id: pi.xsl 8487 2009-07-14 21:43:36Z bobstayton $
28931 <partintro id="partintro" xml:base="../fo/pi.xml">
28932 <title>Introduction</title>
28935 <para>This is generated reference documentation for all
28936 user-specifiable processing instructions (PIs) in the DocBook
28937 XSL stylesheets for FO output.
28940 <para>You add these PIs at particular points in a document to
28941 cause specific “exceptions” to formatting/output behavior. To
28942 make global changes in formatting/output behavior across an
28943 entire document, it’s better to do it by setting an
28944 appropriate stylesheet parameter (if there is one).</para>
28951 <refentry id="dbfo_background-color" xml:base="../fo/pi.xml">
28953 <refname>dbfo_background-color</refname>
28954 <refpurpose>Sets background color for an image</refpurpose>
28958 <synopsis><tag class="xmlpi">dbfo background-color="<replaceable>color</replaceable>"</tag></synopsis>
28961 <refsect1><title>Description</title>
28963 <para>Use the <tag class="xmlpi">dbfo background-color</tag> PI before or
28964 after an image (<tag>graphic</tag>, <tag>inlinegraphic</tag>,
28965 <tag>imagedata</tag>, or <tag>videodata</tag> element) as a
28966 sibling to the element, to set a background color for the
28969 </refsect1><refsect1><title>Parameters</title>
28972 <varlistentry><term>background-color="<replaceable>color</replaceable>"</term>
28975 <para>An HTML color value</para>
28981 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
28983 <para><link role="tcg" xlink:href="BGcolor.html">Background color</link></para>
28985 </refsect1></refentry>
28987 <refentry id="dbfo_bgcolor" xml:base="../fo/pi.xml">
28989 <refname>dbfo_bgcolor</refname>
28990 <refpurpose>Sets background color on a table row or table cell</refpurpose>
28994 <synopsis><tag class="xmlpi">dbfo bgcolor="<replaceable>color</replaceable>"</tag></synopsis>
28997 <refsect1><title>Description</title>
28999 <para>Use the <tag class="xmlpi">dbfo bgcolor</tag> PI as child of a table row
29000 or cell to set a background color for that table row or cell.</para>
29003 <para>This PI works for both CALS and HTML tables.</para>
29005 </refsect1><refsect1><title>Parameters</title>
29008 <varlistentry><term>bgcolor="<replaceable>color</replaceable>"</term>
29011 <para>An HTML color value</para>
29017 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
29019 <para><link role="tcg" xlink:href="BGtableColor.html#CellBGColor">Cell background color</link></para>
29021 </refsect1></refentry>
29023 <refentry id="dbfo_float-type" xml:base="../fo/pi.xml">
29025 <refname>dbfo_float-type</refname>
29026 <refpurpose>Specifies float behavior for a sidebar</refpurpose>
29030 <synopsis><tag class="xmlpi">dbfo float-type="margin.note"</tag></synopsis>
29033 <refsect1><title>Description</title>
29035 <para>Use the <tag class="xmlpi">dbfo float-type</tag> PI to specify the float
29036 behavior for a <tag>sidebar</tag> (to cause the sidebar to be
29037 displayed as a marginal note).</para>
29039 </refsect1><refsect1><title>Parameters</title>
29042 <varlistentry><term>float-type="margin.note"</term>
29045 <para>Specifies that the <tag>sidebar</tag> should be
29046 displayed as a marginal note.</para>
29052 </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
29054 <para><parameter>sidebar.float.type</parameter> (parameter),
29055 <parameter>sidebar.float.width</parameter> (parameter),
29056 <parameter>sidebar.properties</parameter> (attribute-set),
29057 <parameter>sidebar.title.properties</parameter> (attribute-set)
29060 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
29062 <para><link role="tcg" xlink:href="SideFloats.html#SidebarFloats">A sidebar as
29063 side float</link></para>
29065 </refsect1></refentry>
29067 <refentry id="dbfo_funcsynopsis-style" xml:base="../fo/pi.xml">
29069 <refname>dbfo_funcsynopsis-style</refname>
29070 <refpurpose>Specifies presentation style for a funcsynopsis</refpurpose>
29074 <synopsis><tag class="xmlpi">dbfo funcsynopsis-style="kr"|"ansi"</tag></synopsis>
29077 <refsect1><title>Description</title>
29079 <para>Use the <tag class="xmlpi">dbfo funcsynopsis-style</tag> PI as a child of
29080 a <tag>funcsynopsis</tag> or anywhere within a funcsynopsis
29081 to control the presentation style for output of all
29082 <tag>funcprototype</tag> instances within that funcsynopsis.</para>
29084 </refsect1><refsect1><title>Parameters</title>
29087 <varlistentry><term>funcsynopsis-style="kr"</term>
29090 <para>Displays <tag>funcprototype</tag> output in K&R style</para>
29094 <varlistentry><term>funcsynopsis-style="ansi"</term>
29097 <para>Displays <tag>funcprototype</tag> output in ANSI style</para>
29103 </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
29105 <para><parameter>funcsynopsis.style</parameter></para>
29107 </refsect1></refentry>
29109 <refentry id="dbfo_glossary-presentation" xml:base="../fo/pi.xml">
29111 <refname>dbfo_glossary-presentation</refname>
29112 <refpurpose>Specifies presentation style for a glossary</refpurpose>
29116 <synopsis><tag class="xmlpi">dbfo glossary-presentation="list"|"blocks"</tag></synopsis>
29119 <refsect1><title>Description</title>
29121 <para>Use the <tag class="xmlpi">dbfo glossary-presentation</tag> PI as a child of
29122 a <tag>glossary</tag> to control its presentation style.</para>
29124 </refsect1><refsect1><title>Parameters</title>
29127 <varlistentry><term>glossary-presentation="list"</term>
29130 <para>Displays the glossary as a list</para>
29134 <varlistentry><term>glossary-presentation="blocks"</term>
29137 <para>Displays the glossary as blocks</para>
29143 </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
29145 <para><parameter>glossary.as.blocks</parameter></para>
29147 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
29149 <para><link role="tcg" xlink:href="Glossaries.html#GlossaryFormatPrint">Glossary
29150 formatting in print</link></para>
29152 </refsect1></refentry>
29154 <refentry id="dbfo_glosslist-presentation" xml:base="../fo/pi.xml">
29156 <refname>dbfo_glosslist-presentation</refname>
29157 <refpurpose>Specifies presentation style for a glosslist</refpurpose>
29161 <synopsis><tag class="xmlpi">dbfo glosslist-presentation="list"|"blocks"</tag></synopsis>
29164 <refsect1><title>Description</title>
29166 <para>Use the <tag class="xmlpi">dbfo glosslist-presentation</tag> PI as a child of
29167 a <tag>glosslist</tag> to control its presentation style.</para>
29169 </refsect1><refsect1><title>Parameters</title>
29172 <varlistentry><term>glosslist-presentation="list"</term>
29175 <para>Displays the glosslist as a list</para>
29179 <varlistentry><term>glosslist-presentation="blocks"</term>
29182 <para>Displays the glosslist as blocks</para>
29188 </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
29190 <para><parameter>glosslist.as.blocks</parameter> </para>
29192 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
29194 <para><link role="tcg" xlink:href="Glossaries.html#GlossaryFormatPrint">Glossary
29195 formatting in print</link></para>
29197 </refsect1></refentry>
29199 <refentry id="dbfo_glossterm-width" xml:base="../fo/pi.xml">
29201 <refname>dbfo_glossterm-width</refname>
29202 <refpurpose>Specifies the glossterm width for a glossary or
29203 glosslist</refpurpose>
29207 <synopsis><tag class="xmlpi">dbfo glossterm-width="<replaceable>width</replaceable>"</tag></synopsis>
29210 <refsect1><title>Description</title>
29212 <para>Use the <tag class="xmlpi">dbfo glossterm-width</tag> PI as a child of a
29213 <tag>glossary</tag> or <tag>glosslist</tag> to specify the
29214 width for output of <tag>glossterm</tag> instances in the
29217 </refsect1><refsect1><title>Parameters</title>
29220 <varlistentry><term>glossterm-width="<replaceable>width</replaceable>"</term>
29223 <para>Specifies the glossterm width (including units)</para>
29229 </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
29231 <para><parameter>glossterm.width</parameter>,
29232 <parameter>glossterm.separation</parameter>
29235 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
29237 <para><link role="tcg" xlink:href="Glossaries.html#GlossaryFormatPrint">Glossary
29238 formatting in print</link></para>
29240 </refsect1></refentry>
29242 <refentry id="dbfo_keep-together" xml:base="../fo/pi.xml">
29244 <refname>dbfo_keep-together</refname>
29245 <refpurpose>Specifies “keep” behavior for a table, example,
29246 figure, equation, procedure, or task</refpurpose>
29250 <synopsis><tag class="xmlpi">dbfo keep-together="auto"|"always"</tag></synopsis>
29253 <refsect1><title>Description</title>
29255 <para>Use the <tag class="xmlpi">dbfo keep-together</tag> PI as a child of a
29256 formal object (<tag>table</tag>, <tag>example</tag>,
29257 <tag>figure</tag>, <tag>equation</tag>, <tag>procedure</tag>, or
29258 <tag>task</tag>) to specify “keep” behavior (to allow the object to
29259 “break” across a page).</para>
29262 <para>The PI also works with <tag>informaltable</tag>, <tag>informalexample</tag>,
29263 <tag>informalfigure</tag> and <tag>informalequation</tag>.
29267 </refsect1><refsect1><title>Parameters</title>
29270 <varlistentry><term>keep-together="auto"</term>
29273 <para>Enables the object to break across a page</para>
29277 <varlistentry><term>keep-together="always"</term>
29280 <para>Prevents the object from breaking across a page (the
29281 default stylesheet behavior)</para>
29287 </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
29289 <para>formal.object.properties</para>
29291 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
29293 <para><link role="tcg" xlink:href="PageBreaking.html#KeepTogetherPI">Keep-together processing instruction</link></para>
29295 </refsect1></refentry>
29297 <refentry id="dbfo_label-width" xml:base="../fo/pi.xml">
29299 <refname>dbfo_label-width</refname>
29300 <refpurpose>Specifies the label width for a qandaset, itemizedlist, orderedlist
29301 or calloutlist</refpurpose>
29305 <synopsis><tag class="xmlpi">dbfo label-width="<replaceable>width</replaceable>"</tag></synopsis>
29308 <refsect1><title>Description</title>
29310 <para>Use the <tag class="xmlpi">dbfo label-width</tag> PI as a child of a
29311 <tag>qandaset</tag>, <tag>itemizedlist</tag>, <tag>orderedlist</tag>,
29312 or <tag>calloutlist</tag> to specify the width of labels.</para>
29314 </refsect1><refsect1><title>Parameters</title>
29317 <varlistentry><term>label-width="<replaceable>width</replaceable>"</term>
29320 <para>Specifies the label width (including units)</para>
29326 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
29328 <para><link role="tcg" xlink:href="QandAformat.html">Q and A formatting</link></para>
29330 </refsect1></refentry>
29332 <refentry id="dbfo_linenumbering.everyNth" xml:base="../fo/pi.xml">
29334 <refname>dbfo_linenumbering.everyNth</refname>
29335 <refpurpose>Specifies interval for line numbers in verbatims</refpurpose>
29339 <synopsis><tag class="xmlpi">dbfo linenumbering.everyNth="<replaceable>N</replaceable>"</tag></synopsis>
29342 <refsect1><title>Description</title>
29344 <para>Use the <tag class="xmlpi">dbfo linenumbering.everyNth</tag> PI as a child
29345 of a “verbatim” element – <tag>programlisting</tag>,
29346 <tag>screen</tag>, <tag>synopsis</tag> — to specify
29347 the interval at which lines are numbered.</para>
29349 </refsect1><refsect1><title>Parameters</title>
29352 <varlistentry><term>linenumbering.everyNth="<replaceable>N</replaceable>"</term>
29355 <para>Specifies numbering interval; a number is output
29356 before every <replaceable>N</replaceable>th line</para>
29362 </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
29364 <para><parameter>linenumbering.everyNth</parameter></para>
29366 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
29368 <para><link role="tcg" xlink:href="AnnotateListing.html#LineNumbering">Line numbering</link></para>
29370 </refsect1></refentry>
29372 <refentry id="dbfo_linenumbering.separator" xml:base="../fo/pi.xml">
29374 <refname>dbfo_linenumbering.separator</refname>
29375 <refpurpose>Specifies separator text for line numbers in verbatims</refpurpose>
29379 <synopsis><tag class="xmlpi">dbfo linenumbering.separator="<replaceable>text</replaceable>"</tag></synopsis>
29382 <refsect1><title>Description</title>
29384 <para>Use the <tag class="xmlpi">dbfo linenumbering.separator</tag> PI as a child
29385 of a “verbatim” element – <tag>programlisting</tag>,
29386 <tag>screen</tag>, <tag>synopsis</tag> — to specify
29387 the separator text output between the line numbers and content.</para>
29389 </refsect1><refsect1><title>Parameters</title>
29392 <varlistentry><term>linenumbering.separator="<replaceable>text</replaceable>"</term>
29395 <para>Specifies the text (zero or more characters)</para>
29401 </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
29403 <para><parameter>linenumbering.separator</parameter></para>
29405 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
29407 <para><link role="tcg" xlink:href="AnnotateListing.html#LineNumbering">Line numbering</link></para>
29409 </refsect1></refentry>
29411 <refentry id="dbfo_linenumbering.width" xml:base="../fo/pi.xml">
29413 <refname>dbfo_linenumbering.width</refname>
29414 <refpurpose>Specifies width for line numbers in verbatims</refpurpose>
29418 <synopsis><tag class="xmlpi">dbfo linenumbering.width="<replaceable>width</replaceable>"</tag></synopsis>
29421 <refsect1><title>Description</title>
29423 <para>Use the <tag class="xmlpi">dbfo linenumbering.width</tag> PI as a child
29424 of a “verbatim” element – <tag>programlisting</tag>,
29425 <tag>screen</tag>, <tag>synopsis</tag> — to specify
29426 the width set aside for line numbers.</para>
29428 </refsect1><refsect1><title>Parameters</title>
29431 <varlistentry><term>linenumbering.width="<replaceable>width</replaceable>"</term>
29434 <para>Specifies the width (inluding units)</para>
29440 </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
29442 <para><parameter>linenumbering.width</parameter></para>
29444 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
29446 <para><link role="tcg" xlink:href="AnnotateListing.html#LineNumbering">Line numbering</link></para>
29448 </refsect1></refentry>
29450 <refentry id="dbfo_list-presentation" xml:base="../fo/pi.xml">
29452 <refname>dbfo_list-presentation</refname>
29453 <refpurpose>Specifies presentation style for a variablelist or
29454 segmentedlist</refpurpose>
29458 <synopsis><tag class="xmlpi">dbfo list-presentation="list"|"blocks"|"table"</tag></synopsis>
29461 <refsect1><title>Description</title>
29463 <para>Use the <tag class="xmlpi">dbfo list-presentation</tag> PI as a child of
29464 a <tag>variablelist</tag> or <tag>segmentedlist</tag> to
29465 control the presentation style for the list (to cause it, for
29466 example, to be displayed as a table).</para>
29468 </refsect1><refsect1><title>Parameters</title>
29471 <varlistentry><term>list-presentation="list"</term>
29474 <para>Displays the list as a list</para>
29478 <varlistentry><term>list-presentation="blocks"</term>
29481 <para>(<tag>variablelist</tag> only) Displays the list as blocks</para>
29485 <varlistentry><term>list-presentation="table"</term>
29488 <para>(<tag>segmentedlist</tag> only) Displays the list as a table</para>
29494 </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
29499 <para><parameter>variablelist.as.blocks</parameter></para>
29504 <para><parameter>variablelist.as.table</parameter></para>
29509 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
29511 <para><link role="tcg" xlink:href="Variablelists.html#ListIndents">Variable list formatting in print</link></para>
29513 </refsect1></refentry>
29515 <refentry id="dbfo_list-width" xml:base="../fo/pi.xml">
29517 <refname>dbfo_list-width</refname>
29518 <refpurpose>Specifies the width of a horizontal simplelist</refpurpose>
29522 <synopsis><tag class="xmlpi">dbfo list-width="<replaceable>width</replaceable>"</tag></synopsis>
29525 <refsect1><title>Description</title>
29527 <para>Use the <tag class="xmlpi">dbfo list-width</tag> PI as a child of a
29528 <tag>simplelist</tag> whose <tag class="attribute">class</tag>
29529 value is <literal>horizontal</literal>, to specify the width
29530 of the <tag>simplelist</tag>.</para>
29532 </refsect1><refsect1><title>Parameters</title>
29535 <varlistentry><term>list-width="<replaceable>width</replaceable>"</term>
29538 <para>Specifies the <tag>simplelist</tag> width (including units)</para>
29544 </refsect1></refentry>
29546 <refentry id="dbfo_orientation" xml:base="../fo/pi.xml">
29548 <refname>dbfo_orientation</refname>
29549 <refpurpose>Specifies the orientation for a CALS table row or cell</refpurpose>
29553 <synopsis><tag class="xmlpi">dbfo orientation="0"|"90"|"180"|"270"|"-90"|"-180"|"-270"</tag></synopsis>
29556 <refsect1><title>Description</title>
29558 <para>Use the <tag class="xmlpi">dbfo orientation</tag> PI as a child of a CALS
29559 <tag>table</tag> row or cell to specify the orientation
29560 (rotation) for the row or cell.</para>
29562 </refsect1><refsect1><title>Parameters</title>
29565 <varlistentry><term>orientation="0"|"90"|"180"|"270"|"-90"|"-180"|"-270"</term>
29568 <para>Specifies the number of degrees by which the cell or
29569 row is rotated</para>
29575 </refsect1></refentry>
29577 <refentry id="dbfo_pgwide" xml:base="../fo/pi.xml">
29579 <refname>dbfo_pgwide</refname>
29580 <refpurpose>Specifies if an <tag>equation</tag> or <tag>example</tag> goes across full page width</refpurpose>
29584 <synopsis><tag class="xmlpi">dbfo pgwide="0"|"1"</tag></synopsis>
29587 <refsect1><title>Description</title>
29589 <para>Use the <tag class="xmlpi">dbfo pgwide</tag> PI as a child of an
29590 <tag>equation</tag> or <tag>example</tag> to specify that the
29591 content should rendered across the full width of the page.</para>
29593 </refsect1><refsect1><title>Parameters</title>
29596 <varlistentry><term>pgwide="0"</term>
29599 <para>If zero, the content is rendered across the current
29604 <varlistentry><term>pgwide="1"</term>
29607 <para>If <code>1</code> (or any non-zero value), the
29608 content is rendered across the full width of the page</para>
29614 </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
29616 <para><parameter>pgwide.properties</parameter></para>
29618 </refsect1></refentry>
29620 <refentry id="dbfo_rotated-width" xml:base="../fo/pi.xml">
29622 <refname>dbfo_rotated-width</refname>
29623 <refpurpose>Specifies the width for a CALS table <tag>entry</tag> or
29624 <tag>row</tag></refpurpose>
29628 <synopsis><tag class="xmlpi">dbfo rotated-width="<replaceable>width</replaceable>"</tag></synopsis>
29631 <refsect1><title>Description</title>
29633 <para>Use the <tag class="xmlpi">dbfo rotated-width</tag> PI as a child of
29634 <tag>entry</tag> or <tag>row</tag> instance in a CALS table to specify the
29635 width of that the <tag>entry</tag> or <tag>row</tag>; or
29636 use it higher up in table to cause the width to be inherited
29637 recursively down.</para>
29639 </refsect1><refsect1><title>Parameters</title>
29642 <varlistentry><term>rotated-width="<replaceable>width</replaceable>"</term>
29645 <para>Specifies the width of a row or cell (including units)</para>
29651 </refsect1></refentry>
29653 <refentry id="dbfo_sidebar-width" xml:base="../fo/pi.xml">
29655 <refname>dbfo_sidebar-width</refname>
29656 <refpurpose>Specifies the width of a sidebar</refpurpose>
29660 <synopsis><tag class="xmlpi">dbfo sidebar-width="<replaceable>width</replaceable>"</tag></synopsis>
29663 <refsect1><title>Description</title>
29665 <para>Use the <tag class="xmlpi">dbfo sidebar-width</tag> PI as a child of a
29666 <tag>sidebar</tag> to specify the width of the sidebar.</para>
29668 </refsect1><refsect1><title>Parameters</title>
29671 <varlistentry><term>sidebar-width="<replaceable>width</replaceable>"</term>
29674 <para>Specifies the <tag>sidebar</tag> width (including units)</para>
29680 </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
29682 <para><parameter>sidebar.float.type parameter</parameter>,
29683 <parameter>sidebar.float.width parameter</parameter>,
29684 <parameter>sidebar.properties attribute-set</parameter>,
29685 <parameter>sidebar.title.properties</parameter>
29688 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
29690 <para><link role="tcg" xlink:href="SideFloats.html#SidebarFloats">A sidebar as
29691 side float</link></para>
29693 </refsect1></refentry>
29695 <refentry id="dbfo_start" xml:base="../fo/pi.xml">
29697 <refname>dbfo_start</refname>
29698 <refpurpose>(obsolete) Sets the starting number on an ordered list</refpurpose>
29702 <synopsis><tag class="xmlpi">dbfo start="<replaceable>character</replaceable>"</tag></synopsis>
29705 <refsect1><title>Description</title>
29707 <para><emphasis>This PI is obsolete</emphasis>. The intent of
29708 it was to provide a means for setting a specific starting
29709 number for an ordered list. Instead of this PI, set a value
29710 for the <literal>override</literal> attribute on the first
29711 <tag>listitem</tag> in the list; that will have the same
29712 effect as what this PI was intended for.</para>
29714 </refsect1><refsect1><title>Parameters</title>
29717 <varlistentry><term>start="<replaceable>character</replaceable>"</term>
29720 <para>Specifies the character to use as the starting
29721 number; use 0-9, a-z, A-Z, or lowercase or uppercase
29722 Roman numerals</para>
29728 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
29730 <para><link role="tcg" xlink:href="Orderedlists.html#ListStartNum">List starting number</link></para>
29732 </refsect1></refentry>
29734 <refentry id="dbfo_table-width" xml:base="../fo/pi.xml">
29736 <refname>dbfo_table-width</refname>
29737 <refpurpose>Specifies the width for a CALS table or for revhistory
29738 output</refpurpose>
29742 <synopsis><tag class="xmlpi">dbfo table-width="<replaceable>width</replaceable>"</tag></synopsis>
29745 <refsect1><title>Description</title>
29747 <para>Use the <tag class="xmlpi">dbfo table-width</tag> PI as a child or
29748 sibling of a CALS <tag>table</tag>, or as a child of an
29749 <tag>informaltable</tag>, <tag>entrytbl</tag>, or
29750 <tag>revhistory</tag> instance (which is rendered as a table
29751 in output) to specify the width of the table in output.</para>
29753 </refsect1><refsect1><title>Parameters</title>
29756 <varlistentry><term>table-width="<replaceable>width</replaceable>"</term>
29759 <para>Specifies the table width (including units or as a percentage)</para>
29765 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
29767 <para><link role="tcg" xlink:href="Tables.html#TableWidth">Table width</link></para>
29769 </refsect1></refentry>
29771 <refentry id="dbfo_term-width" xml:base="../fo/pi.xml">
29773 <refname>dbfo_term-width</refname>
29774 <refpurpose>Specifies the term width for a variablelist</refpurpose>
29778 <synopsis><tag class="xmlpi">dbfo term-width="<replaceable>width</replaceable>"</tag></synopsis>
29781 <refsect1><title>Description</title>
29783 <para>Use the <tag class="xmlpi">dbfo term-width</tag> PI as a child of a
29784 <tag>variablelist</tag> to specify the width for
29785 <tag>term</tag> output.</para>
29787 </refsect1><refsect1><title>Parameters</title>
29790 <varlistentry><term>term-width="<replaceable>width</replaceable>"</term>
29793 <para>Specifies the term width (including units)</para>
29799 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
29801 <para><link role="tcg" xlink:href="Variablelists.html#ListIndents">Variable list formatting in print</link></para>
29803 </refsect1></refentry>
29805 <refentry id="dbfo_toc" xml:base="../fo/pi.xml">
29807 <refname>dbfo_toc</refname>
29808 <refpurpose>Specifies whether a TOC should be generated for a qandaset</refpurpose>
29812 <synopsis><tag class="xmlpi">dbfo toc="0"|"1"</tag></synopsis>
29815 <refsect1><title>Description</title>
29817 <para>Use the <tag class="xmlpi">dbfo toc</tag> PI as a child of a
29818 <tag>qandaset</tag> to specify whether a table of contents
29819 (TOC) is generated for the <tag>qandaset</tag>.</para>
29821 </refsect1><refsect1><title>Parameters</title>
29824 <varlistentry><term>toc="0"</term>
29827 <para>If zero, no TOC is generated</para>
29831 <varlistentry><term>toc="1"</term>
29834 <para>If <code>1</code> (or any non-zero value),
29835 a TOC is generated</para>
29841 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
29843 <para><link role="tcg" xlink:href="QandAtoc.html">Q and A list of questions</link>,
29844 <link role="tcg" xlink:href="QandAformat.html">Q and A formatting</link></para>
29846 </refsect1></refentry>
29848 <refentry id="dbfo-need" xml:base="../fo/pi.xml">
29850 <refname>dbfo-need</refname>
29851 <refpurpose>Specify a need for space (a kind of soft page break)</refpurpose>
29855 <synopsis><tag class="xmlpi">dbfo-need height="<replaceable>n</replaceable>" [space-before="<replaceable>n</replaceable>"]</tag></synopsis>
29858 <refsect1><title>Description</title>
29860 <para>A “need” is a request for space on a page. If the
29861 requested space is not available, the page breaks and the
29862 content that follows the need request appears on the next
29863 page. If the requested space is available, then no page break
29864 is inserted.</para>
29866 </refsect1><refsect1><title>Parameters</title>
29869 <varlistentry><term>height="<replaceable>n</replaceable>"</term>
29872 <para>The amount of height needed (including units)</para>
29876 <varlistentry><term>space-before="<replaceable>n</replaceable>"</term>
29879 <para>The amount of extra vertical space to add (including units)</para>
29885 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
29887 <para><link role="tcg" xlink:href="PageBreaking.html#SoftPageBreaks">Soft page breaks</link></para>
29889 </refsect1></refentry>
29891 <refentry id="dbfo_row-height" xml:base="../fo/pi.xml">
29893 <refname>dbfo_row-height</refname>
29894 <refpurpose>Specifies the height for a CALS table row</refpurpose>
29898 <synopsis><tag class="xmlpi">dbfo row-height="<replaceable>height</replaceable>"</tag></synopsis>
29901 <refsect1><title>Description</title>
29903 <para>Use the <tag class="xmlpi">dbfo row-height</tag> PI as a child of a
29904 <tag>row</tag> to specify the height of the row.</para>
29906 </refsect1><refsect1><title>Parameters</title>
29909 <varlistentry><term>row-height="<replaceable>height</replaceable>"</term>
29912 <para>Specifies the row height (including units)</para>
29918 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
29920 <para><link role="tcg" xlink:href="RowHeight.html">Row height</link></para>
29922 </refsect1></refentry>
29926 <info xml:base="../manpages/pi.xml"><title>manpages Processing Instruction Reference</title>
29927 <releaseinfo role="meta">
29928 $Id: pi.xsl 7644 2008-01-16 11:04:07Z xmldoc $
29931 <partintro id="partintro" xml:base="../manpages/pi.xml">
29932 <title>Introduction</title>
29934 <para>This is generated reference documentation for all
29935 user-specifiable processing instructions (PIs) in the DocBook
29936 XSL stylesheets for manpages output.
29939 <para>You add these PIs at particular points in a document to
29940 cause specific “exceptions” to formatting/output behavior. To
29941 make global changes in formatting/output behavior across an
29942 entire document, it’s better to do it by setting an
29943 appropriate stylesheet parameter (if there is one).</para>
29950 <refentry id="dbman_funcsynopsis-style" xml:base="../manpages/pi.xml">
29952 <refname>dbman_funcsynopsis-style</refname>
29953 <refpurpose>Specifies presentation style for a funcsynopsis.</refpurpose>
29957 <synopsis><tag class="xmlpi">dbman funcsynopsis-style="kr"|"ansi"</tag></synopsis>
29960 <refsect1><title>Description</title>
29962 <para>Use the <tag class="xmlpi">dbman
29963 funcsynopsis-style</tag> PI as a child of a
29964 <tag>funcsynopsis</tag> or anywhere within a funcsynopsis
29965 to control the presentation style for output of all
29966 <tag>funcprototype</tag> instances within that funcsynopsis.</para>
29968 </refsect1><refsect1><title>Parameters</title>
29971 <varlistentry><term>funcsynopsis-style="kr"</term>
29974 <para>Displays the <tag>funcprototype</tag> in K&R style</para>
29978 <varlistentry><term>funcsynopsis-style="ansi"</term>
29981 <para>Displays the <tag>funcprototype</tag> in ANSI style</para>
29987 </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
29989 <para><parameter>man.funcsynopsis.style</parameter></para>
29991 </refsect1></refentry>
29994 <part id="pi-common">
29995 <info xml:base="../common/pi.xml"><title>Common Processing Instruction Reference</title>
29996 <releaseinfo role="meta">
29997 $Id: pi.xsl 8349 2009-03-17 06:53:03Z bobstayton $
30000 <partintro id="partintro" xml:base="../common/pi.xml">
30001 <title>Introduction</title>
30003 <para>This is generated reference documentation for all
30004 user-specifiable processing instructions (PIs) in the
30005 “common” part of the DocBook XSL stylesheets.
30008 <para>You add these PIs at particular points in a document to
30009 cause specific “exceptions” to formatting/output behavior. To
30010 make global changes in formatting/output behavior across an
30011 entire document, it’s better to do it by setting an
30012 appropriate stylesheet parameter (if there is one).</para>
30019 <refentry id="dbchoice_choice" xml:base="../common/pi.xml">
30021 <refname>dbchoice_choice</refname>
30022 <refpurpose>Generates a localized choice separator</refpurpose>
30026 <synopsis><tag class="xmlpi">dbchoice choice="and"|"or"|<replaceable>string</replaceable>"</tag></synopsis>
30029 <refsect1><title>Description</title>
30031 <para>Use the <tag class="xmlpi">dbchoice choice</tag> PI to
30032 generate an appropriate localized “choice” separator (for
30033 example, <literal>and</literal> or <literal>or</literal>)
30034 before the final item in an inline <tag>simplelist</tag></para>
30038 <para>This PI is a less-than-ideal hack; support for it may
30039 disappear in the future (particularly if and when a more
30040 appropriate means for marking up "choice" lists becomes
30041 available in DocBook).</para>
30044 </refsect1><refsect1><title>Parameters</title>
30047 <varlistentry><term>choice="and"</term>
30050 <para>generates a localized <literal>and</literal> separator</para>
30054 <varlistentry><term>choice="or"</term>
30057 <para>generates a localized <literal>or</literal> separator</para>
30061 <varlistentry><term>choice="<replaceable>string</replaceable>"</term>
30064 <para>generates a literal <replaceable>string</replaceable> separator</para>
30070 </refsect1></refentry>
30072 <refentry id="dbtimestamp" xml:base="../common/pi.xml">
30074 <refname>dbtimestamp</refname>
30075 <refpurpose>Inserts a date timestamp</refpurpose>
30079 <synopsis><tag class="xmlpi">dbtimestamp format="<replaceable>formatstring</replaceable>" [padding="0"|"1"]</tag></synopsis>
30082 <refsect1><title>Description</title>
30084 <para>Use the <tag class="xmlpi">dbtimestamp</tag> PI at any point in a
30085 source document to cause a date timestamp (a formatted
30086 string representing the current date and time) to be
30087 inserted in output of the document.</para>
30089 </refsect1><refsect1><title>Parameters</title>
30092 <varlistentry><term>format="<replaceable>formatstring</replaceable>"</term>
30095 <para>Specifies format in which the date and time are
30100 <para>For details of the content of the format string,
30101 see <link role="tcg" xlink:href="Datetime.html">Date and time</link>.</para>
30106 <varlistentry><term>padding="0"|"1"</term>
30109 <para>Specifies padding behavior; if non-zero, padding is is added</para>
30115 </refsect1></refentry>
30117 <refentry id="dbtex_delims" xml:base="../common/pi.xml">
30119 <refname>dbtex_delims</refname>
30120 <refpurpose>Generates delimiters around embedded TeX equations
30121 in output</refpurpose>
30125 <synopsis><tag class="xmlpi">dbtex delims="no"|"yes"</tag></synopsis>
30128 <refsect1><title>Description</title>
30130 <para>Use the <tag class="xmlpi">dbtex delims</tag> PI as a
30131 child of a <tag>textobject</tag> containing embedded TeX
30132 markup, to cause that markup to be surrounded by
30133 <literal>$</literal> delimiter characters in output.</para>
30135 </refsect1><refsect1><title>Parameters</title>
30138 <varlistentry><term>dbtex delims="no"|"yes"</term>
30141 <para>Specifies whether delimiters are output</para>
30147 </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
30149 <para><parameter>tex.math.delims</parameter></para>
30151 </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
30153 <para><link role="tcg" xlink:href="TexMath.html">DBTeXMath</link></para>
30155 </refsect1></refentry>
30159 <book id="developer"><title>DocBook XSL Stylesheets Developer Reference</title>
30162 <para>This is technical reference documentation for
30163 developers using the DocBook XSL Stylesheets. It is not
30164 intended to be user documentation, but is instead
30165 provided for developers writing customization layers for
30166 the stylesheets.</para>
30170 <?dbhtml dir="lib"?>
30171 <?dbhtml filename="index.html"?>
30172 <title xml:base="../lib/lib.xml">XSL Library Template Reference</title>
30173 <partintro id="libintro">
30174 <title xml:base="../lib/lib.xml">Introduction</title>
30175 <para xml:base="../lib/lib.xml">This is technical reference documentation for the
30176 vocabulary-independent “library” templates in the DocBook XSL
30177 Stylesheets.</para>
30178 <para xml:base="../lib/lib.xml">This is not intended to be user documentation. It is
30179 provided for developers writing customization layers for the
30180 stylesheets.</para>
30183 <reference id="generallibrary" xml:base="../lib/lib.xml">
30184 <title>General Library Templates</title>
30186 <refentry id="dot.count">
30188 <refname>dot.count</refname>
30189 <refpurpose>Returns the number of <quote>.</quote> characters in a string</refpurpose>
30192 <refsect1><title>Description</title>
30194 <para>Given a string, the <function>dot.count</function>
30195 template returns the number of dot/period characters in the
30196 string. This template is useful, for example, when testing the
30197 nesting level of nested inline markup (for nested emphasis,
30198 quotations, etc.).</para>
30200 <programlisting id="dot.count.frag">
30201 <xsl:template name="dot.count">
30202 <!-- Returns the number of "." characters in a string -->
30203 <xsl:param name="string"></xsl:param>
30204 <xsl:param name="count" select="0"></xsl:param>
30206 <xsl:when test="contains($string, '.')">
30207 <xsl:call-template name="dot.count">
30208 <xsl:with-param name="string" select="substring-after($string, '.')"></xsl:with-param>
30209 <xsl:with-param name="count" select="$count+1"></xsl:with-param>
30210 </xsl:call-template>
30212 <xsl:otherwise>
30213 <xsl:value-of select="$count"></xsl:value-of>
30214 </xsl:otherwise>
30215 </xsl:choose>
30216 </xsl:template>
30224 <refentry id="copy-string">
30226 <refname>copy-string</refname>
30227 <refpurpose>Returns <quote>count</quote> copies of a string</refpurpose>
30230 <refsect1><title>Description</title>
30232 <para>Given a string, the <function>copy-string</function>
30233 template creates <replaceable>n</replaceable> copies of the
30234 string, when the value of <replaceable>n</replaceable> is
30235 given by the <parameter>count</parameter> parameter.</para>
30237 <programlisting id="copy-string.frag">
30238 <xsl:template name="copy-string">
30239 <!-- returns 'count' copies of 'string' -->
30240 <xsl:param name="string"></xsl:param>
30241 <xsl:param name="count" select="0"></xsl:param>
30242 <xsl:param name="result"></xsl:param>
30245 <xsl:when test="$count>0">
30246 <xsl:call-template name="copy-string">
30247 <xsl:with-param name="string" select="$string"></xsl:with-param>
30248 <xsl:with-param name="count" select="$count - 1"></xsl:with-param>
30249 <xsl:with-param name="result">
30250 <xsl:value-of select="$result"></xsl:value-of>
30251 <xsl:value-of select="$string"></xsl:value-of>
30252 </xsl:with-param>
30253 </xsl:call-template>
30255 <xsl:otherwise>
30256 <xsl:value-of select="$result"></xsl:value-of>
30257 </xsl:otherwise>
30258 </xsl:choose>
30259 </xsl:template>
30267 <refentry id="string.subst">
30269 <refname>string.subst</refname>
30270 <refpurpose>Substitute one text string for another in a string</refpurpose>
30273 <refsect1><title>Description</title>
30275 <para>The <function>string.subst</function> template replaces all
30276 occurances of <parameter>target</parameter> in <parameter>string</parameter>
30277 with <parameter>replacement</parameter> and returns the result.
30280 <programlisting id="string.subst.frag">
30281 <xsl:template name="string.subst">
30282 <xsl:param name="string"></xsl:param>
30283 <xsl:param name="target"></xsl:param>
30284 <xsl:param name="replacement"></xsl:param>
30287 <xsl:when test="contains($string, $target)">
30288 <xsl:variable name="rest">
30289 <xsl:call-template name="string.subst">
30290 <xsl:with-param name="string" select="substring-after($string, $target)"></xsl:with-param>
30291 <xsl:with-param name="target" select="$target"></xsl:with-param>
30292 <xsl:with-param name="replacement" select="$replacement"></xsl:with-param>
30293 </xsl:call-template>
30294 </xsl:variable>
30295 <xsl:value-of select="concat(substring-before($string, $target), $replacement, $rest)"></xsl:value-of>
30297 <xsl:otherwise>
30298 <xsl:value-of select="$string"></xsl:value-of>
30299 </xsl:otherwise>
30300 </xsl:choose>
30301 </xsl:template>
30309 <refentry id="xpointer.idref">
30311 <refname>xpointer.idref</refname>
30312 <refpurpose>Extract IDREF from an XPointer</refpurpose>
30315 <refsect1><title>Description</title>
30317 <para>The <function>xpointer.idref</function> template returns the
30318 ID portion of an XPointer which is a pointer to an ID within the current
30319 document, or the empty string if it is not.</para>
30320 <para>In other words, <function>xpointer.idref</function> returns
30321 <quote>foo</quote> when passed either <literal>#foo</literal>
30322 or <literal>#xpointer(id('foo'))</literal>, otherwise it returns
30323 the empty string.</para>
30325 <programlisting id="xpointer.idref.frag">
30326 <xsl:template name="xpointer.idref">
30327 <xsl:param name="xpointer">http://...</xsl:param>
30329 <xsl:when test="starts-with($xpointer, '#xpointer(id(')">
30330 <xsl:variable name="rest" select="substring-after($xpointer, '#xpointer(id(')"></xsl:variable>
30331 <xsl:variable name="quote" select="substring($rest, 1, 1)"></xsl:variable>
30332 <xsl:value-of select="substring-before(substring-after($xpointer, $quote), $quote)"></xsl:value-of>
30334 <xsl:when test="starts-with($xpointer, '#')">
30335 <xsl:value-of select="substring-after($xpointer, '#')"></xsl:value-of>
30337 <!-- otherwise it's a pointer to some other document -->
30338 </xsl:choose>
30339 </xsl:template>
30348 <refentry id="length-magnitude">
30350 <refname>length-magnitude</refname>
30351 <refpurpose>Return the unqualified dimension from a length specification</refpurpose>
30354 <refsect1><title>Description</title>
30356 <para>The <function>length-magnitude</function> template returns the
30357 unqualified length ("20" for "20pt") from a dimension.
30360 <programlisting id="length-magnitude.frag">
30361 <xsl:template name="length-magnitude">
30362 <xsl:param name="length" select="'0pt'"></xsl:param>
30365 <xsl:when test="string-length($length) = 0"></xsl:when>
30366 <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) = '.'">
30367 <xsl:value-of select="substring($length,1,1)"></xsl:value-of>
30368 <xsl:call-template name="length-magnitude">
30369 <xsl:with-param name="length" select="substring($length,2)"></xsl:with-param>
30370 </xsl:call-template>
30372 </xsl:choose>
30373 </xsl:template>
30381 <refentry id="length-units">
30383 <refname>length-units</refname>
30384 <refpurpose>Return the units from a length specification</refpurpose>
30387 <refsect1><title>Description</title>
30389 <para>The <function>length-units</function> template returns the
30390 units ("pt" for "20pt") from a length. If no units are supplied on the
30391 length, the <parameter>defauilt.units</parameter> are returned.</para>
30393 <programlisting id="length-units.frag">
30394 <xsl:template name="length-units">
30395 <xsl:param name="length" select="'0pt'"></xsl:param>
30396 <xsl:param name="default.units" select="'px'"></xsl:param>
30397 <xsl:variable name="magnitude">
30398 <xsl:call-template name="length-magnitude">
30399 <xsl:with-param name="length" select="$length"></xsl:with-param>
30400 </xsl:call-template>
30401 </xsl:variable>
30403 <xsl:variable name="units">
30404 <xsl:value-of select="substring($length, string-length($magnitude)+1)"></xsl:value-of>
30405 </xsl:variable>
30408 <xsl:when test="$units = ''">
30409 <xsl:value-of select="$default.units"></xsl:value-of>
30411 <xsl:otherwise>
30412 <xsl:value-of select="$units"></xsl:value-of>
30413 </xsl:otherwise>
30414 </xsl:choose>
30415 </xsl:template>
30423 <refentry id="length-spec">
30425 <refname>length-spec</refname>
30426 <refpurpose>Return a fully qualified length specification</refpurpose>
30429 <refsect1><title>Description</title>
30431 <para>The <function>length-spec</function> template returns the
30432 qualified length from a dimension. If an unqualified length is given,
30433 the <parameter>default.units</parameter> will be added to it.
30436 <programlisting id="length-spec.frag">
30437 <xsl:template name="length-spec">
30438 <xsl:param name="length" select="'0pt'"></xsl:param>
30439 <xsl:param name="default.units" select="'px'"></xsl:param>
30441 <xsl:variable name="magnitude">
30442 <xsl:call-template name="length-magnitude">
30443 <xsl:with-param name="length" select="$length"></xsl:with-param>
30444 </xsl:call-template>
30445 </xsl:variable>
30447 <xsl:variable name="units">
30448 <xsl:value-of select="substring($length, string-length($magnitude)+1)"></xsl:value-of>
30449 </xsl:variable>
30451 <xsl:value-of select="$magnitude"></xsl:value-of>
30453 <xsl:when test="$units='cm' or $units='mm' or $units='in' or $units='pt' or $units='pc' or $units='px' or $units='em'">
30454 <xsl:value-of select="$units"></xsl:value-of>
30456 <xsl:when test="$units = ''">
30457 <xsl:value-of select="$default.units"></xsl:value-of>
30459 <xsl:otherwise>
30460 <xsl:message>
30461 <xsl:text>Unrecognized unit of measure: </xsl:text>
30462 <xsl:value-of select="$units"></xsl:value-of>
30463 <xsl:text>.</xsl:text>
30464 </xsl:message>
30465 </xsl:otherwise>
30466 </xsl:choose>
30467 </xsl:template>
30475 <refentry id="length-in-points">
30477 <refname>length-in-points</refname>
30478 <refpurpose>Returns the size, in points, of a specified length</refpurpose>
30481 <refsect1><title>Description</title>
30483 <para>The <function>length-in-points</function> template converts a length
30484 specification to points and returns that value as an unqualified
30489 <para>There is no way for the template to infer the size of an
30490 <literal>em</literal>. It relies on the default <parameter>em.size</parameter>
30491 which is initially <literal>10</literal> (for 10pt).</para>
30493 <para>Similarly, converting pixels to points relies on the
30494 <parameter>pixels.per.inch</parameter> parameter which is initially
30495 <literal>90</literal>.
30499 <programlisting id="length-in-points.frag">
30500 <xsl:template name="length-in-points">
30501 <xsl:param name="length" select="'0pt'"></xsl:param>
30502 <xsl:param name="em.size" select="10"></xsl:param>
30503 <xsl:param name="pixels.per.inch" select="90"></xsl:param>
30505 <xsl:variable name="magnitude">
30506 <xsl:call-template name="length-magnitude">
30507 <xsl:with-param name="length" select="$length"></xsl:with-param>
30508 </xsl:call-template>
30509 </xsl:variable>
30511 <xsl:variable name="units">
30512 <xsl:value-of select="substring($length, string-length($magnitude)+1)"></xsl:value-of>
30513 </xsl:variable>
30516 <xsl:when test="$units = 'pt'">
30517 <xsl:value-of select="$magnitude"></xsl:value-of>
30519 <xsl:when test="$units = 'cm'">
30520 <xsl:value-of select="$magnitude div 2.54 * 72.0"></xsl:value-of>
30522 <xsl:when test="$units = 'mm'">
30523 <xsl:value-of select="$magnitude div 25.4 * 72.0"></xsl:value-of>
30525 <xsl:when test="$units = 'in'">
30526 <xsl:value-of select="$magnitude * 72.0"></xsl:value-of>
30528 <xsl:when test="$units = 'pc'">
30529 <xsl:value-of select="$magnitude * 12.0"></xsl:value-of>
30531 <xsl:when test="$units = 'px'">
30532 <xsl:value-of select="$magnitude div $pixels.per.inch * 72.0"></xsl:value-of>
30534 <xsl:when test="$units = 'em'">
30535 <xsl:value-of select="$magnitude * $em.size"></xsl:value-of>
30537 <xsl:otherwise>
30538 <xsl:message>
30539 <xsl:text>Unrecognized unit of measure: </xsl:text>
30540 <xsl:value-of select="$units"></xsl:value-of>
30541 <xsl:text>.</xsl:text>
30542 </xsl:message>
30543 </xsl:otherwise>
30544 </xsl:choose>
30545 </xsl:template>
30553 <refentry id="pi-attribute">
30555 <refname>pi-attribute</refname>
30556 <refpurpose>Extract a pseudo-attribute from a PI</refpurpose>
30559 <refsect1><title>Description</title>
30561 <para>The <function>pi-attribute</function> template extracts a pseudo-attribute
30562 from a processing instruction. For example, given the PI
30563 <quote><literal><?foo bar="1" baz='red'?></literal></quote>,</para>
30564 <programlisting><xsl:call-template name="pi-attribute">
30565 <xsl:with-param name="pis" select="processing-instruction('foo')"/>
30566 <xsl:with-param name="attribute" select="'baz'"/>
30567 </xsl:call-template></programlisting>
30568 <para>will return <quote>red</quote>. This template returns the first matching
30569 attribute that it finds. Presented with processing instructions that
30570 contain badly formed pseudo-attributes (missing or unbalanced quotes,
30571 for example), the template may silently return erroneous results.</para>
30573 <programlisting id="pi-attribute.frag">
30574 <xsl:template name="pi-attribute">
30575 <xsl:param name="pis" select="processing-instruction('BOGUS_PI')"></xsl:param>
30576 <xsl:param name="attribute">filename</xsl:param>
30577 <xsl:param name="count">1</xsl:param>
30580 <xsl:when test="$count>count($pis)">
30581 <!-- not found -->
30583 <xsl:otherwise>
30584 <xsl:variable name="pi">
30585 <xsl:value-of select="$pis[$count]"></xsl:value-of>
30586 </xsl:variable>
30587 <xsl:variable name="pivalue">
30588 <xsl:value-of select="concat(' ', normalize-space($pi))"></xsl:value-of>
30589 </xsl:variable>
30591 <xsl:when test="contains($pivalue,concat(' ', $attribute, '='))">
30592 <xsl:variable name="rest" select="substring-after($pivalue,concat(' ', $attribute,'='))"></xsl:variable>
30593 <xsl:variable name="quote" select="substring($rest,1,1)"></xsl:variable>
30594 <xsl:value-of select="substring-before(substring($rest,2),$quote)"></xsl:value-of>
30596 <xsl:otherwise>
30597 <xsl:call-template name="pi-attribute">
30598 <xsl:with-param name="pis" select="$pis"></xsl:with-param>
30599 <xsl:with-param name="attribute" select="$attribute"></xsl:with-param>
30600 <xsl:with-param name="count" select="$count + 1"></xsl:with-param>
30601 </xsl:call-template>
30602 </xsl:otherwise>
30603 </xsl:choose>
30604 </xsl:otherwise>
30605 </xsl:choose>
30606 </xsl:template>
30614 <refentry id="lookup.key">
30616 <refname>lookup.key</refname>
30617 <refpurpose>Retrieve the value associated with a particular key in a table</refpurpose>
30620 <refsect1><title>Description</title>
30622 <para>Given a table of space-delimited key/value pairs,
30623 the <function>lookup.key</function> template extracts the value associated
30624 with a particular key.</para>
30626 <programlisting id="lookup.key.frag">
30627 <xsl:template name="lookup.key">
30628 <xsl:param name="key" select="''"></xsl:param>
30629 <xsl:param name="table" select="''"></xsl:param>
30631 <xsl:if test="contains($table, ' ')">
30633 <xsl:when test="substring-before($table, ' ') = $key">
30634 <xsl:variable name="rest" select="substring-after($table, ' ')"></xsl:variable>
30636 <xsl:when test="contains($rest, ' ')">
30637 <xsl:value-of select="substring-before($rest, ' ')"></xsl:value-of>
30639 <xsl:otherwise>
30640 <xsl:value-of select="$rest"></xsl:value-of>
30641 </xsl:otherwise>
30642 </xsl:choose>
30644 <xsl:otherwise>
30645 <xsl:call-template name="lookup.key">
30646 <xsl:with-param name="key" select="$key"></xsl:with-param>
30647 <xsl:with-param name="table" select="substring-after(substring-after($table,' '), ' ')"></xsl:with-param>
30648 </xsl:call-template>
30649 </xsl:otherwise>
30650 </xsl:choose>
30652 </xsl:template>
30660 <refentry id="xpath.location">
30662 <refname>xpath.location</refname>
30663 <refpurpose>Calculate the XPath child-sequence to the current node</refpurpose>
30666 <refsect1><title>Description</title>
30668 <para>The <function>xpath.location</function> template calculates the
30669 absolute path from the root of the tree to the current element node.
30672 <programlisting id="xpath.location.frag">
30673 <xsl:template name="xpath.location">
30674 <xsl:param name="node" select="."></xsl:param>
30675 <xsl:param name="path" select="''"></xsl:param>
30677 <xsl:variable name="next.path">
30678 <xsl:value-of select="local-name($node)"></xsl:value-of>
30679 <xsl:if test="$path != ''">/</xsl:if>
30680 <xsl:value-of select="$path"></xsl:value-of>
30681 </xsl:variable>
30684 <xsl:when test="$node/parent::*">
30685 <xsl:call-template name="xpath.location">
30686 <xsl:with-param name="node" select="$node/parent::*"></xsl:with-param>
30687 <xsl:with-param name="path" select="$next.path"></xsl:with-param>
30688 </xsl:call-template>
30690 <xsl:otherwise>
30691 <xsl:text>/</xsl:text>
30692 <xsl:value-of select="$next.path"></xsl:value-of>
30693 </xsl:otherwise>
30694 </xsl:choose>
30695 </xsl:template>
30703 <refentry id="comment-escape-string">
30705 <refname>comment-escape-string</refname>
30706 <refpurpose>Prepare a string for inclusion in an XML comment</refpurpose>
30709 <refsect1><title>Description</title>
30711 <para>The <function>comment-escape-string</function> template returns a string
30712 that has been transformed so that it can safely be output as an XML comment.
30713 Internal occurrences of "--" will be replaced with "- -" and a leading and/or
30714 trailing space will be added to the string, if necessary.</para>
30716 <programlisting id="comment-escape-string.frag">
30717 <xsl:template name="comment-escape-string">
30718 <xsl:param name="string" select="''"></xsl:param>
30720 <xsl:if test="starts-with($string, '-')">
30721 <xsl:text> </xsl:text>
30724 <xsl:call-template name="comment-escape-string.recursive">
30725 <xsl:with-param name="string" select="$string"></xsl:with-param>
30726 </xsl:call-template>
30728 <xsl:if test="substring($string, string-length($string), 1) = '-'">
30729 <xsl:text> </xsl:text>
30731 </xsl:template>
30739 <refentry id="comment-escape-string.recursive">
30741 <refname>comment-escape-string.recursive</refname>
30742 <refpurpose>Internal function used by comment-escape-string</refpurpose>
30745 <refsect1><title>Description</title>
30747 <para>The <function>comment-escape-string.recursive</function> template is used
30748 by <function>comment-escape-string</function>.</para>
30750 <programlisting id="comment-escape-string.recursive.frag">
30751 <xsl:template name="comment-escape-string.recursive">
30752 <xsl:param name="string" select="''"></xsl:param>
30754 <xsl:when test="contains($string, '--')">
30755 <xsl:value-of select="substring-before($string, '--')"></xsl:value-of>
30756 <xsl:value-of select="'- -'"></xsl:value-of>
30757 <xsl:call-template name="comment-escape-string.recursive">
30758 <xsl:with-param name="string" select="substring-after($string, '--')"></xsl:with-param>
30759 </xsl:call-template>
30761 <xsl:otherwise>
30762 <xsl:value-of select="$string"></xsl:value-of>
30763 </xsl:otherwise>
30764 </xsl:choose>
30765 </xsl:template>
30772 <refentry id="trim.text">
30774 <refname>trim.text</refname>
30775 <refpurpose>Trim leading and trailing whitespace from a text node</refpurpose>
30778 <refsect1><title>Description</title>
30780 <para>Given a text node, this function trims leading and trailing
30781 whitespace from it and returns the trimmed contents.</para>
30783 <programlisting id="trim.text.frag">
30785 <xsl:template name="trim.text">
30786 <xsl:param name="contents" select="."></xsl:param>
30787 <xsl:variable name="contents-left-trimmed">
30788 <xsl:call-template name="trim-left">
30789 <xsl:with-param name="contents" select="$contents"></xsl:with-param>
30790 </xsl:call-template>
30791 </xsl:variable>
30792 <xsl:variable name="contents-trimmed">
30793 <xsl:call-template name="trim-right">
30794 <xsl:with-param name="contents" select="$contents-left-trimmed"></xsl:with-param>
30795 </xsl:call-template>
30796 </xsl:variable>
30797 <xsl:value-of select="$contents-trimmed"></xsl:value-of>
30798 </xsl:template>
30800 <xsl:template name="trim-left">
30801 <xsl:param name="contents"></xsl:param>
30803 <xsl:when test="starts-with($contents,'
30804 ') or starts-with($contents,'
') or starts-with($contents,' ') or starts-with($contents,' ')">
30805 <xsl:call-template name="trim-left">
30806 <xsl:with-param name="contents" select="substring($contents, 2)"></xsl:with-param>
30807 </xsl:call-template>
30809 <xsl:otherwise>
30810 <xsl:value-of select="$contents"></xsl:value-of>
30811 </xsl:otherwise>
30812 </xsl:choose>
30813 </xsl:template>
30815 <xsl:template name="trim-right">
30816 <xsl:param name="contents"></xsl:param>
30817 <xsl:variable name="last-char">
30818 <xsl:value-of select="substring($contents, string-length($contents), 1)"></xsl:value-of>
30819 </xsl:variable>
30821 <xsl:when test="($last-char = '
30822 ') or ($last-char = '
') or ($last-char = ' ') or ($last-char = ' ')">
30823 <xsl:call-template name="trim-right">
30824 <xsl:with-param name="contents" select="substring($contents, 1, string-length($contents) - 1)"></xsl:with-param>
30825 </xsl:call-template>
30827 <xsl:otherwise>
30828 <xsl:value-of select="$contents"></xsl:value-of>
30829 </xsl:otherwise>
30830 </xsl:choose>
30831 </xsl:template>
30839 <refentry id="str.tokenize.keep.delimiters">
30841 <refname>str.tokenize.keep.delimiters</refname>
30842 <refpurpose>Tokenize a string while preserving any delimiters</refpurpose>
30844 <refsect1><title>Description</title>
30845 <para>Based on the occurrence of one or more delimiter characters,
30846 this function breaks a string into a list of tokens and delimiters,
30847 marking up each of the tokens with a <tag>token</tag> element
30848 and preserving the delimiters as text nodes between the tokens.</para>
30850 <para>This function is a very slightly modified version of a
30851 function from the <link xlink:href="http://www.exslt.org/">EXSLT
30852 site</link>. The original is available at:
30854 <blockquote><para><link xlink:href="http://www.exslt.org/str/functions/tokenize/str.tokenize.template.xsl"/></para></blockquote>
30856 The <function>str.tokenize.keep.delimiters</function> function
30857 differs only in that it preserves the delimiters instead of
30858 discarding them.</para>
30860 <programlisting id="str.tokenize.keep.delimiters.frag">
30861 <xsl:template name="str.tokenize.keep.delimiters">
30862 <xsl:param name="string" select="''"></xsl:param>
30863 <xsl:param name="delimiters" select="' '"></xsl:param>
30865 <xsl:when test="not($string)"></xsl:when>
30866 <xsl:when test="not($delimiters)">
30867 <xsl:call-template name="str.tokenize.keep.delimiters-characters">
30868 <xsl:with-param name="string" select="$string"></xsl:with-param>
30869 </xsl:call-template>
30871 <xsl:otherwise>
30872 <xsl:call-template name="str.tokenize.keep.delimiters-delimiters">
30873 <xsl:with-param name="string" select="$string"></xsl:with-param>
30874 <xsl:with-param name="delimiters" select="$delimiters"></xsl:with-param>
30875 </xsl:call-template>
30876 </xsl:otherwise>
30877 </xsl:choose>
30878 </xsl:template>
30879 <xsl:template name="str.tokenize.keep.delimiters-characters">
30880 <xsl:param name="string"></xsl:param>
30881 <xsl:if test="$string">
30882 <ssb:token><xsl:value-of select="substring($string, 1, 1)"></xsl:value-of></ssb:token>
30883 <xsl:call-template name="str.tokenize.keep.delimiters-characters">
30884 <xsl:with-param name="string" select="substring($string, 2)"></xsl:with-param>
30885 </xsl:call-template>
30887 </xsl:template>
30888 <xsl:template name="str.tokenize.keep.delimiters-delimiters">
30889 <xsl:param name="string"></xsl:param>
30890 <xsl:param name="delimiters"></xsl:param>
30891 <xsl:variable name="delimiter" select="substring($delimiters, 1, 1)"></xsl:variable>
30893 <xsl:when test="not($delimiter)">
30894 <ssb:token><xsl:value-of select="$string"></xsl:value-of></ssb:token>
30896 <xsl:when test="contains($string, $delimiter)">
30897 <xsl:if test="not(starts-with($string, $delimiter))">
30898 <xsl:call-template name="str.tokenize.keep.delimiters-delimiters">
30899 <xsl:with-param name="string" select="substring-before($string, $delimiter)"></xsl:with-param>
30900 <xsl:with-param name="delimiters" select="substring($delimiters, 2)"></xsl:with-param>
30901 </xsl:call-template>
30903 <!-- output each delimiter -->
30904 <xsl:value-of select="$delimiter"></xsl:value-of>
30905 <xsl:call-template name="str.tokenize.keep.delimiters-delimiters">
30906 <xsl:with-param name="string" select="substring-after($string, $delimiter)"></xsl:with-param>
30907 <xsl:with-param name="delimiters" select="$delimiters"></xsl:with-param>
30908 </xsl:call-template>
30910 <xsl:otherwise>
30911 <xsl:call-template name="str.tokenize.keep.delimiters-delimiters">
30912 <xsl:with-param name="string" select="$string"></xsl:with-param>
30913 <xsl:with-param name="delimiters" select="substring($delimiters, 2)"></xsl:with-param>
30914 </xsl:call-template>
30915 </xsl:otherwise>
30916 </xsl:choose>
30917 </xsl:template>
30924 <refentry id="apply-string-subst-map">
30926 <refname>apply-string-subst-map</refname>
30927 <refpurpose>Apply a string-substitution map</refpurpose>
30929 <refsect1><title>Description</title>
30930 <para>This function applies a “string substitution” map. Use it when
30931 you want to do multiple string substitutions on the same target
30932 content. It reads in two things: <parameter>content</parameter>, the
30933 content on which to perform the substitution, and
30934 <parameter>map.contents</parameter>, a node set of
30935 elements (the names of the elements don't matter), with each element
30936 having the following attributes:
30939 <simpara><tag class="attribute">oldstring</tag>, a string to
30940 be replaced</simpara>
30943 <simpara><tag class="attribute">newstring</tag>, a string with
30944 which to replace <tag class="attribute">oldstring</tag></simpara>
30947 The function uses <parameter>map.contents</parameter> to
30948 do substitution on <parameter>content</parameter>, and then
30949 returns the modified contents.</para>
30951 <para>This function is a very slightly modified version of Jeni
30952 Tennison’s <function>replace_strings</function> function in the
30953 <link xlink:href="http://www.dpawson.co.uk/xsl/sect2/StringReplace.html#d9351e13">multiple string replacements</link> section of Dave Pawson’s
30954 <link xlink:href="http://www.dpawson.co.uk/xsl/index.html">XSLT
30956 <para>The <function>apply-string-subst-map</function> function is
30957 essentially the same function as the
30958 <function>apply-character-map</function> function; the only
30959 difference is that in the map that
30960 <function>apply-string-subst-map</function> expects, <tag class="attribute">oldstring</tag> and <tag class="attribute">newstring</tag> attributes are used instead of
30961 <tag class="attribute">character</tag> and <tag class="attribute">string</tag> attributes.</para>
30963 <programlisting id="apply-string-subst-map.frag">
30964 <xsl:template name="apply-string-subst-map">
30965 <xsl:param name="content"></xsl:param>
30966 <xsl:param name="map.contents"></xsl:param>
30967 <xsl:variable name="replaced_text">
30968 <xsl:call-template name="string.subst">
30969 <xsl:with-param name="string" select="$content"></xsl:with-param>
30970 <xsl:with-param name="target" select="$map.contents[1]/@oldstring"></xsl:with-param>
30971 <xsl:with-param name="replacement" select="$map.contents[1]/@newstring"></xsl:with-param>
30972 </xsl:call-template>
30973 </xsl:variable>
30975 <xsl:when test="$map.contents[2]">
30976 <xsl:call-template name="apply-string-subst-map">
30977 <xsl:with-param name="content" select="$replaced_text"></xsl:with-param>
30978 <xsl:with-param name="map.contents" select="$map.contents[position() > 1]"></xsl:with-param>
30979 </xsl:call-template>
30981 <xsl:otherwise>
30982 <xsl:value-of select="$replaced_text"></xsl:value-of>
30983 </xsl:otherwise>
30984 </xsl:choose>
30985 </xsl:template>
30989 </reference><reference id="relativeuri" xml:base="../lib/lib.xml">
30990 <title>Relative URI Functions</title>
30992 <partintro id="partintro"><title>Introduction</title>
30994 <para>These functions manipulate relative URI references.</para>
30996 <para>The following assumptions must hold true:</para>
31000 <para>All URIs are relative.</para>
31003 <para>No URI contains the <quote><literal>../</literal></quote> sequence
31004 which would effectively move <quote>up</quote> the hierarchy.</para>
31008 <para>If these assumptions do not hold, the results are unpredictable.</para>
31014 <refentry id="count.uri.path.depth">
31016 <refname>count.uri.path.depth</refname>
31017 <refpurpose>Count the number of path components in a relative URI</refpurpose>
31020 <refsect1><title>Description</title>
31022 <para>This function counts the number of path components in a relative URI.</para>
31024 <programlisting id="count.uri.path.depth.frag">
31025 <xsl:template name="count.uri.path.depth">
31026 <xsl:param name="filename" select="''"></xsl:param>
31027 <xsl:param name="count" select="0"></xsl:param>
31030 <xsl:when test="contains($filename, '/')">
31031 <xsl:call-template name="count.uri.path.depth">
31032 <xsl:with-param name="filename" select="substring-after($filename, '/')"></xsl:with-param>
31033 <xsl:with-param name="count" select="$count + 1"></xsl:with-param>
31034 </xsl:call-template>
31036 <xsl:otherwise>
31037 <xsl:value-of select="$count"></xsl:value-of>
31038 </xsl:otherwise>
31039 </xsl:choose>
31040 </xsl:template>
31048 <refentry id="trim.common.uri.paths">
31050 <refname>trim.common.uri.paths</refname>
31051 <refpurpose>Trim common leading path components from a relative URI</refpurpose>
31054 <refsect1><title>Description</title>
31056 <para>This function trims common leading path components from a relative URI.</para>
31058 <programlisting id="trim.common.uri.paths.frag">
31059 <xsl:template name="trim.common.uri.paths">
31060 <xsl:param name="uriA" select="''"></xsl:param>
31061 <xsl:param name="uriB" select="''"></xsl:param>
31062 <xsl:param name="return" select="'A'"></xsl:param>
31065 <xsl:when test="contains($uriA, '/') and contains($uriB, '/') and substring-before($uriA, '/') = substring-before($uriB, '/')">
31066 <xsl:call-template name="trim.common.uri.paths">
31067 <xsl:with-param name="uriA" select="substring-after($uriA, '/')"></xsl:with-param>
31068 <xsl:with-param name="uriB" select="substring-after($uriB, '/')"></xsl:with-param>
31069 <xsl:with-param name="return" select="$return"></xsl:with-param>
31070 </xsl:call-template>
31072 <xsl:otherwise>
31074 <xsl:when test="$return = 'A'">
31075 <xsl:value-of select="$uriA"></xsl:value-of>
31077 <xsl:otherwise>
31078 <xsl:value-of select="$uriB"></xsl:value-of>
31079 </xsl:otherwise>
31080 </xsl:choose>
31081 </xsl:otherwise>
31082 </xsl:choose>
31083 </xsl:template>
31091 <part id="common-part"><title>Common Template Reference</title>
31092 <?dbhtml dir="common"?>
31093 <?dbhtml filename="index.html"?>
31096 <para>This is technical reference documentation for the
31097 “base”, “refentry”, and “utility” sets of common
31098 templates in the DocBook XSL Stylesheets. These
31099 templates are “common” in that they are shared across
31100 output formats (that is, they’re not
31101 output-format-dependent)</para>
31102 <para>This documentation is not intended to be user
31103 documentation. It is provided for developers writing
31104 customization layers for the stylesheets.</para>
31107 <reference id="base" xml:base="../common/common.xml">
31109 <title>Common » Base Template Reference</title>
31110 <releaseinfo role="meta">
31111 $Id: common.xsl 8274 2009-02-27 07:02:45Z bobstayton $
31115 <partintro id="partintro">
31116 <title>Introduction</title>
31118 <para>This is technical reference documentation for the “base”
31119 set of common templates in the DocBook XSL Stylesheets.</para>
31122 <para>This is not intended to be user documentation. It is
31123 provided for developers writing customization layers for the
31124 stylesheets.</para>
31128 <refentry id="template.is.component">
31130 <refname>is.component</refname>
31131 <refpurpose>Tests if a given node is a component-level element</refpurpose>
31134 <synopsis><xsl:template name="is.component">
31135 <xsl:param name="node" select="."/>
31137 </xsl:template></synopsis>
31139 <refsect1><title>Description</title>
31141 <para>This template returns '1' if the specified node is a component
31142 (Chapter, Appendix, etc.), and '0' otherwise.</para>
31144 </refsect1><refsect1><title>Parameters</title>
31147 <varlistentry><term>node</term>
31150 <para>The node which is to be tested.</para>
31156 </refsect1><refsect1><title>Returns</title>
31158 <para>This template returns '1' if the specified node is a component
31159 (Chapter, Appendix, etc.), and '0' otherwise.</para>
31161 </refsect1></refentry>
31163 <refentry id="template.is.section">
31165 <refname>is.section</refname>
31166 <refpurpose>Tests if a given node is a section-level element</refpurpose>
31169 <synopsis><xsl:template name="is.section">
31170 <xsl:param name="node" select="."/>
31172 </xsl:template></synopsis>
31174 <refsect1><title>Description</title>
31176 <para>This template returns '1' if the specified node is a section
31177 (Section, Sect1, Sect2, etc.), and '0' otherwise.</para>
31179 </refsect1><refsect1><title>Parameters</title>
31182 <varlistentry><term>node</term>
31185 <para>The node which is to be tested.</para>
31191 </refsect1><refsect1><title>Returns</title>
31193 <para>This template returns '1' if the specified node is a section
31194 (Section, Sect1, Sect2, etc.), and '0' otherwise.</para>
31196 </refsect1></refentry>
31198 <refentry id="template.section.level">
31200 <refname>section.level</refname>
31201 <refpurpose>Returns the hierarchical level of a section</refpurpose>
31204 <synopsis><xsl:template name="section.level">
31205 <xsl:param name="node" select="."/>
31207 </xsl:template></synopsis>
31209 <refsect1><title>Description</title>
31211 <para>This template calculates the hierarchical level of a section.
31212 The element <tag>sect1</tag> is at level 1, <tag>sect2</tag> is
31213 at level 2, etc.</para>
31217 <para>Recursive sections are calculated down to the fifth level.</para>
31219 </refsect1><refsect1><title>Parameters</title>
31222 <varlistentry><term>node</term>
31225 <para>The section node for which the level should be calculated.
31226 Defaults to the context node.</para>
31232 </refsect1><refsect1><title>Returns</title>
31234 <para>The section level, <quote>1</quote>, <quote>2</quote>, etc.
31237 </refsect1></refentry>
31239 <refentry id="template.qanda.section.level">
31241 <refname>qanda.section.level</refname>
31242 <refpurpose>Returns the hierarchical level of a QandASet</refpurpose>
31245 <synopsis><xsl:template name="qanda.section.level"/></synopsis>
31247 <refsect1><title>Description</title>
31249 <para>This template calculates the hierarchical level of a QandASet.
31252 </refsect1><refsect1><title>Returns</title>
31254 <para>The level, <quote>1</quote>, <quote>2</quote>, etc.
31257 </refsect1></refentry>
31259 <refentry id="template.select.mediaobject">
31261 <refname>select.mediaobject</refname>
31262 <refpurpose>Selects and processes an appropriate media object from a list</refpurpose>
31265 <synopsis><xsl:template name="select.mediaobject">
31266 <xsl:param name="olist" select="imageobject|imageobjectco |videoobject|audioobject|textobject"/>
31268 </xsl:template></synopsis>
31270 <refsect1><title>Description</title>
31272 <para>This template takes a list of media objects (usually the
31273 children of a mediaobject or inlinemediaobject) and processes
31274 the "right" object.</para>
31278 <para>This template relies on a template named
31279 "select.mediaobject.index" to determine which object
31280 in the list is appropriate.</para>
31284 <para>If no acceptable object is located, nothing happens.</para>
31286 </refsect1><refsect1><title>Parameters</title>
31289 <varlistentry><term>olist</term>
31292 <para>The node list of potential objects to examine.</para>
31298 </refsect1><refsect1><title>Returns</title>
31300 <para>Calls <xsl:apply-templates> on the selected object.</para>
31302 </refsect1></refentry>
31304 <refentry id="template.select.mediaobject.index">
31306 <refname>select.mediaobject.index</refname>
31307 <refpurpose>Selects the position of the appropriate media object from a list</refpurpose>
31310 <synopsis><xsl:template name="select.mediaobject.index">
31311 <xsl:param name="olist" select="imageobject|imageobjectco |videoobject|audioobject|textobject"/>
31312 <xsl:param name="count">1</xsl:param>
31314 </xsl:template></synopsis>
31316 <refsect1><title>Description</title>
31318 <para>This template takes a list of media objects (usually the
31319 children of a mediaobject or inlinemediaobject) and determines
31320 the "right" object. It returns the position of that object
31321 to be used by the calling template.</para>
31325 <para>If the parameter <parameter>use.role.for.mediaobject</parameter>
31326 is nonzero, then it first checks for an object with
31327 a role attribute of the appropriate value. It takes the first
31328 of those. Otherwise, it takes the first acceptable object
31329 through a recursive pass through the list.</para>
31333 <para>This template relies on a template named "is.acceptable.mediaobject"
31334 to determine if a given object is an acceptable graphic. The semantics
31335 of media objects is that the first acceptable graphic should be used.
31340 <para>If no acceptable object is located, no index is returned.</para>
31342 </refsect1><refsect1><title>Parameters</title>
31345 <varlistentry><term>olist</term>
31348 <para>The node list of potential objects to examine.</para>
31352 <varlistentry><term>count</term>
31355 <para>The position in the list currently being considered by the
31356 recursive process.</para>
31362 </refsect1><refsect1><title>Returns</title>
31364 <para>Returns the position in the original list of the selected object.</para>
31366 </refsect1></refentry>
31368 <refentry id="template.is.acceptable.mediaobject">
31370 <refname>is.acceptable.mediaobject</refname>
31371 <refpurpose>Returns '1' if the specified media object is recognized</refpurpose>
31374 <synopsis><xsl:template name="is.acceptable.mediaobject">
31375 <xsl:param name="object"/>
31377 </xsl:template></synopsis>
31379 <refsect1><title>Description</title>
31381 <para>This template examines a media object and returns '1' if the
31382 object is recognized as a graphic.</para>
31384 </refsect1><refsect1><title>Parameters</title>
31387 <varlistentry><term>object</term>
31390 <para>The media object to consider.</para>
31396 </refsect1><refsect1><title>Returns</title>
31398 <para>0 or 1</para>
31400 </refsect1></refentry>
31402 <refentry id="template.check.id.unique">
31404 <refname>check.id.unique</refname>
31405 <refpurpose>Warn users about references to non-unique IDs</refpurpose>
31408 <synopsis><xsl:template name="check.id.unique">
31409 <xsl:param name="linkend"/>
31411 </xsl:template></synopsis>
31413 <refsect1><title>Description</title>
31415 <para>If passed an ID in <varname>linkend</varname>,
31416 <function>check.id.unique</function> prints
31417 a warning message to the user if either the ID does not exist or
31418 the ID is not unique.</para>
31420 </refsect1></refentry>
31422 <refentry id="template.check.idref.targets">
31424 <refname>check.idref.targets</refname>
31425 <refpurpose>Warn users about incorrectly typed references</refpurpose>
31428 <synopsis><xsl:template name="check.idref.targets">
31429 <xsl:param name="linkend"/>
31430 <xsl:param name="element-list"/>
31432 </xsl:template></synopsis>
31434 <refsect1><title>Description</title>
31436 <para>If passed an ID in <varname>linkend</varname>,
31437 <function>check.idref.targets</function> makes sure that the element
31438 pointed to by the link is one of the elements listed in
31439 <varname>element-list</varname> and warns the user otherwise.</para>
31441 </refsect1></refentry>
31443 <refentry id="template.copyright.years">
31445 <refname>copyright.years</refname>
31446 <refpurpose>Print a set of years with collapsed ranges</refpurpose>
31449 <synopsis><xsl:template name="copyright.years">
31450 <xsl:param name="years"/>
31451 <xsl:param name="print.ranges" select="1"/>
31452 <xsl:param name="single.year.ranges" select="0"/>
31453 <xsl:param name="firstyear" select="0"/>
31454 <xsl:param name="nextyear" select="0"/>
31456 </xsl:template></synopsis>
31458 <refsect1><title>Description</title>
31460 <para>This template prints a list of year elements with consecutive
31461 years printed as a range. In other words:</para>
31464 <screen><year>1992</year>
31465 <year>1993</year>
31466 <year>1994</year></screen>
31469 <para>is printed <quote>1992-1994</quote>, whereas:</para>
31472 <screen><year>1992</year>
31473 <year>1994</year></screen>
31476 <para>is printed <quote>1992, 1994</quote>.</para>
31480 <para>This template assumes that all the year elements contain only
31481 decimal year numbers, that the elements are sorted in increasing
31482 numerical order, that there are no duplicates, and that all the years
31483 are expressed in full <quote>century+year</quote>
31484 (<quote>1999</quote> not <quote>99</quote>) notation.</para>
31486 </refsect1><refsect1><title>Parameters</title>
31489 <varlistentry><term>years</term>
31492 <para>The initial set of year elements.</para>
31496 <varlistentry><term>print.ranges</term>
31499 <para>If non-zero, multi-year ranges are collapsed. If zero, all years
31500 are printed discretely.</para>
31504 <varlistentry><term>single.year.ranges</term>
31507 <para>If non-zero, two consecutive years will be printed as a range,
31508 otherwise, they will be printed discretely. In other words, a single
31509 year range is <quote>1991-1992</quote> but discretely it's
31510 <quote>1991, 1992</quote>.</para>
31516 </refsect1><refsect1><title>Returns</title>
31518 <para>This template returns the formatted list of years.</para>
31520 </refsect1></refentry>
31522 <refentry id="template.find.path.params">
31524 <refname>find.path.params</refname>
31525 <refpurpose>Search in a table for the "best" match for the node</refpurpose>
31528 <synopsis><xsl:template name="find.path.params">
31529 <xsl:param name="node" select="."/>
31530 <xsl:param name="table" select="''"/>
31531 <xsl:param name="location">
31532 <xsl:call-template name="xpath.location">
31533 <xsl:with-param name="node" select="$node"/>
31534 </xsl:call-template>
31537 </xsl:template></synopsis>
31539 <refsect1><title>Description</title>
31541 <para>This template searches in a table for the value that most-closely
31542 (in the typical best-match sense of XSLT) matches the current (element)
31543 node location.</para>
31545 </refsect1></refentry>
31547 <refentry id="template.string.upper">
31549 <refname>string.upper</refname>
31550 <refpurpose>Converts a string to all uppercase letters</refpurpose>
31553 <synopsis><xsl:template name="string.upper">
31554 <xsl:param name="string" select="''"/>
31556 </xsl:template></synopsis>
31558 <refsect1><title>Description</title>
31560 <para>Given a string, this template does a language-aware conversion
31561 of that string to all uppercase letters, based on the values of the
31562 <literal>lowercase.alpha</literal> and
31563 <literal>uppercase.alpha</literal> gentext keys for the current
31564 locale. It affects only those characters found in the values of
31565 <literal>lowercase.alpha</literal> and
31566 <literal>uppercase.alpha</literal>. All other characters are left
31569 </refsect1><refsect1><title>Parameters</title>
31572 <varlistentry><term>string</term>
31575 <para>The string to convert to uppercase.</para>
31581 </refsect1></refentry>
31583 <refentry id="template.string.lower">
31585 <refname>string.lower</refname>
31586 <refpurpose>Converts a string to all lowercase letters</refpurpose>
31589 <synopsis><xsl:template name="string.lower">
31590 <xsl:param name="string" select="''"/>
31592 </xsl:template></synopsis>
31594 <refsect1><title>Description</title>
31596 <para>Given a string, this template does a language-aware conversion
31597 of that string to all lowercase letters, based on the values of the
31598 <literal>uppercase.alpha</literal> and
31599 <literal>lowercase.alpha</literal> gentext keys for the current
31600 locale. It affects only those characters found in the values of
31601 <literal>uppercase.alpha</literal> and
31602 <literal>lowercase.alpha</literal>. All other characters are left
31605 </refsect1><refsect1><title>Parameters</title>
31608 <varlistentry><term>string</term>
31611 <para>The string to convert to lowercase.</para>
31617 </refsect1></refentry>
31619 <refentry id="template.select.choice.separator">
31621 <refname>select.choice.separator</refname>
31622 <refpurpose>Returns localized choice separator</refpurpose>
31625 <synopsis><xsl:template name="select.choice.separator"/></synopsis>
31627 <refsect1><title>Description</title>
31629 <para>This template enables auto-generation of an appropriate
31630 localized "choice" separator (for example, "and" or "or") before
31631 the final item in an inline list (though it could also be useful
31632 for generating choice separators for non-inline lists).</para>
31635 <para>It currently works by evaluating a processing instruction
31636 (PI) of the form <?dbchoice choice="foo"?> :
31640 <simpara>if the value of the <tag>choice</tag>
31641 pseudo-attribute is "and" or "or", returns a localized "and"
31645 <simpara>otherwise returns the literal value of the
31646 <tag>choice</tag> pseudo-attribute</simpara>
31650 The latter is provided only as a temporary workaround because the
31651 locale files do not currently have translations for the word
31652 <wordasword>or</wordasword>. So if you want to generate a a
31653 logical "or" separator in French (for example), you currently need
31655 <literallayout><?dbchoice choice="ou"?></literallayout>
31660 <para>The <tag>dbchoice</tag> processing instruction is
31661 an unfortunate hack; support for it may disappear in the future
31662 (particularly if and when a more appropriate means for marking
31663 up "choice" lists becomes available in DocBook).</para>
31666 </refsect1></refentry>
31668 <refentry id="template.evaluate.info.profile">
31670 <refname>evaluate.info.profile</refname>
31671 <refpurpose>Evaluates an info profile</refpurpose>
31674 <synopsis><xsl:template name="evaluate.info.profile">
31675 <xsl:param name="profile"/>
31676 <xsl:param name="info"/>
31678 </xsl:template></synopsis>
31680 <refsect1><title>Description</title>
31682 <para>This template evaluates an "info profile" matching the XPath
31683 expression given by the <parameter>profile</parameter>
31684 parameter. It relies on the XSLT <function>evaluate()</function>
31685 extension function.</para>
31689 <para>The value of the <parameter>profile</parameter> parameter
31690 can include the literal string <literal>$info</literal>. If found
31691 in the value of the <parameter>profile</parameter> parameter, the
31692 literal string <literal>$info</literal> string is replaced with
31693 the value of the <parameter>info</parameter> parameter, which
31694 should be a set of <replaceable>*info</replaceable> nodes; the
31695 expression is then evaluated using the XSLT
31696 <function>evaluate()</function> extension function.</para>
31698 </refsect1><refsect1><title>Parameters</title>
31702 <term>profile</term>
31705 <para>A string representing an XPath expression </para>
31713 <para>A set of *info nodes</para>
31719 </refsect1><refsect1><title>Returns</title>
31721 <para>Returns a node (the result of evaluating the
31722 <parameter>profile</parameter> parameter)</para>
31724 </refsect1></refentry>
31726 <reference id="refentry" xml:base="../common/refentry.xml">
31728 <title>Common » Refentry Metadata Template Reference</title>
31729 <releaseinfo role="meta">
31730 $Id: refentry.xsl 7867 2008-03-07 09:54:25Z xmldoc $
31734 <partintro id="partintro">
31735 <title>Introduction</title>
31737 <para>This is technical reference documentation for the “refentry
31738 metadata” templates in the DocBook XSL Stylesheets.</para>
31741 <para>This is not intended to be user documentation. It is provided
31742 for developers writing customization layers for the stylesheets.</para>
31746 <para>Currently, only the manpages stylesheets make use of these
31747 templates. They are, however, potentially useful elsewhere.</para>
31752 <refentry id="template.get.refentry.metadata">
31754 <refname>get.refentry.metadata</refname>
31755 <refpurpose>Gathers metadata from a refentry and its ancestors</refpurpose>
31758 <synopsis><xsl:template name="get.refentry.metadata">
31759 <xsl:param name="refname"/>
31760 <xsl:param name="info"/>
31761 <xsl:param name="prefs"/>
31763 </xsl:template></synopsis>
31765 <refsect1><title>Description</title>
31767 <para>Reference documentation for particular commands, functions,
31768 etc., is sometimes viewed in isolation from its greater "context". For
31769 example, users view Unix man pages as, well, individual pages, not as
31770 part of a "book" of some kind. Therefore, it is sometimes necessary to
31771 embed "context" information in output for each <tag>refentry</tag>.</para>
31775 <para>However, one problem is that different users mark up that
31776 context information in different ways. Often (usually), the
31777 context information is not actually part of the content of the
31778 <tag>refentry</tag> itself, but instead part of the content of a
31779 parent or ancestor element to the <tag>refentry</tag>. And
31780 even then, DocBook provides a variety of elements that users might
31781 potentially use to mark up the same kind of information. One user
31782 might use the <tag>productnumber</tag> element to mark up version
31783 information about a particular product, while another might use
31784 the <tag>releaseinfo</tag> element.</para>
31788 <para>Taking all that in mind, the
31789 <function>get.refentry.metadata</function> template tries to gather
31790 metadata from a <tag>refentry</tag> element and its ancestor
31791 elements in an intelligent and user-configurable way. The basic
31792 mechanism used in the XPath expressions throughout this stylesheet
31793 is to select the relevant metadata from the *info element that is
31794 closest to the actual <tag>refentry</tag> – either on the
31795 <tag>refentry</tag> itself, or on its nearest ancestor.</para>
31800 <para>The <function>get.refentry.metadata</function>
31801 template is actually just sort of a "driver" template; it
31802 calls other templates that do the actual data collection,
31803 then returns the data as a set.</para>
31807 </refsect1><refsect1><title>Parameters</title>
31811 <term>refname</term>
31814 <para>The first <tag>refname</tag> in the refentry</para>
31822 <para>A set of info nodes (from a <tag>refentry</tag>
31823 element and its ancestors)</para>
31831 <para>A node containing user preferences (from global
31832 stylesheet parameters)</para>
31838 </refsect1><refsect1><title>Returns</title>
31840 <para>Returns a node set with the following elements. The
31841 descriptions are verbatim from the <literal>man(7)</literal> man
31849 <para>the title of the man page (e.g., <literal>MAN</literal>)</para>
31854 <term>section</term>
31857 <para>the section number the man page should be placed in (e.g.,
31858 <literal>7</literal>)</para>
31866 <para>the date of the last revision</para>
31871 <term>source</term>
31874 <para>the source of the command</para>
31879 <term>manual</term>
31882 <para>the title of the manual (e.g., <citetitle>Linux
31883 Programmer's Manual</citetitle>)</para>
31891 </refsect1></refentry>
31893 <refentry id="template.get.refentry.title">
31895 <refname>get.refentry.title</refname>
31896 <refpurpose>Gets title metadata for a refentry</refpurpose>
31899 <synopsis><xsl:template name="get.refentry.title">
31900 <xsl:param name="refname"/>
31902 </xsl:template></synopsis>
31904 <refsect1><title>Description</title>
31906 <para>The <literal>man(7)</literal> man page describes this as "the
31907 title of the man page (e.g., <literal>MAN</literal>). This differs
31908 from <tag>refname</tag> in that, if the <tag>refentry</tag> has a
31909 <tag>refentrytitle</tag>, we use that as the <tag>title</tag>;
31910 otherwise, we just use first <tag>refname</tag> in the first
31911 <tag>refnamediv</tag> in the source.</para>
31913 </refsect1><refsect1><title>Parameters</title>
31917 <term>refname</term>
31920 <para>The first <tag>refname</tag> in the refentry</para>
31926 </refsect1><refsect1><title>Returns</title>
31928 <para>Returns a <tag>title</tag> node.</para>
31929 </refsect1></refentry>
31931 <refentry id="template.get.refentry.section">
31933 <refname>get.refentry.section</refname>
31934 <refpurpose>Gets section metadata for a refentry</refpurpose>
31937 <synopsis><xsl:template name="get.refentry.section">
31938 <xsl:param name="refname"/>
31939 <xsl:param name="quiet" select="0"/>
31941 </xsl:template></synopsis>
31943 <refsect1><title>Description</title>
31945 <para>The <literal>man(7)</literal> man page describes this as "the
31946 section number the man page should be placed in (e.g.,
31947 <literal>7</literal>)". If we do not find a <tag>manvolnum</tag>
31948 specified in the source, and we find that the <tag>refentry</tag> is
31949 for a function, we use the section number <literal>3</literal>
31950 ["Library calls (functions within program libraries)"]; otherwise, we
31951 default to using <literal>1</literal> ["Executable programs or shell
31954 </refsect1><refsect1><title>Parameters</title>
31958 <term>refname</term>
31961 <para>The first <tag>refname</tag> in the refentry</para>
31969 <para>If non-zero, no "missing" message is emitted</para>
31975 </refsect1><refsect1><title>Returns</title>
31977 <para>Returns a string representing a section number.</para>
31978 </refsect1></refentry>
31980 <refentry id="template.get.refentry.date">
31982 <refname>get.refentry.date</refname>
31983 <refpurpose>Gets date metadata for a refentry</refpurpose>
31986 <synopsis><xsl:template name="get.refentry.date">
31987 <xsl:param name="refname"/>
31988 <xsl:param name="info"/>
31989 <xsl:param name="prefs"/>
31991 </xsl:template></synopsis>
31993 <refsect1><title>Description</title>
31995 <para>The <literal>man(7)</literal> man page describes this as "the
31996 date of the last revision". If we cannot find a date in the source, we
31997 generate one.</para>
31999 </refsect1><refsect1><title>Parameters</title>
32003 <term>refname</term>
32006 <para>The first <tag>refname</tag> in the refentry</para>
32014 <para>A set of info nodes (from a <tag>refentry</tag>
32015 element and its ancestors)</para>
32023 <para>A node containing users preferences (from global stylesheet parameters)</para>
32029 </refsect1><refsect1><title>Returns</title>
32031 <para>Returns a <tag>date</tag> node.</para>
32033 </refsect1></refentry>
32035 <refentry id="template.get.refentry.source">
32037 <refname>get.refentry.source</refname>
32038 <refpurpose>Gets source metadata for a refentry</refpurpose>
32041 <synopsis><xsl:template name="get.refentry.source">
32042 <xsl:param name="refname"/>
32043 <xsl:param name="info"/>
32044 <xsl:param name="prefs"/>
32046 </xsl:template></synopsis>
32048 <refsect1><title>Description</title>
32050 <para>The <literal>man(7)</literal> man page describes this as "the
32051 source of the command", and provides the following examples:
32056 <para>For binaries, use something like: GNU, NET-2, SLS
32057 Distribution, MCC Distribution.</para>
32062 <para>For system calls, use the version of the kernel that you are
32063 currently looking at: Linux 0.99.11.</para>
32068 <para>For library calls, use the source of the function: GNU, BSD
32069 4.3, Linux DLL 4.4.1.</para>
32078 <para>The <literal>solbook(5)</literal> man page describes
32079 something very much like what <literal>man(7)</literal> calls
32080 "source", except that <literal>solbook(5)</literal> names it
32081 "software" and describes it like this:
32084 <para>This is the name of the software product that the topic
32085 discussed on the reference page belongs to. For example UNIX
32086 commands are part of the <literal>SunOS x.x</literal>
32094 <para>In practice, there are many pages that simply have a version
32095 number in the "source" field. So, it looks like what we have is a
32097 <replaceable>Name</replaceable> <replaceable>Version</replaceable>,
32105 <para>product name (e.g., BSD) or org. name (e.g., GNU)</para>
32110 <term>Version</term>
32113 <para>version name</para>
32119 Each part is optional. If the <replaceable>Name</replaceable> is a
32120 product name, then the <replaceable>Version</replaceable> is probably
32121 the version of the product. Or there may be no
32122 <replaceable>Name</replaceable>, in which case, if there is a
32123 <replaceable>Version</replaceable>, it is probably the version of the
32124 item itself, not the product it is part of. Or, if the
32125 <replaceable>Name</replaceable> is an organization name, then there
32126 probably will be no <replaceable>Version</replaceable>.
32129 </refsect1><refsect1><title>Parameters</title>
32133 <term>refname</term>
32136 <para>The first <tag>refname</tag> in the refentry</para>
32144 <para>A set of info nodes (from a <tag>refentry</tag>
32145 element and its ancestors)</para>
32153 <para>A node containing users preferences (from global
32154 stylesheet parameters)</para>
32160 </refsect1><refsect1><title>Returns</title>
32162 <para>Returns a <tag>source</tag> node.</para>
32164 </refsect1></refentry>
32166 <refentry id="template.get.refentry.source.name">
32168 <refname>get.refentry.source.name</refname>
32169 <refpurpose>Gets source-name metadata for a refentry</refpurpose>
32172 <synopsis><xsl:template name="get.refentry.source.name">
32173 <xsl:param name="refname"/>
32174 <xsl:param name="info"/>
32175 <xsl:param name="prefs"/>
32177 </xsl:template></synopsis>
32179 <refsect1><title>Description</title>
32181 <para>A "source name" is one part of a (potentially) two-part
32182 <replaceable>Name</replaceable> <replaceable>Version</replaceable>
32183 source field. For more details, see the documentation for the
32184 <function>get.refentry.source</function> template.</para>
32186 </refsect1><refsect1><title>Parameters</title>
32190 <term>refname</term>
32193 <para>The first <tag>refname</tag> in the refentry</para>
32201 <para>A set of info nodes (from a <tag>refentry</tag>
32202 element and its ancestors)</para>
32210 <para>A node containing users preferences (from global
32211 stylesheet parameters)</para>
32217 </refsect1><refsect1><title>Returns</title>
32219 <para>Depending on what output method is used for the
32220 current stylesheet, either returns a text node or possibly an element
32221 node, containing "source name" data.</para>
32223 </refsect1></refentry>
32225 <refentry id="template.get.refentry.version">
32227 <refname>get.refentry.version</refname>
32228 <refpurpose>Gets version metadata for a refentry</refpurpose>
32231 <synopsis><xsl:template name="get.refentry.version">
32232 <xsl:param name="refname"/>
32233 <xsl:param name="info"/>
32234 <xsl:param name="prefs"/>
32236 </xsl:template></synopsis>
32238 <refsect1><title>Description</title>
32240 <para>A "version" is one part of a (potentially) two-part
32241 <replaceable>Name</replaceable> <replaceable>Version</replaceable>
32242 source field. For more details, see the documentation for the
32243 <function>get.refentry.source</function> template.</para>
32245 </refsect1><refsect1><title>Parameters</title>
32249 <term>refname</term>
32252 <para>The first <tag>refname</tag> in the refentry</para>
32260 <para>A set of info nodes (from a <tag>refentry</tag>
32261 element and its ancestors)</para>
32269 <para>A node containing users preferences (from global
32270 stylesheet parameters)</para>
32276 </refsect1><refsect1><title>Returns</title>
32278 <para>Depending on what output method is used for the
32279 current stylesheet, either returns a text node or possibly an element
32280 node, containing "version" data.</para>
32282 </refsect1></refentry>
32284 <refentry id="template.get.refentry.manual">
32286 <refname>get.refentry.manual</refname>
32287 <refpurpose>Gets source metadata for a refentry</refpurpose>
32290 <synopsis><xsl:template name="get.refentry.manual">
32291 <xsl:param name="refname"/>
32292 <xsl:param name="info"/>
32293 <xsl:param name="prefs"/>
32295 </xsl:template></synopsis>
32297 <refsect1><title>Description</title>
32299 <para>The <literal>man(7)</literal> man page describes this as "the
32300 title of the manual (e.g., <citetitle>Linux Programmer's
32301 Manual</citetitle>)". Here are some examples from existing man pages:
32306 <para><citetitle>dpkg utilities</citetitle>
32307 (<command>dpkg-name</command>)</para>
32312 <para><citetitle>User Contributed Perl Documentation</citetitle>
32313 (<command>GET</command>)</para>
32318 <para><citetitle>GNU Development Tools</citetitle>
32319 (<command>ld</command>)</para>
32324 <para><citetitle>Emperor Norton Utilities</citetitle>
32325 (<command>ddate</command>)</para>
32330 <para><citetitle>Debian GNU/Linux manual</citetitle>
32331 (<command>faked</command>)</para>
32336 <para><citetitle>GIMP Manual Pages</citetitle>
32337 (<command>gimp</command>)</para>
32342 <para><citetitle>KDOC Documentation System</citetitle>
32343 (<command>qt2kdoc</command>)</para>
32352 <para>The <literal>solbook(5)</literal> man page describes
32353 something very much like what <literal>man(7)</literal> calls
32354 "manual", except that <literal>solbook(5)</literal> names it
32355 "sectdesc" and describes it like this:
32358 <para>This is the section title of the reference page; for
32359 example <literal>User Commands</literal>.</para>
32365 </refsect1><refsect1><title>Parameters</title>
32369 <term>refname</term>
32372 <para>The first <tag>refname</tag> in the refentry</para>
32380 <para>A set of info nodes (from a <tag>refentry</tag>
32381 element and its ancestors)</para>
32389 <para>A node containing users preferences (from global
32390 stylesheet parameters)</para>
32396 </refsect1><refsect1><title>Returns</title>
32398 <para>Returns a <tag>manual</tag> node.</para>
32400 </refsect1></refentry>
32402 <refentry id="template.get.refentry.metadata.prefs">
32404 <refname>get.refentry.metadata.prefs</refname>
32405 <refpurpose>Gets user preferences for refentry metadata gathering</refpurpose>
32408 <synopsis><xsl:template name="get.refentry.metadata.prefs"/></synopsis>
32410 <refsect1><title>Description</title>
32412 <para>The DocBook XSL stylesheets include several user-configurable
32413 global stylesheet parameters for controlling <tag>refentry</tag>
32414 metadata gathering. Those parameters are not read directly by the
32415 other <tag>refentry</tag> metadata-gathering
32416 templates. Instead, they are read only by the
32417 <function>get.refentry.metadata.prefs</function> template,
32418 which assembles them into a structure that is then passed to
32419 the other <tag>refentry</tag> metadata-gathering
32424 <para>So the, <function>get.refentry.metadata.prefs</function>
32425 template is the only interface to collecting stylesheet parameters for
32426 controlling <tag>refentry</tag> metadata gathering.</para>
32428 </refsect1><refsect1><title>Parameters</title>
32430 <para>There are no local parameters for this template; however, it
32431 does rely on a number of global parameters.</para>
32433 </refsect1><refsect1><title>Returns</title>
32435 <para>Returns a <tag>manual</tag> node.</para>
32437 </refsect1></refentry>
32439 <refentry id="template.set.refentry.metadata">
32441 <refname>set.refentry.metadata</refname>
32442 <refpurpose>Sets content of a refentry metadata item</refpurpose>
32445 <synopsis><xsl:template name="set.refentry.metadata">
32446 <xsl:param name="refname"/>
32447 <xsl:param name="info"/>
32448 <xsl:param name="contents"/>
32449 <xsl:param name="context"/>
32450 <xsl:param name="preferred"/>
32452 </xsl:template></synopsis>
32454 <refsect1><title>Description</title>
32456 <para>The <function>set.refentry.metadata</function> template is
32457 called each time a suitable source element is found for a certain
32458 metadata field.</para>
32460 </refsect1><refsect1><title>Parameters</title>
32464 <term>refname</term>
32467 <para>The first <tag>refname</tag> in the refentry</para>
32475 <para>A single *info node that contains the selected source element.</para>
32480 <term>contents</term>
32483 <para>A node containing the selected source element.</para>
32488 <term>context</term>
32491 <para>A string describing the metadata context in which the
32492 <function>set.refentry.metadata</function> template was
32493 called: either "date", "source", "version", or "manual".</para>
32499 </refsect1><refsect1><title>Returns</title>
32501 <para>Returns formatted contents of a selected source element.</para>
32502 </refsect1></refentry>
32504 <reference id="utility" xml:base="../common/utility.xml">
32506 <title>Common » Utility Template Reference</title>
32507 <releaseinfo role="meta">
32508 $Id: utility.xsl 7101 2007-07-20 15:32:12Z xmldoc $
32512 <partintro id="partintro">
32513 <title>Introduction</title>
32515 <para>This is technical reference documentation for the
32516 miscellaneous utility templates in the DocBook XSL
32517 Stylesheets.</para>
32521 <para>These templates are defined in a separate file from the set
32522 of “common” templates because some of the common templates
32523 reference DocBook XSL stylesheet parameters, requiring the
32524 entire set of parameters to be imported/included in any
32525 stylesheet that imports/includes the common templates.</para>
32528 <para>The utility templates don’t import or include any DocBook
32529 XSL stylesheet parameters, so the utility templates can be used
32530 without importing the whole set of parameters.</para>
32534 <para>This is not intended to be user documentation. It is
32535 provided for developers writing customization layers for the
32536 stylesheets.</para>
32540 <refentry id="template.log.message">
32542 <refname>log.message</refname>
32543 <refpurpose>Logs/emits formatted notes and warnings</refpurpose>
32546 <synopsis><xsl:template name="log.message">
32547 <xsl:param name="level"/>
32548 <xsl:param name="source"/>
32549 <xsl:param name="context-desc"/>
32550 <xsl:param name="context-desc-field-length">12</xsl:param>
32551 <xsl:param name="context-desc-padded">
32552 <xsl:if test="not($context-desc = '')">
32553 <xsl:call-template name="pad-string">
32554 <xsl:with-param name="leftRight">right</xsl:with-param>
32555 <xsl:with-param name="padVar" select="substring($context-desc, 1, $context-desc-field-length)"/>
32556 <xsl:with-param name="length" select="$context-desc-field-length"/>
32557 </xsl:call-template>
32560 <xsl:param name="message"/>
32561 <xsl:param name="message-field-length" select="45"/>
32562 <xsl:param name="message-padded">
32563 <xsl:variable name="spaces-for-blank-level">
32564 <!-- * if the level field is blank, we'll need to pad out -->
32565 <!-- * the message field with spaces to compensate -->
32567 <xsl:when test="$level = ''">
32568 <xsl:value-of select="4 + 2"/>
32569 <!-- * 4 = hard-coded length of comment text ("Note" or "Warn") -->
32570 <!-- * + 2 = length of colon-plus-space separator ": " -->
32572 <xsl:otherwise>
32573 <xsl:value-of select="0"/>
32574 </xsl:otherwise>
32575 </xsl:choose>
32576 </xsl:variable>
32577 <xsl:variable name="spaces-for-blank-context-desc">
32578 <!-- * if the context-description field is blank, we'll need -->
32579 <!-- * to pad out the message field with spaces to compensate -->
32581 <xsl:when test="$context-desc = ''">
32582 <xsl:value-of select="$context-desc-field-length + 2"/>
32583 <!-- * + 2 = length of colon-plus-space separator ": " -->
32585 <xsl:otherwise>
32586 <xsl:value-of select="0"/>
32587 </xsl:otherwise>
32588 </xsl:choose>
32589 </xsl:variable>
32590 <xsl:variable name="extra-spaces" select="$spaces-for-blank-level + $spaces-for-blank-context-desc"/>
32591 <xsl:call-template name="pad-string">
32592 <xsl:with-param name="leftRight">right</xsl:with-param>
32593 <xsl:with-param name="padVar" select="substring($message, 1, ($message-field-length + $extra-spaces))"/>
32594 <xsl:with-param name="length" select="$message-field-length + $extra-spaces"/>
32595 </xsl:call-template>
32598 </xsl:template></synopsis>
32600 <refsect1><title>Description</title>
32602 <para>The <function>log.message</function> template is a utility
32603 template for logging/emitting formatted messages – that is,
32604 notes and warnings, along with a given log “level” and an
32605 identifier for the “source” that the message relates to.</para>
32607 </refsect1><refsect1><title>Parameters</title>
32610 <varlistentry><term>level</term>
32613 <para>Text to log/emit in the message-level field to
32614 indicate the message level
32615 (<literal>Note</literal> or
32616 <literal>Warning</literal>)</para>
32620 <varlistentry><term>source</term>
32623 <para>Text to log/emit in the source field to identify the
32624 “source” to which the notification/warning relates.
32625 This can be any arbitrary string, but because the
32626 message lacks line and column numbers to identify the
32627 exact part of the source document to which it
32628 relates, the intention is that the value you pass
32629 into the <literal>source</literal> parameter should
32630 give the user some way to identify the portion of
32631 their source document on which to take potentially
32632 take action in response to the log message (for
32633 example, to edit, change, or add content).</para>
32636 <para>So the <literal>source</literal> value should be,
32637 for example, an ID, book/chapter/article title, title
32638 of some formal object, or even a string giving an
32639 XPath expression.</para>
32643 <varlistentry><term>context-desc</term>
32646 <para>Text to log/emit in the context-description field to
32647 describe the context for the message.</para>
32651 <varlistentry><term>context-desc-field-length</term>
32654 <para>Specifies length of the context-description field
32655 (in characters); default is 12</para>
32658 <para>If the text specified by the
32659 <literal>context-desc</literal> parameter is longer
32660 than the number of characters specified in
32661 <literal>context-desc-field-length</literal>, it is
32662 truncated to <literal>context-desc-field-length</literal>
32663 (12 characters by default).</para>
32666 <para>If the specified text is shorter than
32667 <literal>context-desc-field-length</literal>,
32668 it is right-padded out to
32669 <literal>context-desc-field-length</literal> (12 by
32673 <para>If no value has been specified for the
32674 <literal>context-desc</literal> parameter, the field is
32675 left empty and the text of the log message begins with
32676 the value of the <literal>message</literal>
32681 <varlistentry><term>message</term>
32684 <para>Text to log/emit in the actual message field</para>
32688 <varlistentry><term>message-field-length</term>
32691 <para>Specifies length of the message
32692 field (in characters); default is 45</para>
32698 </refsect1><refsect1><title>Returns</title>
32700 <para>Outputs a message (generally, to standard error).</para>
32701 </refsect1></refentry>
32703 <refentry id="template.get.doc.title">
32705 <refname>get.doc.title</refname>
32706 <refpurpose>Gets a title from the current document</refpurpose>
32709 <synopsis><xsl:template name="get.doc.title"/></synopsis>
32711 <refsect1><title>Description</title>
32713 <para>The <function>get.doc.title</function> template is a
32714 utility template for returning the first title found in the
32715 current document.</para>
32717 </refsect1><refsect1><title>Returns</title>
32719 <para>Returns a string containing some identifying title for the
32720 current document .</para>
32721 </refsect1></refentry>
32723 <refentry id="template.pad-string">
32725 <refname>pad-string</refname>
32726 <refpurpose>Right-pads or left-pads a string out to a certain length</refpurpose>
32729 <synopsis><xsl:template name="pad-string">
32730 <xsl:param name="padChar" select="' '"/>
32731 <xsl:param name="leftRight">left</xsl:param>
32732 <xsl:param name="padVar"/>
32733 <xsl:param name="length"/>
32735 </xsl:template></synopsis>
32737 <refsect1><title>Description</title>
32739 <para>This function takes string <parameter>padVar</parameter> and
32740 pads it out in the direction <parameter>rightLeft</parameter> to
32741 the string-length <parameter>length</parameter>, using string
32742 <parameter>padChar</parameter> (a space character by default) as
32743 the padding string (note that <parameter>padChar</parameter> can
32744 be a string; it is not limited to just being a single
32749 <para>This function began as a copy of Nate Austin's
32750 <function>prepend-pad</function> function in the <link xlink:href="http://www.dpawson.co.uk/xsl/sect2/padding.html">Padding
32751 Content</link> section of Dave Pawson's <link xlink:href="http://www.dpawson.co.uk/xsl/index.html">XSLT
32755 </refsect1><refsect1><title>Returns</title>
32757 <para>Returns a (padded) string.</para>
32758 </refsect1></refentry>
32760 <reference id="charmap" xml:base="../common/charmap.xml">
32762 <title>Common » Character-Map Template Reference</title>
32763 <releaseinfo role="meta">
32764 $Id: charmap.xsl 7266 2007-08-22 11:58:42Z xmldoc $
32768 <partintro id="partintro">
32769 <title>Introduction</title>
32771 <para>This is technical reference documentation for the
32772 character-map templates in the DocBook XSL Stylesheets.</para>
32776 <para>These templates are defined in a separate file from the set
32777 of “common” templates because some of the common templates
32778 reference DocBook XSL stylesheet parameters, requiring the
32779 entire set of parameters to be imported/included in any
32780 stylesheet that imports/includes the common templates.</para>
32783 <para>The character-map templates don’t import or include
32784 any DocBook XSL stylesheet parameters, so the
32785 character-map templates can be used without importing the
32786 whole set of parameters.</para>
32790 <para>This is not intended to be user documentation. It is
32791 provided for developers writing customization layers for the
32792 stylesheets.</para>
32796 <refentry id="template.apply-character-map">
32798 <refname>apply-character-map</refname>
32799 <refpurpose>Applies an XSLT character map</refpurpose>
32802 <synopsis><xsl:template name="apply-character-map">
32803 <xsl:param name="content"/>
32804 <xsl:param name="map.contents"/>
32806 </xsl:template></synopsis>
32808 <refsect1><title>Description</title>
32810 <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
32811 individual characters to be substituted with strings of one
32812 or more characters. It is useful mainly for replacing
32813 multiple “special” characters or symbols in the same target
32814 content. It uses the value of
32815 <parameter>map.contents</parameter> to do substitution on
32816 <parameter>content</parameter>, and then returns the
32817 modified contents.</para>
32821 <para>This template is a very slightly modified version of
32822 Jeni Tennison’s <function>replace_strings</function>
32823 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
32824 <link xlink:href="http://www.dpawson.co.uk/xsl/index.html">XSLT FAQ</link>.</para>
32827 <para>The <function>apply-string-subst-map</function>
32828 template is essentially the same template as the
32829 <function>apply-character-map</function> template; the
32830 only difference is that in the map that
32831 <function>apply-string-subst-map</function> expects, <tag class="attribute">oldstring</tag> and <tag class="attribute">newstring</tag> attributes are used
32832 instead of <tag class="attribute">character</tag> and <tag class="attribute">string</tag> attributes.</para>
32835 </refsect1><refsect1><title>Parameters</title>
32838 <varlistentry><term>content</term>
32841 <para>The content on which to perform the character-map
32842 substitution.</para>
32846 <varlistentry><term>map.contents</term>
32849 <para>A node set of elements, with each element having
32850 the following attributes:
32854 <simpara><tag class="attribute">character</tag>, a
32855 character to be replaced</simpara>
32858 <simpara><tag class="attribute">string</tag>, a
32859 string with which to replace <tag class="attribute">character</tag></simpara>
32869 </refsect1></refentry>
32871 <refentry id="template.read-character-map">
32873 <refname>read-character-map</refname>
32874 <refpurpose>Reads in all or part of an XSLT character map</refpurpose>
32877 <synopsis><xsl:template name="read-character-map">
32878 <xsl:param name="use.subset"/>
32879 <xsl:param name="subset.profile"/>
32880 <xsl:param name="uri"/>
32882 </xsl:template></synopsis>
32884 <refsect1><title>Description</title>
32886 <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
32887 to allow a specific character appearing in a text or
32888 attribute node in a final result tree to be substituted by
32889 a specified string of characters during serialization. The
32890 <function>read-character-map</function> template provides a
32891 means for reading and using character maps with XSLT
32892 1.0-based tools.</para>
32895 <para>This template reads the character-map contents from
32896 <parameter>uri</parameter> (in full or in part, depending on
32897 the value of the <parameter>use.subset</parameter>
32898 parameter), then passes those contents to the
32899 <function>apply-character-map</function> template, along with
32900 <parameter>content</parameter>, the data on which to perform
32901 the character substitution.</para>
32904 <para>Using the character map “in part” means that it uses only
32905 those <tag>output-character</tag> elements that match the
32906 XPath expression given in the value of the
32907 <parameter>subset.profile</parameter> parameter. The current
32908 implementation of that capability here relies on the
32909 <function>evaluate</function> extension XSLT function.</para>
32911 </refsect1><refsect1><title>Parameters</title>
32914 <varlistentry><term>use.subset</term>
32917 <para>Specifies whether to use a subset of the character
32918 map instead of the whole map; boolean
32919 <literal>0</literal> or <literal>1</literal></para>
32923 <varlistentry><term>subset.profile</term>
32926 <para>XPath expression that specifies what subset of the
32927 character map to use</para>
32931 <varlistentry><term>uri</term>
32934 <para>URI for a character map</para>
32940 </refsect1></refentry>
32943 <part id="table-templates">
32944 <?dbhtml dir="fo"?>
32946 <info xml:base="../fo/table.xml">
32947 <title>Formatting Object Table Reference</title>
32948 <releaseinfo role="meta">
32949 $Id: table.xsl 8392 2009-04-01 08:47:55Z bobstayton $
32952 <partintro id="partintro" xml:base="../fo/table.xml">
32953 <title>Introduction</title>
32955 <para>This is technical reference documentation for the FO
32956 table-processing templates in the DocBook XSL Stylesheets.</para>
32959 <para>This is not intended to be user documentation. It is
32960 provided for developers writing customization layers for the
32961 stylesheets.</para>
32965 <refentry id="template.calc.column.width" xml:base="../fo/table.xml">
32967 <refname>calc.column.width</refname>
32968 <refpurpose>Calculate an XSL FO table column width specification from a
32969 CALS table column width specification.</refpurpose>
32972 <synopsis><xsl:template name="calc.column.width">
32973 <xsl:param name="colwidth">1*</xsl:param>
32975 </xsl:template></synopsis>
32977 <refsect1><title>Description</title>
32979 <para>CALS expresses table column widths in the following basic
32987 <para><emphasis>99.99units</emphasis>, a fixed length specifier.</para>
32992 <para><emphasis>99.99</emphasis>, a fixed length specifier without any units.</para>
32997 <para><emphasis>99.99*</emphasis>, a relative length specifier.</para>
33002 <para><emphasis>99.99*+99.99units</emphasis>, a combination of both.</para>
33009 <para>The CALS units are points (pt), picas (pi), centimeters (cm),
33010 millimeters (mm), and inches (in). These are the same units as XSL,
33011 except that XSL abbreviates picas "pc" instead of "pi". If a length
33012 specifier has no units, the CALS default unit (pt) is assumed.</para>
33016 <para>Relative length specifiers are represented in XSL with the
33017 proportional-column-width() function.</para>
33021 <para>Here are some examples:</para>
33028 <para>"36pt" becomes "36pt"</para>
33033 <para>"3pi" becomes "3pc"</para>
33038 <para>"36" becomes "36pt"</para>
33043 <para>"3*" becomes "proportional-column-width(3)"</para>
33048 <para>"3*+2pi" becomes "proportional-column-width(3)+2pc"</para>
33053 <para>"1*+2" becomes "proportional-column-width(1)+2pt"</para>
33058 </refsect1><refsect1><title>Parameters</title>
33061 <varlistentry><term>colwidth</term>
33064 <para>The CALS column width specification.</para>
33070 </refsect1><refsect1><title>Returns</title>
33072 <para>The XSL column width specification.</para>
33074 </refsect1></refentry>
33077 <part id="template">
33078 <?dbhtml dir="template"?><?dbhtml filename="index.html"?>
33081 <info xml:base="../template/titlepage.xml">
33082 <title>Titlepage Template Stylesheet Reference</title>
33083 <releaseinfo role="meta">
33084 $Id: titlepage.xsl 7058 2007-07-17 13:59:29Z xmldoc $
33087 <partintro id="intro_partintro" xml:base="../template/titlepage.xml">
33088 <title>Introduction</title>
33090 <para>This is technical reference documentation for the
33091 “titlepage” templates in the DocBook XSL Stylesheets.</para>
33094 <para>This is not intended to be user documentation. It is
33095 provided for developers writing customization layers for the
33096 stylesheets.</para>
33100 <refentry id="templates" xml:base="../template/titlepage.xml">
33102 <refname>t:templates</refname>
33103 <refpurpose>Construct a stylesheet for the templates provided</refpurpose>
33106 <synopsis><xsl:template match="t:templates"/></synopsis>
33108 <refsect1><title>Description</title>
33110 <para>The <literal>t:templates</literal> element is the root of a
33111 set of templates. This template creates an appropriate
33112 <literal>xsl:stylesheet</literal> for the templates.</para>
33116 <para>If the <literal>t:templates</literal> element has a
33117 <literal>base-stylesheet</literal> attribute, an
33118 <literal>xsl:import</literal> statement is constructed for it.</para>
33120 </refsect1></refentry>
33122 <refentry id="star" xml:base="../template/titlepage.xml">
33124 <refname>xsl:*</refname>
33125 <refpurpose>Copy xsl: elements straight through</refpurpose>
33128 <synopsis><xsl:template match="xsl:*"/></synopsis>
33130 <refsect1><title>Description</title>
33132 <para>This template simply copies the xsl: elements
33133 straight through into the result tree.</para>
33135 </refsect1></refentry>
33137 <refentry id="titlepage" xml:base="../template/titlepage.xml">
33139 <refname>t:titlepage</refname>
33140 <refpurpose>Create the templates necessary to construct a title page</refpurpose>
33143 <synopsis><xsl:template match="t:titlepage"/></synopsis>
33145 <refsect1><title>Description</title>
33147 <para>The <literal>t:titlepage</literal> element creates a set of
33148 templates for processing the titlepage for an element. The
33149 <quote>root</quote> of this template set is the template named
33150 <quote><literal>wrapper.titlepage</literal></quote>. That is the
33151 template that should be called to generate the title page.
33156 <para>The <literal>t:titlepage</literal> element has three attributes:
33160 <varlistentry><term>element</term>
33162 <para>The name of the source document element for which
33163 these templates apply. In other words, to make a title page for the
33164 <tag>article</tag> element, set the
33165 <tag class="attribute">element</tag> attribute to
33166 <quote><literal>article</literal></quote>. This attribute is required.
33170 <varlistentry><term>wrapper</term>
33172 <para>The entire title page can be wrapped with an element.
33173 This attribute identifies that element.
33177 <varlistentry><term>class</term>
33179 <para>If the <tag class="attribute">class</tag> attribute
33180 is set, a <tag class="attribute">class</tag> attribute with this
33181 value will be added to the wrapper element that surrounds the entire
33192 <para>Any other attributes are copied through literally to the
33193 wrapper element.</para>
33197 <para>The content of a <literal>t:titlepage</literal> is one or
33198 more <literal>t:titlepage-content</literal>,
33199 <literal>t:titlepage-separator</literal>, and
33200 <literal>t:titlepage-before</literal> elements.</para>
33204 <para>Each of these elements may be provided for the <quote>recto</quote>
33205 and <quote>verso</quote> sides of the title page.</para>
33208 </refsect1></refentry>
33210 <refentry id="attr_star_in_copy.literal.atts" xml:base="../template/titlepage.xml">
33212 <refname>@* (in copy.literal.atts mode)</refname>
33213 <refpurpose>Copy t:titlepage attributes</refpurpose>
33216 <synopsis><xsl:template match="@*" mode="copy.literal.atts"/></synopsis>
33218 <refsect1><title>Description</title>
33220 <para>This template copies all of the <quote>other</quote> attributes
33221 from a <literal>t:titlepage</literal> element onto the specified
33224 </refsect1></refentry>
33226 <refentry id="titlepage-content" xml:base="../template/titlepage.xml">
33228 <refname>t:titlepage-content</refname>
33229 <refpurpose>Create templates for the content of one side of a title page</refpurpose>
33232 <synopsis><xsl:template match="t:titlepage-content"/></synopsis>
33234 <refsect1><title>Description</title>
33236 <para>The title page content, that is, the elements from the source
33237 document that are rendered on the title page, can be controlled independently
33238 for the recto and verso sides of the title page.</para>
33242 <para>The <literal>t:titlepage-content</literal> element has two attributes:
33246 <varlistentry><term>side</term>
33248 <para>Identifies the side of the page to which this title
33249 page content applies. The
33250 <tag class="attribute">side</tag> attribute is required and
33251 must be set to either
33252 <quote><literal>recto</literal></quote> or
33253 <quote><literal>verso</literal></quote>. In addition, you must specify
33254 exactly one <literal>t:titlepage-content</literal> for each side
33255 within each <literal>t:titlepage</literal>.</para>
33259 <varlistentry><term>order</term>
33261 <para>Indicates how the order of the elements presented on
33262 the title page is determined. If the
33263 <tag class="attribute">order</tag> is
33264 <quote><literal>document</literal></quote>, the elements are presented
33265 in document order. Otherwise (if the
33266 <tag class="attribute">order</tag> is
33267 <quote><literal>stylesheet</literal></quote>), the elements are presented
33268 in the order that they appear in the template (and consequently in
33269 the stylesheet).</para>
33279 <para>The content of a <literal>t:titlepage-content</literal> element is
33280 a list of element names. These names should be unqualified. They identify
33281 the elements in the source document that should appear on the title page.
33286 <para>Each element may have a single attribute:
33287 <tag class="attribute">predicate</tag>. The value of this
33288 attribute is used as a predicate for the expression that matches
33289 the element on which it occurs.</para>
33293 <para>In other words, to put only the first three authors on the
33294 recto-side of a title
33295 page, you could specify:
33298 <t:titlepage-contents side="recto">
33299 <!-- other titlepage elements -->
33300 <author predicate="[count(previous-sibling::author)<2]"/>
33301 <!-- other titlepage elements -->
33302 </t:titlepage-contents>
33308 <para>Usually, the elements so named are empty. But it is possible to
33309 make one level of selection within them. Suppose that you want to
33310 process <literal>authorgroup</literal> elements on the title page, but
33311 you want to select only proper authors, editors, or corporate authors,
33312 not collaborators or other credited authors.</para>
33316 <para>In that case, you can put a <literal>t:or</literal> group inside
33317 the <literal>authorgroup</literal> element:
33320 <t:titlepage-contents side="recto">
33321 <!-- other titlepage elements -->
33322 <authorgroup>
33326 <corpauthor/>
33328 </authorgroup>
33329 <!-- other titlepage elements -->
33330 </t:titlepage-contents>
33336 <para>This will have the effect of automatically generating a template
33337 for processing <literal>authorgroup</literal>s in the title page mode,
33338 selecting only the specified children. If you need more complex processing,
33339 you'll have to construct the templates by hand.</para>
33342 </refsect1></refentry>
33344 <refentry id="titlepage-separator" xml:base="../template/titlepage.xml">
33346 <refname>t:titlepage-separator</refname>
33347 <refpurpose>Create templates for the separator</refpurpose>
33350 <synopsis><xsl:template match="t:titlepage-separator"/></synopsis>
33352 <refsect1><title>Description</title>
33354 <para>The title page is separated from the content which follows it by
33355 the markup specified in the <literal>t:titlepage-separator</literal>
33358 </refsect1></refentry>
33360 <refentry id="titlepage-before" xml:base="../template/titlepage.xml">
33362 <refname>t:titlepage-before</refname>
33363 <refpurpose>Create templates for what precedes a title page</refpurpose>
33366 <synopsis><xsl:template match="t:titlepage-before"/></synopsis>
33368 <refsect1><title>Description</title>
33370 <para>Each side of the title page is preceded by the markup specified
33371 in the <literal>t:titlepage-before</literal> element for that
33374 </refsect1></refentry>
33376 <refentry id="star_in_copy" xml:base="../template/titlepage.xml">
33378 <refname>* (in copy mode)</refname>
33379 <refpurpose>Copy elements</refpurpose>
33382 <synopsis><xsl:template match="*" mode="copy"/></synopsis>
33384 <refsect1><title>Description</title>
33386 <para>This template simply copies the elements that it applies to
33387 straight through into the result tree.</para>
33389 </refsect1></refentry>
33391 <refentry id="attr_star_in_copy" xml:base="../template/titlepage.xml">
33393 <refname>@* (in copy mode)</refname>
33394 <refpurpose>Copy attributes</refpurpose>
33397 <synopsis><xsl:template match="@*" mode="copy"/></synopsis>
33399 <refsect1><title>Description</title>
33401 <para>This template simply copies the attributes that it applies to
33402 straight through into the result tree.</para>
33404 </refsect1></refentry>
33406 <refentry id="attr_star_in_document.order" xml:base="../template/titlepage.xml">
33408 <refname>* (in document.order mode)</refname>
33409 <refpurpose>Create rules to process titlepage elements in document order</refpurpose>
33412 <synopsis><xsl:template match="*" mode="document.order"/></synopsis>
33414 <refsect1><title>Description</title>
33416 <para>This template is called to process all of the children of the
33417 <literal>t:titlepage-content</literal> element. It creates the hairy
33418 select expression necessary to process each of those elements in
33419 the title page.</para>
33423 <para>Note that this template automatically handles the case where
33424 some DocBook elements, like title and subtitle, can occur both inside
33425 the *info elements where metadata is usually stored and outside.
33430 <para>It also automatically calculates the name for the *info container
33431 and handles elements that have historically had containers with different
33435 </refsect1></refentry>
33437 <refentry id="star_in_document.order" xml:base="../template/titlepage.xml">
33439 <refname>* (in document.order mode)</refname>
33440 <refpurpose>Create rules to process titlepage elements in stylesheet order</refpurpose>
33443 <synopsis><xsl:template match="*" mode="document.order"/></synopsis>
33445 <refsect1><title>Description</title>
33447 <para>This template is called to process all of the children of the
33448 <literal>t:titlepage-content</literal> element. It creates the set
33449 of <literal>xsl:apply-templates</literal> elements necessary
33450 process each of those elements in the title page.</para>
33454 <para>Note that this template automatically handles the case where
33455 some DocBook elements, like title and subtitle, can occur both inside
33456 the *info elements where metadata is usually stored and outside.
33461 <para>It also automatically calculates the name for the *info container
33462 and handles elements that have historically had containers with different
33466 </refsect1></refentry>
33468 <refentry id="star_in_titlepage.specialrules" xml:base="../template/titlepage.xml">
33470 <refname>* (in titlepage.specialrules mode)</refname>
33471 <refpurpose>Create templates for special rules</refpurpose>
33474 <synopsis><xsl:template match="*" mode="titlepage.specialrules"/></synopsis>
33476 <refsect1><title>Description</title>
33478 <para>This template is called to process all of the descendants of the
33479 <literal>t:titlepage-content</literal> element that require special
33480 processing. At present, that's just <literal>t:or</literal> elements.
33483 </refsect1></refentry>
33485 <refentry id="star_in_titlepage.subrules" xml:base="../template/titlepage.xml">
33487 <refname>* (in titlepage.subrules mode)</refname>
33488 <refpurpose>Create template for individual special rules</refpurpose>
33491 <synopsis><xsl:template match="*" mode="titlepage.subrules"/></synopsis>
33493 <refsect1><title>Description</title>
33495 <para>This template is called to process the children of special
33499 </refsect1></refentry>
33501 <refentry id="or" xml:base="../template/titlepage.xml">
33503 <refname>t:or</refname>
33504 <refpurpose>Process the t:or special rule</refpurpose>
33507 <synopsis><xsl:template match="t:or"/><xsl:template match="t:or" mode="titlepage.subrules"/></synopsis>
33509 <refsect1><title>Description</title>
33511 <para>This template processes t:or.</para>
33513 </refsect1></refentry>
33515 <refentry id="or_in_titlepage.subrules" xml:base="../template/titlepage.xml">
33517 <refname>t:or (in titlepage.subrules mode)</refname>
33518 <refpurpose>Process the t:or special rule in
33519 titlepage.subrules mode</refpurpose>
33522 <synopsis><xsl:template match="t:or" mode="titlepage.subrules"/></synopsis>
33524 <refsect1><title>Description</title>
33526 <para>The titlepage.subrules mode doesn't apply to t:or, so just
33527 reprocess this node in the normal mode.</para>
33529 </refsect1></refentry>
33531 <refentry id="template.element-or-list" xml:base="../template/titlepage.xml">
33533 <refname>element-or-list</refname>
33534 <refpurpose>Construct the "or-list" used in the select attribute for
33535 special rules.</refpurpose>
33538 <synopsis><xsl:template name="element-or-list">
33539 <xsl:param name="elements" select="*"/>
33540 <xsl:param name="element.count" select="count($elements)"/>
33541 <xsl:param name="count" select="1"/>
33542 <xsl:param name="orlist"/>
33544 </xsl:template></synopsis>
33546 <refsect1><title>Description</title>
33548 <para>Walk through each of the children of t:or, producing the
33549 text of the select attribute.</para>
33551 </refsect1></refentry>
33555 </set><!-- * vim: set ft=docbk foldlevel=2: -->