1 <?xml version="1.0" encoding="ASCII"?>
\r
4 <title>HTML Parameter Reference</title>
\r
5 <releaseinfo role="meta">
\r
6 $Id: param.xweb 8345 2009-03-16 06:44:07Z bobstayton $
\r
10 <surname>Walsh</surname>
\r
11 <firstname>Norman</firstname>
\r
24 <holder>Norman Walsh</holder>
\r
27 <para>This is reference documentation for all user-configurable
\r
28 parameters in the DocBook XSL HTML stylesheets (for generating
\r
29 HTML output).</para>
\r
32 <reference xml:id="admons"><title>Admonitions</title>
\r
33 <refentry version="5.0" xml:id="admon.graphics.extension">
\r
35 <refentrytitle>admon.graphics.extension</refentrytitle>
\r
36 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
\r
39 <refname>admon.graphics.extension</refname>
\r
40 <refpurpose>Filename extension for admonition graphics</refpurpose>
\r
44 <programlisting xml:id="admon.graphics.extension.frag">
\r
45 <xsl:param name="admon.graphics.extension">.png</xsl:param>
\r
49 <refsection><info><title>Description</title></info>
\r
51 <para>Sets the filename extension to use on admonition graphics.</para>
\r
56 <refentry version="5.0" xml:id="admon.graphics.path">
\r
58 <refentrytitle>admon.graphics.path</refentrytitle>
\r
59 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
\r
62 <refname>admon.graphics.path</refname>
\r
63 <refpurpose>Path to admonition graphics</refpurpose>
\r
67 <programlisting xml:id="admon.graphics.path.frag"><xsl:param name="admon.graphics.path">images/</xsl:param></programlisting>
\r
70 <refsection><info><title>Description</title></info>
\r
72 <para>Sets the path to the directory containing the admonition graphics
\r
73 (caution.png, important.png etc). This location is normally relative
\r
74 to the output html directory. See <parameter>base.dir</parameter></para>
\r
79 <refentry version="5.0" xml:id="admon.graphics">
\r
81 <refentrytitle>admon.graphics</refentrytitle>
\r
82 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
85 <refname>admon.graphics</refname>
\r
86 <refpurpose>Use graphics in admonitions?</refpurpose>
\r
90 <programlisting xml:id="admon.graphics.frag">
\r
91 <xsl:param name="admon.graphics" select="0"></xsl:param>
\r
95 <refsection><info><title>Description</title></info>
\r
97 <para>If true (non-zero), admonitions are presented in an alternate style that uses
\r
98 a graphic. Default graphics are provided in the distribution.
\r
104 <refentry version="5.0" xml:id="admon.textlabel">
\r
106 <refentrytitle>admon.textlabel</refentrytitle>
\r
107 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
110 <refname>admon.textlabel</refname>
\r
111 <refpurpose>Use text label in admonitions?</refpurpose>
\r
115 <programlisting xml:id="admon.textlabel.frag">
\r
116 <xsl:param name="admon.textlabel" select="1"></xsl:param>
\r
120 <refsection><info><title>Description</title></info>
\r
122 <para>If true (non-zero), admonitions are presented with a generated
\r
123 text label such as Note or Warning in the appropriate language.
\r
124 If zero, such labels are turned off, but any title child
\r
125 of the admonition element are still output.
\r
126 The default value is 1.
\r
132 <refentry version="5.0" xml:id="admon.style">
\r
134 <refentrytitle>admon.style</refentrytitle>
\r
135 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
\r
138 <refname>admon.style</refname>
\r
139 <refpurpose>Specifies the CSS style attribute that should be added to
\r
140 admonitions.</refpurpose>
\r
144 <programlisting xml:id="admon.style.frag"><xsl:param name="admon.style">
\r
145 <xsl:value-of select="concat('margin-', $direction.align.start, ': 0.5in; margin-', $direction.align.end, ': 0.5in;')"></xsl:value-of>
\r
146 </xsl:param></programlisting>
\r
149 <refsection><info><title>Description</title></info>
\r
151 <para>Specifies the value of the CSS <tag class="attribute">style</tag>
\r
152 attribute that should be added to admonitions.
\r
159 <reference xml:id="callouts"><title>Callouts</title>
\r
160 <refentry version="5.0" xml:id="callout.defaultcolumn">
\r
162 <refentrytitle>callout.defaultcolumn</refentrytitle>
\r
163 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
\r
166 <refname>callout.defaultcolumn</refname>
\r
167 <refpurpose>Indicates what column callouts appear in by default</refpurpose>
\r
171 <programlisting xml:id="callout.defaultcolumn.frag">
\r
172 <xsl:param name="callout.defaultcolumn">60</xsl:param>
\r
176 <refsection><info><title>Description</title></info>
\r
178 <para>If a callout does not identify a column (for example, if it uses
\r
179 the <literal>linerange</literal> <tag class="attribute">unit</tag>),
\r
180 it will appear in the default column.
\r
186 <refentry version="5.0" xml:id="callout.graphics.extension">
\r
188 <refentrytitle>callout.graphics.extension</refentrytitle>
\r
189 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
\r
192 <refname>callout.graphics.extension</refname>
\r
193 <refpurpose>Filename extension for callout graphics</refpurpose>
\r
197 <programlisting xml:id="callout.graphics.extension.frag">
\r
198 <xsl:param name="callout.graphics.extension">.png</xsl:param>
\r
203 <refsection><info><title>Description</title></info>
\r
204 <para>Sets the filename extension to use on callout graphics. </para>
\r
207 <para>The Docbook XSL distribution provides callout graphics in the following formats:</para>
\r
208 <listitem><para>SVG (extension: <filename class="extension">.svg</filename>)</para></listitem>
\r
209 <listitem><para>PNG (extension: <filename class="extension">.png</filename>)</para></listitem>
\r
210 <listitem><para>GIF (extension: <filename class="extension">.gif</filename>)</para></listitem>
\r
215 <refentry version="5.0" xml:id="callout.graphics.number.limit">
\r
217 <refentrytitle>callout.graphics.number.limit</refentrytitle>
\r
218 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
\r
221 <refname>callout.graphics.number.limit</refname>
\r
222 <refpurpose>Number of the largest callout graphic</refpurpose>
\r
226 <programlisting xml:id="callout.graphics.number.limit.frag">
\r
227 <xsl:param name="callout.graphics.number.limit">15</xsl:param>
\r
232 <refsection><info><title>Description</title></info>
\r
234 <para>If <parameter>callout.graphics</parameter> is non-zero, graphics
\r
235 are used to represent callout numbers instead of plain text. The value
\r
236 of <parameter>callout.graphics.number.limit</parameter> is the largest
\r
237 number for which a graphic exists. If the callout number exceeds this
\r
238 limit, the default presentation "(plain text instead of a graphic)"
\r
245 <refentry version="5.0" xml:id="callout.graphics.path">
\r
247 <refentrytitle>callout.graphics.path</refentrytitle>
\r
248 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
\r
251 <refname>callout.graphics.path</refname>
\r
252 <refpurpose>Path to callout graphics</refpurpose>
\r
256 <programlisting xml:id="callout.graphics.path.frag">
\r
257 <xsl:param name="callout.graphics.path">images/callouts/</xsl:param>
\r
261 <refsection><info><title>Description</title></info>
\r
263 <para>Sets the path to the directory holding the callout graphics. his
\r
264 location is normally relative to the output html directory. see
\r
265 base.dir. Always terminate the directory with / since the graphic file
\r
266 is appended to this string, hence needs the separator.
\r
272 <refentry version="5.0" xml:id="callout.graphics">
\r
274 <refentrytitle>callout.graphics</refentrytitle>
\r
275 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
278 <refname>callout.graphics</refname>
\r
279 <refpurpose>Use graphics for callouts?</refpurpose>
\r
283 <programlisting xml:id="callout.graphics.frag">
\r
284 <xsl:param name="callout.graphics" select="1"></xsl:param>
\r
288 <refsection><info><title>Description</title></info>
\r
290 <para>If non-zero, callouts are presented with graphics (e.g., reverse-video
\r
291 circled numbers instead of "(1)", "(2)", etc.).
\r
292 Default graphics are provided in the distribution.
\r
298 <refentry version="5.0" xml:id="callout.list.table">
\r
300 <refentrytitle>callout.list.table</refentrytitle>
\r
301 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
304 <refname>callout.list.table</refname>
\r
305 <refpurpose>Present callout lists using a table?</refpurpose>
\r
309 <programlisting xml:id="callout.list.table.frag">
\r
310 <xsl:param name="callout.list.table" select="1"></xsl:param>
\r
314 <refsection><info><title>Description</title></info>
\r
316 <para>The default presentation of <tag>calloutlist</tag>s uses
\r
317 an HTML <tag>DL</tag> element. Some browsers don't align DLs very well
\r
318 if <parameter>callout.graphics</parameter> is used. With this option
\r
319 turned on, <tag>calloutlist</tag>s are presented in an HTML
\r
320 <tag>TABLE</tag>, which usually results in better alignment
\r
321 of the callout number with the callout description.</para>
\r
326 <refentry version="5.0" xml:id="callout.unicode.number.limit">
\r
328 <refentrytitle>callout.unicode.number.limit</refentrytitle>
\r
329 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
\r
332 <refname>callout.unicode.number.limit</refname>
\r
333 <refpurpose>Number of the largest unicode callout character</refpurpose>
\r
337 <programlisting xml:id="callout.unicode.number.limit.frag">
\r
338 <xsl:param name="callout.unicode.number.limit">10</xsl:param>
\r
342 <refsection><info><title>Description</title></info>
\r
344 <para>If <parameter>callout.unicode</parameter>
\r
345 is non-zero, unicode characters are used to represent
\r
346 callout numbers. The value of
\r
347 <parameter>callout.unicode.number.limit</parameter>
\r
349 the largest number for which a unicode character exists. If the callout number
\r
350 exceeds this limit, the default presentation "(nnn)" will always
\r
357 <refentry version="5.0" xml:id="callout.unicode.start.character">
\r
359 <refentrytitle>callout.unicode.start.character</refentrytitle>
\r
360 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
\r
363 <refname>callout.unicode.start.character</refname>
\r
364 <refpurpose>First Unicode character to use, decimal value.</refpurpose>
\r
368 <programlisting xml:id="callout.unicode.start.character.frag">
\r
369 <xsl:param name="callout.unicode.start.character">10102</xsl:param>
\r
373 <refsection><info><title>Description</title></info>
\r
375 <para>If <parameter>callout.graphics</parameter> is zero and <parameter>callout.unicode</parameter>
\r
376 is non-zero, unicode characters are used to represent
\r
377 callout numbers. The value of
\r
378 <parameter>callout.unicode.start.character</parameter>
\r
379 is the decimal unicode value used for callout number one. Currently,
\r
380 only 10102 is supported in the stylesheets for this parameter.
\r
386 <refentry version="5.0" xml:id="callout.unicode">
\r
388 <refentrytitle>callout.unicode</refentrytitle>
\r
389 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
392 <refname>callout.unicode</refname>
\r
393 <refpurpose>Use Unicode characters rather than images for callouts.</refpurpose>
\r
397 <programlisting xml:id="callout.unicode.frag"><xsl:param name="callout.unicode" select="0"></xsl:param></programlisting>
\r
400 <refsection><info><title>Description</title></info>
\r
402 <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.
\r
408 <refentry version="5.0" xml:id="callouts.extension">
\r
410 <refentrytitle>callouts.extension</refentrytitle>
\r
411 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
414 <refname>callouts.extension</refname>
\r
415 <refpurpose>Enable the callout extension</refpurpose>
\r
419 <programlisting xml:id="callouts.extension.frag">
\r
420 <xsl:param name="callouts.extension" select="1"></xsl:param>
\r
424 <refsection><info><title>Description</title></info>
\r
426 <para>The callouts extension processes <tag>areaset</tag>
\r
427 elements in <tag>ProgramListingCO</tag> and other text-based
\r
435 <reference xml:id="ebnf"><title>EBNF</title>
\r
436 <refentry version="5.0" xml:id="ebnf.table.bgcolor">
\r
438 <refentrytitle>ebnf.table.bgcolor</refentrytitle>
\r
439 <refmiscinfo class="other" otherclass="datatype">color</refmiscinfo>
\r
442 <refname>ebnf.table.bgcolor</refname>
\r
443 <refpurpose>Background color for EBNF tables</refpurpose>
\r
447 <programlisting xml:id="ebnf.table.bgcolor.frag">
\r
448 <xsl:param name="ebnf.table.bgcolor">#F5DCB3</xsl:param>
\r
452 <refsection><info><title>Description</title></info>
\r
454 <para>Sets the background color for EBNF tables (a pale brown). No
\r
455 <tag>bgcolor</tag> attribute is output if
\r
456 <parameter>ebnf.table.bgcolor</parameter> is set to the null string. </para>
\r
462 <refentry version="5.0" xml:id="ebnf.table.border">
\r
464 <refentrytitle>ebnf.table.border</refentrytitle>
\r
465 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
468 <refname>ebnf.table.border</refname>
\r
469 <refpurpose>Selects border on EBNF tables</refpurpose>
\r
473 <programlisting xml:id="ebnf.table.border.frag"><xsl:param name="ebnf.table.border" select="1"></xsl:param></programlisting>
\r
476 <refsection><info><title>Description</title></info>
\r
478 <para>Selects the border on EBNF tables. If non-zero, the tables have
\r
479 borders, otherwise they don't.</para>
\r
484 <refentry version="5.0" xml:id="ebnf.assignment">
\r
486 <refentrytitle>ebnf.assignment</refentrytitle>
\r
487 <refmiscinfo class="other" otherclass="datatype">rtf</refmiscinfo>
\r
490 <refname>ebnf.assignment</refname>
\r
491 <refpurpose>The EBNF production assignment operator</refpurpose>
\r
495 <programlisting xml:id="ebnf.assignment.frag">
\r
496 <xsl:param name="ebnf.assignment">
\r
497 <code>::=</code>
\r
503 <refsection><info><title>Description</title></info>
\r
505 <para>The <parameter>ebnf.assignment</parameter> parameter determines what
\r
506 text is used to show <quote>assignment</quote> in <tag>production</tag>s
\r
507 in <tag>productionset</tag>s.</para>
\r
509 <para>While <quote><literal>::=</literal></quote> is common, so are several
\r
510 other operators.</para>
\r
515 <refentry version="5.0" xml:id="ebnf.statement.terminator">
\r
517 <refentrytitle>ebnf.statement.terminator</refentrytitle>
\r
518 <refmiscinfo class="other" otherclass="datatype">rtf</refmiscinfo>
\r
521 <refname>ebnf.statement.terminator</refname>
\r
522 <refpurpose>Punctuation that ends an EBNF statement.</refpurpose>
\r
526 <programlisting xml:id="ebnf.statement.terminator.frag">
\r
527 <xsl:param name="ebnf.statement.terminator"></xsl:param>
\r
532 <refsection><info><title>Description</title></info>
\r
534 <para>The <parameter>ebnf.statement.terminator</parameter> parameter determines what
\r
535 text is used to terminate each <tag>production</tag>
\r
536 in <tag>productionset</tag>.</para>
\r
538 <para>Some notations end each statement with a period.</para>
\r
544 <reference xml:id="toc_index"><title>ToC/LoT/Index Generation</title>
\r
545 <refentry version="5.0" xml:id="annotate.toc">
\r
547 <refentrytitle>annotate.toc</refentrytitle>
\r
548 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
551 <refname>annotate.toc</refname>
\r
552 <refpurpose>Annotate the Table of Contents?</refpurpose>
\r
556 <programlisting xml:id="annotate.toc.frag"><xsl:param name="annotate.toc" select="1"></xsl:param></programlisting>
\r
559 <refsection><info><title>Description</title></info>
\r
561 <para>If true, TOCs will be annotated. At present, this just means
\r
562 that the <tag>refpurpose</tag> of <tag>refentry</tag>
\r
563 TOC entries will be displayed.
\r
569 <refentry version="5.0" xml:id="autotoc.label.separator">
\r
571 <refentrytitle>autotoc.label.separator</refentrytitle>
\r
572 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
\r
575 <refname>autotoc.label.separator</refname>
\r
576 <refpurpose>Separator between labels and titles in the ToC</refpurpose>
\r
580 <programlisting xml:id="autotoc.label.separator.frag">
\r
581 <xsl:param name="autotoc.label.separator">. </xsl:param>
\r
585 <refsection><info><title>Description</title></info>
\r
587 <para>String used to separate labels and titles in a table of contents.</para>
\r
592 <refentry version="5.0" xml:id="autotoc.label.in.hyperlink">
\r
594 <refentrytitle>autotoc.label.in.hyperlink</refentrytitle>
\r
595 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
598 <refname>autotoc.label.in.hyperlink</refname>
\r
599 <refpurpose>Include label in hyperlinked titles in TOC?</refpurpose>
\r
603 <programlisting xml:id="autotoc.label.in.hyperlink.frag"><xsl:param name="autotoc.label.in.hyperlink" select="1"></xsl:param></programlisting>
\r
606 <refsection><info><title>Description</title></info>
\r
608 <para>If the value of
\r
609 <parameter>autotoc.label.in.hyperlink</parameter> is non-zero, labels
\r
610 are included in hyperlinked titles in the TOC. If it is instead zero,
\r
611 labels are still displayed prior to the hyperlinked titles, but
\r
612 are not hyperlinked along with the titles.</para>
\r
617 <refentry version="5.0" xml:id="process.source.toc">
\r
619 <refentrytitle>process.source.toc</refentrytitle>
\r
620 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
623 <refname>process.source.toc</refname>
\r
624 <refpurpose>Process a non-empty <tag>toc</tag> element if it occurs in a source document?</refpurpose>
\r
628 <programlisting xml:id="process.source.toc.frag"><xsl:param name="process.source.toc" select="0"></xsl:param></programlisting>
\r
631 <refsection><info><title>Description</title></info>
\r
633 <para>Specifies that the contents of a non-empty "hard-coded"
\r
634 <tag>toc</tag> element in a source document are processed to
\r
635 generate a TOC in output.
\r
637 <para>This parameter has no effect on automated generation of
\r
638 TOCs. An automated TOC may still be generated along with the
\r
639 "hard-coded" TOC. To suppress automated TOC generation, adjust the
\r
640 value of the <parameter>generate.toc</parameter> paramameter.</para>
\r
642 <para>The <tag>process.source.toc</tag> parameter also has
\r
643 no effect if the <tag>toc</tag> element is empty; handling
\r
644 for empty <tag>toc</tag> is controlled by the
\r
645 <parameter>process.empty.source.toc</parameter> parameter.</para>
\r
652 <refentry version="5.0" xml:id="process.empty.source.toc">
\r
654 <refentrytitle>process.empty.source.toc</refentrytitle>
\r
655 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
658 <refname>process.empty.source.toc</refname>
\r
659 <refpurpose>Generate automated TOC if <tag>toc</tag> element occurs in a source document?</refpurpose>
\r
663 <programlisting xml:id="process.empty.source.toc.frag"><xsl:param name="process.empty.source.toc" select="0"></xsl:param></programlisting>
\r
666 <refsection><info><title>Description</title></info>
\r
668 <para>Specifies that if an empty <tag>toc</tag> element is found in a
\r
669 source document, an automated TOC is generated at this point in the
\r
672 <para>Depending on what the value of the
\r
673 <parameter>generate.toc</parameter> parameter is, setting this
\r
674 parameter to <literal>1</literal> could result in generation of
\r
675 duplicate automated TOCs. So the
\r
676 <parameter>process.empty.source.toc</parameter> is primarily useful
\r
677 as an "override": by placing an empty <tag>toc</tag> in your
\r
678 document and setting this parameter to <literal>1</literal>, you can
\r
679 force a TOC to be generated even if <tag>generate.toc</tag>
\r
680 says not to.</para>
\r
687 <refentry version="5.0" xml:id="bridgehead.in.toc">
\r
689 <refentrytitle>bridgehead.in.toc</refentrytitle>
\r
690 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
693 <refname>bridgehead.in.toc</refname>
\r
694 <refpurpose>Should bridgehead elements appear in the TOC?</refpurpose>
\r
698 <programlisting xml:id="bridgehead.in.toc.frag"><xsl:param name="bridgehead.in.toc" select="0"></xsl:param></programlisting>
\r
701 <refsection><info><title>Description</title></info>
\r
703 <para>If non-zero, <tag>bridgehead</tag>s appear in the TOC. Note that
\r
704 this option is not fully supported and may be removed in a future
\r
705 version of the stylesheets.
\r
711 <refentry version="5.0" xml:id="simplesect.in.toc">
\r
713 <refentrytitle>simplesect.in.toc</refentrytitle>
\r
714 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
717 <refname>simplesect.in.toc</refname>
\r
718 <refpurpose>Should <tag>simplesect</tag> elements appear in the TOC?</refpurpose>
\r
722 <programlisting xml:id="simplesect.in.toc.frag"><xsl:param name="simplesect.in.toc" select="0"></xsl:param></programlisting>
\r
725 <refsection><info><title>Description</title></info>
\r
727 <para>If non-zero, <tag>simplesect</tag>s will be included in the TOC.
\r
733 <refentry version="5.0" xml:id="manual.toc">
\r
735 <refentrytitle>manual.toc</refentrytitle>
\r
736 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
\r
739 <refname>manual.toc</refname>
\r
740 <refpurpose>An explicit TOC to be used for the TOC</refpurpose>
\r
744 <programlisting xml:id="manual.toc.frag">
\r
745 <xsl:param name="manual.toc"></xsl:param>
\r
749 <refsection><info><title>Description</title></info>
\r
751 <para>The <parameter>manual.toc</parameter> identifies an explicit TOC that
\r
752 will be used for building the printed TOC.
\r
758 <refentry version="5.0" xml:id="toc.list.type">
\r
760 <refentrytitle>toc.list.type</refentrytitle>
\r
761 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
\r
762 <refmiscinfo class="other" otherclass="value">dl</refmiscinfo>
\r
763 <refmiscinfo class="other" otherclass="value">ul</refmiscinfo>
\r
764 <refmiscinfo class="other" otherclass="value">ol</refmiscinfo>
\r
767 <refname>toc.list.type</refname>
\r
768 <refpurpose>Type of HTML list element to use for Tables of Contents</refpurpose>
\r
772 <programlisting xml:id="toc.list.type.frag"><xsl:param name="toc.list.type">dl</xsl:param></programlisting>
\r
775 <refsection><info><title>Description</title></info>
\r
777 <para>When an automatically generated Table of Contents (or List of Titles)
\r
778 is produced, this HTML element will be used to make the list.
\r
784 <refentry version="5.0" xml:id="toc.section.depth">
\r
786 <refentrytitle>toc.section.depth</refentrytitle>
\r
787 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
\r
790 <refname>toc.section.depth</refname>
\r
791 <refpurpose>How deep should recursive <tag>section</tag>s appear
\r
792 in the TOC?</refpurpose>
\r
796 <programlisting xml:id="toc.section.depth.frag"><xsl:param name="toc.section.depth">2</xsl:param></programlisting>
\r
799 <refsection><info><title>Description</title></info>
\r
801 <para>Specifies the depth to which recursive sections should appear in the
\r
808 <refentry version="5.0" xml:id="toc.max.depth">
\r
810 <refentrytitle>toc.max.depth</refentrytitle>
\r
811 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
\r
814 <refname>toc.max.depth</refname>
\r
815 <refpurpose>How many levels should be created for each TOC?</refpurpose>
\r
819 <programlisting xml:id="toc.max.depth.frag"><xsl:param name="toc.max.depth">8</xsl:param></programlisting>
\r
822 <refsection><info><title>Description</title></info>
\r
824 <para>Specifies the maximal depth of TOC on all levels.</para>
\r
829 <refentry version="5.0" xml:id="generate.toc">
\r
831 <refentrytitle>generate.toc</refentrytitle>
\r
832 <refmiscinfo class="other" otherclass="datatype">table</refmiscinfo>
\r
835 <refname>generate.toc</refname>
\r
836 <refpurpose>Control generation of ToCs and LoTs</refpurpose>
\r
840 <programlisting xml:id="generate.toc.frag">
\r
841 <xsl:param name="generate.toc">
\r
843 article/appendix nop
\r
845 book toc,title,figure,table,example,equation
\r
851 reference toc,title
\r
864 <refsection><info><title>Description</title></info>
\r
866 <para>This parameter has a structured value. It is a table of space-delimited
\r
867 path/value pairs. Each path identifies some element in the source document
\r
868 using a restricted subset of XPath (only the implicit child axis, no wildcards,
\r
869 no predicates). Paths can be either relative or absolute.</para>
\r
871 <para>When processing a particular element, the stylesheets consult this table to
\r
872 determine if a ToC (or LoT(s)) should be generated.</para>
\r
874 <para>For example, consider the entry:</para>
\r
876 <screen>book toc,figure</screen>
\r
878 <para>This indicates that whenever a <tag>book</tag> is formatted, a
\r
879 Table Of Contents and a List of Figures should be generated. Similarly,</para>
\r
881 <screen>/chapter toc</screen>
\r
883 <para>indicates that whenever a document <emphasis>that has a root
\r
884 of</emphasis> <tag>chapter</tag> is formatted, a Table of
\r
885 Contents should be generated. The entry <literal>chapter</literal> would match
\r
886 all chapters, but <literal>/chapter</literal> matches only <tag>chapter</tag>
\r
887 document elements.</para>
\r
889 <para>Generally, the longest match wins. So, for example, if you want to distinguish
\r
890 articles in books from articles in parts, you could use these two entries:</para>
\r
892 <screen>book/article toc,figure
\r
893 part/article toc</screen>
\r
895 <para>Note that an article in a part can never match a <literal>book/article</literal>,
\r
896 so if you want nothing to be generated for articles in parts, you can simply leave
\r
897 that rule out.</para>
\r
899 <para>If you want to leave the rule in, to make it explicit that you're turning
\r
900 something off, use the value <quote>nop</quote>. For example, the following
\r
901 entry disables ToCs and LoTs for articles:</para>
\r
903 <screen>article nop</screen>
\r
905 <para>Do not simply leave the word <quote>article</quote> in the file
\r
906 without a matching value. That'd be just begging the silly little
\r
907 path/value parser to get confused.</para>
\r
909 <para>Section ToCs are further controlled by the
\r
910 <parameter>generate.section.toc.level</parameter> parameter.
\r
911 For a given section level to have a ToC, it must have both an entry in
\r
912 <parameter>generate.toc</parameter> and be within the range enabled by
\r
913 <parameter>generate.section.toc.level</parameter>.</para>
\r
917 <refentry version="5.0" xml:id="generate.section.toc.level">
\r
919 <refentrytitle>generate.section.toc.level</refentrytitle>
\r
920 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
\r
923 <refname>generate.section.toc.level</refname>
\r
924 <refpurpose>Control depth of TOC generation in sections</refpurpose>
\r
928 <programlisting xml:id="generate.section.toc.level.frag">
\r
929 <xsl:param name="generate.section.toc.level" select="0"></xsl:param>
\r
933 <refsection><info><title>Description</title></info>
\r
935 <para>The <parameter>generate.section.toc.level</parameter> parameter
\r
936 controls the depth of <tag>section</tag> in which TOCs will be generated. Note
\r
937 that this is related to, but not the same as
\r
938 <parameter>toc.section.depth</parameter>, which controls the depth to
\r
939 which TOC entries will be generated in a given TOC.</para>
\r
940 <para>If, for example, <parameter>generate.section.toc.level</parameter>
\r
941 is <literal>3</literal>, TOCs will be generated in first, second, and third
\r
942 level sections, but not in fourth level sections.
\r
948 <refentry version="5.0" xml:id="generate.index">
\r
950 <refentrytitle>generate.index</refentrytitle>
\r
951 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
954 <refname>generate.index</refname>
\r
955 <refpurpose>Do you want an index?</refpurpose>
\r
959 <programlisting xml:id="generate.index.frag"><xsl:param name="generate.index" select="1"></xsl:param></programlisting>
\r
962 <refsection><info><title>Description</title></info>
\r
964 <para>Specify if an index should be generated. </para>
\r
969 <refentry version="5.0" xml:id="index.method">
\r
971 <refentrytitle>index.method</refentrytitle>
\r
972 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
\r
973 <refmiscinfo class="other" otherclass="value">basic</refmiscinfo>
\r
974 <refmiscinfo class="other" otherclass="value">kosek</refmiscinfo>
\r
975 <refmiscinfo class="other" otherclass="value">kimber</refmiscinfo>
\r
978 <refname>index.method</refname>
\r
979 <refpurpose>Select method used to group index entries in an index</refpurpose>
\r
983 <programlisting xml:id="index.method.frag">
\r
984 <xsl:param name="index.method">basic</xsl:param>
\r
988 <refsection><info><title>Description</title></info>
\r
990 <para>This parameter lets you select which method to use for sorting and grouping
\r
991 index entries in an index.
\r
992 Indexes in Latin-based languages that have accented characters typically
\r
993 sort together accented words and unaccented words.
\r
994 Thus <quote>Á</quote> (U+00C1 LATIN CAPITAL LETTER A WITH ACUTE) would sort together
\r
995 with <quote>A</quote> (U+0041 LATIN CAPITAL LETTER A), so both would appear in the <quote>A</quote>
\r
996 section of the index.
\r
997 Languages using other alphabets (such as Russian, which is written in the Cyrillic alphabet)
\r
998 and languages using ideographic chararacters (such as Japanese)
\r
999 require grouping specific to the languages and alphabets.
\r
1002 <para>The default indexing method is limited.
\r
1003 It can group accented characters in Latin-based languages only.
\r
1004 It cannot handle non-Latin alphabets or ideographic languages.
\r
1005 The other indexing methods require extensions of one type or
\r
1006 another, and do not work with
\r
1007 all XSLT processors, which is why they are not used by default.</para>
\r
1009 <para>The three choices for indexing method are:</para>
\r
1012 <term><literal>basic</literal></term>
\r
1015 (default) Sort and groups words based only on the Latin alphabet.
\r
1016 Words with accented Latin letters will group and sort with
\r
1017 their respective primary letter, but
\r
1018 words in non-Latin alphabets will be
\r
1019 put in the <quote>Symbols</quote> section of the index.
\r
1024 <term><literal>kosek</literal></term>
\r
1027 This method sorts and groups words based on letter groups configured in
\r
1028 the DocBook locale file for the given language.
\r
1029 See, for example, the French locale file <filename>common/fr.xml</filename>.
\r
1030 This method requires that the XSLT processor
\r
1031 supports the EXSLT extensions (most do).
\r
1032 It also requires support for using
\r
1033 user-defined functions in xsl:key (xsltproc does not).
\r
1035 <para>This method is suitable for any language for which you can
\r
1036 list all the individual characters that should appear
\r
1037 in each letter group in an index.
\r
1038 It is probably not practical to use it for ideographic languages
\r
1039 such as Chinese that have hundreds or thousands of characters.
\r
1042 <para>To use the kosek method, you must:</para>
\r
1046 <para>Use a processor that supports its extensions, such as
\r
1047 Saxon 6 or Xalan (xsltproc and Saxon 8 do not).
\r
1051 <para>Set the index.method parameter's value to <quote>kosek</quote>.
\r
1055 <para>Import the appropriate index extensions stylesheet module
\r
1056 <filename>fo/autoidx-kosek.xsl</filename> or
\r
1057 <filename>html/autoidx-kosek.xsl</filename> into your
\r
1066 <term><literal>kimber</literal></term>
\r
1069 This method uses extensions to the Saxon processor to implement
\r
1070 sophisticated indexing processes. It uses its own
\r
1071 configuration file, which can include information for any number of
\r
1072 languages. Each language's configuration can group
\r
1073 words using one of two processes. In the
\r
1074 enumerated process similar to that used in the kosek method,
\r
1075 you indicate the groupings character-by-character.
\r
1076 In the between-key process, you specify the
\r
1077 break-points in the sort order that should start a new group.
\r
1078 The latter configuration is useful for ideographic languages
\r
1079 such as Chinese, Japanese, and Korean.
\r
1080 You can also define your own collation algorithms and how you
\r
1081 want mixed Latin-alphabet words sorted.</para>
\r
1084 <para>For a whitepaper describing the extensions, see:
\r
1085 <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://www.innodata-isogen.com/knowledge_center/white_papers/back_of_book_for_xsl_fo.pdf">http://www.innodata-isogen.com/knowledge_center/white_papers/back_of_book_for_xsl_fo.pdf</link>.
\r
1089 <para>To download the extension library, see
\r
1090 <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://www.innodata-isogen.com/knowledge_center/tools_downloads/i18nsupport">http://www.innodata-isogen.com/knowledge_center/tools_downloads/i18nsupport</link>.
\r
1095 <para>To use the kimber method, you must:</para>
\r
1099 <para>Use Saxon (version 6 or 8) as your XSLT processor.
\r
1103 <para>Install and configure the Innodata Isogen library, using
\r
1104 the documentation that comes with it.
\r
1108 <para>Set the index.method parameter's value to <quote>kimber</quote>.
\r
1112 <para>Import the appropriate index extensions stylesheet module
\r
1113 <filename>fo/autoidx-kimber.xsl</filename> or
\r
1114 <filename>html/autoidx-kimber.xsl</filename> into your
\r
1127 <refentry version="5.0" xml:id="index.on.type">
\r
1129 <refentrytitle>index.on.type</refentrytitle>
\r
1130 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
1133 <refname>index.on.type</refname>
\r
1134 <refpurpose>Select indexterms based on <tag class="attribute">type</tag>
\r
1135 attribute value</refpurpose>
\r
1139 <programlisting xml:id="index.on.type.frag">
\r
1140 <xsl:param name="index.on.type" select="0"></xsl:param>
\r
1144 <refsection><info><title>Description</title></info>
\r
1148 then an <tag>index</tag> element that has a
\r
1149 <tag class="attribute">type</tag> attribute
\r
1150 value will contain only those <tag>indexterm</tag>
\r
1151 elements with a matching <tag class="attribute">type</tag> attribute value.
\r
1152 If an <tag>index</tag> has no <tag class="attribute">type</tag>
\r
1153 attribute or it is blank, then the index will contain
\r
1154 all <tag>indexterm</tag>s in the current scope.
\r
1158 If <literal>index.on.type</literal> is zero, then the
\r
1159 <tag class="attribute">type</tag> attribute has no effect
\r
1160 on selecting indexterms for an index.
\r
1163 <para>For those using DocBook version 4.2 or earlier,
\r
1164 the <tag class="attribute">type</tag> attribute is not available
\r
1165 for index terms. However, you can achieve the same
\r
1166 effect by using the <tag class="attribute">role</tag> attribute
\r
1167 in the same manner on <tag>indexterm</tag>
\r
1168 and <tag>index</tag>, and setting the stylesheet parameter
\r
1169 <parameter>index.on.role</parameter> to a nonzero value.
\r
1175 <refentry version="5.0" xml:id="index.on.role">
\r
1177 <refentrytitle>index.on.role</refentrytitle>
\r
1178 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
1181 <refname>index.on.role</refname>
\r
1182 <refpurpose>Select indexterms based on <tag class="attribute">role</tag> value</refpurpose>
\r
1186 <programlisting xml:id="index.on.role.frag">
\r
1187 <xsl:param name="index.on.role" select="0"></xsl:param>
\r
1191 <refsection><info><title>Description</title></info>
\r
1195 then an <tag>index</tag> element that has a
\r
1196 <tag class="attribute">role</tag> attribute
\r
1197 value will contain only those <tag>indexterm</tag>
\r
1198 elements with a matching role value.
\r
1199 If an <tag>index</tag> has no <tag class="attribute">role</tag>
\r
1200 attribute or it is blank, then the index will contain
\r
1201 all <tag>indexterm</tag>s in the current scope.
\r
1204 If <literal>index.on.role</literal> is zero, then the
\r
1205 <tag class="attribute">role</tag> attribute has no effect
\r
1206 on selecting indexterms for an index.
\r
1209 <para>If you are using DocBook version 4.3 or later, you should
\r
1210 use the <tag class="attribute">type</tag> attribute instead of <tag class="attribute">role</tag>
\r
1211 on <tag>indexterm</tag> and <tag>index</tag>,
\r
1212 and set the <parameter>index.on.type</parameter> to a nonzero
\r
1219 <refentry version="5.0" xml:id="index.links.to.section">
\r
1221 <refentrytitle>index.links.to.section</refentrytitle>
\r
1222 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
1225 <refname>index.links.to.section</refname>
\r
1226 <refpurpose>HTML index entries link to container section title</refpurpose>
\r
1230 <programlisting xml:id="index.links.to.section.frag">
\r
1231 <xsl:param name="index.links.to.section" select="1"></xsl:param>
\r
1235 <refsection><info><title>Description</title></info>
\r
1237 <para>If zero, then an index entry in an index links
\r
1238 directly to the location of the
\r
1239 generated <tag>anchor</tag> that is output
\r
1240 for the indexterm. If two identical indexterm elements
\r
1241 exist in the same section, then both entries appear
\r
1242 in the index with the same title but link to different
\r
1245 <para>If non-zero, then an index entry in an index links to the
\r
1246 section title containing the <tag>indexterm</tag>, rather than
\r
1247 directly to the <tag>anchor</tag> output for the indexterm.
\r
1248 Duplicate indexterm entries in the same section are dropped.
\r
1251 <para>The default value is 1, so index entries link to
\r
1252 section titles by default.</para>
\r
1254 <para>In both cases, the link text in an index entry is the
\r
1255 title of the section containing the indexterm.
\r
1256 That is because HTML does not have numbered pages.
\r
1257 It also provides the reader with context information
\r
1258 for each link.</para>
\r
1260 <para>This parameter lets you choose which style of
\r
1261 index linking you want. </para>
\r
1265 <para>When set to 0, an index entry takes you
\r
1266 to the precise location of its corresponding indexterm.
\r
1267 However, if you have a lot of duplicate
\r
1268 entries in sections, then you have a lot of duplicate
\r
1269 titles in the index, which makes it more cluttered.
\r
1270 The reader may not recognize why duplicate titles
\r
1271 appear until they follow the links. Also, the links
\r
1272 may land the reader in the middle of a section where the
\r
1273 section title is not visible, which may also be
\r
1274 confusing to the reader.</para>
\r
1277 <para>When set to 1, an index entry link is
\r
1278 less precise, but duplicate titles in the
\r
1279 index entries are eliminated.
\r
1280 Landing on the section title location may confirm the reader's
\r
1281 expectation that a link that
\r
1282 shows a section title will take them to that section title,
\r
1283 not a location within the section.
\r
1291 <refentry version="5.0" xml:id="index.prefer.titleabbrev">
\r
1293 <refentrytitle>index.prefer.titleabbrev</refentrytitle>
\r
1294 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
1297 <refname>index.prefer.titleabbrev</refname>
\r
1298 <refpurpose>Should abbreviated titles be used as back references?</refpurpose>
\r
1302 <programlisting xml:id="index.prefer.titleabbrev.frag">
\r
1303 <xsl:param name="index.prefer.titleabbrev" select="0"></xsl:param>
\r
1307 <refsection><info><title>Description</title></info>
\r
1309 <para>If non-zero, and if a <tag>titleabbrev</tag> is defined, the abbreviated title
\r
1310 is used as the link text of a back reference in the index.
\r
1316 <refentry version="5.0" xml:id="index.term.separator">
\r
1318 <refentrytitle>index.term.separator</refentrytitle>
\r
1319 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
\r
1322 <refname>index.term.separator</refname>
\r
1323 <refpurpose>Override for punctuation separating an index term
\r
1324 from its list of page references in an index</refpurpose>
\r
1328 <programlisting xml:id="index.term.separator.frag">
\r
1329 <xsl:param name="index.term.separator"></xsl:param>
\r
1333 <refsection><info><title>Description</title></info>
\r
1335 <para>This parameter permits you to override
\r
1336 the text to insert between
\r
1337 the end of an index term and its list of page references.
\r
1338 Typically that might be a comma and a space.
\r
1341 <para>Because this text may be locale dependent,
\r
1342 this parameter's value is normally taken from a gentext
\r
1343 template named 'term-separator' in the
\r
1344 context 'index' in the stylesheet
\r
1345 locale file for the language
\r
1346 of the current document.
\r
1347 This parameter can be used to override the gentext string,
\r
1348 and would typically be used on the command line.
\r
1349 This parameter would apply to all languages.
\r
1352 <para>So this text string can be customized in two ways.
\r
1353 You can reset the default gentext string using
\r
1354 the <parameter>local.l10n.xml</parameter> parameter, or you can
\r
1355 fill in the content for this normally empty
\r
1356 override parameter.
\r
1357 The content can be a simple string, or it can be
\r
1358 something more complex such as a call-template.
\r
1359 For fo output, it could be an <tag>fo:leader</tag>
\r
1360 element to provide space of a specific length, or a dot leader.
\r
1366 <refentry version="5.0" xml:id="index.number.separator">
\r
1368 <refentrytitle>index.number.separator</refentrytitle>
\r
1369 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
\r
1372 <refname>index.number.separator</refname>
\r
1373 <refpurpose>Override for punctuation separating page numbers in index</refpurpose>
\r
1377 <programlisting xml:id="index.number.separator.frag">
\r
1378 <xsl:param name="index.number.separator"></xsl:param>
\r
1382 <refsection><info><title>Description</title></info>
\r
1384 <para>This parameter permits you to override the text to insert between
\r
1385 page references in a formatted index entry. Typically
\r
1386 that would be a comma and a space.
\r
1389 <para>Because this text may be locale dependent,
\r
1390 this parameter's value is normally taken from a gentext
\r
1391 template named 'number-separator' in the
\r
1392 context 'index' in the stylesheet
\r
1393 locale file for the language
\r
1394 of the current document.
\r
1395 This parameter can be used to override the gentext string,
\r
1396 and would typically be used on the command line.
\r
1397 This parameter would apply to all languages.
\r
1400 <para>So this text string can be customized in two ways.
\r
1401 You can reset the default gentext string using
\r
1402 the <parameter>local.l10n.xml</parameter> parameter, or you can
\r
1403 override the gentext with the content of this parameter.
\r
1404 The content can be a simple string, or it can be
\r
1405 something more complex such as a call-template.
\r
1408 <para>In HTML index output, section title references are used instead of
\r
1409 page number references. This punctuation appears between
\r
1410 such section titles in an HTML index.
\r
1416 <refentry version="5.0" xml:id="index.range.separator">
\r
1418 <refentrytitle>index.range.separator</refentrytitle>
\r
1419 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
\r
1422 <refname>index.range.separator</refname>
\r
1423 <refpurpose>Override for punctuation separating the two numbers
\r
1424 in a page range in index</refpurpose>
\r
1428 <programlisting xml:id="index.range.separator.frag">
\r
1429 <xsl:param name="index.range.separator"></xsl:param>
\r
1433 <refsection><info><title>Description</title></info>
\r
1435 <para>This parameter permits you
\r
1436 to override the text to insert between
\r
1437 the two numbers of a page range in an index.
\r
1438 This parameter is only used by those XSL-FO processors
\r
1439 that support an extension for generating such page ranges
\r
1440 (such as XEP).</para>
\r
1442 <para>Because this text may be locale dependent,
\r
1443 this parameter's value is normally taken from a gentext
\r
1444 template named 'range-separator' in the
\r
1445 context 'index' in the stylesheet
\r
1446 locale file for the language
\r
1447 of the current document.
\r
1448 This parameter can be used to override the gentext string,
\r
1449 and would typically be used on the command line.
\r
1450 This parameter would apply to all languages.
\r
1453 <para>So this text string can be customized in two ways.
\r
1454 You can reset the default gentext string using
\r
1455 the <parameter>local.l10n.xml</parameter> parameter, or you can
\r
1456 override the gentext with the content of this parameter.
\r
1457 The content can be a simple string, or it can be
\r
1458 something more complex such as a call-template.
\r
1461 <para>In HTML index output, section title references are used instead of
\r
1462 page number references. So there are no page ranges
\r
1463 and this parameter has no effect.
\r
1470 <reference xml:id="dbk_ext"><title>Stylesheet Extensions</title>
\r
1471 <refentry version="5.0" xml:id="linenumbering.everyNth">
\r
1473 <refentrytitle>linenumbering.everyNth</refentrytitle>
\r
1474 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
\r
1477 <refname>linenumbering.everyNth</refname>
\r
1478 <refpurpose>Indicate which lines should be numbered</refpurpose>
\r
1482 <programlisting xml:id="linenumbering.everyNth.frag">
\r
1483 <xsl:param name="linenumbering.everyNth">5</xsl:param>
\r
1487 <refsection><info><title>Description</title></info>
\r
1489 <para>If line numbering is enabled, everyNth line will be
\r
1490 numbered. Note that numbering is one based, not zero based.
\r
1496 <refentry version="5.0" xml:id="linenumbering.extension">
\r
1498 <refentrytitle>linenumbering.extension</refentrytitle>
\r
1499 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
1502 <refname>linenumbering.extension</refname>
\r
1503 <refpurpose>Enable the line numbering extension</refpurpose>
\r
1507 <programlisting xml:id="linenumbering.extension.frag">
\r
1508 <xsl:param name="linenumbering.extension" select="1"></xsl:param>
\r
1512 <refsection><info><title>Description</title></info>
\r
1514 <para>If non-zero, verbatim environments (<tag>address</tag>, <tag>literallayout</tag>,
\r
1515 <tag>programlisting</tag>, <tag>screen</tag>, <tag>synopsis</tag>) that specify line numbering will
\r
1516 have line numbers.
\r
1522 <refentry version="5.0" xml:id="linenumbering.separator">
\r
1524 <refentrytitle>linenumbering.separator</refentrytitle>
\r
1525 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
\r
1528 <refname>linenumbering.separator</refname>
\r
1529 <refpurpose>Specify a separator between line numbers and lines</refpurpose>
\r
1533 <programlisting xml:id="linenumbering.separator.frag">
\r
1534 <xsl:param name="linenumbering.separator"><xsl:text> </xsl:text></xsl:param>
\r
1538 <refsection><info><title>Description</title></info>
\r
1540 <para>The separator is inserted between line numbers and lines in the
\r
1541 verbatim environment. The default value is a single white space.
\r
1542 Note the interaction with <parameter>linenumbering.width</parameter>
\r
1548 <refentry version="5.0" xml:id="linenumbering.width">
\r
1550 <refentrytitle>linenumbering.width</refentrytitle>
\r
1551 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
\r
1554 <refname>linenumbering.width</refname>
\r
1555 <refpurpose>Indicates the width of line numbers</refpurpose>
\r
1559 <programlisting xml:id="linenumbering.width.frag">
\r
1560 <xsl:param name="linenumbering.width">3</xsl:param>
\r
1564 <refsection><info><title>Description</title></info>
\r
1566 <para>If line numbering is enabled, line numbers will appear right
\r
1567 justified in a field "width" characters wide.
\r
1573 <refentry version="5.0" xml:id="tablecolumns.extension">
\r
1575 <refentrytitle>tablecolumns.extension</refentrytitle>
\r
1576 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
1579 <refname>tablecolumns.extension</refname>
\r
1580 <refpurpose>Enable the table columns extension function</refpurpose>
\r
1584 <programlisting xml:id="tablecolumns.extension.frag">
\r
1585 <xsl:param name="tablecolumns.extension" select="1"></xsl:param>
\r
1589 <refsection><info><title>Description</title></info>
\r
1591 <para>The table columns extension function adjusts the widths of table
\r
1592 columns in the HTML result to more accurately reflect the specifications
\r
1593 in the CALS table.
\r
1599 <refentry version="5.0" xml:id="textinsert.extension">
\r
1601 <refentrytitle>textinsert.extension</refentrytitle>
\r
1602 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
1605 <refname>textinsert.extension</refname>
\r
1606 <refpurpose>Enables the textinsert extension element</refpurpose>
\r
1609 <programlisting xml:id="textinsert.extension.frag">
\r
1610 <xsl:param name="textinsert.extension" select="1"></xsl:param>
\r
1613 <refsection><info><title>Description</title></info>
\r
1614 <para>The textinsert extension element inserts the contents of
\r
1615 a file into the result tree (as text).</para>
\r
1617 <para>To use the textinsert extension element, you must use
\r
1618 either Saxon or Xalan as your XSLT processor (it doesn’t
\r
1619 work with xsltproc), along with either the DocBook Saxon
\r
1620 extensions or DocBook Xalan extensions (for more
\r
1621 information about those extensions, see <link xmlns:xlink="http://www.w3.org/1999/xlink" role="tcg" xlink:href="InstallingAProcessor.html#SaxonExtensions">DocBook Saxon Extensions</link> and <link xmlns:xlink="http://www.w3.org/1999/xlink" role="tcg" xlink:href="InstallingAProcessor.html#XalanExtensions">DocBook Xalan Extensions</link>), and you must set both
\r
1622 the <parameter>use.extensions</parameter> and
\r
1623 <parameter>textinsert.extension</parameter> parameters to
\r
1624 <literal>1</literal>.</para>
\r
1625 <para>As an alternative to using the textinsert element,
\r
1626 consider using an Xinclude element with the
\r
1627 <literal>parse="text"</literal> attribute and value
\r
1628 specified, as detailed in <link xmlns:xlink="http://www.w3.org/1999/xlink" role="tcg" xlink:href="ExternalCode.html#XIncludeCode">Using XInclude for text inclusions</link>.</para>
\r
1631 <refsection><info><title>See Also</title></info>
\r
1632 <para>You can also use the <tag class="xmlpi">dbhtml-include href</tag> processing
\r
1633 instruction to insert external files — both files containing
\r
1634 plain text and files with markup content (including HTML
\r
1637 <refsection><info><title>More information</title></info>
\r
1638 <para>For how-to documentation on inserting contents of
\r
1639 external code files and other text files into output, see
\r
1640 <link xmlns:xlink="http://www.w3.org/1999/xlink" role="tcg" xlink:href="ExternalCode.html">External code files</link>.</para>
\r
1641 <para>For guidelines on inserting contents of
\r
1642 HTML files into output, see <link xmlns:xlink="http://www.w3.org/1999/xlink" role="tcg" xlink:href="InsertExtHtml.html">Inserting external HTML code</link>.</para>
\r
1646 <refentry version="5.0" xml:id="textdata.default.encoding">
\r
1648 <refentrytitle>textdata.default.encoding</refentrytitle>
\r
1649 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
\r
1652 <refname>textdata.default.encoding</refname>
\r
1653 <refpurpose>Default encoding of external text files which are included
\r
1654 using textdata element</refpurpose>
\r
1658 <programlisting xml:id="textdata.default.encoding.frag">
\r
1659 <xsl:param name="textdata.default.encoding"></xsl:param>
\r
1663 <refsection><info><title>Description</title></info>
\r
1665 <para>Specifies the encoding of any external text files included using
\r
1666 <tag>textdata</tag> element. This value is used only when you do
\r
1667 not specify encoding by the appropriate attribute
\r
1668 directly on textdata. An empty string is interpreted as the system
\r
1669 default encoding.</para>
\r
1674 <refentry version="5.0" xml:id="graphicsize.extension">
\r
1676 <refentrytitle>graphicsize.extension</refentrytitle>
\r
1677 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
1680 <refname>graphicsize.extension</refname>
\r
1681 <refpurpose>Enable the getWidth()/getDepth() extension functions</refpurpose>
\r
1685 <programlisting xml:id="graphicsize.extension.frag">
\r
1686 <xsl:param name="graphicsize.extension" select="1"></xsl:param>
\r
1690 <refsection><info><title>Description</title></info>
\r
1692 <para>If non-zero (and if <parameter>use.extensions</parameter> is non-zero
\r
1693 and if you're using a processor that supports extension functions), the
\r
1694 <function>getWidth</function> and <function>getDepth</function> functions
\r
1695 will be used to extract image sizes from graphics.</para>
\r
1700 <refentry version="5.0" xml:id="graphicsize.use.img.src.path">
\r
1702 <refentrytitle>graphicsize.use.img.src.path</refentrytitle>
\r
1703 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
1706 <refname>graphicsize.use.img.src.path</refname>
\r
1707 <refpurpose>Prepend <parameter>img.src.path</parameter> before
\r
1708 filenames passed to extension functions</refpurpose>
\r
1712 <programlisting xml:id="graphicsize.use.img.src.path.frag">
\r
1713 <xsl:param name="graphicsize.use.img.src.path" select="0"></xsl:param>
\r
1717 <refsection><info><title>Description</title></info>
\r
1719 <para>If non-zero <parameter>img.src.path</parameter> parameter will
\r
1720 be appended before filenames passed to extension functions for
\r
1721 measuring image dimensions.</para>
\r
1726 <refentry version="5.0" xml:id="use.extensions">
\r
1728 <refentrytitle>use.extensions</refentrytitle>
\r
1729 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
1732 <refname>use.extensions</refname>
\r
1733 <refpurpose>Enable extensions</refpurpose>
\r
1737 <programlisting xml:id="use.extensions.frag">
\r
1738 <xsl:param name="use.extensions" select="0"></xsl:param>
\r
1742 <refsection><info><title>Description</title></info>
\r
1744 <para>If non-zero, extensions may be used. Each extension is
\r
1745 further controlled by its own parameter. But if
\r
1746 <parameter>use.extensions</parameter> is zero, no extensions will
\r
1754 <reference xml:id="labels"><title>Automatic labelling</title>
\r
1755 <refentry version="5.0" xml:id="chapter.autolabel">
\r
1757 <refentrytitle>chapter.autolabel</refentrytitle>
\r
1758 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
\r
1759 <refmiscinfo class="other" otherclass="value">0<alt>none</alt></refmiscinfo>
\r
1760 <refmiscinfo class="other" otherclass="value">1<alt>1,2,3...</alt></refmiscinfo>
\r
1761 <refmiscinfo class="other" otherclass="value">A<alt>A,B,C...</alt></refmiscinfo>
\r
1762 <refmiscinfo class="other" otherclass="value">a<alt>a,b,c...</alt></refmiscinfo>
\r
1763 <refmiscinfo class="other" otherclass="value">i<alt>i,ii,iii...</alt></refmiscinfo>
\r
1764 <refmiscinfo class="other" otherclass="value">I<alt>I,II,III...</alt></refmiscinfo>
\r
1767 <refname>chapter.autolabel</refname>
\r
1768 <refpurpose>Specifies the labeling format for Chapter titles</refpurpose>
\r
1772 <programlisting xml:id="chapter.autolabel.frag">
\r
1773 <xsl:param name="chapter.autolabel" select="1"></xsl:param></programlisting>
\r
1776 <refsection><info><title>Description</title></info>
\r
1778 <para>If non-zero, then chapters will be numbered using the parameter
\r
1779 value as the number format if the value matches one of the following:
\r
1784 <term>1 or arabic</term>
\r
1786 <para>Arabic numeration (1, 2, 3 ...).</para>
\r
1790 <term>A or upperalpha</term>
\r
1792 <para>Uppercase letter numeration (A, B, C ...).</para>
\r
1796 <term>a or loweralpha</term>
\r
1798 <para>Lowercase letter numeration (a, b, c ...).</para>
\r
1802 <term>I or upperroman</term>
\r
1804 <para>Uppercase roman numeration (I, II, III ...).</para>
\r
1808 <term>i or lowerroman</term>
\r
1810 <para>Lowercase roman letter numeration (i, ii, iii ...).</para>
\r
1815 <para>Any nonzero value other than the above will generate
\r
1816 the default number format (arabic).
\r
1822 <refentry version="5.0" xml:id="appendix.autolabel">
\r
1824 <refentrytitle>appendix.autolabel</refentrytitle>
\r
1825 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
\r
1826 <refmiscinfo class="other" otherclass="value">0<alt>none</alt></refmiscinfo>
\r
1827 <refmiscinfo class="other" otherclass="value">1<alt>1,2,3...</alt></refmiscinfo>
\r
1828 <refmiscinfo class="other" otherclass="value">A<alt>A,B,C...</alt></refmiscinfo>
\r
1829 <refmiscinfo class="other" otherclass="value">a<alt>a,b,c...</alt></refmiscinfo>
\r
1830 <refmiscinfo class="other" otherclass="value">i<alt>i,ii,iii...</alt></refmiscinfo>
\r
1831 <refmiscinfo class="other" otherclass="value">I<alt>I,II,III...</alt></refmiscinfo>
\r
1834 <refname>appendix.autolabel</refname>
\r
1835 <refpurpose>Specifies the labeling format for Appendix titles</refpurpose>
\r
1839 <programlisting xml:id="appendix.autolabel.frag">
\r
1840 <xsl:param name="appendix.autolabel">A</xsl:param>
\r
1844 <refsection><info><title>Description</title></info>
\r
1846 <para>If non-zero, then appendices will be numbered using the
\r
1847 parameter value as the number format if the value matches one of the
\r
1853 <term>1 or arabic</term>
\r
1855 <para>Arabic numeration (1, 2, 3 ...).</para>
\r
1859 <term>A or upperalpha</term>
\r
1861 <para>Uppercase letter numeration (A, B, C ...).</para>
\r
1865 <term>a or loweralpha</term>
\r
1867 <para>Lowercase letter numeration (a, b, c ...).</para>
\r
1871 <term>I or upperroman</term>
\r
1873 <para>Uppercase roman numeration (I, II, III ...).</para>
\r
1877 <term>i or lowerroman</term>
\r
1879 <para>Lowercase roman letter numeration (i, ii, iii ...).</para>
\r
1884 <para>Any nonzero value other than the above will generate
\r
1885 the default number format (upperalpha).
\r
1891 <refentry version="5.0" xml:id="part.autolabel">
\r
1893 <refentrytitle>part.autolabel</refentrytitle>
\r
1894 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
\r
1895 <refmiscinfo class="other" otherclass="value">0<alt>none</alt></refmiscinfo>
\r
1896 <refmiscinfo class="other" otherclass="value">1<alt>1,2,3...</alt></refmiscinfo>
\r
1897 <refmiscinfo class="other" otherclass="value">A<alt>A,B,C...</alt></refmiscinfo>
\r
1898 <refmiscinfo class="other" otherclass="value">a<alt>a,b,c...</alt></refmiscinfo>
\r
1899 <refmiscinfo class="other" otherclass="value">i<alt>i,ii,iii...</alt></refmiscinfo>
\r
1900 <refmiscinfo class="other" otherclass="value">I<alt>I,II,III...</alt></refmiscinfo>
\r
1903 <refname>part.autolabel</refname>
\r
1904 <refpurpose>Specifies the labeling format for Part titles</refpurpose>
\r
1908 <programlisting xml:id="part.autolabel.frag">
\r
1909 <xsl:param name="part.autolabel">I</xsl:param>
\r
1913 <refsection><info><title>Description</title></info>
\r
1915 <para>If non-zero, then parts will be numbered using the parameter
\r
1916 value as the number format if the value matches one of the following:
\r
1921 <term>1 or arabic</term>
\r
1923 <para>Arabic numeration (1, 2, 3 ...).</para>
\r
1927 <term>A or upperalpha</term>
\r
1929 <para>Uppercase letter numeration (A, B, C ...).</para>
\r
1933 <term>a or loweralpha</term>
\r
1935 <para>Lowercase letter numeration (a, b, c ...).</para>
\r
1939 <term>I or upperroman</term>
\r
1941 <para>Uppercase roman numeration (I, II, III ...).</para>
\r
1945 <term>i or lowerroman</term>
\r
1947 <para>Lowercase roman letter numeration (i, ii, iii ...).</para>
\r
1952 <para>Any nonzero value other than the above will generate
\r
1953 the default number format (upperroman).
\r
1960 <refentry version="5.0" xml:id="reference.autolabel">
\r
1962 <refentrytitle>reference.autolabel</refentrytitle>
\r
1963 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
\r
1964 <refmiscinfo class="other" otherclass="value">0<alt>none</alt></refmiscinfo>
\r
1965 <refmiscinfo class="other" otherclass="value">1<alt>1,2,3...</alt></refmiscinfo>
\r
1966 <refmiscinfo class="other" otherclass="value">A<alt>A,B,C...</alt></refmiscinfo>
\r
1967 <refmiscinfo class="other" otherclass="value">a<alt>a,b,c...</alt></refmiscinfo>
\r
1968 <refmiscinfo class="other" otherclass="value">i<alt>i,ii,iii...</alt></refmiscinfo>
\r
1969 <refmiscinfo class="other" otherclass="value">I<alt>I,II,III...</alt></refmiscinfo>
\r
1972 <refname>reference.autolabel</refname>
\r
1973 <refpurpose>Specifies the labeling format for Reference titles</refpurpose>
\r
1976 <programlisting xml:id="reference.autolabel.frag">
\r
1977 <xsl:param name="reference.autolabel">I</xsl:param>
\r
1980 <refsection><info><title>Description</title></info>
\r
1981 <para>If non-zero, references will be numbered using the parameter
\r
1982 value as the number format if the value matches one of the
\r
1987 <term>1 or arabic</term>
\r
1989 <para>Arabic numeration (1, 2, 3 ...).</para>
\r
1993 <term>A or upperalpha</term>
\r
1995 <para>Uppercase letter numeration (A, B, C ...).</para>
\r
1999 <term>a or loweralpha</term>
\r
2001 <para>Lowercase letter numeration (a, b, c ...).</para>
\r
2005 <term>I or upperroman</term>
\r
2007 <para>Uppercase roman numeration (I, II, III ...).</para>
\r
2011 <term>i or lowerroman</term>
\r
2013 <para>Lowercase roman letter numeration (i, ii, iii ...).</para>
\r
2017 <para>Any non-zero value other than the above will generate
\r
2018 the default number format (upperroman).
\r
2023 <refentry version="5.0" xml:id="preface.autolabel">
\r
2025 <refentrytitle>preface.autolabel</refentrytitle>
\r
2026 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
\r
2027 <refmiscinfo class="other" otherclass="value">0<alt>none</alt></refmiscinfo>
\r
2028 <refmiscinfo class="other" otherclass="value">1<alt>1,2,3...</alt></refmiscinfo>
\r
2029 <refmiscinfo class="other" otherclass="value">A<alt>A,B,C...</alt></refmiscinfo>
\r
2030 <refmiscinfo class="other" otherclass="value">a<alt>a,b,c...</alt></refmiscinfo>
\r
2031 <refmiscinfo class="other" otherclass="value">i<alt>i,ii,iii...</alt></refmiscinfo>
\r
2032 <refmiscinfo class="other" otherclass="value">I<alt>I,II,III...</alt></refmiscinfo>
\r
2035 <refname>preface.autolabel</refname>
\r
2036 <refpurpose>Specifices the labeling format for Preface titles</refpurpose>
\r
2040 <programlisting xml:id="preface.autolabel.frag"><xsl:param name="preface.autolabel" select="0"></xsl:param></programlisting>
\r
2043 <refsection><info><title>Description</title></info>
\r
2045 <para>If non-zero then prefaces will be numbered using the parameter
\r
2046 value as the number format if the value matches one of the following:
\r
2051 <term>1 or arabic</term>
\r
2053 <para>Arabic numeration (1, 2, 3 ...).</para>
\r
2057 <term>A or upperalpha</term>
\r
2059 <para>Uppercase letter numeration (A, B, C ...).</para>
\r
2063 <term>a or loweralpha</term>
\r
2065 <para>Lowercase letter numeration (a, b, c ...).</para>
\r
2069 <term>I or upperroman</term>
\r
2071 <para>Uppercase roman numeration (I, II, III ...).</para>
\r
2075 <term>i or lowerroman</term>
\r
2077 <para>Lowercase roman letter numeration (i, ii, iii ...).</para>
\r
2082 <para>Any nonzero value other than the above will generate
\r
2083 the default number format (arabic).
\r
2090 <refentry version="5.0" xml:id="qandadiv.autolabel">
\r
2092 <refentrytitle>qandadiv.autolabel</refentrytitle>
\r
2093 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
2096 <refname>qandadiv.autolabel</refname>
\r
2097 <refpurpose>Are divisions in QAndASets enumerated?</refpurpose>
\r
2101 <programlisting xml:id="qandadiv.autolabel.frag"><xsl:param name="qandadiv.autolabel" select="1"></xsl:param></programlisting>
\r
2104 <refsection><info><title>Description</title></info>
\r
2106 <para>If non-zero, unlabeled qandadivs will be enumerated.
\r
2112 <refentry version="5.0" xml:id="section.autolabel">
\r
2114 <refentrytitle>section.autolabel</refentrytitle>
\r
2115 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
2118 <refname>section.autolabel</refname>
\r
2119 <refpurpose>Are sections enumerated?</refpurpose>
\r
2123 <programlisting xml:id="section.autolabel.frag"><xsl:param name="section.autolabel" select="0"></xsl:param></programlisting>
\r
2126 <refsection><info><title>Description</title></info>
\r
2128 <para>If true (non-zero), unlabeled sections will be enumerated.
\r
2134 <refentry version="5.0" xml:id="section.autolabel.max.depth">
\r
2136 <refentrytitle>section.autolabel.max.depth</refentrytitle>
\r
2137 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
\r
2140 <refname>section.autolabel.max.depth</refname>
\r
2141 <refpurpose>The deepest level of sections that are numbered.</refpurpose>
\r
2145 <programlisting xml:id="section.autolabel.max.depth.frag">
\r
2146 <xsl:param name="section.autolabel.max.depth">8</xsl:param>
\r
2150 <refsection><info><title>Description</title></info>
\r
2152 <para>When section numbering is turned on by the
\r
2153 <parameter>section.autolabel</parameter> parameter, then this
\r
2154 parameter controls the depth of <tag>section</tag> nesting that is
\r
2155 numbered. Sections nested to a level deeper than this value will not
\r
2162 <refentry version="5.0" xml:id="section.label.includes.component.label">
\r
2164 <refentrytitle>section.label.includes.component.label</refentrytitle>
\r
2165 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
2168 <refname>section.label.includes.component.label</refname>
\r
2169 <refpurpose>Do section labels include the component label?</refpurpose>
\r
2173 <programlisting xml:id="section.label.includes.component.label.frag"><xsl:param name="section.label.includes.component.label" select="0"></xsl:param></programlisting>
\r
2176 <refsection><info><title>Description</title></info>
\r
2178 <para>If non-zero, section labels are prefixed with the label of the
\r
2179 component that contains them.
\r
2185 <refentry version="5.0" xml:id="label.from.part">
\r
2187 <refentrytitle>label.from.part</refentrytitle>
\r
2188 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
2191 <refname>label.from.part</refname>
\r
2192 <refpurpose>Renumber components in each part?</refpurpose>
\r
2196 <programlisting xml:id="label.from.part.frag">
\r
2197 <xsl:param name="label.from.part" select="0"></xsl:param>
\r
2201 <refsection><info><title>Description</title></info>
\r
2203 <para>If <parameter>label.from.part</parameter> is non-zero, then
\r
2204 numbering of components — <tag>preface</tag>,
\r
2205 <tag>chapter</tag>, <tag>appendix</tag>, and
\r
2206 <tag>reference</tag> (when <tag>reference</tag> occurs at the
\r
2207 component level) — is re-started within each
\r
2208 <tag>part</tag>.</para>
\r
2209 <para>If <parameter>label.from.part</parameter> is zero (the
\r
2210 default), numbering of components is <emphasis>not</emphasis>
\r
2211 re-started within each <tag>part</tag>; instead, components are
\r
2212 numbered sequentially throughout each <tag>book</tag>,
\r
2213 regardless of whether or not they occur within <tag>part</tag>
\r
2219 <refentry version="5.0" xml:id="component.label.includes.part.label">
\r
2221 <refentrytitle>component.label.includes.part.label</refentrytitle>
\r
2222 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
2225 <refname>component.label.includes.part.label</refname>
\r
2226 <refpurpose>Do component labels include the part label?</refpurpose>
\r
2230 <programlisting xml:id="component.label.includes.part.label.frag"><xsl:param name="component.label.includes.part.label" select="0"></xsl:param></programlisting>
\r
2233 <refsection><info><title>Description</title></info>
\r
2235 <para>If non-zero, number labels for <tag>chapter</tag>,
\r
2236 <tag>appendix</tag>, and other component elements are prefixed with
\r
2237 the label of the part element that contains them. So you might see
\r
2238 Chapter II.3 instead of Chapter 3. Also, the labels for formal
\r
2239 elements such as <tag>table</tag> and <tag>figure</tag> will include
\r
2240 the part label. If there is no part element container, then no prefix
\r
2244 This feature is most useful when the
\r
2245 <parameter>label.from.part</parameter> parameter is turned on.
\r
2246 In that case, there would be more than one <tag>chapter</tag>
\r
2247 <quote>1</quote>, and the extra part label prefix will identify
\r
2248 each chapter unambiguously.
\r
2256 <reference xml:id="html"><title>HTML</title>
\r
2257 <refentry version="5.0" xml:id="html.base">
\r
2259 <refentrytitle>html.base</refentrytitle>
\r
2260 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
\r
2263 <refname>html.base</refname>
\r
2264 <refpurpose>An HTML base URI</refpurpose>
\r
2268 <programlisting xml:id="html.base.frag">
\r
2269 <xsl:param name="html.base"></xsl:param></programlisting>
\r
2272 <refsection><info><title>Description</title></info>
\r
2274 <para>If html.base is set, it is used for the <tag>base</tag> element
\r
2275 in the <tag>head</tag> of the html documents. The parameter specifies
\r
2276 the base URL for all relative URLs in the document. This is useful
\r
2277 for dynamically served html where the base URI needs to be
\r
2283 <refentry version="5.0" xml:id="html.stylesheet.type">
\r
2285 <refentrytitle>html.stylesheet.type</refentrytitle>
\r
2286 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
\r
2289 <refname>html.stylesheet.type</refname>
\r
2290 <refpurpose>The type of the stylesheet used in the generated HTML</refpurpose>
\r
2294 <programlisting xml:id="html.stylesheet.type.frag"><xsl:param name="html.stylesheet.type">text/css</xsl:param></programlisting>
\r
2297 <refsection><info><title>Description</title></info>
\r
2299 <para>The type of the stylesheet to place in the HTML <tag>link</tag> tag.
\r
2305 <refentry version="5.0" xml:id="html.stylesheet">
\r
2307 <refentrytitle>html.stylesheet</refentrytitle>
\r
2308 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
\r
2311 <refname>html.stylesheet</refname>
\r
2312 <refpurpose>Name of the stylesheet(s) to use in the generated HTML</refpurpose>
\r
2316 <programlisting xml:id="html.stylesheet.frag">
\r
2317 <xsl:param name="html.stylesheet"></xsl:param>
\r
2321 <refsection><info><title>Description</title></info>
\r
2323 <para>The <parameter>html.stylesheet</parameter> parameter is either
\r
2324 empty, indicating that no stylesheet <tag>link</tag> tag should be
\r
2325 generated in the html output, or it is a list of one or more
\r
2326 stylesheet files.</para>
\r
2328 <para>Multiple stylesheets are space-delimited. If you need to
\r
2329 reference a stylesheet URI that includes a space, encode it with
\r
2330 <literal>%20</literal>. A separate html <literal>link</literal> element will
\r
2331 be generated for each stylesheet in the order they are listed in the
\r
2337 <refentry version="5.0" xml:id="css.decoration">
\r
2339 <refentrytitle>css.decoration</refentrytitle>
\r
2340 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
2343 <refname>css.decoration</refname>
\r
2344 <refpurpose>Enable CSS decoration of elements</refpurpose>
\r
2348 <programlisting xml:id="css.decoration.frag">
\r
2349 <xsl:param name="css.decoration" select="1"></xsl:param>
\r
2353 <refsection><info><title>Description</title></info>
\r
2356 If non-zero, then html elements produced by the stylesheet may be
\r
2357 decorated with <literal>style</literal> attributes. For example, the
\r
2358 <literal>li</literal> tags produced for list items may include a
\r
2359 fragment of CSS in the <literal>style</literal> attribute which sets
\r
2360 the CSS property "list-style-type".
\r
2366 <refentry version="5.0" xml:id="spacing.paras">
\r
2368 <refentrytitle>spacing.paras</refentrytitle>
\r
2369 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
2372 <refname>spacing.paras</refname>
\r
2373 <refpurpose>Insert additional <p> elements for spacing?</refpurpose>
\r
2377 <programlisting xml:id="spacing.paras.frag">
\r
2378 <xsl:param name="spacing.paras" select="0"></xsl:param>
\r
2382 <refsection><info><title>Description</title></info>
\r
2384 <para>When non-zero, additional, empty paragraphs are inserted in
\r
2385 several contexts (for example, around informal figures), to create a
\r
2386 more pleasing visual appearance in many browsers.
\r
2392 <refentry version="5.0" xml:id="emphasis.propagates.style">
\r
2394 <refentrytitle>emphasis.propagates.style</refentrytitle>
\r
2395 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
2398 <refname>emphasis.propagates.style</refname>
\r
2399 <refpurpose>Pass emphasis role attribute through to HTML?</refpurpose>
\r
2402 <programlisting xml:id="emphasis.propagates.style.frag">
\r
2403 <xsl:param name="emphasis.propagates.style" select="1"></xsl:param>
\r
2406 <refsection><info><title>Description</title></info>
\r
2407 <para>If non-zero, the <literal>role</literal> attribute of
\r
2408 <tag>emphasis</tag> elements will be passed through to the HTML as a
\r
2409 class attribute on a <literal>span</literal> that surrounds the
\r
2414 <refentry version="5.0" xml:id="para.propagates.style">
\r
2416 <refentrytitle>para.propagates.style</refentrytitle>
\r
2417 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
2420 <refname>para.propagates.style</refname>
\r
2421 <refpurpose>Pass para role attribute through to HTML?</refpurpose>
\r
2425 <programlisting xml:id="para.propagates.style.frag">
\r
2426 <xsl:param name="para.propagates.style" select="1"></xsl:param>
\r
2430 <refsection><info><title>Description</title></info>
\r
2432 <para>If true, the role attribute of <tag>para</tag> elements
\r
2433 will be passed through to the HTML as a class attribute on the
\r
2434 <tag>p</tag> generated for the paragraph.</para>
\r
2439 <refentry version="5.0" xml:id="phrase.propagates.style">
\r
2441 <refentrytitle>phrase.propagates.style</refentrytitle>
\r
2442 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
2445 <refname>phrase.propagates.style</refname>
\r
2446 <refpurpose>Pass phrase role attribute through to HTML?</refpurpose>
\r
2450 <programlisting xml:id="phrase.propagates.style.frag">
\r
2451 <xsl:param name="phrase.propagates.style" select="1"></xsl:param></programlisting>
\r
2454 <refsection><info><title>Description</title></info>
\r
2456 <para>If non-zero, the role attribute of <tag>phrase</tag> elements
\r
2457 will be passed through to the HTML as a <literal>class</literal>
\r
2458 attribute on a <literal>span</literal> that surrounds the
\r
2464 <refentry version="5.0" xml:id="entry.propagates.style">
\r
2466 <refentrytitle>entry.propagates.style</refentrytitle>
\r
2467 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
2470 <refname>entry.propagates.style</refname>
\r
2471 <refpurpose>Pass entry role attribute through to HTML?</refpurpose>
\r
2475 <programlisting xml:id="entry.propagates.style.frag">
\r
2476 <xsl:param name="entry.propagates.style" select="1"></xsl:param>
\r
2480 <refsection><info><title>Description</title></info>
\r
2482 <para>If true, the role attribute of <tag>entry</tag> elements
\r
2483 will be passed through to the HTML as a class attribute on the
\r
2484 <tag>td</tag> or <tag>th</tag> generated for the table
\r
2490 <refentry version="5.0" xml:id="html.longdesc">
\r
2492 <refentrytitle>html.longdesc</refentrytitle>
\r
2493 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
2496 <refname>html.longdesc</refname>
\r
2497 <refpurpose>Should longdesc URIs be created?</refpurpose>
\r
2500 <programlisting xml:id="html.longdesc.frag">
\r
2501 <xsl:param name="html.longdesc" select="1"></xsl:param>
\r
2504 <refsection><info><title>Description</title></info>
\r
2505 <para>If non-zero, HTML files will be created for the
\r
2506 <literal>longdesc</literal> attribute. These files
\r
2507 are created from the <tag>textobject</tag>s in
\r
2508 <tag>mediaobject</tag>s and
\r
2509 <tag>inlinemediaobject</tag>.
\r
2514 <refentry version="5.0" xml:id="html.longdesc.link">
\r
2516 <refentrytitle>html.longdesc.link</refentrytitle>
\r
2517 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
2520 <refname>html.longdesc.link</refname>
\r
2521 <refpurpose>Should a link to the longdesc be included in the HTML?</refpurpose>
\r
2525 <programlisting xml:id="html.longdesc.link.frag">
\r
2526 <xsl:param name="html.longdesc.link" select="$html.longdesc"></xsl:param>
\r
2530 <refsection><info><title>Description</title></info>
\r
2532 <para>If non-zero, links will be created to the
\r
2533 HTML files created for the
\r
2534 <literal>longdesc</literal> attribute. It makes no
\r
2535 sense to enable this option without also enabling the
\r
2536 <parameter>html.longdesc</parameter> parameter.</para>
\r
2543 <refentry version="5.0" xml:id="make.valid.html">
\r
2545 <refentrytitle>make.valid.html</refentrytitle>
\r
2546 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
2549 <refname>make.valid.html</refname>
\r
2550 <refpurpose>Attempt to make sure the HTML output is valid HTML</refpurpose>
\r
2554 <programlisting xml:id="make.valid.html.frag">
\r
2555 <xsl:param name="make.valid.html" select="0"></xsl:param>
\r
2559 <refsection><info><title>Description</title></info>
\r
2561 <para>If <parameter>make.valid.html</parameter> is true, the stylesheets take
\r
2562 extra effort to ensure that the resulting HTML is valid. This may mean that some
\r
2563 <tag>para</tag> tags are translated into HTML <tag>div</tag>s or
\r
2564 that other substitutions occur.</para>
\r
2566 <para>This parameter is different from <parameter>html.cleanup</parameter>
\r
2567 because it changes the resulting markup; it does not use extension functions
\r
2568 to manipulate result-tree-fragments and is therefore applicable to any
\r
2569 XSLT processor.</para>
\r
2574 <refentry version="5.0" xml:id="html.cleanup">
\r
2576 <refentrytitle>html.cleanup</refentrytitle>
\r
2577 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
2580 <refname>html.cleanup</refname>
\r
2581 <refpurpose>Attempt to clean up the resulting HTML?</refpurpose>
\r
2585 <programlisting xml:id="html.cleanup.frag">
\r
2586 <xsl:param name="html.cleanup" select="1"></xsl:param>
\r
2590 <refsection><info><title>Description</title></info>
\r
2592 <para>If non-zero, and if the <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://www.exslt.org/">EXSLT</link>
\r
2593 extensions are supported by your processor, the resulting HTML will be
\r
2594 <quote>cleaned up</quote>. This improves the chances that the
\r
2595 resulting HTML will be valid. It may also improve the formatting of
\r
2596 some elements.</para>
\r
2598 <para>This parameter is different from <parameter>make.valid.html</parameter>
\r
2599 because it uses extension functions to manipulate result-tree-fragments.</para>
\r
2604 <refentry version="5.0" xml:id="html.append">
\r
2606 <refentrytitle>html.append</refentrytitle>
\r
2607 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
\r
2610 <refname>html.append</refname>
\r
2611 <refpurpose>Specifies content to append to HTML output</refpurpose>
\r
2615 <programlisting xml:id="html.append.frag"><xsl:param name="html.append"></xsl:param></programlisting>
\r
2618 <refsection><info><title>Description</title></info>
\r
2620 <para>Specifies content to append to the end of HTML files output by
\r
2621 the <filename>html/docbook.xsl</filename> stylesheet, after the
\r
2622 closing <code><html></code> tag. You probably don’t want to set any
\r
2623 value for this parameter; but if you do, the only value it should ever
\r
2624 be set to is a newline character: <code>&#x0a;</code> or
\r
2625 <code>&#10;</code></para>
\r
2630 <refentry version="5.0" xml:id="draft.mode">
\r
2632 <refentrytitle>draft.mode</refentrytitle>
\r
2633 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
\r
2634 <refmiscinfo class="other" otherclass="value">no</refmiscinfo>
\r
2635 <refmiscinfo class="other" otherclass="value">yes</refmiscinfo>
\r
2636 <refmiscinfo class="other" otherclass="value">maybe</refmiscinfo>
\r
2639 <refname>draft.mode</refname>
\r
2640 <refpurpose>Select draft mode</refpurpose>
\r
2644 <programlisting xml:id="draft.mode.frag">
\r
2645 <xsl:param name="draft.mode">maybe</xsl:param>
\r
2649 <refsection><info><title>Description</title></info>
\r
2651 <para>Selects draft mode. If <parameter>draft.mode</parameter> is
\r
2652 <quote><literal>yes</literal></quote>, the entire document will be treated
\r
2653 as a draft. If it is <quote><literal>no</literal></quote>, the entire document
\r
2654 will be treated as a final copy. If it is <quote><literal>maybe</literal></quote>,
\r
2655 individual sections will be treated as draft or final independently, depending
\r
2656 on how their <literal>status</literal> attribute is set.
\r
2662 <refentry version="5.0" xml:id="draft.watermark.image">
\r
2664 <refentrytitle>draft.watermark.image</refentrytitle>
\r
2665 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
\r
2668 <refname>draft.watermark.image</refname>
\r
2669 <refpurpose>The URI of the image to be used for draft watermarks</refpurpose>
\r
2673 <programlisting xml:id="draft.watermark.image.frag">
\r
2674 <xsl:param name="draft.watermark.image">http://docbook.sourceforge.net/release/images/draft.png</xsl:param>
\r
2678 <refsection><info><title>Description</title></info>
\r
2680 <para>The image to be used for draft watermarks.</para>
\r
2685 <refentry version="5.0" xml:id="generate.id.attributes">
\r
2687 <refentrytitle>generate.id.attributes</refentrytitle>
\r
2688 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
2691 <refname>generate.id.attributes</refname>
\r
2692 <refpurpose>Generate ID attributes on container elements?</refpurpose>
\r
2696 <programlisting xml:id="generate.id.attributes.frag">
\r
2697 <xsl:param name="generate.id.attributes" select="0"></xsl:param>
\r
2701 <refsection><info><title>Description</title></info>
\r
2703 <para>If non-zero, the HTML stylesheet will generate ID attributes on
\r
2704 containers. For example, the markup:</para>
\r
2706 <screen><section id="foo"><title>Some Title</title>
\r
2707 <para>Some para.</para>
\r
2708 </section></screen>
\r
2710 <para>might produce:</para>
\r
2712 <screen><div class="section" id="foo">
\r
2713 <h2>Some Title</h2>
\r
2714 <p>Some para.</p>
\r
2715 </div></screen>
\r
2717 <para>The alternative is to generate anchors:</para>
\r
2719 <screen><div class="section">
\r
2720 <h2><a name="foo"></a>Some Title</h2>
\r
2721 <p>Some para.</p>
\r
2722 </div></screen>
\r
2724 <para>Because the <tag class="attribute">name</tag> attribute of
\r
2725 the <tag>a</tag> element and the <tag class="attribute">id</tag>
\r
2726 attribute of other tags are both of type <quote>ID</quote>, producing both
\r
2727 generates invalid documents.</para>
\r
2729 <para>As of version 1.50, you can use this switch to control which type of
\r
2730 identifier is generated. For backwards-compatibility, generating
\r
2731 <tag>a</tag> anchors is preferred.</para>
\r
2733 <para>Note: at present, this switch is incompletely implemented.
\r
2734 Disabling ID attributes will suppress them, but enabling ID attributes
\r
2735 will not suppress the anchors.</para>
\r
2740 <refentry version="5.0" xml:id="generate.meta.abstract">
\r
2742 <refentrytitle>generate.meta.abstract</refentrytitle>
\r
2743 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
2746 <refname>generate.meta.abstract</refname>
\r
2747 <refpurpose>Generate HTML <tag>META</tag> element from <tag>abstract</tag>?</refpurpose>
\r
2751 <programlisting xml:id="generate.meta.abstract.frag">
\r
2752 <xsl:param name="generate.meta.abstract" select="1"></xsl:param>
\r
2756 <refsection><info><title>Description</title></info>
\r
2758 <para>If non-zero, document abstracts will be reproduced in the HTML
\r
2759 <literal>head</literal>, with <literal>>meta name="description" content="..."</literal></para>
\r
2766 <reference xml:id="xslt"><title>XSLT Processing</title>
\r
2767 <refentry version="5.0" xml:id="rootid">
\r
2769 <refentrytitle>rootid</refentrytitle>
\r
2770 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
\r
2773 <refname>rootid</refname>
\r
2774 <refpurpose>Specify the root element to format</refpurpose>
\r
2778 <programlisting xml:id="rootid.frag">
\r
2779 <xsl:param name="rootid"></xsl:param></programlisting>
\r
2782 <refsection><info><title>Description</title></info>
\r
2784 <para>If <parameter>rootid</parameter> is not empty, it must be the
\r
2785 value of an ID that occurs in the document being formatted. The entire
\r
2786 document will be loaded and parsed, but formatting will begin at the
\r
2787 element identified, rather than at the root. For example, this allows
\r
2788 you to process only <tag>chapter</tag> 4 of a <tag>book</tag>.</para>
\r
2789 <para>Because the entire document is available to the processor, automatic
\r
2790 numbering, cross references, and other dependencies are correctly
\r
2796 <refentry version="5.0" xml:id="suppress.navigation">
\r
2798 <refentrytitle>suppress.navigation</refentrytitle>
\r
2799 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
2802 <refname>suppress.navigation</refname>
\r
2803 <refpurpose>Disable header and footer navigation</refpurpose>
\r
2807 <programlisting xml:id="suppress.navigation.frag">
\r
2808 <xsl:param name="suppress.navigation" select="0"></xsl:param>
\r
2812 <refsection><info><title>Description</title></info>
\r
2815 If non-zero, header and footer navigation will be suppressed.</para>
\r
2820 <refentry version="5.0" xml:id="suppress.header.navigation">
\r
2822 <refentrytitle>suppress.header.navigation</refentrytitle>
\r
2823 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
2826 <refname>suppress.header.navigation</refname>
\r
2827 <refpurpose>Disable header navigation</refpurpose>
\r
2831 <programlisting xml:id="suppress.header.navigation.frag">
\r
2832 <xsl:param name="suppress.header.navigation" select="0"></xsl:param>
\r
2836 <refsection><info><title>Description</title></info>
\r
2838 <para>If non-zero, header navigation will be suppressed.</para>
\r
2843 <refentry version="5.0" xml:id="suppress.footer.navigation">
\r
2845 <refentrytitle>suppress.footer.navigation</refentrytitle>
\r
2846 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
2849 <refname>suppress.footer.navigation</refname>
\r
2850 <refpurpose>Disable footer navigation</refpurpose>
\r
2854 <programlisting xml:id="suppress.footer.navigation.frag"><xsl:param name="suppress.footer.navigation">0</xsl:param></programlisting>
\r
2857 <refsection><info><title>Description</title></info>
\r
2860 If non-zero, footer navigation will be suppressed.</para>
\r
2865 <refentry version="5.0" xml:id="header.rule">
\r
2867 <refentrytitle>header.rule</refentrytitle>
\r
2868 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
2871 <refname>header.rule</refname>
\r
2872 <refpurpose>Rule under headers?</refpurpose>
\r
2876 <programlisting xml:id="header.rule.frag">
\r
2877 <xsl:param name="header.rule" select="1"></xsl:param>
\r
2881 <refsection><info><title>Description</title></info>
\r
2883 <para>If non-zero, a rule will be drawn below the page headers.</para>
\r
2888 <refentry version="5.0" xml:id="footer.rule">
\r
2890 <refentrytitle>footer.rule</refentrytitle>
\r
2891 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
2894 <refname>footer.rule</refname>
\r
2895 <refpurpose>Rule over footers?</refpurpose>
\r
2899 <programlisting xml:id="footer.rule.frag">
\r
2900 <xsl:param name="footer.rule" select="1"></xsl:param>
\r
2904 <refsection><info><title>Description</title></info>
\r
2906 <para>If non-zero, a rule will be drawn above the page footers.</para>
\r
2911 <refentry version="5.0" xml:id="id.warnings">
\r
2913 <refentrytitle>id.warnings</refentrytitle>
\r
2914 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
2917 <refname>id.warnings</refname>
\r
2918 <refpurpose>Should warnings be generated for titled elements without IDs?</refpurpose>
\r
2921 <programlisting xml:id="id.warnings.frag">
\r
2922 <xsl:param name="id.warnings" select="0"></xsl:param>
\r
2925 <refsection><info><title>Description</title></info>
\r
2926 <para>If non-zero, the stylesheet will issue a warning for any element
\r
2927 (other than the root element) which has a <tag>title</tag> but does not have an
\r
2933 <reference xml:id="meta"><title>Meta/*Info and Titlepages</title>
\r
2934 <refentry version="5.0" xml:id="inherit.keywords">
\r
2936 <refentrytitle>inherit.keywords</refentrytitle>
\r
2937 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
2940 <refname>inherit.keywords</refname>
\r
2941 <refpurpose>Inherit keywords from ancestor elements?</refpurpose>
\r
2945 <programlisting xml:id="inherit.keywords.frag">
\r
2946 <xsl:param name="inherit.keywords" select="1"></xsl:param></programlisting>
\r
2949 <refsection><info><title>Description</title></info>
\r
2951 <para>If <parameter>inherit.keywords</parameter>
\r
2952 is non-zero, the keyword <literal>meta</literal> for each HTML
\r
2953 <literal>head</literal> element will include all of the keywords from
\r
2954 ancestor elements. Otherwise, only the keywords from the current section
\r
2961 <refentry version="5.0" xml:id="make.single.year.ranges">
\r
2963 <refentrytitle>make.single.year.ranges</refentrytitle>
\r
2964 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
2967 <refname>make.single.year.ranges</refname>
\r
2968 <refpurpose>Print single-year ranges (e.g., 1998-1999)</refpurpose>
\r
2972 <programlisting xml:id="make.single.year.ranges.frag">
\r
2973 <xsl:param name="make.single.year.ranges" select="0"></xsl:param></programlisting>
\r
2976 <refsection><info><title>Description</title></info>
\r
2978 <para>If non-zero, year ranges that span a single year will be printed
\r
2979 in range notation (1998-1999) instead of discrete notation
\r
2980 (1998, 1999).</para>
\r
2985 <refentry version="5.0" xml:id="make.year.ranges">
\r
2987 <refentrytitle>make.year.ranges</refentrytitle>
\r
2988 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
2991 <refname>make.year.ranges</refname>
\r
2992 <refpurpose>Collate copyright years into ranges?</refpurpose>
\r
2996 <programlisting xml:id="make.year.ranges.frag"><xsl:param name="make.year.ranges" select="0"></xsl:param></programlisting>
\r
2999 <refsection><info><title>Description</title></info>
\r
3001 <para>If non-zero, multiple copyright <tag>year</tag> elements will be
\r
3002 collated into ranges.
\r
3003 This works only if each year number is put into a separate
\r
3004 year element. The copyright element permits multiple
\r
3005 year elements. If a year element contains a dash or
\r
3006 a comma, then that year element will not be merged into
\r
3013 <refentry version="5.0" xml:id="author.othername.in.middle">
\r
3015 <refentrytitle>author.othername.in.middle</refentrytitle>
\r
3016 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
3019 <refname>author.othername.in.middle</refname>
\r
3020 <refpurpose>Is <tag>othername</tag> in <tag>author</tag> a
\r
3021 middle name?</refpurpose>
\r
3025 <programlisting xml:id="author.othername.in.middle.frag">
\r
3026 <xsl:param name="author.othername.in.middle" select="1"></xsl:param></programlisting>
\r
3029 <refsection><info><title>Description</title></info>
\r
3031 <para>If non-zero, the <tag>othername</tag> of an <tag>author</tag>
\r
3032 appears between the <tag>firstname</tag> and
\r
3033 <tag>surname</tag>. Otherwise, <tag>othername</tag>
\r
3040 <refentry version="5.0" xml:id="blurb.on.titlepage.enabled">
\r
3042 <refentrytitle>blurb.on.titlepage.enabled</refentrytitle>
\r
3043 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
3046 <refname>blurb.on.titlepage.enabled</refname>
\r
3047 <refpurpose>Display personblurb and authorblurb on title pages?</refpurpose>
\r
3051 <programlisting xml:id="blurb.on.titlepage.enabled.frag">
\r
3052 <xsl:param name="blurb.on.titlepage.enabled" select="0"></xsl:param>
\r
3056 <refsection><info><title>Description</title></info>
\r
3058 <para>If non-zero, output from <tag>authorblurb</tag> and
\r
3059 <tag>personblurb</tag> elements is displayed on title pages. If zero
\r
3060 (the default), output from those elements is suppressed on title pages
\r
3061 (unless you are using a <literal>titlepage</literal> customization
\r
3062 that causes them to be included).</para>
\r
3067 <refentry version="5.0" xml:id="contrib.inline.enabled">
\r
3069 <refentrytitle>contrib.inline.enabled</refentrytitle>
\r
3070 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
3073 <refname>contrib.inline.enabled</refname>
\r
3074 <refpurpose>Display contrib output inline?</refpurpose>
\r
3078 <programlisting xml:id="contrib.inline.enabled.frag"><xsl:param name="contrib.inline.enabled">1</xsl:param></programlisting>
\r
3081 <refsection><info><title>Description</title></info>
\r
3083 <para>If non-zero (the default), output of the <tag>contrib</tag> element is
\r
3084 displayed as inline content rather than as block content.</para>
\r
3089 <refentry version="5.0" xml:id="editedby.enabled">
\r
3091 <refentrytitle>editedby.enabled</refentrytitle>
\r
3092 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
3095 <refname>editedby.enabled</refname>
\r
3096 <refpurpose>Display “Edited by” heading above editor name?</refpurpose>
\r
3100 <programlisting xml:id="editedby.enabled.frag"><xsl:param name="editedby.enabled">1</xsl:param></programlisting>
\r
3103 <refsection><info><title>Description</title></info>
\r
3105 <para>If non-zero, a localized <emphasis role="bold">Edited
\r
3106 by</emphasis> heading is displayed above editor names in output of the
\r
3107 <tag>editor</tag> element.</para>
\r
3112 <refentry version="5.0" xml:id="abstract.notitle.enabled">
\r
3114 <refentrytitle>abstract.notitle.enabled</refentrytitle>
\r
3115 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
3118 <refname>abstract.notitle.enabled</refname>
\r
3119 <refpurpose>Suppress display of abstract titles?</refpurpose>
\r
3122 <programlisting xml:id="abstract.notitle.enabled.frag"><xsl:param name="abstract.notitle.enabled" select="0"></xsl:param></programlisting>
\r
3124 <refsection><info><title>Description</title></info>
\r
3125 <para>If non-zero, in output of the <tag>abstract</tag> element on titlepages,
\r
3126 display of the abstract title is suppressed.</para>
\r
3130 <refentry version="5.0" xml:id="othercredit.like.author.enabled">
\r
3132 <refentrytitle>othercredit.like.author.enabled</refentrytitle>
\r
3133 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
3136 <refname>othercredit.like.author.enabled</refname>
\r
3137 <refpurpose>Display othercredit in same style as author?</refpurpose>
\r
3141 <programlisting xml:id="othercredit.like.author.enabled.frag"><xsl:param name="othercredit.like.author.enabled">0</xsl:param></programlisting>
\r
3144 <refsection><info><title>Description</title></info>
\r
3146 <para>If non-zero, output of the
\r
3147 <tag>othercredit</tag> element on titlepages is displayed in
\r
3148 the same style as <tag>author</tag> and
\r
3149 <tag>editor</tag> output. If zero then
\r
3150 <tag>othercredit</tag> output is displayed using a style
\r
3151 different than that of <tag>author</tag> and
\r
3152 <tag>editor</tag>.</para>
\r
3157 <refentry version="5.0" xml:id="generate.legalnotice.link">
\r
3159 <refentrytitle>generate.legalnotice.link</refentrytitle>
\r
3160 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
3163 <refname>generate.legalnotice.link</refname>
\r
3164 <refpurpose>Write legalnotice to separate chunk and generate link?</refpurpose>
\r
3168 <programlisting xml:id="generate.legalnotice.link.frag"><xsl:param name="generate.legalnotice.link" select="0"></xsl:param></programlisting>
\r
3171 <refsection><info><title>Description</title></info>
\r
3173 <para>If the value of <parameter>generate.legalnotice.link</parameter>
\r
3174 is non-zero, the stylesheet:
\r
3178 <para>writes the contents of <tag>legalnotice</tag> to a separate
\r
3182 <para>inserts a hyperlink to the <tag>legalnotice</tag> file</para>
\r
3185 <para>adds (in the HTML <literal>head</literal>) either a single
\r
3186 <literal>link</literal> or element or multiple
\r
3187 <literal>link</literal> elements (depending on the value of the
\r
3188 <parameter>html.head.legalnotice.link.multiple</parameter>
\r
3189 parameter), with the value or values derived from the
\r
3190 <parameter>html.head.legalnotice.link.types</parameter>
\r
3195 Otherwise, if <parameter>generate.legalnotice.link</parameter> is
\r
3196 zero, <tag>legalnotice</tag> contents are rendered on the title
\r
3199 <para>The name of the separate HTML file is computed as follows:
\r
3203 <para>If a filename is given by the <tag class="xmlpi">dbhtml filename</tag>
\r
3204 processing instruction, that filename is used.</para>
\r
3207 <para>If the legalnotice has an <tag class="attribute">id</tag>/<tag class="attribute">xml:id</tag>
\r
3208 attribute, and if <parameter>use.id.as.filename</parameter> != 0, the filename
\r
3209 is the concatenation of the id value and the value of the <parameter>html.ext</parameter>
\r
3213 <para>If the legalnotice does not have an <tag class="attribute">id</tag>/<tag class="attribute">xml:id</tag>
\r
3214 attribute, or if <parameter>use.id.as.filename</parameter> = 0, the filename is the concatenation of "ln-",
\r
3215 auto-generated id value, and <parameter>html.ext</parameter> value.
\r
3225 <refentry version="5.0" xml:id="generate.revhistory.link">
\r
3227 <refentrytitle>generate.revhistory.link</refentrytitle>
\r
3228 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
3231 <refname>generate.revhistory.link</refname>
\r
3232 <refpurpose>Write revhistory to separate chunk and generate link?</refpurpose>
\r
3236 <programlisting xml:id="generate.revhistory.link.frag"><xsl:param name="generate.revhistory.link" select="0"></xsl:param></programlisting>
\r
3239 <refsection><info><title>Description</title></info>
\r
3241 <para>If non-zero, the contents of <tag>revhistory</tag> are written
\r
3242 to a separate HTML file and a link to the file is
\r
3243 generated. Otherwise, <tag>revhistory</tag> contents are rendered on
\r
3244 the title page.</para>
\r
3246 <para>The name of the separate HTML file is computed as follows:
\r
3250 <para>If a filename is given by the <tag class="xmlpi">dbhtml filename</tag> processing instruction,
\r
3251 that filename is used.</para>
\r
3254 <para>If the revhistory has an <tag class="attribute">id</tag>/<tag class="attribute">xml:id</tag>
\r
3255 attribute, and if <parameter>use.id.as.filename</parameter> != 0, the filename is the concatenation of
\r
3256 the id value and the value of the <parameter>html.ext</parameter> parameter.</para>
\r
3259 <para>If the revhistory does not have an <tag class="attribute">id</tag>/<tag class="attribute">xml:id</tag>
\r
3260 attribute, or if <parameter>use.id.as.filename</parameter> = 0, the filename is the concatenation of "rh-",
\r
3261 auto-generated id value, and <parameter>html.ext</parameter> value.
\r
3271 <refentry version="5.0" xml:id="html.head.legalnotice.link.types">
\r
3273 <refentrytitle>html.head.legalnotice.link.types</refentrytitle>
\r
3274 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
\r
3277 <refname>html.head.legalnotice.link.types</refname>
\r
3278 <refpurpose>Specifies link types for legalnotice link in html head</refpurpose>
\r
3282 <programlisting xml:id="html.head.legalnotice.link.types.frag">
\r
3283 <xsl:param name="html.head.legalnotice.link.types">copyright</xsl:param>
\r
3287 <refsection><info><title>Description</title></info>
\r
3289 <para>The value of
\r
3290 <parameter>html.head.legalnotice.link.types</parameter> is a
\r
3291 space-separated list of link types, as described in <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://www.w3.org/TR/html401/types.html#type-links">Section 6.12
\r
3292 of the HTML 4.01 specification</link>. If the value of the
\r
3293 <parameter>generate.legalnotice.link</parameter> parameter is
\r
3294 non-zero, then the stylesheet generates (in the
\r
3295 <literal>head</literal> section of the HTML source) either a single
\r
3296 HTML <literal>link</literal> element or, if the value of the
\r
3297 <parameter>html.head.legalnotice.link.multiple</parameter> is
\r
3298 non-zero, one <literal>link</literal> element for each link type
\r
3299 specified. Each <literal>link</literal> has the following attributes:
\r
3303 <para>a <tag class="attribute">rel</tag> attribute whose
\r
3304 value is derived from the value of
\r
3305 <parameter>html.head.legalnotice.link.types</parameter></para>
\r
3308 <para>an <tag class="attribute">href</tag> attribute whose
\r
3309 value is set to the URL of the file containing the
\r
3310 <tag>legalnotice</tag></para>
\r
3313 <para>a <tag class="attribute">title</tag> attribute whose
\r
3314 value is set to the title of the corresponding
\r
3315 <tag>legalnotice</tag> (or a title programatically
\r
3316 determined by the stylesheet)</para>
\r
3322 <screen> <link rel="license" href="ln-id2524073.html" title="Legal Notice"></screen>
\r
3325 <refsection><info><title>About the default value</title></info>
\r
3327 <para>In an ideal world, the default value of
\r
3328 <parameter>html.head.legalnotice.link.types</parameter> would
\r
3329 probably be “<literal>license</literal>”, since the content of the
\r
3330 DocBook <tag>legalnotice</tag> is typically license
\r
3331 information, not copyright information. However, the default value
\r
3332 is “<literal>copyright</literal>” for pragmatic reasons: because
\r
3333 that’s among the set of “recognized link types” listed in <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://www.w3.org/TR/html401/types.html#type-links">Section
\r
3334 6.12 of the HTML 4.01 specification</link>, and because certain
\r
3335 browsers and browser extensions are preconfigured to recognize that
\r
3342 <refentry version="5.0" xml:id="html.head.legalnotice.link.multiple">
\r
3344 <refentrytitle>html.head.legalnotice.link.multiple</refentrytitle>
\r
3345 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
3348 <refname>html.head.legalnotice.link.multiple</refname>
\r
3349 <refpurpose>Generate multiple link instances in html head for legalnotice?</refpurpose>
\r
3353 <programlisting xml:id="html.head.legalnotice.link.multiple.frag">
\r
3354 <xsl:param name="html.head.legalnotice.link.multiple" select="1"></xsl:param>
\r
3358 <refsection><info><title>Description</title></info>
\r
3360 <para>If <parameter>html.head.legalnotice.link.multiple</parameter> is
\r
3361 non-zero and the value of
\r
3362 <parameter>html.head.legalnotice.link.types</parameter> contains
\r
3363 multiple link types, then the stylesheet generates (in the
\r
3364 <literal>head</literal> section of the HTML source) one
\r
3365 <literal>link</literal> element for each link type specified. For
\r
3366 example, if the value of
\r
3367 <parameter>html.head.legalnotice.link.types</parameter> is
\r
3368 “<literal>copyright license</literal>”:
\r
3370 <screen> <link rel="copyright" href="ln-id2524073.html" title="Legal Notice">
\r
3371 <link rel="license" href="ln-id2524073.html" title="Legal Notice"></screen>
\r
3373 Otherwise, the stylesheet generates generates a single
\r
3374 <literal>link</literal> instance; for example:
\r
3376 <screen> <link rel="copyright license" href="ln-id2524073.html" title="Legal Notice"></screen>
\r
3383 <reference xml:id="refentry"><title>Reference Pages</title>
\r
3384 <refentry version="5.0" xml:id="funcsynopsis.decoration">
\r
3386 <refentrytitle>funcsynopsis.decoration</refentrytitle>
\r
3387 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
3390 <refname>funcsynopsis.decoration</refname>
\r
3391 <refpurpose>Decorate elements of a <tag>funcsynopsis</tag>?</refpurpose>
\r
3395 <programlisting xml:id="funcsynopsis.decoration.frag">
\r
3396 <xsl:param name="funcsynopsis.decoration" select="1"></xsl:param>
\r
3400 <refsection><info><title>Description</title></info>
\r
3402 <para>If non-zero, elements of the <tag>funcsynopsis</tag> will be
\r
3403 decorated (e.g. rendered as bold or italic text). The decoration is controlled by
\r
3404 templates that can be redefined in a customization layer.
\r
3410 <refentry version="5.0" xml:id="funcsynopsis.style">
\r
3412 <refentrytitle>funcsynopsis.style</refentrytitle>
\r
3413 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
\r
3414 <refmiscinfo class="other" otherclass="value">ansi</refmiscinfo>
\r
3415 <refmiscinfo class="other" otherclass="value">kr</refmiscinfo>
\r
3418 <refname>funcsynopsis.style</refname>
\r
3419 <refpurpose>What style of <tag>funcsynopsis</tag> should be generated?</refpurpose>
\r
3423 <programlisting xml:id="funcsynopsis.style.frag"><xsl:param name="funcsynopsis.style">kr</xsl:param></programlisting>
\r
3426 <refsection><info><title>Description</title></info>
\r
3428 <para>If <parameter>funcsynopsis.style</parameter> is <literal>ansi</literal>,
\r
3429 ANSI-style function synopses are generated for a
\r
3430 <tag>funcsynopsis</tag>, otherwise K&R-style
\r
3431 function synopses are generated.
\r
3437 <refentry version="5.0" xml:id="function.parens">
\r
3439 <refentrytitle>function.parens</refentrytitle>
\r
3440 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
3443 <refname>function.parens</refname>
\r
3444 <refpurpose>Generate parens after a function?</refpurpose>
\r
3448 <programlisting xml:id="function.parens.frag">
\r
3449 <xsl:param name="function.parens" select="0"></xsl:param>
\r
3453 <refsection><info><title>Description</title></info>
\r
3455 <para>If non-zero, the formatting of a <tag>function</tag> element
\r
3456 will include generated parentheses.
\r
3462 <refentry version="5.0" xml:id="refentry.generate.name">
\r
3464 <refentrytitle>refentry.generate.name</refentrytitle>
\r
3465 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
3468 <refname>refentry.generate.name</refname>
\r
3469 <refpurpose>Output NAME header before <tag>refname</tag>s?</refpurpose>
\r
3473 <programlisting xml:id="refentry.generate.name.frag">
\r
3474 <xsl:param name="refentry.generate.name" select="1"></xsl:param>
\r
3478 <refsection><info><title>Description</title></info>
\r
3480 <para>If non-zero, a "NAME" section title is output before the list
\r
3481 of <tag>refname</tag>s. This parameter and
\r
3482 <parameter>refentry.generate.title</parameter> are mutually
\r
3483 exclusive. This means that if you change this parameter to zero, you
\r
3484 should set <parameter>refentry.generate.title</parameter> to non-zero unless
\r
3485 you want get quite strange output.
\r
3491 <refentry version="5.0" xml:id="refentry.generate.title">
\r
3493 <refentrytitle>refentry.generate.title</refentrytitle>
\r
3494 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
3497 <refname>refentry.generate.title</refname>
\r
3498 <refpurpose>Output title before <tag>refname</tag>s?</refpurpose>
\r
3502 <programlisting xml:id="refentry.generate.title.frag">
\r
3503 <xsl:param name="refentry.generate.title" select="0"></xsl:param>
\r
3507 <refsection><info><title>Description</title></info>
\r
3509 <para>If non-zero, the reference page title or first name is
\r
3510 output before the list of <tag>refname</tag>s. This parameter and
\r
3511 <parameter>refentry.generate.name</parameter> are mutually exclusive.
\r
3512 This means that if you change this parameter to non-zero, you
\r
3513 should set <parameter>refentry.generate.name</parameter> to zero unless
\r
3514 you want get quite strange output.</para>
\r
3520 <refentry version="5.0" xml:id="refentry.xref.manvolnum">
\r
3522 <refentrytitle>refentry.xref.manvolnum</refentrytitle>
\r
3523 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
3526 <refname>refentry.xref.manvolnum</refname>
\r
3527 <refpurpose>Output <tag>manvolnum</tag> as part of
\r
3528 <tag>refentry</tag> cross-reference?</refpurpose>
\r
3532 <programlisting xml:id="refentry.xref.manvolnum.frag">
\r
3533 <xsl:param name="refentry.xref.manvolnum" select="1"></xsl:param>
\r
3537 <refsection><info><title>Description</title></info>
\r
3539 <para>if non-zero, the <tag>manvolnum</tag> is used when cross-referencing
\r
3540 <tag>refentry</tag>s, either with <tag>xref</tag>
\r
3541 or <tag>citerefentry</tag>.
\r
3547 <refentry version="5.0" xml:id="citerefentry.link">
\r
3549 <refentrytitle>citerefentry.link</refentrytitle>
\r
3550 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
3553 <refname>citerefentry.link</refname>
\r
3554 <refpurpose>Generate URL links when cross-referencing RefEntrys?</refpurpose>
\r
3558 <programlisting xml:id="citerefentry.link.frag">
\r
3559 <xsl:param name="citerefentry.link" select="0"></xsl:param></programlisting>
\r
3562 <refsection><info><title>Description</title></info>
\r
3564 <para>If non-zero, a web link will be generated, presumably
\r
3565 to an online man->HTML gateway. The text of the link is
\r
3566 generated by the <literal>generate.citerefentry.link</literal> template.
\r
3572 <refentry version="5.0" xml:id="refentry.separator">
\r
3574 <refentrytitle>refentry.separator</refentrytitle>
\r
3575 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
3578 <refname>refentry.separator</refname>
\r
3579 <refpurpose>Generate a separator between consecutive RefEntry elements?</refpurpose>
\r
3583 <programlisting xml:id="refentry.separator.frag">
\r
3584 <xsl:param name="refentry.separator" select="1"></xsl:param>
\r
3588 <refsection><info><title>Description</title></info>
\r
3590 <para>If true, a separator will be generated between consecutive
\r
3597 <refentry version="5.0" xml:id="refclass.suppress">
\r
3599 <refentrytitle>refclass.suppress</refentrytitle>
\r
3600 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
3603 <refname>refclass.suppress</refname>
\r
3604 <refpurpose>Suppress display of refclass contents?</refpurpose>
\r
3608 <programlisting xml:id="refclass.suppress.frag">
\r
3609 <xsl:param name="refclass.suppress" select="0"></xsl:param></programlisting>
\r
3612 <refsection><info><title>Description</title></info>
\r
3614 <para>If the value of <parameter>refclass.suppress</parameter> is
\r
3615 non-zero, then display of <tag>refclass</tag> contents is
\r
3616 suppressed in output.</para>
\r
3622 <reference xml:id="tables"><title>Tables</title>
\r
3623 <refentry version="5.0" xml:id="default.table.width">
\r
3625 <refentrytitle>default.table.width</refentrytitle>
\r
3626 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
\r
3629 <refname>default.table.width</refname>
\r
3630 <refpurpose>The default width of tables</refpurpose>
\r
3633 <programlisting xml:id="default.table.width.frag">
\r
3634 <xsl:param name="default.table.width"></xsl:param>
\r
3637 <refsection><info><title>Description</title></info>
\r
3638 <para>If non-zero, this value will be used for the
\r
3639 <literal>width</literal> attribute on <tag>table</tag>s that do not specify an
\r
3640 alternate width (with the <tag class="xmlpi">dbhtml table-width</tag> or
\r
3641 <tag class="xmlpi">dbfo table-width</tag> processing instruction).</para>
\r
3645 <refentry version="5.0" xml:id="nominal.table.width">
\r
3647 <refentrytitle>nominal.table.width</refentrytitle>
\r
3648 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
\r
3651 <refname>nominal.table.width</refname>
\r
3652 <refpurpose>The (absolute) nominal width of tables</refpurpose>
\r
3656 <programlisting xml:id="nominal.table.width.frag">
\r
3657 <xsl:param name="nominal.table.width">6in</xsl:param>
\r
3661 <refsection><info><title>Description</title></info>
\r
3663 <para>In order to convert CALS column widths into HTML column widths, it
\r
3664 is sometimes necessary to have an absolute table width to use for conversion
\r
3665 of mixed absolute and relative widths. This value must be an absolute
\r
3666 length (not a percentage).</para>
\r
3671 <refentry version="5.0" xml:id="table.borders.with.css">
\r
3673 <refentrytitle>table.borders.with.css</refentrytitle>
\r
3674 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
3677 <refname>table.borders.with.css</refname>
\r
3678 <refpurpose>Use CSS to specify table, row, and cell borders?</refpurpose>
\r
3682 <programlisting xml:id="table.borders.with.css.frag">
\r
3683 <xsl:param name="table.borders.with.css" select="0"></xsl:param>
\r
3687 <refsection><info><title>Description</title></info>
\r
3689 <para>If non-zero, CSS will be used to draw table borders.
\r
3695 <refentry version="5.0" xml:id="table.cell.border.style">
\r
3697 <refentrytitle>table.cell.border.style</refentrytitle>
\r
3698 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
\r
3699 <refmiscinfo class="other" otherclass="value">none</refmiscinfo>
\r
3700 <refmiscinfo class="other" otherclass="value">solid</refmiscinfo>
\r
3701 <refmiscinfo class="other" otherclass="value">dotted</refmiscinfo>
\r
3702 <refmiscinfo class="other" otherclass="value">dashed</refmiscinfo>
\r
3703 <refmiscinfo class="other" otherclass="value">double</refmiscinfo>
\r
3704 <refmiscinfo class="other" otherclass="value">groove</refmiscinfo>
\r
3705 <refmiscinfo class="other" otherclass="value">ridge</refmiscinfo>
\r
3706 <refmiscinfo class="other" otherclass="value">inset</refmiscinfo>
\r
3707 <refmiscinfo class="other" otherclass="value">outset</refmiscinfo>
\r
3708 <refmiscinfo class="other" otherclass="value">solid</refmiscinfo>
\r
3711 <refname>table.cell.border.style</refname>
\r
3712 <refpurpose>Specifies the border style of table cells</refpurpose>
\r
3716 <programlisting xml:id="table.cell.border.style.frag">
\r
3717 <xsl:param name="table.cell.border.style">solid</xsl:param>
\r
3721 <refsection><info><title>Description</title></info>
\r
3723 <para>Specifies the border style of table cells.</para>
\r
3726 <para>To control properties of cell borders in HTML output, you must also turn on the
\r
3727 <parameter>table.borders.with.css</parameter> parameter.</para>
\r
3733 <refentry version="5.0" xml:id="table.cell.border.thickness">
\r
3735 <refentrytitle>table.cell.border.thickness</refentrytitle>
\r
3736 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
\r
3739 <refname>table.cell.border.thickness</refname>
\r
3740 <refpurpose>Specifies the thickness of table cell borders</refpurpose>
\r
3744 <programlisting xml:id="table.cell.border.thickness.frag">
\r
3745 <xsl:param name="table.cell.border.thickness">0.5pt</xsl:param>
\r
3749 <refsection><info><title>Description</title></info>
\r
3751 <para>If non-zero, specifies the thickness of borders on table
\r
3752 cells. The units are points. See <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://www.w3.org/TR/CSS21/box.html#border-width-properties">
\r
3756 <para>To control properties of cell borders in HTML output, you must also turn on the
\r
3757 <parameter>table.borders.with.css</parameter> parameter.</para>
\r
3763 <refentry version="5.0" xml:id="table.cell.border.color">
\r
3765 <refentrytitle>table.cell.border.color</refentrytitle>
\r
3766 <refmiscinfo class="other" otherclass="datatype">color</refmiscinfo>
\r
3769 <refname>table.cell.border.color</refname>
\r
3770 <refpurpose>Specifies the border color of table cells</refpurpose>
\r
3774 <programlisting xml:id="table.cell.border.color.frag">
\r
3775 <xsl:param name="table.cell.border.color"></xsl:param>
\r
3780 <refsection><info><title>Description</title></info>
\r
3782 <para>Set the color of table cell borders. If non-zero, the value is used
\r
3783 for the border coloration. See <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://www.w3.org/TR/CSS21/syndata.html#value-def-color">CSS</link>. A
\r
3784 <literal>color</literal> is either a keyword or a numerical RGB specification.
\r
3785 Keywords are aqua, black, blue, fuchsia, gray, green, lime, maroon,
\r
3786 navy, olive, orange, purple, red, silver, teal, white, and
\r
3790 <para>To control properties of cell borders in HTML output, you must also turn on the
\r
3791 <parameter>table.borders.with.css</parameter> parameter.</para>
\r
3797 <refentry version="5.0" xml:id="table.frame.border.style">
\r
3799 <refentrytitle>table.frame.border.style</refentrytitle>
\r
3800 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
\r
3801 <refmiscinfo class="other" otherclass="value">none</refmiscinfo>
\r
3802 <refmiscinfo class="other" otherclass="value">solid</refmiscinfo>
\r
3803 <refmiscinfo class="other" otherclass="value">dotted</refmiscinfo>
\r
3804 <refmiscinfo class="other" otherclass="value">dashed</refmiscinfo>
\r
3805 <refmiscinfo class="other" otherclass="value">double</refmiscinfo>
\r
3806 <refmiscinfo class="other" otherclass="value">groove</refmiscinfo>
\r
3807 <refmiscinfo class="other" otherclass="value">ridge</refmiscinfo>
\r
3808 <refmiscinfo class="other" otherclass="value">inset</refmiscinfo>
\r
3809 <refmiscinfo class="other" otherclass="value">outset</refmiscinfo>
\r
3810 <refmiscinfo class="other" otherclass="value">solid</refmiscinfo>
\r
3813 <refname>table.frame.border.style</refname>
\r
3814 <refpurpose>Specifies the border style of table frames</refpurpose>
\r
3818 <programlisting xml:id="table.frame.border.style.frag">
\r
3819 <xsl:param name="table.frame.border.style">solid</xsl:param>
\r
3823 <refsection><info><title>Description</title></info>
\r
3825 <para>Specifies the border style of table frames.</para>
\r
3830 <refentry version="5.0" xml:id="table.frame.border.thickness">
\r
3832 <refentrytitle>table.frame.border.thickness</refentrytitle>
\r
3833 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
\r
3836 <refname>table.frame.border.thickness</refname>
\r
3837 <refpurpose>Specifies the thickness of the frame border</refpurpose>
\r
3841 <programlisting xml:id="table.frame.border.thickness.frag">
\r
3842 <xsl:param name="table.frame.border.thickness">0.5pt</xsl:param>
\r
3846 <refsection><info><title>Description</title></info>
\r
3848 <para>Specifies the thickness of the border on the table's frame.</para>
\r
3853 <refentry version="5.0" xml:id="table.frame.border.color">
\r
3855 <refentrytitle>table.frame.border.color</refentrytitle>
\r
3856 <refmiscinfo class="other" otherclass="datatype">color</refmiscinfo>
\r
3859 <refname>table.frame.border.color</refname>
\r
3860 <refpurpose>Specifies the border color of table frames</refpurpose>
\r
3864 <programlisting xml:id="table.frame.border.color.frag">
\r
3865 <xsl:param name="table.frame.border.color"></xsl:param>
\r
3870 <refsection><info><title>Description</title></info>
\r
3872 <para>Specifies the border color of table frames.</para>
\r
3877 <refentry version="5.0" xml:id="default.table.frame">
\r
3879 <refentrytitle>default.table.frame</refentrytitle>
\r
3880 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
\r
3883 <refname>default.table.frame</refname>
\r
3884 <refpurpose>The default framing of tables</refpurpose>
\r
3888 <programlisting xml:id="default.table.frame.frag">
\r
3889 <xsl:param name="default.table.frame">all</xsl:param>
\r
3893 <refsection><info><title>Description</title></info>
\r
3895 <para>This value will be used when there is no frame attribute on the
\r
3901 <refentry version="5.0" xml:id="html.cellspacing">
\r
3903 <refentrytitle>html.cellspacing</refentrytitle>
\r
3904 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
\r
3907 <refname>html.cellspacing</refname>
\r
3908 <refpurpose>Default value for cellspacing in HTML tables</refpurpose>
\r
3912 <programlisting xml:id="html.cellspacing.frag">
\r
3913 <xsl:param name="html.cellspacing"></xsl:param>
\r
3917 <refsection><info><title>Description</title></info>
\r
3919 <para>If non-zero, this value will be used as the default cellspacing
\r
3920 value in HTML tables. nn for pixels or nn% for percentage
\r
3921 length. E.g. 5 or 5%</para>
\r
3926 <refentry version="5.0" xml:id="html.cellpadding">
\r
3928 <refentrytitle>html.cellpadding</refentrytitle>
\r
3929 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
\r
3932 <refname>html.cellpadding</refname>
\r
3933 <refpurpose>Default value for cellpadding in HTML tables</refpurpose>
\r
3937 <programlisting xml:id="html.cellpadding.frag">
\r
3938 <xsl:param name="html.cellpadding"></xsl:param>
\r
3942 <refsection><info><title>Description</title></info>
\r
3944 <para>If non-zero, this value will be used as the default cellpadding value
\r
3945 in HTML tables. nn for pixels or nn% for percentage length. E.g. 5 or
\r
3952 <reference xml:id="qa"><title>QAndASet</title>
\r
3953 <refentry version="5.0" xml:id="qanda.defaultlabel">
\r
3955 <refentrytitle>qanda.defaultlabel</refentrytitle>
\r
3956 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
\r
3957 <refmiscinfo class="other" otherclass="value">number</refmiscinfo>
\r
3958 <refmiscinfo class="other" otherclass="value">qanda</refmiscinfo>
\r
3959 <refmiscinfo class="other" otherclass="value">none</refmiscinfo>
\r
3962 <refname>qanda.defaultlabel</refname>
\r
3963 <refpurpose>Sets the default for defaultlabel on QandASet.</refpurpose>
\r
3967 <programlisting xml:id="qanda.defaultlabel.frag">
\r
3968 <xsl:param name="qanda.defaultlabel">number</xsl:param>
\r
3972 <refsection><info><title>Description</title></info>
\r
3974 <para>If no <literal>defaultlabel</literal> attribute is specified on
\r
3975 a <tag>qandaset</tag>, this value is used. It is generally one of the legal
\r
3976 values for the defaultlabel attribute (<literal>none</literal>,
\r
3977 <literal>number</literal> or
\r
3978 <literal>qanda</literal>), or one of the additional stylesheet-specific values
\r
3979 (<literal>qnumber</literal> or <literal>qnumberanda</literal>).
\r
3980 The default value is 'number'.
\r
3982 <para>The values are rendered as follows:</para>
\r
3984 <varlistentry><term><literal>qanda</literal></term>
\r
3986 <para><tag>question</tag>s are labeled "Q:" and
\r
3987 <tag>answer</tag>s are labeled "A:". </para>
\r
3991 <varlistentry><term><literal>number</literal></term>
\r
3993 <para>The questions are enumerated and the answers
\r
3994 are not labeled. </para>
\r
3998 <varlistentry><term><literal>qnumber</literal></term>
\r
4000 <para>The questions are labeled "Q:" followed by a number, and answers are not
\r
4002 When sections are numbered, adding a label
\r
4003 to the number distinguishes the question numbers
\r
4004 from the section numbers.
\r
4005 This value is not allowed in the
\r
4006 <tag class="attribute">defaultlabel</tag> attribute
\r
4007 of a <tag>qandaset</tag> element.</para>
\r
4011 <varlistentry><term><literal>qnumberanda</literal></term>
\r
4013 <para>The questions are labeled "Q:" followed by a number, and
\r
4014 the answers are labeled "A:".
\r
4015 When sections are numbered, adding a label
\r
4016 to the number distinguishes the question numbers
\r
4017 from the section numbers.
\r
4018 This value is not allowed in the
\r
4019 <tag class="attribute">defaultlabel</tag> attribute
\r
4020 of a <tag>qandaset</tag> element.</para>
\r
4024 <varlistentry><term><literal>none</literal></term>
\r
4026 <para>No distinguishing label precedes Questions or Answers.
\r
4035 <refentry version="5.0" xml:id="qanda.inherit.numeration">
\r
4037 <refentrytitle>qanda.inherit.numeration</refentrytitle>
\r
4038 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
4041 <refname>qanda.inherit.numeration</refname>
\r
4042 <refpurpose>Does enumeration of QandASet components inherit the numeration of parent elements?</refpurpose>
\r
4046 <programlisting xml:id="qanda.inherit.numeration.frag">
\r
4047 <xsl:param name="qanda.inherit.numeration" select="1"></xsl:param>
\r
4051 <refsection><info><title>Description</title></info>
\r
4053 <para>If non-zero, numbered <tag>qandadiv</tag> elements and
\r
4054 <tag>question</tag> and <tag>answer</tag> inherit the enumeration of
\r
4055 the ancestors of the <tag>qandaset</tag>.
\r
4061 <refentry version="5.0" xml:id="qanda.in.toc">
\r
4063 <refentrytitle>qanda.in.toc</refentrytitle>
\r
4064 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
4067 <refname>qanda.in.toc</refname>
\r
4068 <refpurpose>Should qandaentry questions appear in
\r
4069 the document table of contents?</refpurpose>
\r
4073 <programlisting xml:id="qanda.in.toc.frag"><xsl:param name="qanda.in.toc" select="0"></xsl:param></programlisting>
\r
4076 <refsection><info><title>Description</title></info>
\r
4078 <para>If true (non-zero), then the generated table of contents
\r
4079 for a document will include <tag>qandaset</tag> titles,
\r
4080 <tag>qandadiv</tag> titles,
\r
4081 and <tag>question</tag> elements. The default value (zero) excludes
\r
4082 them from the TOC.
\r
4084 <para>This parameter does not affect any tables of contents
\r
4085 that may be generated inside a qandaset or qandadiv.
\r
4091 <refentry version="5.0" xml:id="qanda.nested.in.toc">
\r
4093 <refentrytitle>qanda.nested.in.toc</refentrytitle>
\r
4094 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
4097 <refname>qanda.nested.in.toc</refname>
\r
4098 <refpurpose>Should nested answer/qandaentry instances appear in TOC?</refpurpose>
\r
4102 <programlisting xml:id="qanda.nested.in.toc.frag">
\r
4103 <xsl:param name="qanda.nested.in.toc" select="0"></xsl:param>
\r
4107 <refsection><info><title>Description</title></info>
\r
4109 <para>If non-zero, instances of <tag>qandaentry</tag>
\r
4110 that are children of <tag>answer</tag> elements are shown in
\r
4117 <reference xml:id="links"><title>Linking</title>
\r
4118 <refentry version="5.0" xml:id="target.database.document">
\r
4120 <refentrytitle>target.database.document</refentrytitle>
\r
4121 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
\r
4124 <refname>target.database.document</refname>
\r
4125 <refpurpose>Name of master database file for resolving
\r
4126 olinks</refpurpose>
\r
4129 <programlisting xml:id="target.database.document.frag">
\r
4130 <xsl:param name="target.database.document">olinkdb.xml</xsl:param>
\r
4131 </programlisting>
\r
4132 </refsynopsisdiv>
\r
4133 <refsection><info><title>Description</title></info>
\r
4136 To resolve olinks between documents, the stylesheets use a master
\r
4137 database document that identifies the target datafiles for all the
\r
4138 documents within the scope of the olinks. This parameter value is the
\r
4139 URI of the master document to be read during processing to resolve
\r
4140 olinks. The default value is <filename>olinkdb.xml</filename>.</para>
\r
4142 <para>The data structure of the file is defined in the
\r
4143 <filename>targetdatabase.dtd</filename> DTD. The database file
\r
4144 provides the high level elements to record the identifiers, locations,
\r
4145 and relationships of documents. The cross reference data for
\r
4146 individual documents is generally pulled into the database using
\r
4147 system entity references or XIncludes. See also
\r
4148 <parameter>targets.filename</parameter>. </para> </refsection>
\r
4151 <refentry version="5.0" xml:id="targets.filename">
\r
4153 <refentrytitle>targets.filename</refentrytitle>
\r
4154 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
\r
4157 <refname>targets.filename</refname>
\r
4158 <refpurpose>Name of cross reference targets data file</refpurpose>
\r
4160 <refsynopsisdiv> <programlisting xml:id="targets.filename.frag">
\r
4161 <xsl:param name="targets.filename">target.db</xsl:param>
\r
4162 </programlisting>
\r
4163 </refsynopsisdiv>
\r
4164 <refsection><info><title>Description</title></info>
\r
4167 In order to resolve olinks efficiently, the stylesheets can
\r
4168 generate an external data file containing information about
\r
4169 all potential cross reference endpoints in a document.
\r
4170 This parameter lets you change the name of the generated
\r
4171 file from the default name <filename>target.db</filename>.
\r
4172 The name must agree with that used in the target database
\r
4173 used to resolve olinks during processing.
\r
4174 See also <parameter>target.database.document</parameter>.
\r
4179 <refentry version="5.0" xml:id="olink.base.uri">
\r
4181 <refentrytitle>olink.base.uri</refentrytitle>
\r
4182 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
\r
4185 <refname>olink.base.uri</refname>
\r
4186 <refpurpose>Base URI used in olink hrefs</refpurpose>
\r
4188 <refsynopsisdiv> <programlisting xml:id="olink.base.uri.frag">
\r
4189 <xsl:param name="olink.base.uri"></xsl:param>
\r
4190 </programlisting>
\r
4191 </refsynopsisdiv>
\r
4192 <refsection><info><title>Description</title></info>
\r
4194 <para>When cross reference data is collected for resolving olinks, it
\r
4195 may be necessary to prepend a base URI to each target's href. This
\r
4196 parameter lets you set that base URI when cross reference data is
\r
4197 collected. This feature is needed when you want to link to a document
\r
4198 that is processed without chunking. The output filename for such a
\r
4199 document is not known to the XSL stylesheet; the only target
\r
4200 information consists of fragment identifiers such as
\r
4201 <literal>#idref</literal>. To enable the resolution of olinks between
\r
4202 documents, you should pass the name of the HTML output file as the
\r
4203 value of this parameter. Then the hrefs recorded in the cross
\r
4204 reference data collection look like
\r
4205 <literal>outfile.html#idref</literal>, which can be reached as links
\r
4206 from other documents.</para>
\r
4210 <refentry version="5.0" xml:id="use.local.olink.style">
\r
4212 <refentrytitle>use.local.olink.style</refentrytitle>
\r
4213 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
4216 <refname>use.local.olink.style</refname>
\r
4217 <refpurpose>Process olinks using xref style of current
\r
4218 document</refpurpose>
\r
4220 <refsynopsisdiv> <programlisting xml:id="use.local.olink.style.frag">
\r
4221 <xsl:param name="use.local.olink.style" select="0"></xsl:param> </programlisting>
\r
4222 </refsynopsisdiv>
\r
4223 <refsection><info><title>Description</title></info>
\r
4225 <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
\r
4226 reference string is formed again from the target title, number, and
\r
4227 element name, using the stylesheet processing the targeting document.
\r
4228 Then olinks will match the xref style in the targeting document
\r
4229 rather than in the target document. If both documents are processed
\r
4230 with the same stylesheet, then the results will be the same.</para>
\r
4234 <refentry version="5.0" xml:id="current.docid">
\r
4236 <refentrytitle>current.docid</refentrytitle>
\r
4237 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
\r
4240 <refname>current.docid</refname>
\r
4241 <refpurpose>targetdoc identifier for the document being
\r
4242 processed</refpurpose>
\r
4244 <refsynopsisdiv> <programlisting xml:id="current.docid.frag">
\r
4245 <xsl:param name="current.docid"></xsl:param>
\r
4246 </programlisting>
\r
4247 </refsynopsisdiv>
\r
4248 <refsection><info><title>Description</title></info>
\r
4250 <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
\r
4251 the targetdoc identifier of the current document, since that
\r
4252 identifier does not appear in the document itself. </para>
\r
4253 <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>
\r
4257 <refentry version="5.0" xml:id="olink.doctitle">
\r
4259 <refentrytitle>olink.doctitle</refentrytitle>
\r
4260 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
\r
4261 <refmiscinfo class="other" otherclass="value">no</refmiscinfo>
\r
4262 <refmiscinfo class="other" otherclass="value">yes</refmiscinfo>
\r
4263 <refmiscinfo class="other" otherclass="value">maybe</refmiscinfo>
\r
4266 <refname>olink.doctitle</refname>
\r
4267 <refpurpose>show the document title for external olinks?</refpurpose>
\r
4270 <refsynopsisdiv> <programlisting xml:id="olink.doctitle.frag">
\r
4271 <xsl:param name="olink.doctitle">no</xsl:param>
\r
4272 </programlisting>
\r
4273 </refsynopsisdiv>
\r
4274 <refsection><info><title>Description</title></info>
\r
4276 <para>When olinks between documents are resolved, the generated text
\r
4277 may not make it clear that the reference is to another document.
\r
4278 It is possible for the stylesheets to append the other document's
\r
4279 title to external olinks. For this to happen, two parameters must
\r
4283 <para>This <parameter>olink.doctitle</parameter> parameter
\r
4284 should be set to either <literal>yes</literal> or <literal>maybe</literal>
\r
4285 to enable this feature.
\r
4289 <para>And you should also set the <parameter>current.docid</parameter>
\r
4290 parameter to the document id for the document currently
\r
4291 being processed for output.
\r
4297 Then if an olink's <literal>targetdoc</literal> id differs from
\r
4298 the <literal>current.docid</literal> value, the stylesheet knows
\r
4299 that it is a reference to another document and can
\r
4300 append the target document's
\r
4301 title to the generated olink text. </para>
\r
4303 <para>The text for the target document's title is copied from the
\r
4304 olink database from the <tag>ttl</tag> element
\r
4305 of the top-level <tag>div</tag> for that document.
\r
4306 If that <tag>ttl</tag> element is missing or empty,
\r
4307 no title is output.
\r
4310 <para>The supported values for <parameter>olink.doctitle</parameter> are:
\r
4314 <term><literal>yes</literal></term>
\r
4317 Always insert the title to the target document if it is not
\r
4318 the current document.
\r
4323 <term><literal>no</literal></term>
\r
4326 Never insert the title to the target document, even if requested
\r
4327 in an <tag class="attribute">xrefstyle</tag> attribute.
\r
4332 <term><literal>maybe</literal></term>
\r
4335 Only insert the title to the target document, if requested
\r
4336 in an <tag class="attribute">xrefstyle</tag> attribute.
\r
4341 <para>An <tag class="attribute">xrefstyle</tag> attribute
\r
4342 may override the global setting for individual olinks.
\r
4343 The following values are supported in an
\r
4344 <tag class="attribute">xrefstyle</tag>
\r
4345 attribute using the <literal>select:</literal> syntax:
\r
4350 <term><literal>docname</literal></term>
\r
4353 Insert the target document name for this olink using the
\r
4354 <literal>docname</literal> gentext template, but only
\r
4355 if the value of <parameter>olink.doctitle</parameter>
\r
4356 is not <literal>no</literal>.
\r
4361 <term><literal>docnamelong</literal></term>
\r
4364 Insert the target document name for this olink using the
\r
4365 <literal>docnamelong</literal> gentext template, but only
\r
4366 if the value of <parameter>olink.doctitle</parameter>
\r
4367 is not <literal>no</literal>.
\r
4372 <term><literal>nodocname</literal></term>
\r
4375 Omit the target document name even if
\r
4376 the value of <parameter>olink.doctitle</parameter>
\r
4377 is <literal>yes</literal>.
\r
4382 <para>Another way of inserting the target document name
\r
4383 for a single olink is to employ an
\r
4384 <tag class="attribute">xrefstyle</tag>
\r
4385 attribute using the <literal>template:</literal> syntax.
\r
4386 The <literal>%o</literal> placeholder (the letter o, not zero)
\r
4387 in such a template
\r
4388 will be filled in with the target document's title when it is processed.
\r
4389 This will occur regardless of
\r
4390 the value of <parameter>olink.doctitle</parameter>.
\r
4392 <para>Note that prior to version 1.66 of the XSL stylesheets,
\r
4393 the allowed values for this parameter were 0 and 1. Those
\r
4394 values are still supported and mapped to 'no' and 'yes', respectively.
\r
4399 <refentry version="5.0" xml:id="olink.debug">
\r
4401 <refentrytitle>olink.debug</refentrytitle>
\r
4402 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
4405 <refname>olink.debug</refname>
\r
4406 <refpurpose>Turn on debugging messages for olinks</refpurpose>
\r
4410 <programlisting xml:id="olink.debug.frag">
\r
4411 <xsl:param name="olink.debug" select="0"></xsl:param>
\r
4415 <refsection><info><title>Description</title></info>
\r
4417 <para>If non-zero, then each olink will generate several
\r
4418 messages about how it is being resolved during processing.
\r
4419 This is useful when an olink does not resolve properly
\r
4420 and the standard error messages are not sufficient to
\r
4421 find the problem.
\r
4424 <para>You may need to read through the olink XSL templates
\r
4425 to understand the context for some of the debug messages.
\r
4431 <refentry version="5.0" xml:id="olink.properties">
\r
4433 <refentrytitle>olink.properties</refentrytitle>
\r
4434 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
\r
4437 <refname>olink.properties</refname>
\r
4438 <refpurpose>Properties associated with the cross-reference
\r
4439 text of an olink.</refpurpose>
\r
4443 <programlisting xml:id="olink.properties.frag">
\r
4444 <xsl:attribute-set name="olink.properties">
\r
4445 <xsl:attribute name="show-destination">replace</xsl:attribute>
\r
4446 </xsl:attribute-set>
\r
4450 <refsection><info><title>Description</title></info>
\r
4452 <para>This <literal>attribute set</literal> is applied to the
\r
4453 <literal>fo:basic-link</literal> element of an olink. It is not applied to the
\r
4454 optional page number or optional title of the external
\r
4460 <refentry version="5.0" xml:id="olink.lang.fallback.sequence">
\r
4462 <refentrytitle>olink.lang.fallback.sequence</refentrytitle>
\r
4463 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
\r
4466 <refname>olink.lang.fallback.sequence</refname>
\r
4467 <refpurpose>look up translated documents if olink not found?</refpurpose>
\r
4470 <refsynopsisdiv> <programlisting xml:id="olink.lang.fallback.sequence.frag">
\r
4471 <xsl:param name="olink.lang.fallback.sequence"></xsl:param>
\r
4472 </programlisting>
\r
4473 </refsynopsisdiv>
\r
4474 <refsection><info><title>Description</title></info>
\r
4477 <para>This parameter defines a list of lang values
\r
4478 to search among to resolve olinks.
\r
4481 <para>Normally an olink tries to resolve to a document in the same
\r
4482 language as the olink itself. The language of an olink
\r
4483 is determined by its nearest ancestor element with a
\r
4484 <tag class="attribute">lang</tag> attribute, otherwise the
\r
4485 value of the <parameter>l10n.gentext.default.lang</parameter>
\r
4489 <para>An olink database can contain target data for the same
\r
4490 document in multiple languages. Each set of data has the
\r
4491 same value for the <tag>targetdoc</tag> attribute in
\r
4492 the <tag>document</tag> element in the database, but with a
\r
4493 different <tag>lang</tag> attribute value.
\r
4496 <para>When an olink is being resolved, the target is first
\r
4497 sought in the document with the same language as the olink.
\r
4498 If no match is found there, then this parameter is consulted
\r
4499 for additional languages to try.</para>
\r
4501 <para>The <parameter>olink.lang.fallback.sequence</parameter>
\r
4502 must be a whitespace separated list of lang values to
\r
4503 try. The first one with a match in the olink database is used.
\r
4504 The default value is empty.</para>
\r
4506 <para>For example, a document might be written in German
\r
4507 and contain an olink with
\r
4508 <literal>targetdoc="adminguide"</literal>.
\r
4509 When the document is processed, the processor
\r
4510 first looks for a target dataset in the
\r
4511 olink database starting with:</para>
\r
4513 <literallayout><literal><document targetdoc="adminguide" lang="de"></literal>.
\r
4516 <para>If there is no such element, then the
\r
4517 <parameter>olink.lang.fallback.sequence</parameter>
\r
4518 parameter is consulted.
\r
4519 If its value is, for example, <quote>fr en</quote>, then the processor next
\r
4520 looks for <literal>targetdoc="adminguide" lang="fr"</literal>, and
\r
4521 then for <literal>targetdoc="adminguide" lang="en"</literal>.
\r
4522 If there is still no match, it looks for
\r
4523 <literal>targetdoc="adminguide"</literal> with no
\r
4527 <para>This parameter is useful when a set of documents is only
\r
4528 partially translated, or is in the process of being translated.
\r
4529 If a target of an olink has not yet been translated, then this
\r
4530 parameter permits the processor to look for the document in
\r
4531 other languages. This assumes the reader would rather have
\r
4532 a link to a document in a different language than to have
\r
4539 <refentry version="5.0" xml:id="insert.olink.page.number">
\r
4541 <refentrytitle>insert.olink.page.number</refentrytitle>
\r
4542 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
\r
4543 <refmiscinfo class="other" otherclass="value">no</refmiscinfo>
\r
4544 <refmiscinfo class="other" otherclass="value">yes</refmiscinfo>
\r
4545 <refmiscinfo class="other" otherclass="value">maybe</refmiscinfo>
\r
4548 <refname>insert.olink.page.number</refname>
\r
4549 <refpurpose>Turns page numbers in olinks on and off</refpurpose>
\r
4553 <programlisting xml:id="insert.olink.page.number.frag">
\r
4554 <xsl:param name="insert.olink.page.number">no</xsl:param>
\r
4558 <refsection><info><title>Description</title></info>
\r
4560 <para>The value of this parameter determines if
\r
4561 cross references made between documents with
\r
4562 <tag>olink</tag> will
\r
4563 include page number citations.
\r
4564 In most cases this is only applicable to references in printed output.
\r
4566 <para>The parameter has three possible values.
\r
4571 <listitem><para>No page number references will be generated for olinks.
\r
4572 </para></listitem>
\r
4576 <listitem><para>Page number references will be generated
\r
4577 for all <tag>olink</tag> references.
\r
4578 The style of page reference may be changed
\r
4579 if an <tag class="attribute">xrefstyle</tag>
\r
4580 attribute is used.
\r
4581 </para></listitem>
\r
4584 <term>maybe</term>
\r
4585 <listitem><para>Page number references will not be generated
\r
4586 for an <tag>olink</tag> element unless
\r
4588 <tag class="attribute">xrefstyle</tag>
\r
4589 attribute whose value specifies a page reference.
\r
4590 </para></listitem>
\r
4593 <para>Olinks that point to targets within the same document
\r
4594 are treated as <tag>xref</tag>s, and controlled by
\r
4595 the <parameter>insert.xref.page.number</parameter> parameter.
\r
4598 <para>Page number references for olinks to
\r
4599 external documents can only be inserted if the
\r
4600 information exists in the olink database.
\r
4601 This means each olink target element
\r
4602 (<tag>div</tag> or <tag>obj</tag>)
\r
4603 must have a <tag class="attribute">page</tag> attribute
\r
4604 whose value is its page number in the target document.
\r
4605 The XSL stylesheets are not able to extract that information
\r
4606 during processing because pages have not yet been created in
\r
4607 XSLT transformation. Only the XSL-FO processor knows what
\r
4608 page each element is placed on.
\r
4609 Therefore some postprocessing must take place to populate
\r
4610 page numbers in the olink database.
\r
4618 <refentry version="5.0" xml:id="insert.olink.pdf.frag">
\r
4620 <refentrytitle>insert.olink.pdf.frag</refentrytitle>
\r
4621 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
4624 <refname>insert.olink.pdf.frag</refname>
\r
4625 <refpurpose>Add fragment identifiers for links into PDF files</refpurpose>
\r
4629 <programlisting xml:id="insert.olink.pdf.frag.frag">
\r
4630 <xsl:param name="insert.olink.pdf.frag" select="0"></xsl:param>
\r
4634 <refsection><info><title>Description</title></info>
\r
4636 <para>The value of this parameter determines whether
\r
4637 the cross reference URIs to PDF documents made with
\r
4638 <tag>olink</tag> will
\r
4639 include fragment identifiers.
\r
4642 <para>When forming a URI to link to a PDF document,
\r
4643 a fragment identifier (typically a '#' followed by an
\r
4644 id value) appended to the PDF filename can be used by
\r
4645 the PDF viewer to open
\r
4646 the PDF file to a location within the document instead of
\r
4648 However, not all PDF files have id
\r
4649 values embedded in them, and not all PDF viewers can
\r
4650 handle fragment identifiers.
\r
4653 <para>If <parameter>insert.olink.pdf.frag</parameter> is set
\r
4654 to a non-zero value, then any olink targeting a
\r
4655 PDF file will have the fragment identifier appended to the URI.
\r
4656 The URI is formed by concatenating the value of the
\r
4657 <parameter>olink.base.uri</parameter> parameter, the
\r
4658 value of the <tag class="attribute">baseuri</tag>
\r
4659 attribute from the <tag class="element">document</tag>
\r
4660 element in the olink database with the matching
\r
4661 <tag class="attribute">targetdoc</tag> value,
\r
4662 and the value of the <tag class="attribute">href</tag>
\r
4663 attribute for the targeted element in the olink database.
\r
4664 The <tag class="attribute">href</tag> attribute
\r
4665 contains the fragment identifier.
\r
4668 <para>If <parameter>insert.olink.pdf.frag</parameter> is set
\r
4669 to zero (the default value), then
\r
4670 the <tag class="attribute">href</tag> attribute
\r
4671 from the olink database
\r
4672 is not appended to PDF olinks, so the fragment identifier is left off.
\r
4673 A PDF olink is any olink for which the
\r
4674 <tag class="attribute">baseuri</tag> attribute
\r
4675 from the matching <tag class="element">document</tag>
\r
4676 element in the olink database ends with '.pdf'.
\r
4677 Any other olinks will still have the fragment identifier added.
\r
4682 <refentry version="5.0" xml:id="prefer.internal.olink">
\r
4684 <refentrytitle>prefer.internal.olink</refentrytitle>
\r
4685 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
4688 <refname>prefer.internal.olink</refname>
\r
4689 <refpurpose>Prefer a local olink reference to an external reference</refpurpose>
\r
4693 <programlisting xml:id="prefer.internal.olink.frag">
\r
4694 <xsl:param name="prefer.internal.olink" select="0"></xsl:param>
\r
4698 <refsection><info><title>Description</title></info>
\r
4700 <para>If you are re-using XML content modules in multiple documents,
\r
4701 you may want to redirect some of your olinks. This parameter
\r
4702 permits you to redirect an olink to the current document.
\r
4705 <para>For example: you are writing documentation for a product,
\r
4706 which includes 3 manuals: a little installation
\r
4707 booklet (booklet.xml), a user
\r
4708 guide (user.xml), and a reference manual (reference.xml).
\r
4709 All 3 documents begin with the same introduction section (intro.xml) that
\r
4710 contains a reference to the customization section (custom.xml) which is
\r
4711 included in both user.xml and reference.xml documents.
\r
4714 <para>How do you write the link to custom.xml in intro.xml
\r
4715 so that it is interpreted correctly in all 3 documents?</para>
\r
4717 <listitem><para>If you use xref, it will fail in user.xml.</para>
\r
4719 <listitem><para>If you use olink (pointing to reference.xml),
\r
4720 the reference in user.xml
\r
4721 will point to the customization section of the reference manual, while it is
\r
4722 actually available in user.xml.</para>
\r
4726 <para>If you set the <parameter>prefer.internal.olink</parameter>
\r
4727 parameter to a non-zero value, then the processor will
\r
4728 first look in the olink database
\r
4729 for the olink's <tag>targetptr</tag> attribute value
\r
4730 in document matching the <parameter>current.docid</parameter>
\r
4731 parameter value. If it isn't found there, then
\r
4732 it tries the document in the database
\r
4733 with the <tag>targetdoc</tag>
\r
4734 value that matches the olink's <tag>targetdoc</tag>
\r
4738 <para>This feature permits an olink reference to resolve to
\r
4739 the current document if there is an element
\r
4740 with an id matching the olink's <tag>targetptr</tag>
\r
4741 value. The current document's olink data must be
\r
4742 included in the target database for this to work.</para>
\r
4745 <para>There is a potential for incorrect links if
\r
4746 the same <tag>id</tag> attribute value is used for different
\r
4747 content in different documents.
\r
4748 Some of your olinks may be redirected to the current document
\r
4749 when they shouldn't be. It is not possible to control
\r
4750 individual olink instances.</para>
\r
4756 <refentry version="5.0" xml:id="link.mailto.url">
\r
4758 <refentrytitle>link.mailto.url</refentrytitle>
\r
4759 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
\r
4762 <refname>link.mailto.url</refname>
\r
4763 <refpurpose>Mailto URL for the LINK REL=made HTML HEAD element</refpurpose>
\r
4767 <programlisting xml:id="link.mailto.url.frag">
\r
4768 <xsl:param name="link.mailto.url"></xsl:param>
\r
4772 <refsection><info><title>Description</title></info>
\r
4774 <para>If not the empty string, this address will be used for the
\r
4775 rel=made <literal>link</literal> element in the html <literal>head</literal>
\r
4781 <refentry version="5.0" xml:id="ulink.target">
\r
4783 <refentrytitle>ulink.target</refentrytitle>
\r
4784 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
\r
4787 <refname>ulink.target</refname>
\r
4788 <refpurpose>The HTML anchor target for ULinks</refpurpose>
\r
4792 <programlisting xml:id="ulink.target.frag">
\r
4793 <xsl:param name="ulink.target">_top</xsl:param>
\r
4797 <refsection><info><title>Description</title></info>
\r
4799 <para>If <parameter>ulink.target</parameter> is non-zero, its value will
\r
4800 be used for the <literal>target</literal> attribute
\r
4801 on anchors generated for <tag>ulink</tag>s.</para>
\r
4806 <refentry version="5.0" xml:id="olink.fragid">
\r
4808 <refentrytitle>olink.fragid</refentrytitle>
\r
4809 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
\r
4812 <refname>olink.fragid</refname>
\r
4813 <refpurpose>Names the fragment identifier portion of an OLink resolver query</refpurpose>
\r
4816 <programlisting xml:id="olink.fragid.frag">
\r
4817 <xsl:param name="olink.fragid">fragid=</xsl:param>
\r
4820 <refsection><info><title>Description</title></info>
\r
4821 <para>The fragment identifier portion of an <tag>olink</tag> target.</para>
\r
4825 <refentry version="5.0" xml:id="olink.outline.ext">
\r
4827 <refentrytitle>olink.outline.ext</refentrytitle>
\r
4828 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
\r
4831 <refname>olink.outline.ext</refname>
\r
4832 <refpurpose>The extension of OLink outline files</refpurpose>
\r
4836 <programlisting xml:id="olink.outline.ext.frag">
\r
4837 <xsl:param name="olink.outline.ext">.olink</xsl:param>
\r
4841 <refsection><info><title>Description</title></info>
\r
4843 <para>The extension to be expected for OLink outline files</para>
\r
4844 <para>Bob has this parameter as dead. Please don't use</para>
\r
4849 <refentry version="5.0" xml:id="olink.pubid">
\r
4851 <refentrytitle>olink.pubid</refentrytitle>
\r
4852 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
\r
4855 <refname>olink.pubid</refname>
\r
4856 <refpurpose>Names the public identifier portion of an OLink resolver query</refpurpose>
\r
4860 <programlisting xml:id="olink.pubid.frag">
\r
4861 <xsl:param name="olink.pubid">pubid</xsl:param>
\r
4865 <refsection><info><title>Description</title></info>
\r
4872 <refentry version="5.0" xml:id="olink.sysid">
\r
4874 <refentrytitle>olink.sysid</refentrytitle>
\r
4875 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
\r
4878 <refname>olink.sysid</refname>
\r
4879 <refpurpose>Names the system identifier portion of an OLink resolver query</refpurpose>
\r
4883 <programlisting xml:id="olink.sysid.frag">
\r
4884 <xsl:param name="olink.sysid">sysid</xsl:param>
\r
4888 <refsection><info><title>Description</title></info>
\r
4890 <para>FIXME</para>
\r
4895 <refentry version="5.0" xml:id="olink.resolver">
\r
4897 <refentrytitle>olink.resolver</refentrytitle>
\r
4898 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
\r
4901 <refname>olink.resolver</refname>
\r
4902 <refpurpose>The root name of the OLink resolver (usually a script)</refpurpose>
\r
4905 <programlisting xml:id="olink.resolver.frag">
\r
4906 <xsl:param name="olink.resolver">/cgi-bin/olink</xsl:param>
\r
4909 <refsection><info><title>Description</title></info>
\r
4910 <para>FIXME:</para>
\r
4915 <reference xml:id="xrefs"><title>Cross References</title>
\r
4916 <refentry version="5.0" xml:id="collect.xref.targets">
\r
4918 <refentrytitle>collect.xref.targets</refentrytitle>
\r
4919 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
\r
4920 <refmiscinfo class="other" otherclass="value">no</refmiscinfo>
\r
4921 <refmiscinfo class="other" otherclass="value">yes</refmiscinfo>
\r
4922 <refmiscinfo class="other" otherclass="value">only</refmiscinfo>
\r
4925 <refname>collect.xref.targets</refname>
\r
4926 <refpurpose>Controls whether cross reference data is
\r
4927 collected</refpurpose>
\r
4929 <refsynopsisdiv> <programlisting xml:id="collect.xref.targets.frag">
\r
4930 <xsl:param name="collect.xref.targets">no</xsl:param>
\r
4931 </programlisting>
\r
4932 </refsynopsisdiv>
\r
4933 <refsection><info><title>Description</title></info>
\r
4936 In order to resolve olinks efficiently, the stylesheets can
\r
4937 generate an external data file containing information about
\r
4938 all potential cross reference endpoints in a document.
\r
4939 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.
\r
4940 See also <parameter>targets.filename</parameter>.
\r
4945 <refentry version="5.0" xml:id="insert.xref.page.number">
\r
4947 <refentrytitle>insert.xref.page.number</refentrytitle>
\r
4948 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
\r
4949 <refmiscinfo class="other" otherclass="value">no</refmiscinfo>
\r
4950 <refmiscinfo class="other" otherclass="value">yes</refmiscinfo>
\r
4951 <refmiscinfo class="other" otherclass="value">maybe</refmiscinfo>
\r
4954 <refname>insert.xref.page.number</refname>
\r
4955 <refpurpose>Turns page numbers in xrefs on and off</refpurpose>
\r
4959 <programlisting xml:id="insert.xref.page.number.frag">
\r
4960 <xsl:param name="insert.xref.page.number">no</xsl:param>
\r
4964 <refsection><info><title>Description</title></info>
\r
4966 <para>The value of this parameter determines if
\r
4967 cross references (<tag>xref</tag>s) in
\r
4968 printed output will
\r
4969 include page number citations.
\r
4970 It has three possible values.
\r
4975 <listitem><para>No page number references will be generated.
\r
4976 </para></listitem>
\r
4980 <listitem><para>Page number references will be generated
\r
4981 for all <tag>xref</tag> elements.
\r
4982 The style of page reference may be changed
\r
4983 if an <tag class="attribute">xrefstyle</tag>
\r
4984 attribute is used.
\r
4985 </para></listitem>
\r
4988 <term>maybe</term>
\r
4989 <listitem><para>Page number references will not be generated
\r
4990 for an <tag>xref</tag> element unless
\r
4992 <tag class="attribute">xrefstyle</tag>
\r
4993 attribute whose value specifies a page reference.
\r
4994 </para></listitem>
\r
5001 <refentry version="5.0" xml:id="use.role.as.xrefstyle">
\r
5003 <refentrytitle>use.role.as.xrefstyle</refentrytitle>
\r
5004 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
5007 <refname>use.role.as.xrefstyle</refname>
\r
5008 <refpurpose>Use <tag class="attribute">role</tag> attribute for
\r
5009 <tag class="attribute">xrefstyle</tag> on <tag>xref</tag>?</refpurpose>
\r
5013 <programlisting xml:id="use.role.as.xrefstyle.frag">
\r
5014 <xsl:param name="use.role.as.xrefstyle" select="1"></xsl:param>
\r
5018 <refsection><info><title>Description</title></info>
\r
5020 <para>In DocBook documents that conform to a schema older than V4.3, this parameter allows
\r
5021 <tag class="attribute">role</tag> to serve the purpose of specifying the cross reference style.</para>
\r
5023 <para>If non-zero, the <tag class="attribute">role</tag> attribute on
\r
5024 <tag>xref</tag> will be used to select the cross reference style.
\r
5025 In DocBook V4.3, the <tag class="attribute">xrefstyle</tag> attribute was added for this purpose.
\r
5026 If the <tag class="attribute">xrefstyle</tag> attribute is present,
\r
5027 <tag class="attribute">role</tag> will be ignored, regardless of the setting
\r
5028 of this parameter.</para>
\r
5032 <refsection><info><title>Example</title></info>
\r
5034 <para>The following small stylesheet shows how to configure the
\r
5035 stylesheets to make use of the cross reference style:</para>
\r
5037 <programlisting><?xml version="1.0"?>
\r
5038 <xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
\r
5041 <xsl:import href="../xsl/html/docbook.xsl"/>
\r
5043 <xsl:output method="html"/>
\r
5045 <xsl:param name="local.l10n.xml" select="document('')"/>
\r
5046 <l:i18n xmlns:l="http://docbook.sourceforge.net/xmlns/l10n/1.0">
\r
5047 <l:l10n xmlns:l="http://docbook.sourceforge.net/xmlns/l10n/1.0" language="en">
\r
5048 <l:context name="xref">
\r
5049 <l:template name="chapter" style="title" text="Chapter %n, %t"/>
\r
5050 <l:template name="chapter" text="Chapter %n"/>
\r
5051 </l:context>
\r
5055 </xsl:stylesheet></programlisting>
\r
5057 <para>With this stylesheet, the cross references in the following document:</para>
\r
5059 <programlisting><?xml version="1.0" encoding="utf-8"?>
\r
5060 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
\r
5061 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
\r
5062 <book id="book"><title>Book</title>
\r
5065 <title>Preface</title>
\r
5067 <para>Normal: <xref linkend="ch1"/>.</para>
\r
5068 <para>Title: <xref xrefstyle="title" linkend="ch1"/>.</para>
\r
5072 <chapter id="ch1">
\r
5073 <title>First Chapter</title>
\r
5075 <para>Irrelevant.</para>
\r
5078 </book></programlisting>
\r
5080 <para>will appear as:</para>
\r
5083 <para>Normal: Chapter 1.</para>
\r
5084 <para>Title: Chapter 1, <emphasis>First Chapter</emphasis>.</para>
\r
5085 </informalexample>
\r
5090 <refentry version="5.0" xml:id="xref.with.number.and.title">
\r
5092 <refentrytitle>xref.with.number.and.title</refentrytitle>
\r
5093 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
5096 <refname>xref.with.number.and.title</refname>
\r
5097 <refpurpose>Use number and title in cross references</refpurpose>
\r
5101 <programlisting xml:id="xref.with.number.and.title.frag">
\r
5102 <xsl:param name="xref.with.number.and.title" select="1"></xsl:param>
\r
5106 <refsection><info><title>Description</title></info>
\r
5108 <para>A cross reference may include the number (for example, the number of
\r
5109 an example or figure) and the <tag>title</tag> which is a required child of some
\r
5110 targets. This parameter inserts both the relevant number as well as
\r
5111 the title into the link. </para>
\r
5116 <refentry version="5.0" xml:id="xref.label-page.separator">
\r
5118 <refentrytitle>xref.label-page.separator</refentrytitle>
\r
5119 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
\r
5122 <refname>xref.label-page.separator</refname>
\r
5123 <refpurpose>Punctuation or space separating label from page number in xref</refpurpose>
\r
5127 <programlisting xml:id="xref.label-page.separator.frag"><xsl:param name="xref.label-page.separator"><xsl:text> </xsl:text></xsl:param></programlisting>
\r
5130 <refsection><info><title>Description</title></info>
\r
5133 This parameter allows you to control the punctuation of certain
\r
5134 types of generated cross reference text.
\r
5135 When cross reference text is generated for an
\r
5136 <tag class="element">xref</tag> or
\r
5137 <tag class="element">olink</tag> element
\r
5138 using an <tag class="attribute">xrefstyle</tag> attribute
\r
5139 that makes use of the <literal>select:</literal> feature,
\r
5140 and the selected components include both label and page
\r
5142 then the value of this parameter is inserted between
\r
5143 label and page number in the output.
\r
5144 If a title is included, then other separators are used.
\r
5150 <refentry version="5.0" xml:id="xref.label-title.separator">
\r
5152 <refentrytitle>xref.label-title.separator</refentrytitle>
\r
5153 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
\r
5156 <refname>xref.label-title.separator</refname>
\r
5157 <refpurpose>Punctuation or space separating label from title in xref</refpurpose>
\r
5161 <programlisting xml:id="xref.label-title.separator.frag"><xsl:param name="xref.label-title.separator">: </xsl:param></programlisting>
\r
5164 <refsection><info><title>Description</title></info>
\r
5167 This parameter allows you to control the punctuation of certain
\r
5168 types of generated cross reference text.
\r
5169 When cross reference text is generated for an
\r
5170 <tag class="element">xref</tag> or
\r
5171 <tag class="element">olink</tag> element
\r
5172 using an <tag class="attribute">xrefstyle</tag> attribute
\r
5173 that makes use of the <literal>select:</literal> feature,
\r
5174 and the selected components include both label and title,
\r
5175 then the value of this parameter is inserted between
\r
5176 label and title in the output.
\r
5182 <refentry version="5.0" xml:id="xref.title-page.separator">
\r
5184 <refentrytitle>xref.title-page.separator</refentrytitle>
\r
5185 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
\r
5188 <refname>xref.title-page.separator</refname>
\r
5189 <refpurpose>Punctuation or space separating title from page number in xref</refpurpose>
\r
5193 <programlisting xml:id="xref.title-page.separator.frag"><xsl:param name="xref.title-page.separator"><xsl:text> </xsl:text></xsl:param></programlisting>
\r
5196 <refsection><info><title>Description</title></info>
\r
5199 This parameter allows you to control the punctuation of certain
\r
5200 types of generated cross reference text.
\r
5201 When cross reference text is generated for an
\r
5202 <tag class="element">xref</tag> or
\r
5203 <tag class="element">olink</tag> element
\r
5204 using an <tag class="attribute">xrefstyle</tag> attribute
\r
5205 that makes use of the <literal>select:</literal> feature,
\r
5206 and the selected components include both title and page number,
\r
5207 then the value of this parameter is inserted between
\r
5208 title and page number in the output.
\r
5215 <reference xml:id="lists"><title>Lists</title>
\r
5216 <refentry version="5.0" xml:id="segmentedlist.as.table">
\r
5218 <refentrytitle>segmentedlist.as.table</refentrytitle>
\r
5219 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
5222 <refname>segmentedlist.as.table</refname>
\r
5223 <refpurpose>Format segmented lists as tables?</refpurpose>
\r
5227 <programlisting xml:id="segmentedlist.as.table.frag">
\r
5228 <xsl:param name="segmentedlist.as.table" select="0"></xsl:param>
\r
5232 <refsection><info><title>Description</title></info>
\r
5234 <para>If non-zero, <tag>segmentedlist</tag>s will be formatted as
\r
5240 <refentry version="5.0" xml:id="variablelist.as.table">
\r
5242 <refentrytitle>variablelist.as.table</refentrytitle>
\r
5243 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
5246 <refname>variablelist.as.table</refname>
\r
5247 <refpurpose>Format <tag>variablelist</tag>s as tables?</refpurpose>
\r
5251 <programlisting xml:id="variablelist.as.table.frag">
\r
5252 <xsl:param name="variablelist.as.table" select="0"></xsl:param>
\r
5256 <refsection><info><title>Description</title></info>
\r
5258 <para>If non-zero, <tag>variablelist</tag>s will be formatted as
\r
5259 tables. A processing instruction exists to specify a particular width for the
\r
5260 column containing the <tag>term</tag>s:
\r
5261 <tag class="xmlpi">dbhtml term-width=".25in"</tag></para>
\r
5263 <para>You can override this setting with a processing instruction as the
\r
5264 child of <tag>variablelist</tag>: <tag class="xmlpi">dbhtml
\r
5265 list-presentation="table"</tag> or <tag class="xmlpi">dbhtml
\r
5266 list-presentation="list"</tag>.</para>
\r
5268 <para>This parameter only applies to the HTML transformations. In the
\r
5269 FO case, proper list markup is robust enough to handle the formatting.
\r
5270 But see also <parameter>variablelist.as.blocks</parameter>.</para>
\r
5272 <programlisting> <variablelist>
\r
5273 <?dbhtml list-presentation="table"?>
\r
5274 <?dbhtml term-width="1.5in"?>
\r
5275 <?dbfo list-presentation="list"?>
\r
5276 <?dbfo term-width="1in"?>
\r
5277 <varlistentry>
\r
5278 <term>list</term>
\r
5281 Formatted as a table even if variablelist.as.table is set to 0.
\r
5284 </varlistentry>
\r
5285 </variablelist></programlisting>
\r
5290 <refentry version="5.0" xml:id="variablelist.term.separator">
\r
5292 <refentrytitle>variablelist.term.separator</refentrytitle>
\r
5293 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
\r
5296 <refname>variablelist.term.separator</refname>
\r
5297 <refpurpose>Text to separate <tag>term</tag>s within a multi-term
\r
5298 <tag>varlistentry</tag></refpurpose>
\r
5302 <programlisting xml:id="variablelist.term.separator.frag">
\r
5303 <xsl:param name="variablelist.term.separator">, </xsl:param></programlisting>
\r
5306 <refsection><info><title>Description</title></info>
\r
5308 <para>When a <tag>varlistentry</tag> contains multiple <tag>term</tag>
\r
5309 elements, the string specified in the value of the
\r
5310 <parameter>variablelist.term.separator</parameter> parameter is placed
\r
5311 after each <tag>term</tag> except the last.</para>
\r
5314 <para>To generate a line break between multiple <tag>term</tag>s in
\r
5315 a <tag>varlistentry</tag>, set a non-zero value for the
\r
5316 <parameter>variablelist.term.break.after</parameter> parameter. If
\r
5317 you do so, you may also want to set the value of the
\r
5318 <parameter>variablelist.term.separator</parameter> parameter to an
\r
5319 empty string (to suppress rendering of the default comma and space
\r
5320 after each <tag>term</tag>).</para>
\r
5326 <refentry version="5.0" xml:id="variablelist.term.break.after">
\r
5328 <refentrytitle>variablelist.term.break.after</refentrytitle>
\r
5329 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
5332 <refname>variablelist.term.break.after</refname>
\r
5333 <refpurpose>Generate line break after each <tag>term</tag> within a
\r
5334 multi-term <tag>varlistentry</tag>?</refpurpose>
\r
5338 <programlisting xml:id="variablelist.term.break.after.frag">
\r
5339 <xsl:param name="variablelist.term.break.after">0</xsl:param></programlisting>
\r
5342 <refsection><info><title>Description</title></info>
\r
5344 <para>Set a non-zero value for the
\r
5345 <parameter>variablelist.term.break.after</parameter> parameter to
\r
5346 generate a line break between <tag>term</tag>s in a
\r
5347 multi-term <tag>varlistentry</tag>.</para>
\r
5350 <para>If you set a non-zero value for
\r
5351 <parameter>variablelist.term.break.after</parameter>, you may also
\r
5352 want to set the value of the
\r
5353 <parameter>variablelist.term.separator</parameter> parameter to an
\r
5354 empty string (to suppress rendering of the default comma and space
\r
5355 after each <tag>term</tag>).</para>
\r
5362 <reference xml:id="biblio"><title>Bibliography</title>
\r
5363 <refentry version="5.0" xml:id="bibliography.style">
\r
5365 <refentrytitle>bibliography.style</refentrytitle>
\r
5366 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
\r
5367 <refmiscinfo class="other" otherclass="value">normal</refmiscinfo>
\r
5368 <refmiscinfo class="other" otherclass="value">iso690</refmiscinfo>
\r
5371 <refname>bibliography.style</refname>
\r
5372 <refpurpose>Style used for formatting of biblioentries.</refpurpose>
\r
5376 <programlisting xml:id="bibliography.style.frag">
\r
5377 <xsl:param name="bibliography.style">normal</xsl:param>
\r
5381 <refsection><info><title>Description</title></info>
\r
5383 <para>Currently only <literal>normal</literal> and
\r
5384 <literal>iso690</literal> styles are supported.</para>
\r
5386 <para>In order to use ISO690 style to the full extent you might need
\r
5387 to use additional markup described on <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://wiki.docbook.org/topic/ISO690Bibliography">the
\r
5388 following WiKi page</link>.</para>
\r
5393 <refentry version="5.0" xml:id="biblioentry.item.separator">
\r
5395 <refentrytitle>biblioentry.item.separator</refentrytitle>
\r
5396 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
\r
5399 <refname>biblioentry.item.separator</refname>
\r
5400 <refpurpose>Text to separate bibliography entries</refpurpose>
\r
5404 <programlisting xml:id="biblioentry.item.separator.frag"><xsl:param name="biblioentry.item.separator">. </xsl:param></programlisting>
\r
5407 <refsection><info><title>Description</title></info>
\r
5409 <para>Text to separate bibliography entries
\r
5415 <refentry version="5.0" xml:id="bibliography.collection">
\r
5417 <refentrytitle>bibliography.collection</refentrytitle>
\r
5418 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
\r
5421 <refname>bibliography.collection</refname>
\r
5422 <refpurpose>Name of the bibliography collection file</refpurpose>
\r
5426 <programlisting xml:id="bibliography.collection.frag">
\r
5427 <xsl:param name="bibliography.collection">http://docbook.sourceforge.net/release/bibliography/bibliography.xml</xsl:param>
\r
5432 <refsection><info><title>Description</title></info>
\r
5434 <para>Maintaining bibliography entries across a set of documents is tedious, time
\r
5435 consuming, and error prone. It makes much more sense, usually, to store all of
\r
5436 the bibliography entries in a single place and simply <quote>extract</quote>
\r
5437 the ones you need in each document.</para>
\r
5439 <para>That's the purpose of the
\r
5440 <parameter>bibliography.collection</parameter> parameter. To setup a global
\r
5441 bibliography <quote>database</quote>, follow these steps:</para>
\r
5443 <para>First, create a stand-alone bibliography document that contains all of
\r
5444 the documents that you wish to reference. Make sure that each bibliography
\r
5445 entry (whether you use <tag>biblioentry</tag> or <tag>bibliomixed</tag>)
\r
5448 <para>My global bibliography, <filename>~/bibliography.xml</filename> begins
\r
5452 <programlisting><!DOCTYPE bibliography
\r
5453 PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
\r
5454 "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
\r
5455 <bibliography><title>References</title>
\r
5457 <bibliomixed id="xml-rec"><abbrev>XML 1.0</abbrev>Tim Bray,
\r
5458 Jean Paoli, C. M. Sperberg-McQueen, and Eve Maler, editors.
\r
5459 <citetitle><ulink url="http://www.w3.org/TR/REC-xml">Extensible Markup
\r
5460 Language (XML) 1.0 Second Edition</ulink></citetitle>.
\r
5461 World Wide Web Consortium, 2000.
\r
5462 </bibliomixed>
\r
5464 <bibliomixed id="xml-names"><abbrev>Namespaces</abbrev>Tim Bray,
\r
5466 and Andrew Layman, editors.
\r
5467 <citetitle><ulink url="http://www.w3.org/TR/REC-xml-names/">Namespaces in
\r
5468 XML</ulink></citetitle>.
\r
5469 World Wide Web Consortium, 1999.
\r
5470 </bibliomixed>
\r
5472 <!-- ... -->
\r
5473 </bibliography>
\r
5475 </informalexample>
\r
5477 <para>When you create a bibliography in your document, simply
\r
5478 provide <emphasis>empty</emphasis> <tag>bibliomixed</tag>
\r
5479 entries for each document that you wish to cite. Make sure that these
\r
5480 elements have the same ID as the corresponding <quote>real</quote>
\r
5481 entry in your global bibliography.</para>
\r
5483 <para>For example:</para>
\r
5486 <programlisting><bibliography><title>Bibliography</title>
\r
5488 <bibliomixed id="xml-rec"/>
\r
5489 <bibliomixed id="xml-names"/>
\r
5490 <bibliomixed id="DKnuth86">Donald E. Knuth. <citetitle>Computers and
\r
5491 Typesetting: Volume B, TeX: The Program</citetitle>. Addison-Wesley,
\r
5492 1986. ISBN 0-201-13437-3.
\r
5493 </bibliomixed>
\r
5494 <bibliomixed id="relaxng"/>
\r
5496 </bibliography></programlisting>
\r
5497 </informalexample>
\r
5499 <para>Note that it's perfectly acceptable to mix entries from your
\r
5500 global bibliography with <quote>normal</quote> entries. You can use
\r
5501 <tag>xref</tag> or other elements to cross-reference your
\r
5502 bibliography entries in exactly the same way you do now.</para>
\r
5504 <para>Finally, when you are ready to format your document, simply set the
\r
5505 <parameter>bibliography.collection</parameter> parameter (in either a
\r
5506 customization layer or directly through your processor's interface) to
\r
5507 point to your global bibliography.</para>
\r
5509 <para>The stylesheets will format the bibliography in your document as if
\r
5510 all of the entries referenced appeared there literally.</para>
\r
5515 <refentry version="5.0" xml:id="bibliography.numbered">
\r
5517 <refentrytitle>bibliography.numbered</refentrytitle>
\r
5518 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
5521 <refname>bibliography.numbered</refname>
\r
5522 <refpurpose>Should bibliography entries be numbered?</refpurpose>
\r
5526 <programlisting xml:id="bibliography.numbered.frag">
\r
5527 <xsl:param name="bibliography.numbered" select="0"></xsl:param>
\r
5531 <refsection><info><title>Description</title></info>
\r
5533 <para>If non-zero bibliography entries will be numbered</para>
\r
5539 <reference xml:id="glossary"><title>Glossary</title>
\r
5540 <refentry version="5.0" xml:id="glossterm.auto.link">
\r
5542 <refentrytitle>glossterm.auto.link</refentrytitle>
\r
5543 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
5546 <refname>glossterm.auto.link</refname>
\r
5547 <refpurpose>Generate links from glossterm to glossentry automatically?</refpurpose>
\r
5551 <programlisting xml:id="glossterm.auto.link.frag">
\r
5552 <xsl:param name="glossterm.auto.link" select="0"></xsl:param>
\r
5556 <refsection><info><title>Description</title></info>
\r
5558 <para>If non-zero, links from inline <tag>glossterm</tag>s to the corresponding
\r
5559 <tag>glossentry</tag> elements in a <tag>glossary</tag> or <tag>glosslist</tag>
\r
5560 will be automatically generated. This is useful when your glossterms are consistent
\r
5561 and you don't want to add links manually.</para>
\r
5563 <para>The automatic link generation feature is not used on <tag>glossterm</tag> elements
\r
5564 that have a <tag class="attribute">linkend</tag> attribute.</para>
\r
5569 <refentry version="5.0" xml:id="firstterm.only.link">
\r
5571 <refentrytitle>firstterm.only.link</refentrytitle>
\r
5572 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
5575 <refname>firstterm.only.link</refname>
\r
5576 <refpurpose>Does automatic glossterm linking only apply to firstterms?</refpurpose>
\r
5580 <programlisting xml:id="firstterm.only.link.frag">
\r
5581 <xsl:param name="firstterm.only.link" select="0"></xsl:param>
\r
5585 <refsection><info><title>Description</title></info>
\r
5587 <para>If non-zero, only <tag>firstterm</tag>s will be automatically linked
\r
5588 to the glossary. If glossary linking is not enabled, this parameter
\r
5589 has no effect.</para>
\r
5594 <refentry version="5.0" xml:id="glossary.collection">
\r
5596 <refentrytitle>glossary.collection</refentrytitle>
\r
5597 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
\r
5600 <refname>glossary.collection</refname>
\r
5601 <refpurpose>Name of the glossary collection file</refpurpose>
\r
5605 <programlisting xml:id="glossary.collection.frag">
\r
5606 <xsl:param name="glossary.collection"></xsl:param>
\r
5610 <refsection><info><title>Description</title></info>
\r
5612 <para>Glossaries maintained independently across a set of documents
\r
5613 are likely to become inconsistent unless considerable effort is
\r
5614 expended to keep them in sync. It makes much more sense, usually, to
\r
5615 store all of the glossary entries in a single place and simply
\r
5616 <quote>extract</quote> the ones you need in each document.</para>
\r
5618 <para>That's the purpose of the
\r
5619 <parameter>glossary.collection</parameter> parameter. To setup a global
\r
5620 glossary <quote>database</quote>, follow these steps:</para>
\r
5622 <refsection><info><title>Setting Up the Glossary Database</title></info>
\r
5624 <para>First, create a stand-alone glossary document that contains all of
\r
5625 the entries that you wish to reference. Make sure that each glossary
\r
5626 entry has an ID.</para>
\r
5628 <para>Here's an example glossary:</para>
\r
5632 <?xml version="1.0" encoding="utf-8"?>
\r
5633 <!DOCTYPE glossary
\r
5634 PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
\r
5635 "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
\r
5637 <glossaryinfo>
\r
5638 <editor><firstname>Eric</firstname><surname>Raymond</surname></editor>
\r
5639 <title>Jargon File 4.2.3 (abridged)</title>
\r
5640 <releaseinfo>Just some test data</releaseinfo>
\r
5641 </glossaryinfo>
\r
5643 <glossdiv><title>0</title>
\r
5645 <glossentry>
\r
5646 <glossterm>0</glossterm>
\r
5648 <para>Numeric zero, as opposed to the letter `O' (the 15th letter of
\r
5649 the English alphabet). In their unmodified forms they look a lot
\r
5650 alike, and various kluges invented to make them visually distinct have
\r
5651 compounded the confusion. If your zero is center-dotted and letter-O
\r
5652 is not, or if letter-O looks almost rectangular but zero looks more
\r
5653 like an American football stood on end (or the reverse), you're
\r
5654 probably looking at a modern character display (though the dotted zero
\r
5655 seems to have originated as an option on IBM 3270 controllers). If
\r
5656 your zero is slashed but letter-O is not, you're probably looking at
\r
5657 an old-style ASCII graphic set descended from the default typewheel on
\r
5658 the venerable ASR-33 Teletype (Scandinavians, for whom /O is a letter,
\r
5659 curse this arrangement). (Interestingly, the slashed zero long
\r
5660 predates computers; Florian Cajori's monumental "A History of
\r
5661 Mathematical Notations" notes that it was used in the twelfth and
\r
5662 thirteenth centuries.) If letter-O has a slash across it and the zero
\r
5663 does not, your display is tuned for a very old convention used at IBM
\r
5664 and a few other early mainframe makers (Scandinavians curse <emphasis>this</emphasis>
\r
5665 arrangement even more, because it means two of their letters collide).
\r
5666 Some Burroughs/Unisys equipment displays a zero with a <emphasis>reversed</emphasis>
\r
5667 slash. Old CDC computers rendered letter O as an unbroken oval and 0
\r
5668 as an oval broken at upper right and lower left. And yet another
\r
5669 convention common on early line printers left zero unornamented but
\r
5670 added a tail or hook to the letter-O so that it resembled an inverted
\r
5671 Q or cursive capital letter-O (this was endorsed by a draft ANSI
\r
5672 standard for how to draw ASCII characters, but the final standard
\r
5673 changed the distinguisher to a tick-mark in the upper-left corner).
\r
5674 Are we sufficiently confused yet?</para>
\r
5676 </glossentry>
\r
5678 <glossentry>
\r
5679 <glossterm>1TBS</glossterm>
\r
5681 <para role="accidence">
\r
5682 <phrase role="pronounce"></phrase>
\r
5683 <phrase role="partsofspeach">n</phrase>
\r
5685 <para>The "One True Brace Style"</para>
\r
5686 <glossseealso>indent style</glossseealso>
\r
5688 </glossentry>
\r
5690 <!-- ... -->
\r
5694 <!-- ... -->
\r
5696 </glossary></programlisting>
\r
5697 </informalexample>
\r
5701 <refsection><info><title>Marking Up Glossary Terms</title></info>
\r
5703 <para>That takes care of the glossary database, now you have to get the entries
\r
5704 into your document. Unlike bibliography entries, which can be empty, creating
\r
5705 <quote>placeholder</quote> glossary entries would be very tedious. So instead,
\r
5706 support for <parameter>glossary.collection</parameter> relies on implicit linking.</para>
\r
5708 <para>In your source document, simply use <tag>firstterm</tag> and
\r
5709 <tag>glossterm</tag> to identify the terms you wish to have included
\r
5710 in the glossary. The stylesheets assume that you will either set the
\r
5711 <tag class="attribute">baseform</tag> attribute correctly, or that the
\r
5712 content of the element exactly matches a term in your glossary.</para>
\r
5714 <para>If you're using a <parameter>glossary.collection</parameter>, don't
\r
5715 make explicit links on the terms in your document.</para>
\r
5717 <para>So, in your document, you might write things like this:</para>
\r
5720 <programlisting><para>This is dummy text, without any real meaning.
\r
5721 The point is simply to reference glossary terms like <glossterm>0</glossterm>
\r
5722 and the <firstterm baseform="1TBS">One True Brace Style (1TBS)</firstterm>.
\r
5723 The <glossterm>1TBS</glossterm>, as you can probably imagine, is a nearly
\r
5724 religious issue.</para></programlisting>
\r
5725 </informalexample>
\r
5727 <para>If you set the <parameter>firstterm.only.link</parameter> parameter,
\r
5728 only the terms marked with <tag>firstterm</tag> will be links.
\r
5729 Otherwise, all the terms will be linked.</para>
\r
5733 <refsection><info><title>Marking Up the Glossary</title></info>
\r
5735 <para>The glossary itself has to be identified for the stylesheets. For lack
\r
5736 of a better choice, the <tag class="attribute">role</tag> is used.
\r
5737 To identify the glossary as the target for automatic processing, set
\r
5738 the role to <quote><literal>auto</literal></quote>. The title of this
\r
5739 glossary (and any other information from the <tag>glossaryinfo</tag>
\r
5740 that's rendered by your stylesheet) will be displayed, but the entries will
\r
5741 come from the database.
\r
5744 <para>Unfortunately, the glossary can't be empty, so you must put in
\r
5745 at least one <tag>glossentry</tag>. The content of this entry
\r
5746 is irrelevant, it will not be rendered:</para>
\r
5749 <programlisting><glossary role="auto">
\r
5750 <glossentry>
\r
5751 <glossterm>Irrelevant</glossterm>
\r
5753 <para>If you can see this, the document was processed incorrectly. Use
\r
5754 the <parameter>glossary.collection</parameter> parameter.</para>
\r
5756 </glossentry>
\r
5757 </glossary></programlisting>
\r
5758 </informalexample>
\r
5760 <para>What about glossary divisions? If your glossary database has glossary
\r
5761 divisions <emphasis>and</emphasis> your automatic glossary contains at least
\r
5762 one <tag>glossdiv</tag>, the automic glossary will have divisions.
\r
5763 If the <tag>glossdiv</tag> is missing from either location, no divisions
\r
5764 will be rendered.</para>
\r
5766 <para>Glossary entries (and divisions, if appropriate) in the glossary will
\r
5767 occur in precisely the order they occur in your database.</para>
\r
5771 <refsection><info><title>Formatting the Document</title></info>
\r
5773 <para>Finally, when you are ready to format your document, simply set the
\r
5774 <parameter>glossary.collection</parameter> parameter (in either a
\r
5775 customization layer or directly through your processor's interface) to
\r
5776 point to your global glossary.</para>
\r
5778 <para>The stylesheets will format the glossary in your document as if
\r
5779 all of the entries implicilty referenced appeared there literally.</para>
\r
5782 <refsection><info><title>Limitations</title></info>
\r
5784 <para>Glossary cross-references <emphasis>within the glossary</emphasis> are
\r
5785 not supported. For example, this <emphasis>will not</emphasis> work:</para>
\r
5788 <programlisting><glossentry>
\r
5789 <glossterm>gloss-1</glossterm>
\r
5790 <glossdef><para>A description that references <glossterm>gloss-2</glossterm>.</para>
\r
5791 <glossseealso>gloss-2</glossseealso>
\r
5793 </glossentry></programlisting>
\r
5794 </informalexample>
\r
5796 <para>If you put glossary cross-references in your glossary that way,
\r
5797 you'll get the cryptic error: <computeroutput>Warning:
\r
5798 glossary.collection specified, but there are 0 automatic
\r
5799 glossaries</computeroutput>.</para>
\r
5801 <para>Instead, you must do two things:</para>
\r
5805 <para>Markup your glossary using <tag>glossseealso</tag>:</para>
\r
5808 <programlisting><glossentry>
\r
5809 <glossterm>gloss-1</glossterm>
\r
5810 <glossdef><para>A description that references <glossterm>gloss-2</glossterm>.</para>
\r
5811 <glossseealso>gloss-2</glossseealso>
\r
5813 </glossentry></programlisting>
\r
5814 </informalexample>
\r
5818 <para>Make sure there is at least one <tag>glossterm</tag> reference to
\r
5819 <glossterm>gloss-2</glossterm> <emphasis>in your document</emphasis>. The
\r
5820 easiest way to do that is probably within a <tag>remark</tag> in your
\r
5821 automatic glossary:</para>
\r
5824 <programlisting><glossary role="auto">
\r
5825 <remark>Make sure there's a reference to <glossterm>gloss-2</glossterm>.</remark>
\r
5826 <glossentry>
\r
5827 <glossterm>Irrelevant</glossterm>
\r
5829 <para>If you can see this, the document was processed incorrectly. Use
\r
5830 the <parameter>glossary.collection</parameter> parameter.</para>
\r
5832 </glossentry>
\r
5833 </glossary></programlisting>
\r
5834 </informalexample>
\r
5842 <refentry version="5.0" xml:id="glossary.sort">
\r
5844 <refentrytitle>glossary.sort</refentrytitle>
\r
5845 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
5848 <refname>glossary.sort</refname>
\r
5849 <refpurpose>Sort glossentry elements?</refpurpose>
\r
5853 <programlisting xml:id="glossary.sort.frag">
\r
5854 <xsl:param name="glossary.sort" select="0"></xsl:param>
\r
5858 <refsection><info><title>Description</title></info>
\r
5860 <para>If non-zero, then the glossentry elements within a
\r
5861 glossary, glossdiv, or glosslist are sorted on the glossterm, using
\r
5862 the current lang setting. If zero (the default), then
\r
5863 glossentry elements are not sorted and are presented
\r
5864 in document order.
\r
5870 <refentry version="5.0" xml:id="glossentry.show.acronym">
\r
5872 <refentrytitle>glossentry.show.acronym</refentrytitle>
\r
5873 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
\r
5874 <refmiscinfo class="other" otherclass="value">no</refmiscinfo>
\r
5875 <refmiscinfo class="other" otherclass="value">yes</refmiscinfo>
\r
5876 <refmiscinfo class="other" otherclass="value">primary</refmiscinfo>
\r
5879 <refname>glossentry.show.acronym</refname>
\r
5880 <refpurpose>Display <tag>glossentry</tag> acronyms?</refpurpose>
\r
5884 <programlisting xml:id="glossentry.show.acronym.frag">
\r
5885 <xsl:param name="glossentry.show.acronym">no</xsl:param>
\r
5889 <refsection><info><title>Description</title></info>
\r
5891 <para>A setting of <quote>yes</quote> means they should be displayed;
\r
5892 <quote>no</quote> means they shouldn't. If <quote>primary</quote> is used,
\r
5893 then they are shown as the primary text for the entry.</para>
\r
5896 <para>This setting controls both <tag>acronym</tag> and
\r
5897 <tag>abbrev</tag> elements in the <tag>glossentry</tag>.</para>
\r
5904 <reference xml:id="misc"><title>Miscellaneous</title>
\r
5905 <refentry version="5.0" xml:id="formal.procedures">
\r
5907 <refentrytitle>formal.procedures</refentrytitle>
\r
5908 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
5911 <refname>formal.procedures</refname>
\r
5912 <refpurpose>Selects formal or informal procedures</refpurpose>
\r
5916 <programlisting xml:id="formal.procedures.frag">
\r
5917 <xsl:param name="formal.procedures" select="1"></xsl:param>
\r
5921 <refsection><info><title>Description</title></info>
\r
5923 <para>Formal procedures are numbered and always have a title.
\r
5929 <refentry version="5.0" xml:id="formal.title.placement">
\r
5931 <refentrytitle>formal.title.placement</refentrytitle>
\r
5932 <refmiscinfo class="other" otherclass="datatype">table</refmiscinfo>
\r
5935 <refname>formal.title.placement</refname>
\r
5936 <refpurpose>Specifies where formal object titles should occur</refpurpose>
\r
5940 <programlisting xml:id="formal.title.placement.frag">
\r
5941 <xsl:param name="formal.title.placement">
\r
5948 </xsl:param>
\r
5952 <refsection><info><title>Description</title></info>
\r
5954 <para>Specifies where formal object titles should occur. For each formal object
\r
5955 type (<tag>figure</tag>,
\r
5956 <tag>example</tag>,
\r
5957 <tag>equation</tag>,
\r
5958 <tag>table</tag>, and <tag>procedure</tag>)
\r
5959 you can specify either the keyword
\r
5960 <quote><literal>before</literal></quote> or
\r
5961 <quote><literal>after</literal></quote>.</para>
\r
5966 <refentry version="5.0" xml:id="runinhead.default.title.end.punct">
\r
5968 <refentrytitle>runinhead.default.title.end.punct</refentrytitle>
\r
5969 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
\r
5972 <refname>runinhead.default.title.end.punct</refname>
\r
5973 <refpurpose>Default punctuation character on a run-in-head</refpurpose>
\r
5977 <programlisting xml:id="runinhead.default.title.end.punct.frag"><xsl:param name="runinhead.default.title.end.punct">.</xsl:param>
\r
5981 <refsection><info><title>Description</title></info>
\r
5983 <para>If non-zero, For a <tag>formalpara</tag>, use the specified
\r
5984 string as the separator between the title and following text. The period is the default value.</para>
\r
5989 <refentry version="5.0" xml:id="runinhead.title.end.punct">
\r
5991 <refentrytitle>runinhead.title.end.punct</refentrytitle>
\r
5992 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
\r
5995 <refname>runinhead.title.end.punct</refname>
\r
5996 <refpurpose>Characters that count as punctuation on a run-in-head</refpurpose>
\r
6000 <programlisting xml:id="runinhead.title.end.punct.frag">
\r
6001 <xsl:param name="runinhead.title.end.punct">.!?:</xsl:param>
\r
6005 <refsection><info><title>Description</title></info>
\r
6007 <para>Specify which characters are to be counted as punctuation. These
\r
6008 characters are checked for a match with the last character of the
\r
6009 title. If no match is found, the
\r
6010 <parameter>runinhead.default.title.end.punct</parameter> contents are
\r
6011 inserted. This is to avoid duplicated punctuation in the output.
\r
6017 <refentry version="5.0" xml:id="show.comments">
\r
6019 <refentrytitle>show.comments</refentrytitle>
\r
6020 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
6023 <refname>show.comments</refname>
\r
6024 <refpurpose>Display <tag>remark</tag> elements?</refpurpose>
\r
6028 <programlisting xml:id="show.comments.frag">
\r
6029 <xsl:param name="show.comments" select="1"></xsl:param>
\r
6033 <refsection><info><title>Description</title></info>
\r
6035 <para>If non-zero, comments will be displayed, otherwise they
\r
6036 are suppressed. Comments here refers to the <tag>remark</tag> element
\r
6037 (which was called <literal>comment</literal> prior to DocBook
\r
6038 4.0), not XML comments (<-- like this -->) which are
\r
6045 <refentry version="5.0" xml:id="show.revisionflag">
\r
6047 <refentrytitle>show.revisionflag</refentrytitle>
\r
6048 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
6051 <refname>show.revisionflag</refname>
\r
6052 <refpurpose>Enable decoration of elements that have a revisionflag</refpurpose>
\r
6056 <programlisting xml:id="show.revisionflag.frag">
\r
6057 <xsl:param name="show.revisionflag" select="0"></xsl:param>
\r
6061 <refsection><info><title>Description</title></info>
\r
6064 If <parameter>show.revisionflag</parameter> is turned on, then the stylesheets
\r
6065 may produce additional markup designed to allow a CSS stylesheet to
\r
6066 highlight elements that have specific revisionflag settings.</para>
\r
6068 <para>The markup inserted will be usually be either a <span> or
\r
6069 <div> with an appropriate <literal>class</literal>
\r
6070 attribute. (The value of the class attribute will be the same as the
\r
6071 value of the revisionflag attribute). In some contexts, for example
\r
6072 tables, where extra markup would be structurally illegal, the class
\r
6073 attribute will be added to the appropriate container element.</para>
\r
6075 <para>In general, the stylesheets only test for revisionflag in contexts
\r
6076 where an importing stylesheet would have to redefine whole templates.
\r
6077 Most of the revisionflag processing is expected to be done by another
\r
6078 stylesheet, for example <filename>changebars.xsl</filename>.</para>
\r
6083 <refentry version="5.0" xml:id="shade.verbatim">
\r
6085 <refentrytitle>shade.verbatim</refentrytitle>
\r
6086 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
6089 <refname>shade.verbatim</refname>
\r
6090 <refpurpose>Should verbatim environments be shaded?</refpurpose>
\r
6094 <programlisting xml:id="shade.verbatim.frag"><xsl:param name="shade.verbatim" select="0"></xsl:param></programlisting>
\r
6097 <refsection><info><title>Description</title></info>
\r
6099 <para>In the FO stylesheet, if this parameter is non-zero then the
\r
6100 <property>shade.verbatim.style</property> properties will be applied
\r
6101 to verbatim environments.</para>
\r
6103 <para>In the HTML stylesheet, this parameter is now deprecated. Use
\r
6104 CSS instead.</para>
\r
6109 <refentry version="5.0" xml:id="shade.verbatim.style">
\r
6111 <refentrytitle>shade.verbatim.style</refentrytitle>
\r
6112 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
\r
6115 <refname>shade.verbatim.style</refname>
\r
6116 <refpurpose>Properties that specify the style of shaded verbatim listings</refpurpose>
\r
6120 <programlisting xml:id="shade.verbatim.style.frag">
\r
6121 <xsl:attribute-set name="shade.verbatim.style">
\r
6122 <xsl:attribute name="border">0</xsl:attribute>
\r
6123 <xsl:attribute name="bgcolor">#E0E0E0</xsl:attribute>
\r
6124 </xsl:attribute-set>
\r
6129 <refsection><info><title>Description</title></info>
\r
6131 <para>Properties that specify the style of shaded verbatim listings. The
\r
6132 parameters specified (the border and background color) are added to
\r
6133 the styling of the xsl-fo output. A border might be specified as "thin
\r
6134 black solid" for example. See <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://www.w3.org/TR/2004/WD-xsl11-20041216/#border">xsl-fo</link></para>
\r
6139 <refentry version="5.0" xml:id="punct.honorific">
\r
6141 <refentrytitle>punct.honorific</refentrytitle>
\r
6142 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
\r
6145 <refname>punct.honorific</refname>
\r
6146 <refpurpose>Punctuation after an honorific in a personal name.</refpurpose>
\r
6150 <programlisting xml:id="punct.honorific.frag">
\r
6151 <xsl:param name="punct.honorific">.</xsl:param>
\r
6155 <refsection><info><title>Description</title></info>
\r
6157 <para>This parameter specifies the punctuation that should be added after an
\r
6158 honorific in a personal name.</para>
\r
6163 <refentry version="5.0" xml:id="tex.math.in.alt">
\r
6165 <refentrytitle>tex.math.in.alt</refentrytitle>
\r
6166 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
\r
6167 <refmiscinfo class="other" otherclass="value">plain</refmiscinfo>
\r
6168 <refmiscinfo class="other" otherclass="value">latex</refmiscinfo>
\r
6171 <refname>tex.math.in.alt</refname>
\r
6172 <refpurpose>TeX notation used for equations</refpurpose>
\r
6176 <programlisting xml:id="tex.math.in.alt.frag">
\r
6177 <xsl:param name="tex.math.in.alt"></xsl:param>
\r
6181 <refsection><info><title>Description</title></info>
\r
6183 <para>If you want type math directly in TeX notation in equations,
\r
6184 this parameter specifies notation used. Currently are supported two
\r
6185 values -- <literal>plain</literal> and <literal>latex</literal>. Empty
\r
6186 value means that you are not using TeX math at all.</para>
\r
6188 <para>Preferred way for including TeX alternative of math is inside of
\r
6189 <tag>textobject</tag> element. Eg.:</para>
\r
6191 <programlisting><inlineequation>
\r
6192 <inlinemediaobject>
\r
6193 <imageobject>
\r
6194 <imagedata fileref="eq1.gif"/>
\r
6195 </imageobject>
\r
6196 <textobject><phrase>E=mc squared</phrase></textobject>
\r
6197 <textobject role="tex"><phrase>E=mc^2</phrase></textobject>
\r
6198 </inlinemediaobject>
\r
6199 </inlineequation></programlisting>
\r
6201 <para>If you are using <tag>graphic</tag> element, you can
\r
6202 store TeX inside <tag>alt</tag> element:</para>
\r
6204 <programlisting><inlineequation>
\r
6205 <alt role="tex">a^2+b^2=c^2</alt>
\r
6206 <graphic fileref="a2b2c2.gif"/>
\r
6207 </inlineequation></programlisting>
\r
6209 <para>If you want use this feature, you should process your FO with
\r
6210 PassiveTeX, which only supports TeX math notation. When calling
\r
6211 stylsheet, don't forget to specify also
\r
6212 passivetex.extensions=1.</para>
\r
6214 <para>If you want equations in HTML, just process generated file
\r
6215 <filename>tex-math-equations.tex</filename> by TeX or LaTeX. Then run
\r
6216 dvi2bitmap program on result DVI file. You will get images for
\r
6217 equations in your document.</para>
\r
6220 <para>This feature is useful for print/PDF output only if you
\r
6221 use the obsolete and now unsupported PassiveTeX XSL-FO
\r
6227 <refsection><info><title>Related Parameters</title></info>
\r
6228 <para><parameter>tex.math.delims</parameter>,
\r
6229 <parameter>passivetex.extensions</parameter>,
\r
6230 <parameter>tex.math.file</parameter></para>
\r
6232 <refsection><info><title>More information</title></info>
\r
6233 <para>For how-to documentation on embedding TeX equations and
\r
6234 generating output from them, see
\r
6235 <link xmlns:xlink="http://www.w3.org/1999/xlink" role="tcg" xlink:href="TexMath.html">DBTeXMath</link>.</para>
\r
6239 <refentry version="5.0" xml:id="tex.math.file">
\r
6241 <refentrytitle>tex.math.file</refentrytitle>
\r
6242 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
\r
6245 <refname>tex.math.file</refname>
\r
6246 <refpurpose>Name of temporary file for generating images from equations</refpurpose>
\r
6250 <programlisting xml:id="tex.math.file.frag">
\r
6251 <xsl:param name="tex.math.file">tex-math-equations.tex</xsl:param>
\r
6255 <refsection><info><title>Description</title></info>
\r
6257 <para>Name of auxiliary file for TeX equations. This file can be
\r
6258 processed by dvi2bitmap to get bitmap versions of equations for HTML
\r
6262 <refsection><info><title>Related Parameters</title></info>
\r
6263 <para><parameter>tex.math.in.alt</parameter>,
\r
6264 <parameter>tex.math.delims</parameter>,
\r
6267 <refsection><info><title>More information</title></info>
\r
6268 <para>For how-to documentation on embedding TeX equations and
\r
6269 generating output from them, see
\r
6270 <link xmlns:xlink="http://www.w3.org/1999/xlink" role="tcg" xlink:href="TexMath.html">DBTeXMath</link>.</para>
\r
6274 <refentry version="5.0" xml:id="tex.math.delims">
\r
6276 <refentrytitle>tex.math.delims</refentrytitle>
\r
6277 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
6280 <refname>tex.math.delims</refname>
\r
6281 <refpurpose>Should equations output for processing by TeX be
\r
6282 surrounded by math mode delimiters?</refpurpose>
\r
6286 <programlisting xml:id="tex.math.delims.frag">
\r
6287 <xsl:param name="tex.math.delims" select="1"></xsl:param>
\r
6291 <refsection><info><title>Description</title></info>
\r
6293 <para>For compatibility with DSSSL based DBTeXMath from Allin Cottrell
\r
6294 you should set this parameter to 0.</para>
\r
6297 <refsection><info><title>Related Parameters</title></info>
\r
6298 <para><parameter>tex.math.in.alt</parameter>,
\r
6299 <parameter>passivetex.extensions</parameter></para>
\r
6302 <refsection><info><title>See Also</title></info>
\r
6303 <para>You can also use the <tag class="xmlpi">dbtex delims</tag> processing
\r
6304 instruction to control whether delimiters are output.</para>
\r
6306 <refsection><info><title>More information</title></info>
\r
6307 <para>For how-to documentation on embedding TeX equations and
\r
6308 generating output from them, see
\r
6309 <link xmlns:xlink="http://www.w3.org/1999/xlink" role="tcg" xlink:href="TexMath.html">DBTeXMath</link>.</para>
\r
6313 <refentry version="5.0" xml:id="pixels.per.inch">
\r
6315 <refentrytitle>pixels.per.inch</refentrytitle>
\r
6316 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
\r
6319 <refname>pixels.per.inch</refname>
\r
6320 <refpurpose>How many pixels are there per inch?</refpurpose>
\r
6324 <programlisting xml:id="pixels.per.inch.frag">
\r
6325 <xsl:param name="pixels.per.inch">90</xsl:param>
\r
6329 <refsection><info><title>Description</title></info>
\r
6331 <para>When lengths are converted to pixels, this value is used to
\r
6332 determine the size of a pixel. The default value is taken from the
\r
6333 <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://www.w3.org/TR/2004/WD-xsl11-20041216/">XSL
\r
6334 Recommendation</link>.
\r
6340 <refentry version="5.0" xml:id="points.per.em">
\r
6342 <refentrytitle>points.per.em</refentrytitle>
\r
6343 <refmiscinfo class="other" otherclass="datatype">number</refmiscinfo>
\r
6346 <refname>points.per.em</refname>
\r
6347 <refpurpose>Specify the nominal size of an em-space in points</refpurpose>
\r
6351 <programlisting xml:id="points.per.em.frag">
\r
6352 <xsl:param name="points.per.em">10</xsl:param>
\r
6356 <refsection><info><title>Description</title></info>
\r
6358 <para>The fixed value used for calculations based upon the size of a
\r
6359 character. The assumption made is that ten point font is in use. This
\r
6360 assumption may not be valid.</para>
\r
6365 <refentry version="5.0" xml:id="use.svg">
\r
6367 <refentrytitle>use.svg</refentrytitle>
\r
6368 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
6371 <refname>use.svg</refname>
\r
6372 <refpurpose>Allow SVG in the result tree?</refpurpose>
\r
6376 <programlisting xml:id="use.svg.frag">
\r
6377 <xsl:param name="use.svg" select="1"></xsl:param>
\r
6381 <refsection><info><title>Description</title></info>
\r
6383 <para>If non-zero, SVG will be considered an acceptable image format. SVG
\r
6384 is passed through to the result tree, so correct rendering of the resulting
\r
6385 diagram depends on the formatter (FO processor or web browser) that is used
\r
6386 to process the output from the stylesheet.</para>
\r
6391 <refentry version="5.0" xml:id="menuchoice.separator">
\r
6393 <refentrytitle>menuchoice.separator</refentrytitle>
\r
6394 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
\r
6397 <refname>menuchoice.separator</refname>
\r
6398 <refpurpose>Separator between items of a <tag>menuchoice</tag>
\r
6399 other than <tag>guimenuitem</tag> and
\r
6400 <tag>guisubmenu</tag></refpurpose>
\r
6404 <programlisting xml:id="menuchoice.separator.frag">
\r
6405 <xsl:param name="menuchoice.separator">+</xsl:param>
\r
6409 <refsection><info><title>Description</title></info>
\r
6411 <para>Separator used to connect items of a <tag>menuchoice</tag> other
\r
6412 than <tag>guimenuitem</tag> and <tag>guisubmenu</tag>. The latter
\r
6413 elements are linked with <parameter>menuchoice.menu.separator</parameter>.
\r
6419 <refentry version="5.0" xml:id="menuchoice.menu.separator">
\r
6421 <refentrytitle>menuchoice.menu.separator</refentrytitle>
\r
6422 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
\r
6425 <refname>menuchoice.menu.separator</refname>
\r
6426 <refpurpose>Separator between items of a <tag>menuchoice</tag>
\r
6427 with <tag>guimenuitem</tag> or
\r
6428 <tag>guisubmenu</tag></refpurpose>
\r
6432 <programlisting xml:id="menuchoice.menu.separator.frag">
\r
6433 <xsl:param name="menuchoice.menu.separator"> → </xsl:param>
\r
6437 <refsection><info><title>Description</title></info>
\r
6439 <para>Separator used to connect items of a <tag>menuchoice</tag> with
\r
6440 <tag>guimenuitem</tag> or <tag>guisubmenu</tag>. Other elements
\r
6441 are linked with <parameter>menuchoice.separator</parameter>.
\r
6443 <para>The default value is &#x2192;, which is the
\r
6444 &rarr; (right arrow) character entity.
\r
6445 The current FOP (0.20.5) requires setting the font-family
\r
6448 <para>The default value also includes spaces around the arrow,
\r
6449 which will allow a line to break. Replace the spaces with
\r
6450 &#xA0; (nonbreaking space) if you don't want those
\r
6457 <refentry version="5.0" xml:id="default.float.class">
\r
6459 <refentrytitle>default.float.class</refentrytitle>
\r
6460 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
\r
6463 <refname>default.float.class</refname>
\r
6464 <refpurpose>Specifies the default float class</refpurpose>
\r
6468 <programlisting xml:id="default.float.class.frag">
\r
6469 <xsl:param name="default.float.class">
\r
6470 <xsl:choose>
\r
6471 <xsl:when test="contains($stylesheet.result.type,'html')">left</xsl:when>
\r
6472 <xsl:otherwise>before</xsl:otherwise>
\r
6473 </xsl:choose>
\r
6474 </xsl:param>
\r
6478 <refsection><info><title>Description</title></info>
\r
6480 <para>Selects the direction in which a float should be placed. for
\r
6481 xsl-fo this is before, for html it is left. For Western texts, the
\r
6482 before direction is the top of the page.</para>
\r
6487 <refentry version="5.0" xml:id="footnote.number.format">
\r
6489 <refentrytitle>footnote.number.format</refentrytitle>
\r
6490 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
\r
6491 <refmiscinfo class="other" otherclass="value">1<alt>1,2,3...</alt></refmiscinfo>
\r
6492 <refmiscinfo class="other" otherclass="value">A<alt>A,B,C...</alt></refmiscinfo>
\r
6493 <refmiscinfo class="other" otherclass="value">a<alt>a,b,c...</alt></refmiscinfo>
\r
6494 <refmiscinfo class="other" otherclass="value">i<alt>i,ii,iii...</alt></refmiscinfo>
\r
6495 <refmiscinfo class="other" otherclass="value">I<alt>I,II,III...</alt></refmiscinfo>
\r
6498 <refname>footnote.number.format</refname>
\r
6499 <refpurpose>Identifies the format used for footnote numbers</refpurpose>
\r
6503 <programlisting xml:id="footnote.number.format.frag">
\r
6504 <xsl:param name="footnote.number.format">1</xsl:param>
\r
6508 <refsection><info><title>Description</title></info>
\r
6510 <para>The <parameter>footnote.number.format</parameter> specifies the format
\r
6511 to use for footnote numeration (1, i, I, a, or A).</para>
\r
6516 <refentry version="5.0" xml:id="table.footnote.number.format">
\r
6518 <refentrytitle>table.footnote.number.format</refentrytitle>
\r
6519 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
\r
6520 <refmiscinfo class="other" otherclass="value">1<alt>1,2,3...</alt></refmiscinfo>
\r
6521 <refmiscinfo class="other" otherclass="value">A<alt>A,B,C...</alt></refmiscinfo>
\r
6522 <refmiscinfo class="other" otherclass="value">a<alt>a,b,c...</alt></refmiscinfo>
\r
6523 <refmiscinfo class="other" otherclass="value">i<alt>i,ii,iii...</alt></refmiscinfo>
\r
6524 <refmiscinfo class="other" otherclass="value">I<alt>I,II,III...</alt></refmiscinfo>
\r
6527 <refname>table.footnote.number.format</refname>
\r
6528 <refpurpose>Identifies the format used for footnote numbers in tables</refpurpose>
\r
6532 <programlisting xml:id="table.footnote.number.format.frag">
\r
6533 <xsl:param name="table.footnote.number.format">a</xsl:param>
\r
6537 <refsection><info><title>Description</title></info>
\r
6539 <para>The <parameter>table.footnote.number.format</parameter> specifies the format
\r
6540 to use for footnote numeration (1, i, I, a, or A) in tables.</para>
\r
6545 <refentry version="5.0" xml:id="footnote.number.symbols">
\r
6547 <refentrytitle>footnote.number.symbols</refentrytitle>
\r
6548 <refmiscinfo class="other" otherclass="datatype"/>
\r
6551 <refname>footnote.number.symbols</refname>
\r
6552 <refpurpose>Special characters to use as footnote markers</refpurpose>
\r
6556 <programlisting xml:id="footnote.number.symbols.frag">
\r
6557 <xsl:param name="footnote.number.symbols"></xsl:param>
\r
6561 <refsection><info><title>Description</title></info>
\r
6563 <para>If <parameter>footnote.number.symbols</parameter> is not the empty string,
\r
6564 footnotes will use the characters it contains as footnote symbols. For example,
\r
6565 <quote>*&#x2020;&#x2021;&#x25CA;&#x2720;</quote> will identify
\r
6566 footnotes with <quote>*</quote>, <quote>†</quote>, <quote>‡</quote>,
\r
6567 <quote>◊</quote>, and <quote>✠</quote>. If there are more footnotes
\r
6568 than symbols, the stylesheets will fall back to numbered footnotes using
\r
6569 <parameter>footnote.number.format</parameter>.</para>
\r
6571 <para>The use of symbols for footnotes depends on the ability of your
\r
6572 processor (or browser) to render the symbols you select. Not all systems are
\r
6573 capable of displaying the full range of Unicode characters. If the quoted characters
\r
6574 in the preceding paragraph are not displayed properly, that's a good indicator
\r
6575 that you may have trouble using those symbols for footnotes.</para>
\r
6580 <refentry version="5.0" xml:id="table.footnote.number.symbols">
\r
6582 <refentrytitle>table.footnote.number.symbols</refentrytitle>
\r
6583 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
\r
6586 <refname>table.footnote.number.symbols</refname>
\r
6587 <refpurpose>Special characters to use a footnote markers in tables</refpurpose>
\r
6591 <programlisting xml:id="table.footnote.number.symbols.frag">
\r
6592 <xsl:param name="table.footnote.number.symbols"></xsl:param>
\r
6596 <refsection><info><title>Description</title></info>
\r
6598 <para>If <parameter>table.footnote.number.symbols</parameter> is not the empty string,
\r
6599 table footnotes will use the characters it contains as footnote symbols. For example,
\r
6600 <quote>*&#x2020;&#x2021;&#x25CA;&#x2720;</quote> will identify
\r
6601 footnotes with <quote>*</quote>, <quote>†</quote>, <quote>‡</quote>,
\r
6602 <quote>◊</quote>, and <quote>✠</quote>. If there are more footnotes
\r
6603 than symbols, the stylesheets will fall back to numbered footnotes using
\r
6604 <parameter>table.footnote.number.format</parameter>.</para>
\r
6606 <para>The use of symbols for footnotes depends on the ability of your
\r
6607 processor (or browser) to render the symbols you select. Not all systems are
\r
6608 capable of displaying the full range of Unicode characters. If the quoted characters
\r
6609 in the preceding paragraph are not displayed properly, that's a good indicator
\r
6610 that you may have trouble using those symbols for footnotes.</para>
\r
6615 <refentry version="5.0" xml:id="highlight.source">
\r
6617 <refentrytitle>highlight.source</refentrytitle>
\r
6618 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
6621 <refname>highlight.source</refname>
\r
6622 <refpurpose>Should the content of <tag>programlisting</tag>
\r
6623 be syntactically highlighted?</refpurpose>
\r
6627 <programlisting xml:id="highlight.source.frag">
\r
6628 <xsl:param name="highlight.source" select="0"></xsl:param>
\r
6632 <refsection><info><title>Description</title></info>
\r
6634 <para>When this parameter is non-zero, the stylesheets will try to do syntax highlighting of the
\r
6635 content of <tag>programlisting</tag> elements. You specify the language for each programlisting
\r
6636 by using the <tag class="attribute">language</tag> attribute. The <parameter>highlight.default.language</parameter>
\r
6637 parameter can be used to specify the language for programlistings without a <tag class="attribute">language</tag>
\r
6638 attribute. Syntax highlighting also works for <tag>screen</tag> and <tag>synopsis</tag> elements.</para>
\r
6640 <para>The actual highlighting work is done by the XSLTHL extension module. This is an external Java library that has to be
\r
6641 downloaded separately (see below).</para>
\r
6644 <para>In order to use this extension, you must</para>
\r
6646 <listitem><para>add <filename>xslthl-2.x.x.jar</filename> to your Java classpath. The latest version is available
\r
6647 from <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://sourceforge.net/projects/xslthl">the XSLT syntax highlighting project</link>
\r
6648 at SourceForge.</para>
\r
6651 <para>use a customization layer in which you import one of the following stylesheet modules:
\r
6654 <para><filename>html/highlight.xsl</filename>
\r
6658 <para><filename>xhtml/highlight.xsl</filename>
\r
6662 <para><filename>xhtml-1_1/highlight.xsl</filename>
\r
6666 <para><filename>fo/highlight.xsl</filename>
\r
6672 <listitem><para>let either the <literal>xslthl.config</literal> Java system property or the
\r
6673 <parameter>highlight.xslthl.config</parameter> parameter point to the configuration file for syntax
\r
6674 highlighting (using URL syntax). DocBook XSL comes with a ready-to-use configuration file,
\r
6675 <filename>highlighting/xslthl-config.xml</filename>.</para>
\r
6679 <para>The extension works with Saxon 6.5.x and Xalan-J. (Saxon 8.5 or later is also supported, but since it is
\r
6680 an XSLT 2.0 processor it is not guaranteed to work with DocBook XSL in all circumstances.)</para>
\r
6682 <para>The following is an example of a Saxon 6 command adapted for syntax highlighting, to be used on Windows:</para>
\r
6685 <para><command>java -cp c:/Java/saxon.jar;c:/Java/xslthl-2.0.1.jar
\r
6686 -Dxslthl.config=file:///c:/docbook-xsl/highlighting/xslthl-config.xml com.icl.saxon.StyleSheet
\r
6687 -o test.html test.xml myhtml.xsl</command></para>
\r
6688 </informalexample>
\r
6693 <refentry version="5.0" xml:id="highlight.xslthl.config">
\r
6695 <refentrytitle>highlight.xslthl.config</refentrytitle>
\r
6696 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
\r
6699 <refname>highlight.xslthl.config</refname>
\r
6700 <refpurpose>Location of XSLTHL configuration file</refpurpose>
\r
6704 <programlisting xml:id="highlight.xslthl.config.frag">
\r
6705 <xsl:param name="highlight.xslthl.config"></xsl:param>
\r
6709 <refsection><info><title>Description</title></info>
\r
6711 <para>This location has precedence over the corresponding Java property.</para>
\r
6716 <refentry version="5.0" xml:id="highlight.default.language">
\r
6718 <refentrytitle>highlight.default.language</refentrytitle>
\r
6719 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
\r
6722 <refname>highlight.default.language</refname>
\r
6723 <refpurpose>Default language of programlisting</refpurpose>
\r
6727 <programlisting xml:id="highlight.default.language.frag">
\r
6728 <xsl:param name="highlight.default.language"></xsl:param>
\r
6732 <refsection><info><title>Description</title></info>
\r
6734 <para>This language is used when there is no language attribute on programlisting.</para>
\r
6739 <refentry version="5.0" xml:id="email.delimiters.enabled">
\r
6741 <refentrytitle>email.delimiters.enabled</refentrytitle>
\r
6742 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
6745 <refname>email.delimiters.enabled</refname>
\r
6746 <refpurpose>Generate delimiters around email addresses?</refpurpose>
\r
6750 <programlisting xml:id="email.delimiters.enabled.frag">
\r
6751 <xsl:param name="email.delimiters.enabled" select="1"></xsl:param>
\r
6755 <refsection><info><title>Description</title></info>
\r
6757 <para>If non-zero, delimiters
\r
6759 <footnote><para>For delimiters, the
\r
6760 stylesheets are currently hard-coded to output angle
\r
6761 brackets.</para></footnote>
\r
6763 are generated around e-mail addresses
\r
6764 (the output of the <tag>email</tag> element).</para>
\r
6769 <refentry version="5.0" xml:id="exsl.node.set.available">
\r
6771 <refentrytitle>exsl.node.set.available</refentrytitle>
\r
6772 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
6775 <refname>exsl.node.set.available</refname>
\r
6776 <refpurpose>Is the test function-available('exsl:node-set') true?</refpurpose>
\r
6780 <programlisting xml:id="exsl.node.set.available.frag"><xsl:param name="exsl.node.set.available">
\r
6781 <xsl:choose>
\r
6782 <xsl:when exsl:foo="" test="function-available('exsl:node-set') or contains(system-property('xsl:vendor'), 'Apache Software Foundation')">1</xsl:when>
\r
6783 <xsl:otherwise>0</xsl:otherwise>
\r
6784 </xsl:choose>
\r
6785 </xsl:param>
\r
6789 <refsection><info><title>Description</title></info>
\r
6791 <para>If non-zero,
\r
6792 then the exsl:node-set() function is available to be used in
\r
6794 If zero, then the function is not available.
\r
6795 This param automatically detects the presence of
\r
6796 the function and does not normally need to be set manually.</para>
\r
6798 <para>This param was created to handle a long-standing
\r
6799 bug in the Xalan processor that fails to detect the
\r
6800 function even though it is available.</para>
\r
6806 <reference xml:id="annos"><title>Annotations</title>
\r
6807 <refentry version="5.0" xml:id="annotation.support">
\r
6809 <refentrytitle>annotation.support</refentrytitle>
\r
6810 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
6813 <refname>annotation.support</refname>
\r
6814 <refpurpose>Enable annotations?</refpurpose>
\r
6818 <programlisting xml:id="annotation.support.frag">
\r
6819 <xsl:param name="annotation.support" select="0"></xsl:param>
\r
6823 <refsection><info><title>Description</title></info>
\r
6825 <para>If non-zero, the stylesheets will attempt to support annotation
\r
6826 elements in HTML by including some JavaScript (see
\r
6827 <parameter>annotation.js</parameter>).</para>
\r
6832 <refentry version="5.0" xml:id="annotation.js">
\r
6834 <refentrytitle>annotation.js</refentrytitle>
\r
6835 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
\r
6838 <refname>annotation.js</refname>
\r
6839 <refpurpose>URIs identifying JavaScript files with support for annotation popups</refpurpose>
\r
6843 <programlisting xml:id="annotation.js.frag">
\r
6845 <xsl:param name="annotation.js">
\r
6846 <xsl:text>http://docbook.sourceforge.net/release/script/AnchorPosition.js http://docbook.sourceforge.net/release/script/PopupWindow.js</xsl:text></xsl:param>
\r
6851 <refsection><info><title>Description</title></info>
\r
6853 <para>If <property>annotation.support</property> is enabled and the
\r
6854 document contains <tag>annotation</tag>s, then the URIs listed
\r
6855 in this parameter will be included. These JavaScript files are required
\r
6856 for popup annotation support.</para>
\r
6861 <refentry version="5.0" xml:id="annotation.css">
\r
6863 <refentrytitle>annotation.css</refentrytitle>
\r
6864 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
\r
6867 <refname>annotation.css</refname>
\r
6868 <refpurpose>CSS rules for annotations</refpurpose>
\r
6872 <programlisting xml:id="annotation.css.frag">
\r
6873 <xsl:param name="annotation.css">
\r
6874 /* ======================================================================
\r
6878 div.annotation-list { visibility: hidden;
\r
6881 div.annotation-nocss { position: absolute;
\r
6882 visibility: hidden;
\r
6885 div.annotation-popup { position: absolute;
\r
6887 visibility: hidden;
\r
6890 border-style: solid;
\r
6891 border-width: 1px;
\r
6893 background-color: white;
\r
6896 div.annotation-title { padding: 1px;
\r
6897 font-weight: bold;
\r
6898 border-bottom-style: solid;
\r
6899 border-bottom-width: 1px;
\r
6901 background-color: black;
\r
6904 div.annotation-body { padding: 2px;
\r
6907 div.annotation-body p { margin-top: 0px;
\r
6911 div.annotation-close { position: absolute;
\r
6915 </xsl:param>
\r
6919 <refsection><info><title>Description</title></info>
\r
6921 <para>If <parameter>annotation.support</parameter> is enabled and the
\r
6922 document contains <tag>annotation</tag>s, then the CSS in this
\r
6923 parameter will be included in the document.</para>
\r
6928 <refentry version="5.0" xml:id="annotation.graphic.open">
\r
6930 <refentrytitle>annotation.graphic.open</refentrytitle>
\r
6931 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
\r
6934 <refname>annotation.graphic.open</refname>
\r
6935 <refpurpose>Image for identifying a link that opens an annotation popup</refpurpose>
\r
6939 <programlisting xml:id="annotation.graphic.open.frag">
\r
6940 <xsl:param name="annotation.graphic.open">http://docbook.sourceforge.net/release/images/annot-open.png</xsl:param>
\r
6944 <refsection><info><title>Description</title></info>
\r
6946 <para>This image is used inline to identify the location of
\r
6947 annotations. It may be replaced by a user provided graphic. The size should be approximately 10x10 pixels.</para>
\r
6952 <refentry version="5.0" xml:id="annotation.graphic.close">
\r
6954 <refentrytitle>annotation.graphic.close</refentrytitle>
\r
6955 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
\r
6958 <refname>annotation.graphic.close</refname>
\r
6959 <refpurpose>Image for identifying a link that closes an annotation popup</refpurpose>
\r
6963 <programlisting xml:id="annotation.graphic.close.frag">
\r
6964 <xsl:param name="annotation.graphic.close">
\r
6965 http://docbook.sourceforge.net/release/images/annot-close.png</xsl:param>
\r
6969 <refsection><info><title>Description</title></info>
\r
6971 <para>This image is used on popup annotations as the “x” that the
\r
6972 user can click to dismiss the popup.</para>
\r
6973 <para>This image is used on popup annotations as the “x” that the user can
\r
6974 click to dismiss the popup. It may be replaced by a user provided graphic. The size should be approximately 10x10 pixels.</para>
\r
6980 <reference xml:id="graphics"><title>Graphics</title>
\r
6981 <refentry version="5.0" xml:id="img.src.path">
\r
6983 <refentrytitle>img.src.path</refentrytitle>
\r
6984 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
\r
6987 <refname>img.src.path</refname>
\r
6988 <refpurpose>Path to HTML/FO image files</refpurpose>
\r
6992 <programlisting xml:id="img.src.path.frag"><xsl:param name="img.src.path"></xsl:param></programlisting>
\r
6995 <refsection><info><title>Description</title></info>
\r
6997 <para>Add a path prefix to the value of the <tag class="attribute">fileref</tag>
\r
6998 attribute of <tag>graphic</tag>, <tag>inlinegraphic</tag>, and <tag>imagedata</tag> elements. The resulting
\r
6999 compound path is used in the output as the value of the <tag class="attribute">src</tag>
\r
7000 attribute of <tag class="element">img</tag> (HTML) or <tag class="element">external-graphic</tag> (FO).
\r
7004 The path given by <literal>img.src.path</literal> could be relative to the directory where the HTML/FO
\r
7005 files are created, or it could be an absolute URI.
\r
7006 The default value is empty.
\r
7007 Be sure to include a trailing slash if needed.
\r
7010 <para>This prefix is not applied to any filerefs that start
\r
7011 with "/" or contain "//:".
\r
7017 <refentry version="5.0" xml:id="keep.relative.image.uris">
\r
7019 <refentrytitle>keep.relative.image.uris</refentrytitle>
\r
7020 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
7023 <refname>keep.relative.image.uris</refname>
\r
7024 <refpurpose>Should image URIs be resolved against xml:base?</refpurpose>
\r
7028 <programlisting xml:id="keep.relative.image.uris.frag">
\r
7029 <xsl:param name="keep.relative.image.uris" select="1"></xsl:param>
\r
7034 <refsection><info><title>Description</title></info>
\r
7036 <para>If non-zero, relative URIs (in, for example
\r
7037 <literal>fileref</literal> attributes) will be used in the generated
\r
7038 output. Otherwise, the URIs will be made absolute with respect to the
\r
7041 <para>Note that the stylesheets calculate (and use) the absolute form
\r
7042 for some purposes, this only applies to the resulting output.</para>
\r
7047 <refentry version="5.0" xml:id="graphic.default.extension">
\r
7049 <refentrytitle>graphic.default.extension</refentrytitle>
\r
7050 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
\r
7053 <refname>graphic.default.extension</refname>
\r
7054 <refpurpose>Default extension for graphic filenames</refpurpose>
\r
7058 <programlisting xml:id="graphic.default.extension.frag"><xsl:param name="graphic.default.extension"></xsl:param></programlisting>
\r
7061 <refsection><info><title>Description</title></info>
\r
7063 <para>If a <tag>graphic</tag> or <tag>mediaobject</tag>
\r
7064 includes a reference to a filename that does not include an extension,
\r
7065 and the <tag class="attribute">format</tag> attribute is
\r
7066 <emphasis>unspecified</emphasis>, the default extension will be used.
\r
7072 <refentry version="5.0" xml:id="default.image.width">
\r
7074 <refentrytitle>default.image.width</refentrytitle>
\r
7075 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
\r
7078 <refname>default.image.width</refname>
\r
7079 <refpurpose>The default width of images</refpurpose>
\r
7083 <programlisting xml:id="default.image.width.frag">
\r
7084 <xsl:param name="default.image.width"></xsl:param>
\r
7088 <refsection><info><title>Description</title></info>
\r
7090 <para>If specified, this value will be used for the
\r
7091 <tag class="attribute">width</tag> attribute on
\r
7092 images that do not specify any
\r
7093 <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://docbook.org/tdg/en/html/imagedata.html#viewport.area">viewport
\r
7094 dimensions</link>.</para>
\r
7099 <refentry version="5.0" xml:id="nominal.image.width">
\r
7101 <refentrytitle>nominal.image.width</refentrytitle>
\r
7102 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
\r
7105 <refname>nominal.image.width</refname>
\r
7106 <refpurpose>The nominal image width</refpurpose>
\r
7110 <programlisting xml:id="nominal.image.width.frag">
\r
7111 <xsl:param name="nominal.image.width" select="6 * $pixels.per.inch"></xsl:param>
\r
7115 <refsection><info><title>Description</title></info>
\r
7117 <para>Graphic widths expressed as a percentage are problematic. In the
\r
7118 following discussion, we speak of width and contentwidth, but
\r
7119 the same issues apply to depth and contentdepth.</para>
\r
7121 <para>A width of 50% means "half of the available space for the image."
\r
7122 That's fine. But note that in HTML, this is a dynamic property and
\r
7123 the image size will vary if the browser window is resized.</para>
\r
7125 <para>A contentwidth of 50% means "half of the actual image width".
\r
7126 But what does that mean if the stylesheets cannot assess the image's
\r
7127 actual size? Treating this as a width of 50% is one possibility, but
\r
7128 it produces behavior (dynamic scaling) that seems entirely out of
\r
7129 character with the meaning.</para>
\r
7131 <para>Instead, the stylesheets define a
\r
7132 <parameter>nominal.image.width</parameter> and convert percentages to
\r
7133 actual values based on that nominal size.</para>
\r
7138 <refentry version="5.0" xml:id="nominal.image.depth">
\r
7140 <refentrytitle>nominal.image.depth</refentrytitle>
\r
7141 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
\r
7144 <refname>nominal.image.depth</refname>
\r
7145 <refpurpose>Nominal image depth</refpurpose>
\r
7149 <programlisting xml:id="nominal.image.depth.frag">
\r
7150 <xsl:param name="nominal.image.depth" select="4 * $pixels.per.inch"></xsl:param>
\r
7154 <refsection><info><title>Description</title></info>
\r
7156 <para>See <parameter>nominal.image.width</parameter>.</para>
\r
7161 <refentry version="5.0" xml:id="use.embed.for.svg">
\r
7163 <refentrytitle>use.embed.for.svg</refentrytitle>
\r
7164 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
7167 <refname>use.embed.for.svg</refname>
\r
7168 <refpurpose>Use HTML <tag>embed</tag> for SVG?</refpurpose>
\r
7172 <programlisting xml:id="use.embed.for.svg.frag">
\r
7173 <xsl:param name="use.embed.for.svg" select="0"></xsl:param>
\r
7177 <refsection><info><title>Description</title></info>
\r
7179 <para>If non-zero, an <tag>embed</tag> element will be created for
\r
7180 SVG figures. An <tag>object</tag> is <emphasis>always</emphasis> created,
\r
7181 this parameter merely controls whether or not an additional <tag>embed</tag>
\r
7182 is generated inside the <tag>object</tag>.</para>
\r
7184 <para>On the plus side, this may be more portable among browsers and plug-ins.
\r
7185 On the minus side, it isn't valid HTML.</para>
\r
7190 <refentry version="5.0" xml:id="make.graphic.viewport">
\r
7192 <refentrytitle>make.graphic.viewport</refentrytitle>
\r
7193 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
7196 <refname>make.graphic.viewport</refname>
\r
7197 <refpurpose>Use tables in HTML to make viewports for graphics</refpurpose>
\r
7201 <programlisting xml:id="make.graphic.viewport.frag">
\r
7202 <xsl:param name="make.graphic.viewport" select="1"></xsl:param>
\r
7206 <refsection><info><title>Description</title></info>
\r
7208 <para>The HTML <tag>img</tag> element only supports the notion
\r
7209 of content-area scaling; it doesn't support the distinction between a
\r
7210 content-area and a viewport-area, so we have to make some compromises.</para>
\r
7212 <para>If <parameter>make.graphic.viewport</parameter> is non-zero, a table
\r
7213 will be used to frame the image. This creates an effective viewport-area.
\r
7216 <para>Tables and alignment don't work together, so this parameter is ignored
\r
7217 if alignment is specified on an image.</para>
\r
7221 <refentry version="5.0" xml:id="preferred.mediaobject.role">
\r
7223 <refentrytitle>preferred.mediaobject.role</refentrytitle>
\r
7224 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
\r
7227 <refname>preferred.mediaobject.role</refname>
\r
7228 <refpurpose>Select which mediaobject to use based on
\r
7229 this value of an object's <tag class="attribute">role</tag> attribute.
\r
7234 <programlisting xml:id="preferred.mediaobject.role.frag">
\r
7235 <xsl:param name="preferred.mediaobject.role"></xsl:param>
\r
7239 <refsection><info><title>Description</title></info>
\r
7241 <para>A mediaobject may contain several objects such as imageobjects.
\r
7242 If the parameter <parameter>use.role.for.mediaobject</parameter> is
\r
7243 non-zero, then the <literal>role</literal> attribute on
\r
7244 <tag>imageobject</tag>s and other objects within a
\r
7245 <tag>mediaobject</tag> container will be used to select which object
\r
7246 will be used. If one of the objects has a role value that matches the
\r
7247 <parameter>preferred.mediaobject.role</parameter> parameter, then it
\r
7248 has first priority for selection. If more than one has such a role
\r
7249 value, the first one is used.
\r
7252 See the <parameter>use.role.for.mediaobject</parameter> parameter
\r
7253 for the sequence of selection.</para>
\r
7257 <refentry version="5.0" xml:id="use.role.for.mediaobject">
\r
7259 <refentrytitle>use.role.for.mediaobject</refentrytitle>
\r
7260 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
7263 <refname>use.role.for.mediaobject</refname>
\r
7264 <refpurpose>Use <tag class="attribute">role</tag> attribute
\r
7265 value for selecting which of several objects within a mediaobject to use.
\r
7270 <programlisting xml:id="use.role.for.mediaobject.frag">
\r
7271 <xsl:param name="use.role.for.mediaobject" select="1"></xsl:param>
\r
7275 <refsection><info><title>Description</title></info>
\r
7277 <para>If non-zero, the <tag class="attribute">role</tag> attribute on
\r
7278 <tag>imageobject</tag>s or other objects within a <tag>mediaobject</tag> container will be used to select which object will be
\r
7282 The order of selection when then parameter is non-zero is:
\r
7286 <para>If the stylesheet parameter <parameter>preferred.mediaobject.role</parameter> has a value, then the object whose role equals that value is selected.</para>
\r
7289 <para>Else if an object's role attribute has a value of
\r
7290 <literal>html</literal> for HTML processing or
\r
7291 <literal>fo</literal> for FO output, then the first
\r
7292 of such objects is selected.
\r
7296 <para>Else the first suitable object is selected.</para>
\r
7301 <parameter>use.role.for.mediaobject</parameter>
\r
7302 is zero, then role attributes are not considered
\r
7303 and the first suitable object
\r
7304 with or without a role value is used.
\r
7309 <refentry version="5.0" xml:id="ignore.image.scaling">
\r
7311 <refentrytitle>ignore.image.scaling</refentrytitle>
\r
7312 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
7315 <refname>ignore.image.scaling</refname>
\r
7316 <refpurpose>Tell the stylesheets to ignore the author's image scaling attributes</refpurpose>
\r
7320 <programlisting xml:id="ignore.image.scaling.frag">
\r
7321 <xsl:param name="ignore.image.scaling" select="0"></xsl:param>
\r
7325 <refsection><info><title>Description</title></info>
\r
7327 <para>If non-zero, the scaling attributes on graphics and media objects are
\r
7334 <reference xml:id="chunking"><title>Chunking</title>
\r
7335 <refentry version="5.0" xml:id="chunker.output.cdata-section-elements">
\r
7337 <refentrytitle>chunker.output.cdata-section-elements</refentrytitle>
\r
7338 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
\r
7341 <refname>chunker.output.cdata-section-elements</refname>
\r
7342 <refpurpose>List of elements to escape with CDATA sections</refpurpose>
\r
7345 <programlisting xml:id="chunker.output.cdata-section-elements.frag">
\r
7346 <xsl:param name="chunker.output.cdata-section-elements"></xsl:param>
\r
7349 <refsection><info><title>Description</title></info>
\r
7350 <para>This parameter specifies the list of elements that should be escaped
\r
7351 as CDATA sections by the chunking stylesheet. Not all processors support
\r
7352 specification of this parameter.
\r
7355 <para>This parameter is documented here, but the declaration is actually
\r
7356 in the <filename>chunker.xsl</filename> stylesheet module.</para>
\r
7361 <refentry version="5.0" xml:id="chunker.output.doctype-public">
\r
7363 <refentrytitle>chunker.output.doctype-public</refentrytitle>
\r
7364 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
\r
7367 <refname>chunker.output.doctype-public</refname>
\r
7368 <refpurpose>Public identifer to use in the document type of generated pages</refpurpose>
\r
7371 <programlisting xml:id="chunker.output.doctype-public.frag">
\r
7372 <xsl:param name="chunker.output.doctype-public"></xsl:param>
\r
7375 <refsection><info><title>Description</title></info>
\r
7376 <para>This parameter specifies the public identifier that should be used by
\r
7377 the chunking stylesheet in the document type declaration of chunked pages.
\r
7378 Not all processors support specification of
\r
7382 <para>This parameter is documented here, but the declaration is actually
\r
7383 in the <filename>chunker.xsl</filename> stylesheet module.</para>
\r
7388 <refentry version="5.0" xml:id="chunker.output.doctype-system">
\r
7390 <refentrytitle>chunker.output.doctype-system</refentrytitle>
\r
7391 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
\r
7394 <refname>chunker.output.doctype-system</refname>
\r
7395 <refpurpose>System identifier to use for the document type in generated pages</refpurpose>
\r
7398 <programlisting xml:id="chunker.output.doctype-system.frag">
\r
7399 <xsl:param name="chunker.output.doctype-system"></xsl:param>
\r
7402 <refsection><info><title>Description</title></info>
\r
7403 <para>This parameter specifies the system identifier that should be used by
\r
7404 the chunking stylesheet in the document type declaration of chunked pages.
\r
7405 Not all processors support specification of
\r
7409 <para>This parameter is documented here, but the declaration is actually
\r
7410 in the <filename>chunker.xsl</filename> stylesheet module.</para>
\r
7415 <refentry version="5.0" xml:id="chunker.output.encoding">
\r
7417 <refentrytitle>chunker.output.encoding</refentrytitle>
\r
7418 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
\r
7421 <refname>chunker.output.encoding</refname>
\r
7422 <refpurpose>Encoding used in generated pages</refpurpose>
\r
7425 <programlisting xml:id="chunker.output.encoding.frag">
\r
7426 <xsl:param name="chunker.output.encoding">ISO-8859-1</xsl:param>
\r
7429 <refsection><info><title>Description</title></info>
\r
7430 <para>This parameter specifies the encoding to be used in files
\r
7431 generated by the chunking stylesheet. Not all processors support
\r
7432 specification of this parameter.
\r
7434 <para>This parameter used to be named <literal>default.encoding</literal>.</para>
\r
7436 <para>This parameter is documented here, but the declaration is actually
\r
7437 in the <filename>chunker.xsl</filename> stylesheet module.</para>
\r
7442 <refentry version="5.0" xml:id="chunker.output.indent">
\r
7444 <refentrytitle>chunker.output.indent</refentrytitle>
\r
7445 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
\r
7448 <refname>chunker.output.indent</refname>
\r
7449 <refpurpose>Specification of indentation on generated pages</refpurpose>
\r
7452 <programlisting xml:id="chunker.output.indent.frag">
\r
7453 <xsl:param name="chunker.output.indent">no</xsl:param>
\r
7456 <refsection><info><title>Description</title></info>
\r
7457 <para>This parameter specifies the value of the indent
\r
7458 specification for generated pages. Not all processors support
\r
7459 specification of this parameter.
\r
7462 <para>This parameter is documented here, but the declaration is actually
\r
7463 in the <filename>chunker.xsl</filename> stylesheet module.</para>
\r
7468 <refentry version="5.0" xml:id="chunker.output.media-type">
\r
7470 <refentrytitle>chunker.output.media-type</refentrytitle>
\r
7471 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
\r
7474 <refname>chunker.output.media-type</refname>
\r
7475 <refpurpose>Media type to use in generated pages</refpurpose>
\r
7478 <programlisting xml:id="chunker.output.media-type.frag">
\r
7479 <xsl:param name="chunker.output.media-type"></xsl:param>
\r
7482 <refsection><info><title>Description</title></info>
\r
7483 <para>This parameter specifies the media type that should be used by
\r
7484 the chunking stylesheet. Not all processors support specification of
\r
7487 <para>This parameter specifies the media type that should be used by the
\r
7488 chunking stylesheet. This should be one from those defined in
\r
7489 <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://www.ietf.org/rfc/rfc2045.txt">[RFC2045]</link> and
\r
7490 <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://www.ietf.org/rfc/rfc2046.txt">[RFC2046]</link> </para>
\r
7492 <para>This parameter is documented here, but the declaration is actually
\r
7493 in the <filename>chunker.xsl</filename> stylesheet module.</para>
\r
7494 <para>It must be one from html, xml or text</para>
\r
7499 <refentry version="5.0" xml:id="chunker.output.method">
\r
7501 <refentrytitle>chunker.output.method</refentrytitle>
\r
7502 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
\r
7503 <refmiscinfo class="other" otherclass="value">html</refmiscinfo>
\r
7504 <refmiscinfo class="other" otherclass="value">xml</refmiscinfo>
\r
7507 <refname>chunker.output.method</refname>
\r
7508 <refpurpose>Method used in generated pages</refpurpose>
\r
7511 <programlisting xml:id="chunker.output.method.frag">
\r
7512 <xsl:param name="chunker.output.method">html</xsl:param>
\r
7515 <refsection><info><title>Description</title></info>
\r
7516 <para>This parameter specifies the output method to be used in files
\r
7517 generated by the chunking stylesheet.
\r
7519 <para>This parameter used to be named <literal>output.method</literal>.</para>
\r
7521 <para>This parameter is documented here, but the declaration is actually
\r
7522 in the <filename>chunker.xsl</filename> stylesheet module.</para>
\r
7527 <refentry version="5.0" xml:id="chunker.output.omit-xml-declaration">
\r
7529 <refentrytitle>chunker.output.omit-xml-declaration</refentrytitle>
\r
7530 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
\r
7533 <refname>chunker.output.omit-xml-declaration</refname>
\r
7534 <refpurpose>Omit-xml-declaration for generated pages</refpurpose>
\r
7537 <programlisting xml:id="chunker.output.omit-xml-declaration.frag">
\r
7538 <xsl:param name="chunker.output.omit-xml-declaration">no</xsl:param>
\r
7541 <refsection><info><title>Description</title></info>
\r
7542 <para>This parameter specifies the value of the omit-xml-declaration
\r
7543 specification for generated pages. Not all processors support
\r
7544 specification of this parameter.
\r
7547 <para>This parameter is documented here, but the declaration is actually
\r
7548 in the <filename>chunker.xsl</filename> stylesheet module.</para>
\r
7553 <refentry version="5.0" xml:id="chunker.output.standalone">
\r
7555 <refentrytitle>chunker.output.standalone</refentrytitle>
\r
7556 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
\r
7559 <refname>chunker.output.standalone</refname>
\r
7560 <refpurpose>Standalone declaration for generated pages</refpurpose>
\r
7563 <programlisting xml:id="chunker.output.standalone.frag">
\r
7564 <xsl:param name="chunker.output.standalone">no</xsl:param>
\r
7567 <refsection><info><title>Description</title></info>
\r
7568 <para>This parameter specifies the value of the standalone
\r
7569 specification for generated pages. It must be either
\r
7570 <literal>yes</literal> or <literal>no</literal>. Not all
\r
7571 processors support specification of this parameter.
\r
7574 <para>This parameter is documented here, but the declaration is actually
\r
7575 in the <filename>chunker.xsl</filename> stylesheet module.</para>
\r
7580 <refentry version="5.0" xml:id="saxon.character.representation">
\r
7582 <refentrytitle>saxon.character.representation</refentrytitle>
\r
7583 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
\r
7586 <refname>saxon.character.representation</refname>
\r
7587 <refpurpose>Saxon character representation used in generated HTML pages</refpurpose>
\r
7591 <programlisting xml:id="saxon.character.representation.frag"><xsl:param name="saxon.character.representation" select="'entity;decimal'"></xsl:param></programlisting>
\r
7594 <refsection><info><title>Description</title></info>
\r
7596 <para>This parameter has effect only when Saxon 6 is used (version 6.4.2 or later).
\r
7597 It sets the character representation in files generated by the chunking stylesheets.
\r
7598 If you want to suppress entity references for characters with direct representations in
\r
7599 <parameter>chunker.output.encoding</parameter>, set the parameter value to <literal>native</literal>.
\r
7602 <para> For more information, see <link xmlns:xlink="http://www.w3.org/1999/xlink" role="tcg" xlink:href="OutputEncoding.html#SaxonCharacter">Saxon output character representation</link>.</para>
\r
7605 <para>This parameter is documented here, but the declaration is actually
\r
7606 in the <filename>chunker.xsl</filename> stylesheet module.</para>
\r
7613 <refentry version="5.0" xml:id="html.ext">
\r
7615 <refentrytitle>html.ext</refentrytitle>
\r
7616 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
\r
7619 <refname>html.ext</refname>
\r
7620 <refpurpose>Identifies the extension of generated HTML files</refpurpose>
\r
7624 <programlisting xml:id="html.ext.frag">
\r
7625 <xsl:param name="html.ext">.html</xsl:param>
\r
7629 <refsection><info><title>Description</title></info>
\r
7631 <para>The extension identified by <parameter>html.ext</parameter> will
\r
7632 be used as the filename extension for chunks created by this
\r
7633 stylesheet. </para>
\r
7638 <refentry version="5.0" xml:id="use.id.as.filename">
\r
7640 <refentrytitle>use.id.as.filename</refentrytitle>
\r
7641 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
7644 <refname>use.id.as.filename</refname>
\r
7645 <refpurpose>Use ID value of chunk elements as the filename?</refpurpose>
\r
7649 <programlisting xml:id="use.id.as.filename.frag">
\r
7650 <xsl:param name="use.id.as.filename" select="0"></xsl:param>
\r
7654 <refsection><info><title>Description</title></info>
\r
7656 <para>If <parameter>use.id.as.filename</parameter>
\r
7657 is non-zero, the filename of chunk elements that have IDs will be
\r
7658 derived from the ID value.
\r
7664 <refentry version="5.0" xml:id="html.extra.head.links">
\r
7666 <refentrytitle>html.extra.head.links</refentrytitle>
\r
7667 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
7670 <refname>html.extra.head.links</refname>
\r
7671 <refpurpose>Toggle extra HTML head link information</refpurpose>
\r
7675 <programlisting xml:id="html.extra.head.links.frag">
\r
7676 <xsl:param name="html.extra.head.links" select="0"></xsl:param>
\r
7680 <refsection><info><title>Description</title></info>
\r
7682 <para>If non-zero, extra <tag>link</tag> elements will be
\r
7683 generated in the <tag>head</tag> of chunked HTML files. These
\r
7684 extra links point to chapters, appendixes, sections, etc. as supported
\r
7685 by the <quote>Site Navigation Bar</quote> in Mozilla 1.0 (as of CR1, at least).
\r
7691 <refentry version="5.0" xml:id="root.filename">
\r
7693 <refentrytitle>root.filename</refentrytitle>
\r
7694 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
\r
7697 <refname>root.filename</refname>
\r
7698 <refpurpose>Identifies the name of the root HTML file when chunking</refpurpose>
\r
7702 <programlisting xml:id="root.filename.frag">
\r
7703 <xsl:param name="root.filename">index</xsl:param>
\r
7707 <refsection><info><title>Description</title></info>
\r
7709 <para>The <parameter>root.filename</parameter> is the base filename for
\r
7710 the chunk created for the root of each document processed.
\r
7716 <refentry version="5.0" xml:id="base.dir">
\r
7718 <refentrytitle>base.dir</refentrytitle>
\r
7719 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
\r
7722 <refname>base.dir</refname>
\r
7723 <refpurpose>The base directory of chunks</refpurpose>
\r
7727 <programlisting xml:id="base.dir.frag">
\r
7728 <xsl:param name="base.dir"></xsl:param>
\r
7732 <refsection><info><title>Description</title></info>
\r
7734 <para>If specified, the <parameter>base.dir</parameter> identifies
\r
7735 the output directory for chunks. (If not specified, the output directory
\r
7736 is system dependent.)</para>
\r
7741 <refentry version="5.0" xml:id="generate.manifest">
\r
7743 <refentrytitle>generate.manifest</refentrytitle>
\r
7744 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
7747 <refname>generate.manifest</refname>
\r
7748 <refpurpose>Generate a manifest file?</refpurpose>
\r
7752 <programlisting xml:id="generate.manifest.frag"><xsl:param name="generate.manifest" select="0"></xsl:param></programlisting>
\r
7755 <refsection><info><title>Description</title></info>
\r
7757 <para>If non-zero, a list of HTML files generated by the
\r
7758 stylesheet transformation is written to the file named by
\r
7759 the <parameter>manifest</parameter> parameter.</para>
\r
7764 <refentry version="5.0" xml:id="manifest">
\r
7766 <refentrytitle>manifest</refentrytitle>
\r
7767 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
\r
7770 <refname>manifest</refname>
\r
7771 <refpurpose>Name of manifest file</refpurpose>
\r
7775 <programlisting xml:id="manifest.frag">
\r
7776 <xsl:param name="manifest">HTML.manifest</xsl:param>
\r
7780 <refsection><info><title>Description</title></info>
\r
7782 <para>The name of the file to which a manifest is written (if the
\r
7783 value of the <parameter>generate.manifest</parameter> parameter
\r
7784 is non-zero).</para>
\r
7789 <refentry version="5.0" xml:id="manifest.in.base.dir">
\r
7791 <refentrytitle>manifest.in.base.dir</refentrytitle>
\r
7792 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
7795 <refname>manifest.in.base.dir</refname>
\r
7796 <refpurpose>Should the manifest file be written into <parameter>base.dir</parameter>?</refpurpose>
\r
7800 <programlisting xml:id="manifest.in.base.dir.frag">
\r
7801 <xsl:param name="manifest.in.base.dir" select="0"></xsl:param>
\r
7805 <refsection><info><title>Description</title></info>
\r
7807 <para>If non-zero, the manifest file as well as project files for HTML Help and
\r
7808 Eclipse Help are written into <parameter>base.dir</parameter> instead
\r
7809 of the current directory.</para>
\r
7814 <refentry version="5.0" xml:id="chunk.toc">
\r
7816 <refentrytitle>chunk.toc</refentrytitle>
\r
7817 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
\r
7820 <refname>chunk.toc</refname>
\r
7821 <refpurpose>An explicit TOC to be used for chunking</refpurpose>
\r
7825 <programlisting xml:id="chunk.toc.frag">
\r
7826 <xsl:param name="chunk.toc"></xsl:param>
\r
7830 <refsection><info><title>Description</title></info>
\r
7832 <para>The <parameter>chunk.toc</parameter> identifies an explicit TOC that
\r
7833 will be used for chunking. This parameter is only used by the
\r
7834 <filename>chunktoc.xsl</filename> stylesheet (and customization layers built
\r
7840 <refentry version="5.0" xml:id="chunk.tocs.and.lots">
\r
7842 <refentrytitle>chunk.tocs.and.lots</refentrytitle>
\r
7843 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
7846 <refname>chunk.tocs.and.lots</refname>
\r
7847 <refpurpose>Should ToC and LoTs be in separate chunks?</refpurpose>
\r
7851 <programlisting xml:id="chunk.tocs.and.lots.frag">
\r
7852 <xsl:param name="chunk.tocs.and.lots" select="0"></xsl:param>
\r
7856 <refsection><info><title>Description</title></info>
\r
7858 <para>If non-zero, ToC and LoT (List of Examples, List of Figures, etc.)
\r
7859 will be put in a separate chunk. At the moment, this chunk is not in the
\r
7860 normal forward/backward navigation list. Instead, a new link is added to the
\r
7861 navigation footer.</para>
\r
7863 <para>This feature is still somewhat experimental. Feedback welcome.</para>
\r
7868 <refentry version="5.0" xml:id="chunk.separate.lots">
\r
7870 <refentrytitle>chunk.separate.lots</refentrytitle>
\r
7871 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
7874 <refname>chunk.separate.lots</refname>
\r
7875 <refpurpose>Should each LoT be in its own separate chunk?</refpurpose>
\r
7879 <programlisting xml:id="chunk.separate.lots.frag">
\r
7880 <xsl:param name="chunk.separate.lots" select="0"></xsl:param>
\r
7884 <refsection><info><title>Description</title></info>
\r
7886 <para>If non-zero, each of the ToC and LoTs
\r
7887 (List of Examples, List of Figures, etc.)
\r
7888 will be put in its own separate chunk.
\r
7889 The title page includes generated links to each of the separate files.
\r
7892 This feature depends on the
\r
7893 <parameter>chunk.tocs.and.lots</parameter>
\r
7894 parameter also being non-zero.
\r
7900 <refentry version="5.0" xml:id="chunk.tocs.and.lots.has.title">
\r
7902 <refentrytitle>chunk.tocs.and.lots.has.title</refentrytitle>
\r
7903 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
7906 <refname>chunk.tocs.and.lots.has.title</refname>
\r
7907 <refpurpose>Should ToC and LoTs in a separate chunks have title?</refpurpose>
\r
7911 <programlisting xml:id="chunk.tocs.and.lots.has.title.frag">
\r
7912 <xsl:param name="chunk.tocs.and.lots.has.title" select="1"></xsl:param>
\r
7916 <refsection><info><title>Description</title></info>
\r
7918 <para>If non-zero title of document is shown before ToC/LoT in
\r
7919 separate chunk.</para>
\r
7924 <refentry version="5.0" xml:id="chunk.section.depth">
\r
7926 <refentrytitle>chunk.section.depth</refentrytitle>
\r
7927 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
\r
7930 <refname>chunk.section.depth</refname>
\r
7931 <refpurpose>Depth to which sections should be chunked</refpurpose>
\r
7935 <programlisting xml:id="chunk.section.depth.frag">
\r
7936 <xsl:param name="chunk.section.depth" select="1"></xsl:param>
\r
7940 <refsection><info><title>Description</title></info>
\r
7942 <para>This parameter sets the depth of section chunking.</para>
\r
7947 <refentry version="5.0" xml:id="chunk.first.sections">
\r
7949 <refentrytitle>chunk.first.sections</refentrytitle>
\r
7950 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
7953 <refname>chunk.first.sections</refname>
\r
7954 <refpurpose>Chunk the first top-level section?</refpurpose>
\r
7958 <programlisting xml:id="chunk.first.sections.frag">
\r
7959 <xsl:param name="chunk.first.sections" select="0"></xsl:param>
\r
7963 <refsection><info><title>Description</title></info>
\r
7965 <para>If non-zero, a chunk will be created for the first top-level
\r
7966 <tag>sect1</tag> or <tag>section</tag> elements in
\r
7967 each component. Otherwise, that section will be part of the chunk for
\r
7974 <refentry version="5.0" xml:id="chunk.quietly">
\r
7976 <refentrytitle>chunk.quietly</refentrytitle>
\r
7977 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
7980 <refname>chunk.quietly</refname>
\r
7981 <refpurpose>Omit the chunked filename messages.</refpurpose>
\r
7985 <programlisting xml:id="chunk.quietly.frag">
\r
7986 <xsl:param name="chunk.quietly" select="0"></xsl:param>
\r
7990 <refsection><info><title>Description</title></info>
\r
7992 <para>If zero (the default), the XSL processor emits a message naming
\r
7993 each separate chunk filename as it is being output.
\r
7994 If nonzero, then the messages are suppressed.
\r
8000 <refentry version="5.0" xml:id="chunk.append">
\r
8002 <refentrytitle>chunk.append</refentrytitle>
\r
8003 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
\r
8006 <refname>chunk.append</refname>
\r
8007 <refpurpose>Specifies content to append to chunked HTML output</refpurpose>
\r
8011 <programlisting xml:id="chunk.append.frag"><xsl:param name="chunk.append"></xsl:param></programlisting>
\r
8014 <refsection><info><title>Description</title></info>
\r
8016 <para>Specifies content to append to the end of HTML files output by
\r
8017 the <filename>html/chunk.xsl</filename> stylesheet, after the closing
\r
8018 <code><html></code> tag. You probably don’t want to set any value
\r
8019 for this parameter; but if you do, the only value it should ever be
\r
8020 set to is a newline character: <code>&#x0a;</code> or
\r
8021 <code>&#10;</code></para>
\r
8026 <refentry version="5.0" xml:id="navig.graphics">
\r
8028 <refentrytitle>navig.graphics</refentrytitle>
\r
8029 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
8032 <refname>navig.graphics</refname>
\r
8033 <refpurpose>Use graphics in navigational headers and footers?</refpurpose>
\r
8037 <programlisting xml:id="navig.graphics.frag">
\r
8038 <xsl:param name="navig.graphics" select="0"></xsl:param>
\r
8042 <refsection><info><title>Description</title></info>
\r
8044 <para>If non-zero, the navigational headers and footers in chunked
\r
8045 HTML are presented in an alternate style that uses graphical icons for
\r
8046 Next, Previous, Up, and Home. Default graphics are provided in the
\r
8047 distribution. If zero, text is used instead of graphics.
\r
8053 <refentry version="5.0" xml:id="navig.graphics.extension">
\r
8055 <refentrytitle>navig.graphics.extension</refentrytitle>
\r
8056 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
\r
8059 <refname>navig.graphics.extension</refname>
\r
8060 <refpurpose>Extension for navigational graphics</refpurpose>
\r
8064 <programlisting xml:id="navig.graphics.extension.frag">
\r
8065 <xsl:param name="navig.graphics.extension">.gif</xsl:param>
\r
8069 <refsection><info><title>Description</title></info>
\r
8071 <para>Sets the filename extension to use on navigational graphics used
\r
8072 in the headers and footers of chunked HTML.</para>
\r
8077 <refentry version="5.0" xml:id="navig.graphics.path">
\r
8079 <refentrytitle>navig.graphics.path</refentrytitle>
\r
8080 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
\r
8083 <refname>navig.graphics.path</refname>
\r
8084 <refpurpose>Path to navigational graphics</refpurpose>
\r
8088 <programlisting xml:id="navig.graphics.path.frag">
\r
8089 <xsl:param name="navig.graphics.path">images/</xsl:param>
\r
8093 <refsection><info><title>Description</title></info>
\r
8095 <para>Sets the path, probably relative to the directory where the HTML
\r
8096 files are created, to the navigational graphics used in the
\r
8097 headers and footers of chunked HTML.
\r
8103 <refentry version="5.0" xml:id="navig.showtitles">
\r
8105 <refentrytitle>navig.showtitles</refentrytitle>
\r
8106 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
8109 <refname>navig.showtitles</refname>
\r
8110 <refpurpose>Display titles in HTML headers and footers?</refpurpose>
\r
8114 <programlisting xml:id="navig.showtitles.frag"><xsl:param name="navig.showtitles">1</xsl:param></programlisting>
\r
8117 <refsection><info><title>Description</title></info>
\r
8119 <para>If non-zero,
\r
8120 the headers and footers of chunked HTML
\r
8121 display the titles of the next and previous chunks,
\r
8122 along with the words 'Next' and 'Previous' (or the
\r
8123 equivalent graphical icons if navig.graphics is true).
\r
8124 If false (zero), then only the words 'Next' and 'Previous'
\r
8125 (or the icons) are displayed.
\r
8132 <reference xml:id="profiling"><title>Profiling</title>
\r
8133 <partintro xml:id="partintro">
\r
8134 <para>The following parameters can be used for attribute-based
\r
8135 profiling of your document. For more information about profiling, see
\r
8136 <link xmlns:xlink="http://www.w3.org/1999/xlink" role="tcg" xlink:href="Profiling.html">Profiling (conditional text)</link>.</para>
\r
8138 <refentry version="5.0" xml:id="profile.arch">
\r
8140 <refentrytitle>profile.arch</refentrytitle>
\r
8141 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
\r
8144 <refname>profile.arch</refname>
\r
8145 <refpurpose>Target profile for <tag class="attribute">arch</tag>
\r
8146 attribute</refpurpose>
\r
8150 <programlisting xml:id="profile.arch.frag">
\r
8151 <xsl:param name="profile.arch"></xsl:param>
\r
8156 <refsection><info><title>Description</title></info>
\r
8158 <para>The value of this parameter specifies profiles which should be
\r
8159 included in the output. You can specify multiple profiles by
\r
8160 separating them by semicolon. You can change separator character by
\r
8161 <parameter>profile.separator</parameter>
\r
8164 <para>This parameter has effect only when you are using profiling
\r
8165 stylesheets (<filename>profile-docbook.xsl</filename>,
\r
8166 <filename>profile-chunk.xsl</filename>, …) instead of normal
\r
8167 ones (<filename>docbook.xsl</filename>,
\r
8168 <filename>chunk.xsl</filename>, …).</para>
\r
8173 <refentry version="5.0" xml:id="profile.audience">
\r
8175 <refentrytitle>profile.audience</refentrytitle>
\r
8176 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
\r
8179 <refname>profile.audience</refname>
\r
8180 <refpurpose>Target profile for <tag class="attribute">audience</tag>
\r
8181 attribute</refpurpose>
\r
8185 <programlisting xml:id="profile.audience.frag">
\r
8186 <xsl:param name="profile.audience"></xsl:param>
\r
8190 <refsection><info><title>Description</title></info>
\r
8192 <para>Value of this parameter specifies profiles which should be
\r
8193 included in the output. You can specify multiple profiles by
\r
8194 separating them by semicolon. You can change separator character by
\r
8195 <parameter>profile.separator</parameter>
\r
8198 <para>This parameter has effect only when you are using profiling
\r
8199 stylesheets (<filename>profile-docbook.xsl</filename>,
\r
8200 <filename>profile-chunk.xsl</filename>, …) instead of normal
\r
8201 ones (<filename>docbook.xsl</filename>,
\r
8202 <filename>chunk.xsl</filename>, …).</para>
\r
8207 <refentry version="5.0" xml:id="profile.condition">
\r
8209 <refentrytitle>profile.condition</refentrytitle>
\r
8210 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
\r
8213 <refname>profile.condition</refname>
\r
8214 <refpurpose>Target profile for <tag class="attribute">condition</tag>
\r
8215 attribute</refpurpose>
\r
8219 <programlisting xml:id="profile.condition.frag">
\r
8220 <xsl:param name="profile.condition"></xsl:param>
\r
8224 <refsection><info><title>Description</title></info>
\r
8226 <para>The value of this parameter specifies profiles which should be
\r
8227 included in the output. You can specify multiple profiles by
\r
8228 separating them by semicolon. You can change separator character by
\r
8229 <parameter>profile.separator</parameter>
\r
8232 <para>This parameter has effect only when you are using profiling
\r
8233 stylesheets (<filename>profile-docbook.xsl</filename>,
\r
8234 <filename>profile-chunk.xsl</filename>, …) instead of normal
\r
8235 ones (<filename>docbook.xsl</filename>,
\r
8236 <filename>chunk.xsl</filename>, …).</para>
\r
8241 <refentry version="5.0" xml:id="profile.conformance">
\r
8243 <refentrytitle>profile.conformance</refentrytitle>
\r
8244 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
\r
8247 <refname>profile.conformance</refname>
\r
8248 <refpurpose>Target profile for <tag class="attribute">conformance</tag>
\r
8249 attribute</refpurpose>
\r
8253 <programlisting xml:id="profile.conformance.frag">
\r
8254 <xsl:param name="profile.conformance"></xsl:param>
\r
8258 <refsection><info><title>Description</title></info>
\r
8260 <para>The value of this parameter specifies profiles which should be
\r
8261 included in the output. You can specify multiple profiles by
\r
8262 separating them by semicolon. You can change separator character by
\r
8263 <parameter>profile.separator</parameter>
\r
8266 <para>This parameter has effect only when you are using profiling
\r
8267 stylesheets (<filename>profile-docbook.xsl</filename>,
\r
8268 <filename>profile-chunk.xsl</filename>, …) instead of normal
\r
8269 ones (<filename>docbook.xsl</filename>,
\r
8270 <filename>chunk.xsl</filename>, …).</para>
\r
8275 <refentry version="5.0" xml:id="profile.lang">
\r
8277 <refentrytitle>profile.lang</refentrytitle>
\r
8278 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
\r
8281 <refname>profile.lang</refname>
\r
8282 <refpurpose>Target profile for <tag class="attribute">lang</tag>
\r
8283 attribute</refpurpose>
\r
8287 <programlisting xml:id="profile.lang.frag">
\r
8288 <xsl:param name="profile.lang"></xsl:param>
\r
8292 <refsection><info><title>Description</title></info>
\r
8294 <para>The value of this parameter specifies profiles which should be
\r
8295 included in the output. You can specify multiple profiles by
\r
8296 separating them by semicolon. You can change separator character by
\r
8297 <parameter>profile.separator</parameter>
\r
8300 <para>This parameter has effect only when you are using profiling
\r
8301 stylesheets (<filename>profile-docbook.xsl</filename>,
\r
8302 <filename>profile-chunk.xsl</filename>, …) instead of normal
\r
8303 ones (<filename>docbook.xsl</filename>,
\r
8304 <filename>chunk.xsl</filename>, …).</para>
\r
8309 <refentry version="5.0" xml:id="profile.os">
\r
8311 <refentrytitle>profile.os</refentrytitle>
\r
8312 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
\r
8315 <refname>profile.os</refname>
\r
8316 <refpurpose>Target profile for <tag class="attribute">os</tag>
\r
8317 attribute</refpurpose>
\r
8321 <programlisting xml:id="profile.os.frag">
\r
8322 <xsl:param name="profile.os"></xsl:param>
\r
8326 <refsection><info><title>Description</title></info>
\r
8328 <para>The value of this parameter specifies profiles which should be
\r
8329 included in the output. You can specify multiple profiles by
\r
8330 separating them by semicolon. You can change separator character by
\r
8331 <parameter>profile.separator</parameter>
\r
8334 <para>This parameter has effect only when you are using profiling
\r
8335 stylesheets (<filename>profile-docbook.xsl</filename>,
\r
8336 <filename>profile-chunk.xsl</filename>, …) instead of normal
\r
8337 ones (<filename>docbook.xsl</filename>,
\r
8338 <filename>chunk.xsl</filename>, …).</para>
\r
8343 <refentry version="5.0" xml:id="profile.revision">
\r
8345 <refentrytitle>profile.revision</refentrytitle>
\r
8346 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
\r
8349 <refname>profile.revision</refname>
\r
8350 <refpurpose>Target profile for <tag class="attribute">revision</tag>
\r
8351 attribute</refpurpose>
\r
8355 <programlisting xml:id="profile.revision.frag">
\r
8356 <xsl:param name="profile.revision"></xsl:param>
\r
8360 <refsection><info><title>Description</title></info>
\r
8362 <para>The value of this parameter specifies profiles which should be
\r
8363 included in the output. You can specify multiple profiles by
\r
8364 separating them by semicolon. You can change separator character by
\r
8365 <parameter>profile.separator</parameter>
\r
8368 <para>This parameter has effect only when you are using profiling
\r
8369 stylesheets (<filename>profile-docbook.xsl</filename>,
\r
8370 <filename>profile-chunk.xsl</filename>, …) instead of normal
\r
8371 ones (<filename>docbook.xsl</filename>,
\r
8372 <filename>chunk.xsl</filename>, …).</para>
\r
8377 <refentry version="5.0" xml:id="profile.revisionflag">
\r
8379 <refentrytitle>profile.revisionflag</refentrytitle>
\r
8380 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
\r
8383 <refname>profile.revisionflag</refname>
\r
8384 <refpurpose>Target profile for <tag class="attribute">revisionflag</tag>
\r
8385 attribute</refpurpose>
\r
8389 <programlisting xml:id="profile.revisionflag.frag">
\r
8390 <xsl:param name="profile.revisionflag"></xsl:param>
\r
8394 <refsection><info><title>Description</title></info>
\r
8396 <para>The value of this parameter specifies profiles which should be
\r
8397 included in the output. You can specify multiple profiles by
\r
8398 separating them by semicolon. You can change separator character by
\r
8399 <parameter>profile.separator</parameter>
\r
8402 <para>This parameter has effect only when you are using profiling
\r
8403 stylesheets (<filename>profile-docbook.xsl</filename>,
\r
8404 <filename>profile-chunk.xsl</filename>, …) instead of normal
\r
8405 ones (<filename>docbook.xsl</filename>,
\r
8406 <filename>chunk.xsl</filename>, …).</para>
\r
8411 <refentry version="5.0" xml:id="profile.role">
\r
8413 <refentrytitle>profile.role</refentrytitle>
\r
8414 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
\r
8417 <refname>profile.role</refname>
\r
8418 <refpurpose>Target profile for <tag class="attribute">role</tag>
\r
8419 attribute</refpurpose>
\r
8423 <programlisting xml:id="profile.role.frag">
\r
8424 <xsl:param name="profile.role"></xsl:param>
\r
8428 <refsection><info><title>Description</title></info>
\r
8430 <para>The value of this parameter specifies profiles which should be
\r
8431 included in the output. You can specify multiple profiles by
\r
8432 separating them by semicolon. You can change separator character by
\r
8433 <parameter>profile.separator</parameter>
\r
8436 <para>This parameter has effect only when you are using profiling
\r
8437 stylesheets (<filename>profile-docbook.xsl</filename>,
\r
8438 <filename>profile-chunk.xsl</filename>, …) instead of normal
\r
8439 ones (<filename>docbook.xsl</filename>,
\r
8440 <filename>chunk.xsl</filename>, …).</para>
\r
8443 <para>Note that <tag class="attribute">role</tag> is often
\r
8444 used for other purposes than profiling. For example it is commonly
\r
8445 used to get emphasize in bold font:</para>
\r
8447 <programlisting><emphasis role="bold">very important</emphasis></programlisting>
\r
8449 <para>If you are using <tag class="attribute">role</tag> for
\r
8450 these purposes do not forget to add values like <literal>bold</literal> to
\r
8451 value of this parameter. If you forgot you will get document with
\r
8452 small pieces missing which are very hard to track.</para>
\r
8454 <para>For this reason it is not recommended to use <tag class="attribute">role</tag> attribute for profiling. You should
\r
8455 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>
\r
8461 <refentry version="5.0" xml:id="profile.security">
\r
8463 <refentrytitle>profile.security</refentrytitle>
\r
8464 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
\r
8467 <refname>profile.security</refname>
\r
8468 <refpurpose>Target profile for <tag class="attribute">security</tag>
\r
8469 attribute</refpurpose>
\r
8473 <programlisting xml:id="profile.security.frag">
\r
8474 <xsl:param name="profile.security"></xsl:param>
\r
8478 <refsection><info><title>Description</title></info>
\r
8480 <para>The value of this parameter specifies profiles which should be
\r
8481 included in the output. You can specify multiple profiles by
\r
8482 separating them by semicolon. You can change separator character by
\r
8483 <parameter>profile.separator</parameter>
\r
8486 <para>This parameter has effect only when you are using profiling
\r
8487 stylesheets (<filename>profile-docbook.xsl</filename>,
\r
8488 <filename>profile-chunk.xsl</filename>, …) instead of normal
\r
8489 ones (<filename>docbook.xsl</filename>,
\r
8490 <filename>chunk.xsl</filename>, …).</para>
\r
8495 <refentry version="5.0" xml:id="profile.status">
\r
8497 <refentrytitle>profile.status</refentrytitle>
\r
8498 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
\r
8501 <refname>profile.status</refname>
\r
8502 <refpurpose>Target profile for <tag class="attribute">status</tag>
\r
8503 attribute</refpurpose>
\r
8507 <programlisting xml:id="profile.status.frag">
\r
8508 <xsl:param name="profile.status"></xsl:param>
\r
8512 <refsection><info><title>Description</title></info>
\r
8514 <para>The value of this parameter specifies profiles which should be
\r
8515 included in the output. You can specify multiple profiles by
\r
8516 separating them by semicolon. You can change separator character by
\r
8517 <parameter>profile.separator</parameter>
\r
8520 <para>This parameter has effect only when you are using profiling
\r
8521 stylesheets (<filename>profile-docbook.xsl</filename>,
\r
8522 <filename>profile-chunk.xsl</filename>, …) instead of normal
\r
8523 ones (<filename>docbook.xsl</filename>,
\r
8524 <filename>chunk.xsl</filename>, …).</para>
\r
8529 <refentry version="5.0" xml:id="profile.userlevel">
\r
8531 <refentrytitle>profile.userlevel</refentrytitle>
\r
8532 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
\r
8535 <refname>profile.userlevel</refname>
\r
8536 <refpurpose>Target profile for <tag class="attribute">userlevel</tag>
\r
8537 attribute</refpurpose>
\r
8541 <programlisting xml:id="profile.userlevel.frag">
\r
8542 <xsl:param name="profile.userlevel"></xsl:param>
\r
8546 <refsection><info><title>Description</title></info>
\r
8548 <para>The value of this parameter specifies profiles which should be
\r
8549 included in the output. You can specify multiple profiles by
\r
8550 separating them by semicolon. You can change separator character by
\r
8551 <parameter>profile.separator</parameter>
\r
8554 <para>This parameter has effect only when you are using profiling
\r
8555 stylesheets (<filename>profile-docbook.xsl</filename>,
\r
8556 <filename>profile-chunk.xsl</filename>, …) instead of normal
\r
8557 ones (<filename>docbook.xsl</filename>,
\r
8558 <filename>chunk.xsl</filename>, …).</para>
\r
8563 <refentry version="5.0" xml:id="profile.vendor">
\r
8565 <refentrytitle>profile.vendor</refentrytitle>
\r
8566 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
\r
8569 <refname>profile.vendor</refname>
\r
8570 <refpurpose>Target profile for <tag class="attribute">vendor</tag>
\r
8571 attribute</refpurpose>
\r
8575 <programlisting xml:id="profile.vendor.frag">
\r
8576 <xsl:param name="profile.vendor"></xsl:param>
\r
8580 <refsection><info><title>Description</title></info>
\r
8582 <para>The value of this parameter specifies profiles which should be
\r
8583 included in the output. You can specify multiple profiles by
\r
8584 separating them by semicolon. You can change separator character by
\r
8585 <parameter>profile.separator</parameter>
\r
8588 <para>This parameter has effect only when you are using profiling
\r
8589 stylesheets (<filename>profile-docbook.xsl</filename>,
\r
8590 <filename>profile-chunk.xsl</filename>, …) instead of normal
\r
8591 ones (<filename>docbook.xsl</filename>,
\r
8592 <filename>chunk.xsl</filename>, …).</para>
\r
8597 <refentry version="5.0" xml:id="profile.wordsize">
\r
8599 <refentrytitle>profile.wordsize</refentrytitle>
\r
8600 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
\r
8603 <refname>profile.wordsize</refname>
\r
8604 <refpurpose>Target profile for <tag class="attribute">wordsize</tag>
\r
8605 attribute</refpurpose>
\r
8609 <programlisting xml:id="profile.wordsize.frag">
\r
8610 <xsl:param name="profile.wordsize"></xsl:param>
\r
8614 <refsection><info><title>Description</title></info>
\r
8616 <para>The value of this parameter specifies profiles which should be
\r
8617 included in the output. You can specify multiple profiles by
\r
8618 separating them by semicolon. You can change separator character by
\r
8619 <parameter>profile.separator</parameter>
\r
8622 <para>This parameter has effect only when you are using profiling
\r
8623 stylesheets (<filename>profile-docbook.xsl</filename>,
\r
8624 <filename>profile-chunk.xsl</filename>, …) instead of normal
\r
8625 ones (<filename>docbook.xsl</filename>,
\r
8626 <filename>chunk.xsl</filename>, …).</para>
\r
8631 <refentry version="5.0" xml:id="profile.attribute">
\r
8633 <refentrytitle>profile.attribute</refentrytitle>
\r
8634 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
\r
8637 <refname>profile.attribute</refname>
\r
8638 <refpurpose>Name of user-specified profiling attribute</refpurpose>
\r
8642 <programlisting xml:id="profile.attribute.frag">
\r
8643 <xsl:param name="profile.attribute"></xsl:param>
\r
8647 <refsection><info><title>Description</title></info>
\r
8649 <para>This parameter is used in conjuction with
\r
8650 <parameter>profile.value</parameter>.</para>
\r
8652 <para>This parameter has effect only when you are using profiling
\r
8653 stylesheets (<filename>profile-docbook.xsl</filename>,
\r
8654 <filename>profile-chunk.xsl</filename>, …) instead of normal
\r
8655 ones (<filename>docbook.xsl</filename>,
\r
8656 <filename>chunk.xsl</filename>, …).</para>
\r
8661 <refentry version="5.0" xml:id="profile.value">
\r
8663 <refentrytitle>profile.value</refentrytitle>
\r
8664 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
\r
8667 <refname>profile.value</refname>
\r
8668 <refpurpose>Target profile for user-specified attribute</refpurpose>
\r
8672 <programlisting xml:id="profile.value.frag">
\r
8673 <xsl:param name="profile.value"></xsl:param>
\r
8677 <refsection><info><title>Description</title></info>
\r
8679 <para>When you are using this parameter you must also specify name of
\r
8680 profiling attribute with parameter
\r
8681 <parameter>profile.attribute</parameter>.</para>
\r
8683 <para>The value of this parameter specifies profiles which should be
\r
8684 included in the output. You can specify multiple profiles by
\r
8685 separating them by semicolon. You can change separator character by
\r
8686 <parameter>profile.separator</parameter>
\r
8689 <para>This parameter has effect only when you are using profiling
\r
8690 stylesheets (<filename>profile-docbook.xsl</filename>,
\r
8691 <filename>profile-chunk.xsl</filename>, …) instead of normal
\r
8692 ones (<filename>docbook.xsl</filename>,
\r
8693 <filename>chunk.xsl</filename>, …).</para>
\r
8698 <refentry version="5.0" xml:id="profile.separator">
\r
8700 <refentrytitle>profile.separator</refentrytitle>
\r
8701 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
\r
8704 <refname>profile.separator</refname>
\r
8705 <refpurpose>Separator character for compound profile values</refpurpose>
\r
8709 <programlisting xml:id="profile.separator.frag">
\r
8710 <xsl:param name="profile.separator">;</xsl:param>
\r
8714 <refsection><info><title>Description</title></info>
\r
8716 <para>Separator character used for compound profile values. See <parameter>profile.arch</parameter></para>
\r
8722 <reference xml:id="htmlhelp"><title>HTML Help</title>
\r
8723 <refentry version="5.0" xml:id="htmlhelp.encoding">
\r
8725 <refentrytitle>htmlhelp.encoding</refentrytitle>
\r
8726 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
\r
8729 <refname>htmlhelp.encoding</refname>
\r
8730 <refpurpose>Character encoding to use in files for HTML Help compiler.</refpurpose>
\r
8734 <programlisting xml:id="htmlhelp.encoding.frag">
\r
8735 <xsl:param name="htmlhelp.encoding">iso-8859-1</xsl:param>
\r
8739 <refsection><info><title>Description</title></info>
\r
8741 <para>HTML Help Compiler is not UTF-8 aware, so you should always use an
\r
8742 appropriate single-byte encoding here. Use one from <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="ftp://ftp.isi.edu/in-notes/iana/assignments/character-sets">iana</link>, the registered charset values.</para>
\r
8747 <refentry version="5.0" xml:id="htmlhelp.autolabel">
\r
8749 <refentrytitle>htmlhelp.autolabel</refentrytitle>
\r
8750 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
8753 <refname>htmlhelp.autolabel</refname>
\r
8754 <refpurpose>Should tree-like ToC use autonumbering feature?</refpurpose>
\r
8758 <programlisting xml:id="htmlhelp.autolabel.frag">
\r
8759 <xsl:param name="htmlhelp.autolabel" select="0"></xsl:param>
\r
8763 <refsection><info><title>Description</title></info>
\r
8765 <para>Set this to non-zero to include chapter and section numbers into ToC
\r
8766 in the left panel.</para>
\r
8771 <refentry version="5.0" xml:id="htmlhelp.chm">
\r
8773 <refentrytitle>htmlhelp.chm</refentrytitle>
\r
8774 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
\r
8777 <refname>htmlhelp.chm</refname>
\r
8778 <refpurpose>Filename of output HTML Help file.</refpurpose>
\r
8782 <programlisting xml:id="htmlhelp.chm.frag">
\r
8783 <xsl:param name="htmlhelp.chm">htmlhelp.chm</xsl:param>
\r
8787 <refsection><info><title>Description</title></info>
\r
8789 <para>Set the name of resulting CHM file</para>
\r
8794 <refentry version="5.0" xml:id="htmlhelp.default.topic">
\r
8796 <refentrytitle>htmlhelp.default.topic</refentrytitle>
\r
8797 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
\r
8800 <refname>htmlhelp.default.topic</refname>
\r
8801 <refpurpose>Name of file with default topic</refpurpose>
\r
8805 <programlisting xml:id="htmlhelp.default.topic.frag">
\r
8806 <xsl:param name="htmlhelp.default.topic"></xsl:param>
\r
8810 <refsection><info><title>Description</title></info>
\r
8812 <para>Normally first chunk of document is displayed when you open HTML
\r
8813 Help file. If you want to display another topic, simply set its
\r
8814 filename by this parameter.</para>
\r
8816 <para>This is useful especially if you don't generate ToC in front of
\r
8817 your document and you also hide root element in ToC. E.g.:</para>
\r
8819 <programlisting><xsl:param name="generate.book.toc" select="0"/>
\r
8820 <xsl:param name="htmlhelp.hhc.show.root" select="0"/>
\r
8821 <xsl:param name="htmlhelp.default.topic">pr01.html</xsl:param>
\r
8827 <refentry version="5.0" xml:id="htmlhelp.display.progress">
\r
8829 <refentrytitle>htmlhelp.display.progress</refentrytitle>
\r
8830 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
8833 <refname>htmlhelp.display.progress</refname>
\r
8834 <refpurpose>Display compile progress?</refpurpose>
\r
8838 <programlisting xml:id="htmlhelp.display.progress.frag">
\r
8839 <xsl:param name="htmlhelp.display.progress" select="1"></xsl:param>
\r
8843 <refsection><info><title>Description</title></info>
\r
8845 <para>Set to non-zero to to display compile progress
\r
8851 <refentry version="5.0" xml:id="htmlhelp.hhp">
\r
8853 <refentrytitle>htmlhelp.hhp</refentrytitle>
\r
8854 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
\r
8857 <refname>htmlhelp.hhp</refname>
\r
8858 <refpurpose>Filename of project file.</refpurpose>
\r
8862 <programlisting xml:id="htmlhelp.hhp.frag">
\r
8863 <xsl:param name="htmlhelp.hhp">htmlhelp.hhp</xsl:param>
\r
8867 <refsection><info><title>Description</title></info>
\r
8869 <para>Change this parameter if you want different name of project
\r
8870 file than htmlhelp.hhp.</para>
\r
8875 <refentry version="5.0" xml:id="htmlhelp.hhc">
\r
8877 <refentrytitle>htmlhelp.hhc</refentrytitle>
\r
8878 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
\r
8881 <refname>htmlhelp.hhc</refname>
\r
8882 <refpurpose>Filename of TOC file.</refpurpose>
\r
8886 <programlisting xml:id="htmlhelp.hhc.frag">
\r
8887 <xsl:param name="htmlhelp.hhc">toc.hhc</xsl:param>
\r
8891 <refsection><info><title>Description</title></info>
\r
8893 <para>Set the name of the TOC file. The default is <filename>toc.hhc</filename>.</para>
\r
8898 <refentry version="5.0" xml:id="htmlhelp.hhk">
\r
8900 <refentrytitle>htmlhelp.hhk</refentrytitle>
\r
8901 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
\r
8904 <refname>htmlhelp.hhk</refname>
\r
8905 <refpurpose>Filename of index file.</refpurpose>
\r
8909 <programlisting xml:id="htmlhelp.hhk.frag">
\r
8910 <xsl:param name="htmlhelp.hhk">index.hhk</xsl:param>
\r
8914 <refsection><info><title>Description</title></info>
\r
8916 <para>set the name of the index file. The default is <filename>index.hhk</filename>.</para>
\r
8921 <refentry version="5.0" xml:id="htmlhelp.hhp.tail">
\r
8923 <refentrytitle>htmlhelp.hhp.tail</refentrytitle>
\r
8924 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
\r
8927 <refname>htmlhelp.hhp.tail</refname>
\r
8928 <refpurpose>Additional content for project file.</refpurpose>
\r
8932 <programlisting xml:id="htmlhelp.hhp.tail.frag">
\r
8933 <xsl:param name="htmlhelp.hhp.tail"></xsl:param>
\r
8937 <refsection><info><title>Description</title></info>
\r
8939 <para>If you want to include some additional parameters into project file,
\r
8940 store appropriate part of project file into this parameter.</para>
\r
8945 <refentry version="5.0" xml:id="htmlhelp.hhp.window">
\r
8947 <refentrytitle>htmlhelp.hhp.window</refentrytitle>
\r
8948 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
\r
8951 <refname>htmlhelp.hhp.window</refname>
\r
8952 <refpurpose>Name of default window.</refpurpose>
\r
8956 <programlisting xml:id="htmlhelp.hhp.window.frag">
\r
8957 <xsl:param name="htmlhelp.hhp.window">Main</xsl:param>
\r
8961 <refsection><info><title>Description</title></info>
\r
8963 <para>Name of default window. If empty no [WINDOWS] section will be
\r
8964 added to project file.</para>
\r
8969 <refentry version="5.0" xml:id="htmlhelp.hhp.windows">
\r
8971 <refentrytitle>htmlhelp.hhp.windows</refentrytitle>
\r
8972 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
\r
8975 <refname>htmlhelp.hhp.windows</refname>
\r
8976 <refpurpose>Definition of additional windows</refpurpose>
\r
8980 <programlisting xml:id="htmlhelp.hhp.windows.frag">
\r
8981 <xsl:param name="htmlhelp.hhp.windows"></xsl:param>
\r
8985 <refsection><info><title>Description</title></info>
\r
8987 <para>Content of this parameter is placed at the end of [WINDOWS]
\r
8988 section of project file. You can use it for defining your own
\r
8989 addtional windows.</para>
\r
8994 <refentry version="5.0" xml:id="htmlhelp.enhanced.decompilation">
\r
8996 <refentrytitle>htmlhelp.enhanced.decompilation</refentrytitle>
\r
8997 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
9000 <refname>htmlhelp.enhanced.decompilation</refname>
\r
9001 <refpurpose>Allow enhanced decompilation of CHM?</refpurpose>
\r
9005 <programlisting xml:id="htmlhelp.enhanced.decompilation.frag">
\r
9006 <xsl:param name="htmlhelp.enhanced.decompilation" select="0"></xsl:param>
\r
9010 <refsection><info><title>Description</title></info>
\r
9012 <para>When non-zero this parameter enables enhanced decompilation of CHM.</para>
\r
9017 <refentry version="5.0" xml:id="htmlhelp.enumerate.images">
\r
9019 <refentrytitle>htmlhelp.enumerate.images</refentrytitle>
\r
9020 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
9023 <refname>htmlhelp.enumerate.images</refname>
\r
9024 <refpurpose>Should the paths to all used images be added to the project file?</refpurpose>
\r
9028 <programlisting xml:id="htmlhelp.enumerate.images.frag">
\r
9029 <xsl:param name="htmlhelp.enumerate.images" select="0"></xsl:param>
\r
9033 <refsection><info><title>Description</title></info>
\r
9035 <para>Set to non-zero if you insert images into your documents as
\r
9036 external binary entities or if you are using absolute image paths.</para>
\r
9041 <refentry version="5.0" xml:id="htmlhelp.force.map.and.alias">
\r
9043 <refentrytitle>htmlhelp.force.map.and.alias</refentrytitle>
\r
9044 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
9047 <refname>htmlhelp.force.map.and.alias</refname>
\r
9048 <refpurpose>Should [MAP] and [ALIAS] sections be added to the project file unconditionally?</refpurpose>
\r
9051 <programlisting xml:id="htmlhelp.force.map.and.alias.frag">
\r
9052 <xsl:param name="htmlhelp.force.map.and.alias" select="0"></xsl:param>
\r
9055 <refsection><info><title>Description</title></info>
\r
9056 <para>Set to non-zero if you have your own
\r
9057 <literal>alias.h</literal> and <literal>context.h</literal>
\r
9058 files and you want to include references to them in the project
\r
9063 <refentry version="5.0" xml:id="htmlhelp.map.file">
\r
9065 <refentrytitle>htmlhelp.map.file</refentrytitle>
\r
9066 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
\r
9069 <refname>htmlhelp.map.file</refname>
\r
9070 <refpurpose>Filename of map file.</refpurpose>
\r
9073 <programlisting xml:id="htmlhelp.map.file.frag">
\r
9074 <xsl:param name="htmlhelp.map.file">context.h</xsl:param>
\r
9077 <refsection><info><title>Description</title></info>
\r
9078 <para>Set the name of map file. The default is
\r
9079 <filename>context.h</filename>. (used for context-sensitive
\r
9084 <refentry version="5.0" xml:id="htmlhelp.alias.file">
\r
9086 <refentrytitle>htmlhelp.alias.file</refentrytitle>
\r
9087 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
\r
9090 <refname>htmlhelp.alias.file</refname>
\r
9091 <refpurpose>Filename of alias file.</refpurpose>
\r
9095 <programlisting xml:id="htmlhelp.alias.file.frag">
\r
9096 <xsl:param name="htmlhelp.alias.file">alias.h</xsl:param>
\r
9100 <refsection><info><title>Description</title></info>
\r
9102 <para>Specifies the filename of the alias file (used for context-sensitive help).</para>
\r
9107 <refentry version="5.0" xml:id="htmlhelp.hhc.section.depth">
\r
9109 <refentrytitle>htmlhelp.hhc.section.depth</refentrytitle>
\r
9110 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
\r
9113 <refname>htmlhelp.hhc.section.depth</refname>
\r
9114 <refpurpose>Depth of TOC for sections in a left pane.</refpurpose>
\r
9118 <programlisting xml:id="htmlhelp.hhc.section.depth.frag">
\r
9119 <xsl:param name="htmlhelp.hhc.section.depth">5</xsl:param>
\r
9123 <refsection><info><title>Description</title></info>
\r
9125 <para>Set the section depth in the left pane of HTML Help viewer. </para>
\r
9130 <refentry version="5.0" xml:id="htmlhelp.hhc.show.root">
\r
9132 <refentrytitle>htmlhelp.hhc.show.root</refentrytitle>
\r
9133 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
9136 <refname>htmlhelp.hhc.show.root</refname>
\r
9137 <refpurpose>Should there be an entry for the root element in the ToC?</refpurpose>
\r
9141 <programlisting xml:id="htmlhelp.hhc.show.root.frag">
\r
9142 <xsl:param name="htmlhelp.hhc.show.root" select="1"></xsl:param>
\r
9146 <refsection><info><title>Description</title></info>
\r
9148 <para>If set to zero, there will be no entry for the root element in the
\r
9149 ToC. This is useful when you want to provide the user with an expanded
\r
9150 ToC as a default.</para>
\r
9155 <refentry version="5.0" xml:id="htmlhelp.hhc.folders.instead.books">
\r
9157 <refentrytitle>htmlhelp.hhc.folders.instead.books</refentrytitle>
\r
9158 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
9161 <refname>htmlhelp.hhc.folders.instead.books</refname>
\r
9162 <refpurpose>Use folder icons in ToC (instead of book icons)?</refpurpose>
\r
9166 <programlisting xml:id="htmlhelp.hhc.folders.instead.books.frag">
\r
9167 <xsl:param name="htmlhelp.hhc.folders.instead.books" select="1"></xsl:param>
\r
9171 <refsection><info><title>Description</title></info>
\r
9173 <para>Set non-zero for folder-like icons or zero for book-like icons in the TOC
\r
9174 ToC. If you want to use folder-like icons you must swith off binary
\r
9175 ToC using (xref) <parameter>htmlhelp.hhc.binary</parameter>.
\r
9184 <refentry version="5.0" xml:id="htmlhelp.hhc.binary">
\r
9186 <refentrytitle>htmlhelp.hhc.binary</refentrytitle>
\r
9187 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
9190 <refname>htmlhelp.hhc.binary</refname>
\r
9191 <refpurpose>Generate binary ToC?</refpurpose>
\r
9195 <programlisting xml:id="htmlhelp.hhc.binary.frag">
\r
9196 <xsl:param name="htmlhelp.hhc.binary" select="1"></xsl:param>
\r
9200 <refsection><info><title>Description</title></info>
\r
9202 <para>Set to non-zero to generate a binary TOC. You must create a binary TOC
\r
9203 if you want to add Prev/Next buttons to toolbar (which is default
\r
9204 behaviour). Files with binary TOC can't be merged.</para>
\r
9209 <refentry version="5.0" xml:id="htmlhelp.hhc.width">
\r
9211 <refentrytitle>htmlhelp.hhc.width</refentrytitle>
\r
9212 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
\r
9215 <refname>htmlhelp.hhc.width</refname>
\r
9216 <refpurpose>Width of navigation pane</refpurpose>
\r
9220 <programlisting xml:id="htmlhelp.hhc.width.frag">
\r
9221 <xsl:param name="htmlhelp.hhc.width"></xsl:param>
\r
9225 <refsection><info><title>Description</title></info>
\r
9227 <para>This parameter specifies the width of the navigation pane (containing TOC and
\r
9228 other navigation tabs) in pixels.</para>
\r
9233 <refentry version="5.0" xml:id="htmlhelp.title">
\r
9235 <refentrytitle>htmlhelp.title</refentrytitle>
\r
9236 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
\r
9239 <refname>htmlhelp.title</refname>
\r
9240 <refpurpose>Title of HTML Help</refpurpose>
\r
9244 <programlisting xml:id="htmlhelp.title.frag">
\r
9245 <xsl:param name="htmlhelp.title"></xsl:param>
\r
9249 <refsection><info><title>Description</title></info>
\r
9251 <para>Content of this parameter will be used as a title for generated
\r
9252 HTML Help. If empty, title will be automatically taken from document.</para>
\r
9257 <refentry version="5.0" xml:id="htmlhelp.show.menu">
\r
9259 <refentrytitle>htmlhelp.show.menu</refentrytitle>
\r
9260 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
9263 <refname>htmlhelp.show.menu</refname>
\r
9264 <refpurpose>Should the menu bar be shown?</refpurpose>
\r
9268 <programlisting xml:id="htmlhelp.show.menu.frag">
\r
9269 <xsl:param name="htmlhelp.show.menu" select="0"></xsl:param>
\r
9273 <refsection><info><title>Description</title></info>
\r
9275 <para>Set to non-zero to have an application menu bar in your HTML Help window.
\r
9281 <refentry version="5.0" xml:id="htmlhelp.show.toolbar.text">
\r
9283 <refentrytitle>htmlhelp.show.toolbar.text</refentrytitle>
\r
9284 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
9287 <refname>htmlhelp.show.toolbar.text</refname>
\r
9288 <refpurpose>Show text under toolbar buttons?</refpurpose>
\r
9292 <programlisting xml:id="htmlhelp.show.toolbar.text.frag">
\r
9293 <xsl:param name="htmlhelp.show.toolbar.text" select="1"></xsl:param>
\r
9297 <refsection><info><title>Description</title></info>
\r
9299 <para>Set to non-zero to display texts under toolbar buttons, zero to switch
\r
9300 off displays.</para>
\r
9305 <refentry version="5.0" xml:id="htmlhelp.show.advanced.search">
\r
9307 <refentrytitle>htmlhelp.show.advanced.search</refentrytitle>
\r
9308 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
9311 <refname>htmlhelp.show.advanced.search</refname>
\r
9312 <refpurpose>Should advanced search features be available?</refpurpose>
\r
9316 <programlisting xml:id="htmlhelp.show.advanced.search.frag">
\r
9317 <xsl:param name="htmlhelp.show.advanced.search" select="0"></xsl:param>
\r
9321 <refsection><info><title>Description</title></info>
\r
9323 <para>If you want advanced search features in your help, turn this
\r
9324 parameter to 1.</para>
\r
9329 <refentry version="5.0" xml:id="htmlhelp.show.favorities">
\r
9331 <refentrytitle>htmlhelp.show.favorities</refentrytitle>
\r
9332 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
9335 <refname>htmlhelp.show.favorities</refname>
\r
9336 <refpurpose>Should the Favorites tab be shown?</refpurpose>
\r
9340 <programlisting xml:id="htmlhelp.show.favorities.frag">
\r
9341 <xsl:param name="htmlhelp.show.favorities" select="0"></xsl:param>
\r
9345 <refsection><info><title>Description</title></info>
\r
9347 <para>Set to non-zero to include a Favorites tab in the navigation pane
\r
9348 of the help window.</para>
\r
9353 <refentry version="5.0" xml:id="htmlhelp.button.hideshow">
\r
9355 <refentrytitle>htmlhelp.button.hideshow</refentrytitle>
\r
9356 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
9359 <refname>htmlhelp.button.hideshow</refname>
\r
9360 <refpurpose>Should the Hide/Show button be shown?</refpurpose>
\r
9364 <programlisting xml:id="htmlhelp.button.hideshow.frag">
\r
9365 <xsl:param name="htmlhelp.button.hideshow" select="1"></xsl:param>
\r
9369 <refsection><info><title>Description</title></info>
\r
9371 <para>Set to non-zero to include the Hide/Show button shown on toolbar</para>
\r
9376 <refentry version="5.0" xml:id="htmlhelp.button.back">
\r
9378 <refentrytitle>htmlhelp.button.back</refentrytitle>
\r
9379 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
9382 <refname>htmlhelp.button.back</refname>
\r
9383 <refpurpose>Should the Back button be shown?</refpurpose>
\r
9387 <programlisting xml:id="htmlhelp.button.back.frag">
\r
9388 <xsl:param name="htmlhelp.button.back" select="1"></xsl:param>
\r
9392 <refsection><info><title>Description</title></info>
\r
9394 <para>Set to non-zero to include the Hide/Show button shown on toolbar</para>
\r
9399 <refentry version="5.0" xml:id="htmlhelp.button.forward">
\r
9401 <refentrytitle>htmlhelp.button.forward</refentrytitle>
\r
9402 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
9405 <refname>htmlhelp.button.forward</refname>
\r
9406 <refpurpose>Should the Forward button be shown?</refpurpose>
\r
9410 <programlisting xml:id="htmlhelp.button.forward.frag">
\r
9411 <xsl:param name="htmlhelp.button.forward" select="0"></xsl:param>
\r
9415 <refsection><info><title>Description</title></info>
\r
9417 <para>Set to non-zero to include the Forward button on the toolbar.</para>
\r
9422 <refentry version="5.0" xml:id="htmlhelp.button.stop">
\r
9424 <refentrytitle>htmlhelp.button.stop</refentrytitle>
\r
9425 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
9428 <refname>htmlhelp.button.stop</refname>
\r
9429 <refpurpose>Should the Stop button be shown?</refpurpose>
\r
9433 <programlisting xml:id="htmlhelp.button.stop.frag">
\r
9434 <xsl:param name="htmlhelp.button.stop" select="0"></xsl:param>
\r
9438 <refsection><info><title>Description</title></info>
\r
9440 <para>If you want Stop button shown on toolbar, turn this
\r
9441 parameter to 1.</para>
\r
9446 <refentry version="5.0" xml:id="htmlhelp.button.refresh">
\r
9448 <refentrytitle>htmlhelp.button.refresh</refentrytitle>
\r
9449 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
9452 <refname>htmlhelp.button.refresh</refname>
\r
9453 <refpurpose>Should the Refresh button be shown?</refpurpose>
\r
9457 <programlisting xml:id="htmlhelp.button.refresh.frag">
\r
9458 <xsl:param name="htmlhelp.button.refresh" select="0"></xsl:param>
\r
9462 <refsection><info><title>Description</title></info>
\r
9464 <para>Set to non-zero to include the Stop button on the toolbar.</para>
\r
9469 <refentry version="5.0" xml:id="htmlhelp.button.home">
\r
9471 <refentrytitle>htmlhelp.button.home</refentrytitle>
\r
9472 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
9475 <refname>htmlhelp.button.home</refname>
\r
9476 <refpurpose>Should the Home button be shown?</refpurpose>
\r
9480 <programlisting xml:id="htmlhelp.button.home.frag">
\r
9481 <xsl:param name="htmlhelp.button.home" select="0"></xsl:param>
\r
9485 <refsection><info><title>Description</title></info>
\r
9487 <para>Set to non-zero to include the Home button on the toolbar.</para>
\r
9492 <refentry version="5.0" xml:id="htmlhelp.button.home.url">
\r
9494 <refentrytitle>htmlhelp.button.home.url</refentrytitle>
\r
9495 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
\r
9498 <refname>htmlhelp.button.home.url</refname>
\r
9499 <refpurpose>URL address of page accessible by Home button</refpurpose>
\r
9503 <programlisting xml:id="htmlhelp.button.home.url.frag">
\r
9504 <xsl:param name="htmlhelp.button.home.url"></xsl:param>
\r
9508 <refsection><info><title>Description</title></info>
\r
9510 <para>URL address of page accessible by Home button.</para>
\r
9515 <refentry version="5.0" xml:id="htmlhelp.button.options">
\r
9517 <refentrytitle>htmlhelp.button.options</refentrytitle>
\r
9518 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
9521 <refname>htmlhelp.button.options</refname>
\r
9522 <refpurpose>Should the Options button be shown?</refpurpose>
\r
9526 <programlisting xml:id="htmlhelp.button.options.frag">
\r
9527 <xsl:param name="htmlhelp.button.options" select="1"></xsl:param>
\r
9531 <refsection><info><title>Description</title></info>
\r
9533 <para>If you want Options button shown on toolbar, turn this
\r
9534 parameter to 1.</para>
\r
9539 <refentry version="5.0" xml:id="htmlhelp.button.print">
\r
9541 <refentrytitle>htmlhelp.button.print</refentrytitle>
\r
9542 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
9545 <refname>htmlhelp.button.print</refname>
\r
9546 <refpurpose>Should the Print button be shown?</refpurpose>
\r
9550 <programlisting xml:id="htmlhelp.button.print.frag">
\r
9551 <xsl:param name="htmlhelp.button.print" select="1"></xsl:param>
\r
9555 <refsection><info><title>Description</title></info>
\r
9557 <para>Set to non-zero to include the Print button on the toolbar.
\r
9563 <refentry version="5.0" xml:id="htmlhelp.button.locate">
\r
9565 <refentrytitle>htmlhelp.button.locate</refentrytitle>
\r
9566 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
9569 <refname>htmlhelp.button.locate</refname>
\r
9570 <refpurpose>Should the Locate button be shown?</refpurpose>
\r
9574 <programlisting xml:id="htmlhelp.button.locate.frag">
\r
9575 <xsl:param name="htmlhelp.button.locate" select="0"></xsl:param>
\r
9579 <refsection><info><title>Description</title></info>
\r
9581 <para>If you want Locate button shown on toolbar, turn this
\r
9582 parameter to 1.</para>
\r
9587 <refentry version="5.0" xml:id="htmlhelp.button.jump1">
\r
9589 <refentrytitle>htmlhelp.button.jump1</refentrytitle>
\r
9590 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
9593 <refname>htmlhelp.button.jump1</refname>
\r
9594 <refpurpose>Should the Jump1 button be shown?</refpurpose>
\r
9597 <programlisting xml:id="htmlhelp.button.jump1.frag">
\r
9598 <xsl:param name="htmlhelp.button.jump1" select="0"></xsl:param>
\r
9601 <refsection><info><title>Description</title></info>
\r
9602 <para>Set to non-zero to include the <literal>Jump1</literal> button on the toolbar.</para>
\r
9606 <refentry version="5.0" xml:id="htmlhelp.button.jump1.url">
\r
9608 <refentrytitle>htmlhelp.button.jump1.url</refentrytitle>
\r
9609 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
\r
9612 <refname>htmlhelp.button.jump1.url</refname>
\r
9613 <refpurpose>URL address of page accessible by Jump1 button</refpurpose>
\r
9617 <programlisting xml:id="htmlhelp.button.jump1.url.frag">
\r
9618 <xsl:param name="htmlhelp.button.jump1.url"></xsl:param>
\r
9622 <refsection><info><title>Description</title></info>
\r
9624 <para>URL address of page accessible by Jump1 button.</para>
\r
9629 <refentry version="5.0" xml:id="htmlhelp.button.jump1.title">
\r
9631 <refentrytitle>htmlhelp.button.jump1.title</refentrytitle>
\r
9632 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
\r
9635 <refname>htmlhelp.button.jump1.title</refname>
\r
9636 <refpurpose>Title of Jump1 button</refpurpose>
\r
9640 <programlisting xml:id="htmlhelp.button.jump1.title.frag">
\r
9641 <xsl:param name="htmlhelp.button.jump1.title">User1</xsl:param>
\r
9645 <refsection><info><title>Description</title></info>
\r
9647 <para>Title of Jump1 button.</para>
\r
9652 <refentry version="5.0" xml:id="htmlhelp.button.jump2">
\r
9654 <refentrytitle>htmlhelp.button.jump2</refentrytitle>
\r
9655 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
9658 <refname>htmlhelp.button.jump2</refname>
\r
9659 <refpurpose>Should the Jump2 button be shown?</refpurpose>
\r
9663 <programlisting xml:id="htmlhelp.button.jump2.frag">
\r
9664 <xsl:param name="htmlhelp.button.jump2" select="0"></xsl:param>
\r
9668 <refsection><info><title>Description</title></info>
\r
9670 <para>Set to non-zero to include the Jump2 button on the toolbar.</para>
\r
9675 <refentry version="5.0" xml:id="htmlhelp.button.jump2.url">
\r
9677 <refentrytitle>htmlhelp.button.jump2.url</refentrytitle>
\r
9678 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
\r
9681 <refname>htmlhelp.button.jump2.url</refname>
\r
9682 <refpurpose>URL address of page accessible by Jump2 button</refpurpose>
\r
9686 <programlisting xml:id="htmlhelp.button.jump2.url.frag">
\r
9687 <xsl:param name="htmlhelp.button.jump2.url"></xsl:param>
\r
9691 <refsection><info><title>Description</title></info>
\r
9693 <para>URL address of page accessible by Jump2 button.</para>
\r
9698 <refentry version="5.0" xml:id="htmlhelp.button.jump2.title">
\r
9700 <refentrytitle>htmlhelp.button.jump2.title</refentrytitle>
\r
9701 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
\r
9704 <refname>htmlhelp.button.jump2.title</refname>
\r
9705 <refpurpose>Title of Jump2 button</refpurpose>
\r
9709 <programlisting xml:id="htmlhelp.button.jump2.title.frag">
\r
9710 <xsl:param name="htmlhelp.button.jump2.title">User2</xsl:param>
\r
9714 <refsection><info><title>Description</title></info>
\r
9716 <para>Title of Jump2 button.</para>
\r
9721 <refentry version="5.0" xml:id="htmlhelp.button.next">
\r
9723 <refentrytitle>htmlhelp.button.next</refentrytitle>
\r
9724 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
9727 <refname>htmlhelp.button.next</refname>
\r
9728 <refpurpose>Should the Next button be shown?</refpurpose>
\r
9732 <programlisting xml:id="htmlhelp.button.next.frag">
\r
9733 <xsl:param name="htmlhelp.button.next" select="1"></xsl:param>
\r
9737 <refsection><info><title>Description</title></info>
\r
9739 <para>Set to non-zero to include the Next button on the toolbar.</para>
\r
9744 <refentry version="5.0" xml:id="htmlhelp.button.prev">
\r
9746 <refentrytitle>htmlhelp.button.prev</refentrytitle>
\r
9747 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
9750 <refname>htmlhelp.button.prev</refname>
\r
9751 <refpurpose>Should the Prev button be shown?</refpurpose>
\r
9755 <programlisting xml:id="htmlhelp.button.prev.frag">
\r
9756 <xsl:param name="htmlhelp.button.prev" select="1"></xsl:param>
\r
9760 <refsection><info><title>Description</title></info>
\r
9762 <para>Set to non-zero to include the Prev button on the toolbar.
\r
9768 <refentry version="5.0" xml:id="htmlhelp.button.zoom">
\r
9770 <refentrytitle>htmlhelp.button.zoom</refentrytitle>
\r
9771 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
9774 <refname>htmlhelp.button.zoom</refname>
\r
9775 <refpurpose>Should the Zoom button be shown?</refpurpose>
\r
9779 <programlisting xml:id="htmlhelp.button.zoom.frag">
\r
9780 <xsl:param name="htmlhelp.button.zoom" select="0"></xsl:param>
\r
9784 <refsection><info><title>Description</title></info>
\r
9786 <para>Set to non-zero to include the Zoom button on the toolbar.
\r
9792 <refentry version="5.0" xml:id="htmlhelp.remember.window.position">
\r
9794 <refentrytitle>htmlhelp.remember.window.position</refentrytitle>
\r
9795 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
9798 <refname>htmlhelp.remember.window.position</refname>
\r
9799 <refpurpose>Remember help window position?</refpurpose>
\r
9803 <programlisting xml:id="htmlhelp.remember.window.position.frag">
\r
9804 <xsl:param name="htmlhelp.remember.window.position" select="0"></xsl:param>
\r
9808 <refsection><info><title>Description</title></info>
\r
9810 <para>Set to non-zero to remember help window position between starts.</para>
\r
9815 <refentry version="5.0" xml:id="htmlhelp.window.geometry">
\r
9817 <refentrytitle>htmlhelp.window.geometry</refentrytitle>
\r
9818 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
\r
9821 <refname>htmlhelp.window.geometry</refname>
\r
9822 <refpurpose>Set initial geometry of help window</refpurpose>
\r
9826 <programlisting xml:id="htmlhelp.window.geometry.frag">
\r
9827 <xsl:param name="htmlhelp.window.geometry"></xsl:param>
\r
9831 <refsection><info><title>Description</title></info>
\r
9833 <para>This parameter specifies initial position of help
\r
9834 window. E.g.</para>
\r
9836 <programlisting><xsl:param name="htmlhelp.window.geometry">[160,64,992,704]</xsl:param></programlisting>
\r
9841 <refentry version="5.0" xml:id="htmlhelp.use.hhk">
\r
9843 <refentrytitle>htmlhelp.use.hhk</refentrytitle>
\r
9844 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
9847 <refname>htmlhelp.use.hhk</refname>
\r
9848 <refpurpose>Should the index be built using the HHK file?</refpurpose>
\r
9852 <programlisting xml:id="htmlhelp.use.hhk.frag">
\r
9853 <xsl:param name="htmlhelp.use.hhk" select="0"></xsl:param>
\r
9857 <refsection><info><title>Description</title></info>
\r
9859 <para>If non-zero, the index is created using the HHK file (instead of using <tag role="html">object</tag>
\r
9860 elements in the HTML files). For more information, see <link xmlns:xlink="http://www.w3.org/1999/xlink" role="tcg" xlink:href="HtmlHelp.html#HHGenIndex">Generating an index</link>.</para>
\r
9864 <refentry version="5.0" xml:id="htmlhelp.only">
\r
9866 <refentrytitle>htmlhelp.only</refentrytitle>
\r
9867 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
9870 <refname>htmlhelp.only</refname>
\r
9871 <refpurpose>Should only project files be generated?</refpurpose>
\r
9875 <programlisting xml:id="htmlhelp.only.frag">
\r
9876 <xsl:param name="htmlhelp.only" select="0"></xsl:param>
\r
9880 <refsection><info><title>Description</title></info>
\r
9883 <para>Set to non-zero if you want to play with various HTML Help parameters
\r
9884 and you don't need to regenerate all HTML files. This setting will not
\r
9885 process whole document, only project files (hhp, hhc, hhk,...) will be
\r
9893 <reference xml:id="eclipse_help"><title>Eclipse Help Platform</title>
\r
9894 <refentry version="5.0" xml:id="eclipse.autolabel">
\r
9896 <refentrytitle>eclipse.autolabel</refentrytitle>
\r
9897 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
9900 <refname>eclipse.autolabel</refname>
\r
9901 <refpurpose>Should tree-like ToC use autonumbering feature?</refpurpose>
\r
9905 <programlisting xml:id="eclipse.autolabel.frag">
\r
9906 <xsl:param name="eclipse.autolabel" select="0"></xsl:param>
\r
9910 <refsection><info><title>Description</title></info>
\r
9912 <para>If you want to include chapter and section numbers into ToC in
\r
9913 the left panel, set this parameter to 1.</para>
\r
9918 <refentry version="5.0" xml:id="eclipse.plugin.name">
\r
9920 <refentrytitle>eclipse.plugin.name</refentrytitle>
\r
9921 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
\r
9924 <refname>eclipse.plugin.name</refname>
\r
9925 <refpurpose>Eclipse Help plugin name</refpurpose>
\r
9929 <programlisting xml:id="eclipse.plugin.name.frag">
\r
9930 <xsl:param name="eclipse.plugin.name">DocBook Online Help Sample</xsl:param>
\r
9934 <refsection><info><title>Description</title></info>
\r
9936 <para>Eclipse Help plugin name.</para>
\r
9941 <refentry version="5.0" xml:id="eclipse.plugin.id">
\r
9943 <refentrytitle>eclipse.plugin.id</refentrytitle>
\r
9944 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
\r
9947 <refname>eclipse.plugin.id</refname>
\r
9948 <refpurpose>Eclipse Help plugin id</refpurpose>
\r
9952 <programlisting xml:id="eclipse.plugin.id.frag">
\r
9953 <xsl:param name="eclipse.plugin.id">com.example.help</xsl:param>
\r
9957 <refsection><info><title>Description</title></info>
\r
9959 <para>Eclipse Help plugin id. You should change this id to something
\r
9960 unique for each help.</para>
\r
9965 <refentry version="5.0" xml:id="eclipse.plugin.provider">
\r
9967 <refentrytitle>eclipse.plugin.provider</refentrytitle>
\r
9968 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
\r
9971 <refname>eclipse.plugin.provider</refname>
\r
9972 <refpurpose>Eclipse Help plugin provider name</refpurpose>
\r
9976 <programlisting xml:id="eclipse.plugin.provider.frag">
\r
9977 <xsl:param name="eclipse.plugin.provider">Example provider</xsl:param>
\r
9981 <refsection><info><title>Description</title></info>
\r
9983 <para>Eclipse Help plugin provider name.</para>
\r
9989 <reference xml:id="javahelp"><title>JavaHelp</title>
\r
9990 <refentry version="5.0" xml:id="javahelp.encoding">
\r
9992 <refentrytitle>javahelp.encoding</refentrytitle>
\r
9993 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
\r
9996 <refname>javahelp.encoding</refname>
\r
9997 <refpurpose>Character encoding to use in control files for JavaHelp.</refpurpose>
\r
10001 <programlisting xml:id="javahelp.encoding.frag">
\r
10002 <xsl:param name="javahelp.encoding">iso-8859-1</xsl:param>
\r
10003 </programlisting>
\r
10004 </refsynopsisdiv>
\r
10006 <refsection><info><title>Description</title></info>
\r
10008 <para>JavaHelp crashes on some characters when written as character
\r
10009 references. In that case you can use this parameter to select an appropriate encoding.</para>
\r
10018 <reference xml:id="l10n"><title>Localization</title>
\r
10019 <refentry version="5.0" xml:id="l10n.gentext.language">
\r
10021 <refentrytitle>l10n.gentext.language</refentrytitle>
\r
10022 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
\r
10025 <refname>l10n.gentext.language</refname>
\r
10026 <refpurpose>Sets the gentext language</refpurpose>
\r
10030 <programlisting xml:id="l10n.gentext.language.frag">
\r
10031 <xsl:param name="l10n.gentext.language"></xsl:param>
\r
10032 </programlisting>
\r
10033 </refsynopsisdiv>
\r
10035 <refsection><info><title>Description</title></info>
\r
10037 <para>If this parameter is set to any value other than the empty string, its
\r
10038 value will be used as the value for the language when generating text. Setting
\r
10039 <parameter>l10n.gentext.language</parameter> overrides any settings within the
\r
10040 document being formatted.</para>
\r
10042 <para>It's much more likely that you might want to set the
\r
10043 <parameter>l10n.gentext.default.language</parameter> parameter.</para>
\r
10048 <refentry version="5.0" xml:id="l10n.gentext.default.language">
\r
10050 <refentrytitle>l10n.gentext.default.language</refentrytitle>
\r
10051 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
\r
10054 <refname>l10n.gentext.default.language</refname>
\r
10055 <refpurpose>Sets the default language for generated text</refpurpose>
\r
10059 <programlisting xml:id="l10n.gentext.default.language.frag">
\r
10060 <xsl:param name="l10n.gentext.default.language">en</xsl:param>
\r
10061 </programlisting>
\r
10062 </refsynopsisdiv>
\r
10064 <refsection><info><title>Description</title></info>
\r
10066 <para>The value of the <parameter>l10n.gentext.default.language</parameter>
\r
10067 parameter is used as the language for generated text if no setting is provided
\r
10068 in the source document.</para>
\r
10073 <refentry version="5.0" xml:id="l10n.gentext.use.xref.language">
\r
10075 <refentrytitle>l10n.gentext.use.xref.language</refentrytitle>
\r
10076 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
10079 <refname>l10n.gentext.use.xref.language</refname>
\r
10080 <refpurpose>Use the language of target when generating cross-reference text?</refpurpose>
\r
10084 <programlisting xml:id="l10n.gentext.use.xref.language.frag">
\r
10085 <xsl:param name="l10n.gentext.use.xref.language" select="0"></xsl:param>
\r
10086 </programlisting>
\r
10087 </refsynopsisdiv>
\r
10089 <refsection><info><title>Description</title></info>
\r
10091 <para>If non-zero, the language of the target will be used when
\r
10092 generating cross reference text. Usually, the <quote>current</quote>
\r
10093 language is used when generating text (that is, the language of the
\r
10094 element that contains the cross-reference element). But setting this parameter
\r
10095 allows the language of the element <emphasis>pointed to</emphasis> to control
\r
10096 the generated text.</para>
\r
10098 <para>Consider the following example:</para>
\r
10100 <informalexample>
\r
10101 <programlisting><para lang="en">See also <xref linkend="chap3"/>.</para>
\r
10102 </programlisting>
\r
10103 </informalexample>
\r
10105 <para>Suppose that Chapter 3 happens to be written in German.
\r
10106 If <parameter>l10n.gentext.use.xref.language</parameter> is non-zero, the
\r
10107 resulting text will be something like this:</para>
\r
10110 <para>See also Kapital 3.</para>
\r
10113 <para>Where the more traditional rendering would be:</para>
\r
10116 <para>See also Chapter 3.</para>
\r
10122 <refentry version="5.0" xml:id="l10n.lang.value.rfc.compliant">
\r
10124 <refentrytitle>l10n.lang.value.rfc.compliant</refentrytitle>
\r
10125 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
10128 <refname>l10n.lang.value.rfc.compliant</refname>
\r
10129 <refpurpose>Make value of lang attribute RFC compliant?</refpurpose>
\r
10133 <programlisting xml:id="l10n.lang.value.rfc.compliant.frag">
\r
10134 <xsl:param name="l10n.lang.value.rfc.compliant" select="1"></xsl:param>
\r
10135 </programlisting>
\r
10136 </refsynopsisdiv>
\r
10138 <refsection><info><title>Description</title></info>
\r
10140 <para>If non-zero, ensure that the values for all <tag class="attribute">lang</tag> attributes in HTML output are RFC
\r
10141 compliant<footnote><para>Section 8.1.1, <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://www.w3.org/TR/REC-html40/struct/dirlang.html#h-8.1.1">Language Codes</link>, in the HTML 4.0 Recommendation states that:
\r
10143 <blockquote><para>[RFC1766] defines and explains the language codes
\r
10144 that must be used in HTML documents.</para>
\r
10145 <para>Briefly, language codes consist of a primary code and a possibly
\r
10146 empty series of subcodes:
\r
10148 <literallayout class="monospaced">language-code = primary-code ( "-" subcode )*</literallayout>
\r
10150 <para>And in RFC 1766, <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://www.ietf.org/rfc/rfc1766.txt">Tags for the Identification
\r
10151 of Languages</link>, the EBNF for "language tag" is given as:
\r
10153 <literallayout class="monospaced">Language-Tag = Primary-tag *( "-" Subtag )
\r
10154 Primary-tag = 1*8ALPHA
\r
10155 Subtag = 1*8ALPHA</literallayout>
\r
10158 </para></footnote>.
\r
10160 by taking any underscore characters in any <tag class="attribute">lang</tag> values found in source documents, and
\r
10161 replacing them with hyphen characters in output HTML files. For
\r
10162 example, <literal>zh_CN</literal> in a source document becomes
\r
10163 <literal>zh-CN</literal> in the HTML output form that source.
\r
10166 <para>This parameter does not cause any case change in <tag class="attribute">lang</tag> values, because RFC 1766
\r
10167 explicitly states that all "language tags" (as it calls them) "are
\r
10168 to be treated as case insensitive".</para>
\r
10175 <refentry version="5.0" xml:id="writing.mode">
\r
10177 <refentrytitle>writing.mode</refentrytitle>
\r
10178 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
\r
10181 <refname>writing.mode</refname>
\r
10182 <refpurpose>Direction of text flow based on locale</refpurpose>
\r
10186 <programlisting xml:id="writing.mode.frag">
\r
10187 <xsl:param name="writing.mode">
\r
10188 <xsl:call-template name="gentext">
\r
10189 <xsl:with-param name="key">writing-mode</xsl:with-param>
\r
10190 <xsl:with-param name="lang">
\r
10191 <xsl:call-template name="l10n.language">
\r
10192 <xsl:with-param name="target" select="/*[1]"></xsl:with-param>
\r
10193 </xsl:call-template>
\r
10194 </xsl:with-param>
\r
10195 </xsl:call-template>
\r
10196 </xsl:param>
\r
10197 </programlisting>
\r
10198 </refsynopsisdiv>
\r
10200 <refsection><info><title>Description</title></info>
\r
10202 <para>Sets direction of text flow and text alignment based on locale.
\r
10203 The value is normally taken from the gentext file for the
\r
10204 lang attribute of the document's root element, using the
\r
10205 key name 'writing-mode' to look it up in the gentext file.
\r
10206 But the param can also be
\r
10207 set on the command line to override that gentext value.
\r
10209 <para>Accepted values are:
\r
10212 <term>lr-tb</term>
\r
10214 <para>Left-to-right text flow in each line, lines stack top to bottom.</para>
\r
10218 <term>rl-tb</term>
\r
10220 <para>Right-to-left text flow in each line, lines stack top to bottom.</para>
\r
10224 <term>tb-rl</term>
\r
10226 <para>Top-to-bottom text flow in each vertical line, lines stack right to left.
\r
10227 Supported by only a few XSL-FO processors. Not supported in HTML output.</para>
\r
10233 <para>Shorthand for lr-tb.</para>
\r
10239 <para>Shorthand for rl-tb.</para>
\r
10245 <para>Shorthand for tb-rl.</para>
\r
10255 <appendix xml:id="stylesheet"><title>The Stylesheet</title>
\r
10257 <para>The <filename>param.xsl</filename> stylesheet is just a wrapper
\r
10258 around all these parameters.</para>
\r
10260 <programlisting xml:id="top">
\r
10262 <!-- This file is generated from param.xweb -->
\r
10264 <xsl:stylesheet exclude-result-prefixes="src" version="1.0">
\r
10266 <!-- ********************************************************************
\r
10267 $Id: param.xweb 8345 2009-03-16 06:44:07Z bobstayton $
\r
10268 ********************************************************************
\r
10270 This file is part of the XSL DocBook Stylesheet distribution.
\r
10271 See ../README or http://docbook.sf.net/release/xsl/current/ for
\r
10272 copyright and other information.
\r
10274 ******************************************************************** -->
\r
10276 <src:fragref linkend="admon.graphics.extension.frag"></src:fragref>
\r
10277 <src:fragref linkend="admon.graphics.frag"></src:fragref>
\r
10278 <src:fragref linkend="admon.graphics.path.frag"></src:fragref>
\r
10279 <src:fragref linkend="admon.style.frag"></src:fragref>
\r
10280 <src:fragref linkend="admon.textlabel.frag"></src:fragref>
\r
10281 <src:fragref linkend="annotate.toc.frag"></src:fragref>
\r
10282 <src:fragref linkend="annotation.css.frag"></src:fragref>
\r
10283 <src:fragref linkend="annotation.js.frag"></src:fragref>
\r
10284 <src:fragref linkend="annotation.graphic.open.frag"></src:fragref>
\r
10285 <src:fragref linkend="annotation.graphic.close.frag"></src:fragref>
\r
10286 <src:fragref linkend="annotation.support.frag"></src:fragref>
\r
10287 <src:fragref linkend="appendix.autolabel.frag"></src:fragref>
\r
10288 <src:fragref linkend="author.othername.in.middle.frag"></src:fragref>
\r
10289 <src:fragref linkend="autotoc.label.separator.frag"></src:fragref>
\r
10290 <src:fragref linkend="autotoc.label.in.hyperlink.frag"></src:fragref>
\r
10291 <src:fragref linkend="base.dir.frag"></src:fragref>
\r
10292 <src:fragref linkend="biblioentry.item.separator.frag"></src:fragref>
\r
10293 <src:fragref linkend="bibliography.collection.frag"></src:fragref>
\r
10294 <src:fragref linkend="bibliography.numbered.frag"></src:fragref>
\r
10295 <src:fragref linkend="bibliography.style.frag"></src:fragref>
\r
10296 <src:fragref linkend="blurb.on.titlepage.enabled.frag"></src:fragref>
\r
10297 <src:fragref linkend="bridgehead.in.toc.frag"></src:fragref>
\r
10298 <src:fragref linkend="callout.defaultcolumn.frag"></src:fragref>
\r
10299 <src:fragref linkend="callout.graphics.extension.frag"></src:fragref>
\r
10300 <src:fragref linkend="callout.graphics.frag"></src:fragref>
\r
10301 <src:fragref linkend="callout.graphics.number.limit.frag"></src:fragref>
\r
10302 <src:fragref linkend="callout.graphics.path.frag"></src:fragref>
\r
10303 <src:fragref linkend="callout.list.table.frag"></src:fragref>
\r
10304 <src:fragref linkend="callout.unicode.frag"></src:fragref>
\r
10305 <src:fragref linkend="callout.unicode.number.limit.frag"></src:fragref>
\r
10306 <src:fragref linkend="callout.unicode.start.character.frag"></src:fragref>
\r
10307 <src:fragref linkend="callouts.extension.frag"></src:fragref>
\r
10308 <src:fragref linkend="chapter.autolabel.frag"></src:fragref>
\r
10309 <src:fragref linkend="chunk.append.frag"></src:fragref>
\r
10310 <src:fragref linkend="chunk.first.sections.frag"></src:fragref>
\r
10311 <src:fragref linkend="chunk.quietly.frag"></src:fragref>
\r
10312 <src:fragref linkend="chunk.section.depth.frag"></src:fragref>
\r
10313 <src:fragref linkend="chunk.toc.frag"></src:fragref>
\r
10314 <src:fragref linkend="chunk.tocs.and.lots.frag"></src:fragref>
\r
10315 <src:fragref linkend="chunk.tocs.and.lots.has.title.frag"></src:fragref>
\r
10316 <src:fragref linkend="chunk.separate.lots.frag"></src:fragref>
\r
10317 <src:fragref linkend="citerefentry.link.frag"></src:fragref>
\r
10318 <src:fragref linkend="collect.xref.targets.frag"></src:fragref>
\r
10319 <src:fragref linkend="component.label.includes.part.label.frag"></src:fragref>
\r
10320 <src:fragref linkend="contrib.inline.enabled.frag"></src:fragref>
\r
10321 <src:fragref linkend="css.decoration.frag"></src:fragref>
\r
10322 <src:fragref linkend="current.docid.frag"></src:fragref>
\r
10323 <src:fragref linkend="default.float.class.frag"></src:fragref>
\r
10324 <src:fragref linkend="default.image.width.frag"></src:fragref>
\r
10325 <src:fragref linkend="default.table.width.frag"></src:fragref>
\r
10326 <src:fragref linkend="default.table.frame.frag"></src:fragref>
\r
10327 <src:fragref linkend="draft.mode.frag"></src:fragref>
\r
10328 <src:fragref linkend="draft.watermark.image.frag"></src:fragref>
\r
10329 <src:fragref linkend="ebnf.table.bgcolor.frag"></src:fragref>
\r
10330 <src:fragref linkend="ebnf.table.border.frag"></src:fragref>
\r
10331 <src:fragref linkend="ebnf.assignment.frag"></src:fragref>
\r
10332 <src:fragref linkend="ebnf.statement.terminator.frag"></src:fragref>
\r
10333 <src:fragref linkend="eclipse.autolabel.frag"></src:fragref>
\r
10334 <src:fragref linkend="eclipse.plugin.name.frag"></src:fragref>
\r
10335 <src:fragref linkend="eclipse.plugin.id.frag"></src:fragref>
\r
10336 <src:fragref linkend="eclipse.plugin.provider.frag"></src:fragref>
\r
10337 <src:fragref linkend="editedby.enabled.frag"></src:fragref>
\r
10338 <src:fragref linkend="email.delimiters.enabled.frag"></src:fragref>
\r
10339 <src:fragref linkend="emphasis.propagates.style.frag"></src:fragref>
\r
10340 <src:fragref linkend="entry.propagates.style.frag"></src:fragref>
\r
10341 <src:fragref linkend="exsl.node.set.available.frag"></src:fragref>
\r
10342 <src:fragref linkend="firstterm.only.link.frag"></src:fragref>
\r
10343 <src:fragref linkend="footer.rule.frag"></src:fragref>
\r
10344 <src:fragref linkend="footnote.number.format.frag"></src:fragref>
\r
10345 <src:fragref linkend="footnote.number.symbols.frag"></src:fragref>
\r
10346 <src:fragref linkend="formal.procedures.frag"></src:fragref>
\r
10347 <src:fragref linkend="formal.title.placement.frag"></src:fragref>
\r
10348 <src:fragref linkend="funcsynopsis.decoration.frag"></src:fragref>
\r
10349 <src:fragref linkend="funcsynopsis.style.frag"></src:fragref>
\r
10350 <src:fragref linkend="function.parens.frag"></src:fragref>
\r
10351 <src:fragref linkend="generate.id.attributes.frag"></src:fragref>
\r
10352 <src:fragref linkend="generate.index.frag"></src:fragref>
\r
10353 <src:fragref linkend="generate.legalnotice.link.frag"></src:fragref>
\r
10354 <src:fragref linkend="generate.revhistory.link.frag"></src:fragref>
\r
10355 <src:fragref linkend="generate.manifest.frag"></src:fragref>
\r
10356 <src:fragref linkend="generate.meta.abstract.frag"></src:fragref>
\r
10357 <src:fragref linkend="generate.section.toc.level.frag"></src:fragref>
\r
10358 <src:fragref linkend="generate.toc.frag"></src:fragref>
\r
10359 <src:fragref linkend="glossary.collection.frag"></src:fragref>
\r
10360 <src:fragref linkend="glossary.sort.frag"></src:fragref>
\r
10361 <src:fragref linkend="glossentry.show.acronym.frag"></src:fragref>
\r
10362 <src:fragref linkend="glossterm.auto.link.frag"></src:fragref>
\r
10363 <src:fragref linkend="graphic.default.extension.frag"></src:fragref>
\r
10364 <src:fragref linkend="graphicsize.extension.frag"></src:fragref>
\r
10365 <src:fragref linkend="graphicsize.use.img.src.path.frag"></src:fragref>
\r
10366 <src:fragref linkend="header.rule.frag"></src:fragref>
\r
10367 <src:fragref linkend="highlight.default.language.frag"></src:fragref>
\r
10368 <src:fragref linkend="highlight.source.frag"></src:fragref>
\r
10369 <src:fragref linkend="highlight.xslthl.config.frag"></src:fragref>
\r
10370 <src:fragref linkend="html.append.frag"></src:fragref>
\r
10371 <src:fragref linkend="html.base.frag"></src:fragref>
\r
10372 <src:fragref linkend="html.cellpadding.frag"></src:fragref>
\r
10373 <src:fragref linkend="html.cellspacing.frag"></src:fragref>
\r
10374 <src:fragref linkend="html.cleanup.frag"></src:fragref>
\r
10375 <src:fragref linkend="html.ext.frag"></src:fragref>
\r
10376 <src:fragref linkend="html.extra.head.links.frag"></src:fragref>
\r
10377 <src:fragref linkend="html.head.legalnotice.link.types.frag"></src:fragref>
\r
10378 <src:fragref linkend="html.head.legalnotice.link.multiple.frag"></src:fragref>
\r
10379 <src:fragref linkend="html.longdesc.frag"></src:fragref>
\r
10380 <src:fragref linkend="html.longdesc.link.frag"></src:fragref>
\r
10381 <src:fragref linkend="html.stylesheet.frag"></src:fragref>
\r
10382 <src:fragref linkend="html.stylesheet.type.frag"></src:fragref>
\r
10383 <src:fragref linkend="htmlhelp.alias.file.frag"></src:fragref>
\r
10384 <src:fragref linkend="htmlhelp.autolabel.frag"></src:fragref>
\r
10385 <src:fragref linkend="htmlhelp.button.back.frag"></src:fragref>
\r
10386 <src:fragref linkend="htmlhelp.button.forward.frag"></src:fragref>
\r
10387 <src:fragref linkend="htmlhelp.button.hideshow.frag"></src:fragref>
\r
10388 <src:fragref linkend="htmlhelp.button.home.frag"></src:fragref>
\r
10389 <src:fragref linkend="htmlhelp.button.home.url.frag"></src:fragref>
\r
10390 <src:fragref linkend="htmlhelp.button.jump1.frag"></src:fragref>
\r
10391 <src:fragref linkend="htmlhelp.button.jump1.title.frag"></src:fragref>
\r
10392 <src:fragref linkend="htmlhelp.button.jump1.url.frag"></src:fragref>
\r
10393 <src:fragref linkend="htmlhelp.button.jump2.frag"></src:fragref>
\r
10394 <src:fragref linkend="htmlhelp.button.jump2.title.frag"></src:fragref>
\r
10395 <src:fragref linkend="htmlhelp.button.jump2.url.frag"></src:fragref>
\r
10396 <src:fragref linkend="htmlhelp.button.locate.frag"></src:fragref>
\r
10397 <src:fragref linkend="htmlhelp.button.next.frag"></src:fragref>
\r
10398 <src:fragref linkend="htmlhelp.button.options.frag"></src:fragref>
\r
10399 <src:fragref linkend="htmlhelp.button.prev.frag"></src:fragref>
\r
10400 <src:fragref linkend="htmlhelp.button.print.frag"></src:fragref>
\r
10401 <src:fragref linkend="htmlhelp.button.refresh.frag"></src:fragref>
\r
10402 <src:fragref linkend="htmlhelp.button.stop.frag"></src:fragref>
\r
10403 <src:fragref linkend="htmlhelp.button.zoom.frag"></src:fragref>
\r
10404 <src:fragref linkend="htmlhelp.chm.frag"></src:fragref>
\r
10405 <src:fragref linkend="htmlhelp.default.topic.frag"></src:fragref>
\r
10406 <src:fragref linkend="htmlhelp.display.progress.frag"></src:fragref>
\r
10407 <src:fragref linkend="htmlhelp.encoding.frag"></src:fragref>
\r
10408 <src:fragref linkend="htmlhelp.enhanced.decompilation.frag"></src:fragref>
\r
10409 <src:fragref linkend="htmlhelp.enumerate.images.frag"></src:fragref>
\r
10410 <src:fragref linkend="htmlhelp.force.map.and.alias.frag"></src:fragref>
\r
10411 <src:fragref linkend="htmlhelp.hhc.binary.frag"></src:fragref>
\r
10412 <src:fragref linkend="htmlhelp.hhc.folders.instead.books.frag"></src:fragref>
\r
10413 <src:fragref linkend="htmlhelp.hhc.frag"></src:fragref>
\r
10414 <src:fragref linkend="htmlhelp.hhc.section.depth.frag"></src:fragref>
\r
10415 <src:fragref linkend="htmlhelp.hhc.show.root.frag"></src:fragref>
\r
10416 <src:fragref linkend="htmlhelp.hhc.width.frag"></src:fragref>
\r
10417 <src:fragref linkend="htmlhelp.hhk.frag"></src:fragref>
\r
10418 <src:fragref linkend="htmlhelp.hhp.frag"></src:fragref>
\r
10419 <src:fragref linkend="htmlhelp.hhp.tail.frag"></src:fragref>
\r
10420 <src:fragref linkend="htmlhelp.hhp.window.frag"></src:fragref>
\r
10421 <src:fragref linkend="htmlhelp.hhp.windows.frag"></src:fragref>
\r
10422 <src:fragref linkend="htmlhelp.map.file.frag"></src:fragref>
\r
10423 <src:fragref linkend="htmlhelp.only.frag"></src:fragref>
\r
10424 <src:fragref linkend="htmlhelp.remember.window.position.frag"></src:fragref>
\r
10425 <src:fragref linkend="htmlhelp.show.advanced.search.frag"></src:fragref>
\r
10426 <src:fragref linkend="htmlhelp.show.favorities.frag"></src:fragref>
\r
10427 <src:fragref linkend="htmlhelp.show.menu.frag"></src:fragref>
\r
10428 <src:fragref linkend="htmlhelp.show.toolbar.text.frag"></src:fragref>
\r
10429 <src:fragref linkend="htmlhelp.title.frag"></src:fragref>
\r
10430 <src:fragref linkend="htmlhelp.use.hhk.frag"></src:fragref>
\r
10431 <src:fragref linkend="htmlhelp.window.geometry.frag"></src:fragref>
\r
10432 <src:fragref linkend="img.src.path.frag"></src:fragref>
\r
10433 <src:fragref linkend="id.warnings.frag"></src:fragref>
\r
10434 <src:fragref linkend="index.method.frag"></src:fragref>
\r
10435 <src:fragref linkend="index.on.role.frag"></src:fragref>
\r
10436 <src:fragref linkend="index.links.to.section.frag"></src:fragref>
\r
10437 <src:fragref linkend="index.on.type.frag"></src:fragref>
\r
10438 <src:fragref linkend="index.number.separator.frag"></src:fragref>
\r
10439 <src:fragref linkend="index.term.separator.frag"></src:fragref>
\r
10440 <src:fragref linkend="index.range.separator.frag"></src:fragref>
\r
10441 <src:fragref linkend="index.prefer.titleabbrev.frag"></src:fragref>
\r
10442 <src:fragref linkend="ignore.image.scaling.frag"></src:fragref>
\r
10443 <src:fragref linkend="inherit.keywords.frag"></src:fragref>
\r
10444 <src:fragref linkend="insert.xref.page.number.frag"></src:fragref>
\r
10445 <src:fragref linkend="javahelp.encoding.frag"></src:fragref>
\r
10446 <src:fragref linkend="keep.relative.image.uris.frag"></src:fragref>
\r
10447 <src:fragref linkend="l10n.gentext.default.language.frag"></src:fragref>
\r
10448 <src:fragref linkend="l10n.gentext.language.frag"></src:fragref>
\r
10449 <src:fragref linkend="l10n.gentext.use.xref.language.frag"></src:fragref>
\r
10450 <src:fragref linkend="l10n.lang.value.rfc.compliant.frag"></src:fragref>
\r
10451 <src:fragref linkend="label.from.part.frag"></src:fragref>
\r
10452 <src:fragref linkend="linenumbering.everyNth.frag"></src:fragref>
\r
10453 <src:fragref linkend="linenumbering.extension.frag"></src:fragref>
\r
10454 <src:fragref linkend="linenumbering.separator.frag"></src:fragref>
\r
10455 <src:fragref linkend="linenumbering.width.frag"></src:fragref>
\r
10456 <src:fragref linkend="link.mailto.url.frag"></src:fragref>
\r
10457 <src:fragref linkend="make.graphic.viewport.frag"></src:fragref>
\r
10458 <src:fragref linkend="make.single.year.ranges.frag"></src:fragref>
\r
10459 <src:fragref linkend="make.valid.html.frag"></src:fragref>
\r
10460 <src:fragref linkend="make.year.ranges.frag"></src:fragref>
\r
10461 <src:fragref linkend="manifest.frag"></src:fragref>
\r
10462 <src:fragref linkend="manifest.in.base.dir.frag"></src:fragref>
\r
10463 <src:fragref linkend="manual.toc.frag"></src:fragref>
\r
10464 <src:fragref linkend="menuchoice.menu.separator.frag"></src:fragref>
\r
10465 <src:fragref linkend="menuchoice.separator.frag"></src:fragref>
\r
10466 <src:fragref linkend="navig.graphics.extension.frag"></src:fragref>
\r
10467 <src:fragref linkend="navig.graphics.frag"></src:fragref>
\r
10468 <src:fragref linkend="navig.graphics.path.frag"></src:fragref>
\r
10469 <src:fragref linkend="navig.showtitles.frag"></src:fragref>
\r
10470 <src:fragref linkend="nominal.image.depth.frag"></src:fragref>
\r
10471 <src:fragref linkend="nominal.image.width.frag"></src:fragref>
\r
10472 <src:fragref linkend="nominal.table.width.frag"></src:fragref>
\r
10473 <src:fragref linkend="olink.base.uri.frag"></src:fragref>
\r
10474 <src:fragref linkend="olink.debug.frag"></src:fragref>
\r
10475 <src:fragref linkend="olink.properties.frag"></src:fragref>
\r
10476 <src:fragref linkend="insert.olink.page.number.frag"></src:fragref>
\r
10477 <src:fragref linkend="insert.olink.pdf.frag.frag"></src:fragref>
\r
10478 <src:fragref linkend="prefer.internal.olink.frag"></src:fragref>
\r
10479 <src:fragref linkend="olink.lang.fallback.sequence.frag"></src:fragref>
\r
10480 <src:fragref linkend="olink.doctitle.frag"></src:fragref>
\r
10481 <src:fragref linkend="olink.fragid.frag"></src:fragref>
\r
10482 <src:fragref linkend="olink.outline.ext.frag"></src:fragref>
\r
10483 <src:fragref linkend="olink.pubid.frag"></src:fragref>
\r
10484 <src:fragref linkend="olink.resolver.frag"></src:fragref>
\r
10485 <src:fragref linkend="olink.sysid.frag"></src:fragref>
\r
10486 <src:fragref linkend="abstract.notitle.enabled.frag"></src:fragref>
\r
10487 <src:fragref linkend="othercredit.like.author.enabled.frag"></src:fragref>
\r
10488 <src:fragref linkend="para.propagates.style.frag"></src:fragref>
\r
10489 <src:fragref linkend="part.autolabel.frag"></src:fragref>
\r
10490 <src:fragref linkend="phrase.propagates.style.frag"></src:fragref>
\r
10491 <src:fragref linkend="pixels.per.inch.frag"></src:fragref>
\r
10492 <src:fragref linkend="points.per.em.frag"></src:fragref>
\r
10493 <src:fragref linkend="preface.autolabel.frag"></src:fragref>
\r
10494 <src:fragref linkend="preferred.mediaobject.role.frag"></src:fragref>
\r
10495 <src:fragref linkend="process.empty.source.toc.frag"></src:fragref>
\r
10496 <src:fragref linkend="process.source.toc.frag"></src:fragref>
\r
10497 <src:fragref linkend="profile.arch.frag"></src:fragref>
\r
10498 <src:fragref linkend="profile.audience.frag"></src:fragref>
\r
10499 <src:fragref linkend="profile.attribute.frag"></src:fragref>
\r
10500 <src:fragref linkend="profile.condition.frag"></src:fragref>
\r
10501 <src:fragref linkend="profile.conformance.frag"></src:fragref>
\r
10502 <src:fragref linkend="profile.lang.frag"></src:fragref>
\r
10503 <src:fragref linkend="profile.os.frag"></src:fragref>
\r
10504 <src:fragref linkend="profile.revision.frag"></src:fragref>
\r
10505 <src:fragref linkend="profile.revisionflag.frag"></src:fragref>
\r
10506 <src:fragref linkend="profile.role.frag"></src:fragref>
\r
10507 <src:fragref linkend="profile.security.frag"></src:fragref>
\r
10508 <src:fragref linkend="profile.separator.frag"></src:fragref>
\r
10509 <src:fragref linkend="profile.status.frag"></src:fragref>
\r
10510 <src:fragref linkend="profile.userlevel.frag"></src:fragref>
\r
10511 <src:fragref linkend="profile.value.frag"></src:fragref>
\r
10512 <src:fragref linkend="profile.vendor.frag"></src:fragref>
\r
10513 <src:fragref linkend="profile.wordsize.frag"></src:fragref>
\r
10514 <src:fragref linkend="punct.honorific.frag"></src:fragref>
\r
10515 <src:fragref linkend="qanda.defaultlabel.frag"></src:fragref>
\r
10516 <src:fragref linkend="qanda.inherit.numeration.frag"></src:fragref>
\r
10517 <src:fragref linkend="qanda.in.toc.frag"></src:fragref>
\r
10518 <src:fragref linkend="qanda.nested.in.toc.frag"></src:fragref>
\r
10519 <src:fragref linkend="qandadiv.autolabel.frag"></src:fragref>
\r
10520 <src:fragref linkend="refentry.generate.name.frag"></src:fragref>
\r
10521 <src:fragref linkend="refentry.generate.title.frag"></src:fragref>
\r
10522 <src:fragref linkend="refentry.separator.frag"></src:fragref>
\r
10523 <src:fragref linkend="refentry.xref.manvolnum.frag"></src:fragref>
\r
10524 <src:fragref linkend="reference.autolabel.frag"></src:fragref>
\r
10525 <src:fragref linkend="refclass.suppress.frag"></src:fragref>
\r
10526 <src:fragref linkend="root.filename.frag"></src:fragref>
\r
10527 <src:fragref linkend="rootid.frag"></src:fragref>
\r
10528 <src:fragref linkend="runinhead.default.title.end.punct.frag"></src:fragref>
\r
10529 <src:fragref linkend="runinhead.title.end.punct.frag"></src:fragref>
\r
10530 <src:fragref linkend="section.autolabel.frag"></src:fragref>
\r
10531 <src:fragref linkend="section.autolabel.max.depth.frag"></src:fragref>
\r
10532 <src:fragref linkend="section.label.includes.component.label.frag"></src:fragref>
\r
10533 <src:fragref linkend="segmentedlist.as.table.frag"></src:fragref>
\r
10534 <src:fragref linkend="shade.verbatim.frag"></src:fragref>
\r
10535 <src:fragref linkend="shade.verbatim.style.frag"></src:fragref>
\r
10536 <src:fragref linkend="show.comments.frag"></src:fragref>
\r
10537 <src:fragref linkend="show.revisionflag.frag"></src:fragref>
\r
10538 <src:fragref linkend="simplesect.in.toc.frag"></src:fragref>
\r
10539 <src:fragref linkend="spacing.paras.frag"></src:fragref>
\r
10540 <src:fragref linkend="suppress.footer.navigation.frag"></src:fragref>
\r
10541 <src:fragref linkend="suppress.header.navigation.frag"></src:fragref>
\r
10542 <src:fragref linkend="suppress.navigation.frag"></src:fragref>
\r
10543 <src:fragref linkend="table.borders.with.css.frag"></src:fragref>
\r
10544 <src:fragref linkend="table.cell.border.color.frag"></src:fragref>
\r
10545 <src:fragref linkend="table.cell.border.style.frag"></src:fragref>
\r
10546 <src:fragref linkend="table.cell.border.thickness.frag"></src:fragref>
\r
10547 <src:fragref linkend="table.footnote.number.format.frag"></src:fragref>
\r
10548 <src:fragref linkend="table.footnote.number.symbols.frag"></src:fragref>
\r
10549 <src:fragref linkend="table.frame.border.color.frag"></src:fragref>
\r
10550 <src:fragref linkend="table.frame.border.style.frag"></src:fragref>
\r
10551 <src:fragref linkend="table.frame.border.thickness.frag"></src:fragref>
\r
10552 <src:fragref linkend="tablecolumns.extension.frag"></src:fragref>
\r
10553 <src:fragref linkend="target.database.document.frag"></src:fragref>
\r
10554 <src:fragref linkend="targets.filename.frag"></src:fragref>
\r
10555 <src:fragref linkend="textdata.default.encoding.frag"></src:fragref>
\r
10556 <src:fragref linkend="tex.math.delims.frag"></src:fragref>
\r
10557 <src:fragref linkend="tex.math.file.frag"></src:fragref>
\r
10558 <src:fragref linkend="tex.math.in.alt.frag"></src:fragref>
\r
10559 <src:fragref linkend="textinsert.extension.frag"></src:fragref>
\r
10560 <src:fragref linkend="toc.list.type.frag"></src:fragref>
\r
10561 <src:fragref linkend="toc.section.depth.frag"></src:fragref>
\r
10562 <src:fragref linkend="toc.max.depth.frag"></src:fragref>
\r
10563 <src:fragref linkend="ulink.target.frag"></src:fragref>
\r
10564 <src:fragref linkend="use.embed.for.svg.frag"></src:fragref>
\r
10565 <src:fragref linkend="use.extensions.frag"></src:fragref>
\r
10566 <src:fragref linkend="use.id.as.filename.frag"></src:fragref>
\r
10567 <src:fragref linkend="use.local.olink.style.frag"></src:fragref>
\r
10568 <src:fragref linkend="use.role.as.xrefstyle.frag"></src:fragref>
\r
10569 <src:fragref linkend="use.role.for.mediaobject.frag"></src:fragref>
\r
10570 <src:fragref linkend="use.svg.frag"></src:fragref>
\r
10571 <src:fragref linkend="variablelist.as.table.frag"></src:fragref>
\r
10572 <src:fragref linkend="variablelist.term.separator.frag"></src:fragref>
\r
10573 <src:fragref linkend="variablelist.term.break.after.frag"></src:fragref>
\r
10574 <src:fragref linkend="writing.mode.frag"></src:fragref>
\r
10575 <src:fragref linkend="xref.with.number.and.title.frag"></src:fragref>
\r
10576 <src:fragref linkend="xref.label-title.separator.frag"></src:fragref>
\r
10577 <src:fragref linkend="xref.label-page.separator.frag"></src:fragref>
\r
10578 <src:fragref linkend="xref.title-page.separator.frag"></src:fragref>
\r
10580 </xsl:stylesheet>
\r
10581 </programlisting>
\r
projects / working / Evergreen.git / blob