1 <?xml version="1.0" encoding="ASCII"?>
4 <title>FO Parameter Reference</title>
5 <releaseinfo role="meta">
6 $Id: param.xweb 9996 2015-10-01 16:35:10Z bobstayton $
10 <surname>Walsh</surname>
11 <firstname>Norman</firstname>
28 <holder>Norman Walsh</holder>
31 <para>This is reference documentation for all user-configurable
32 parameters in the DocBook XSL FO stylesheets (for generating
33 XSL-FO output destined for final print/PDF output).</para>
36 <reference xml:id="admons"><title>Admonitions</title>
37 <refentry version="5.0" xml:id="admon.graphics">
39 <refentrytitle>admon.graphics</refentrytitle>
40 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
43 <refname>admon.graphics</refname>
44 <refpurpose>Use graphics in admonitions?</refpurpose>
48 <programlisting xml:id="admon.graphics.frag">
49 <xsl:param name="admon.graphics" select="0"></xsl:param>
53 <refsection><info><title>Description</title></info>
55 <para>If true (non-zero), admonitions are presented in an alternate style that uses
56 a graphic. Default graphics are provided in the distribution.
62 <refentry version="5.0" xml:id="admon.graphics.extension">
64 <refentrytitle>admon.graphics.extension</refentrytitle>
65 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
68 <refname>admon.graphics.extension</refname>
69 <refpurpose>Filename extension for admonition graphics</refpurpose>
73 <programlisting xml:id="admon.graphics.extension.frag">
74 <xsl:param name="admon.graphics.extension">.png</xsl:param>
78 <refsection><info><title>Description</title></info>
80 <para>Sets the filename extension to use on admonition graphics.</para>
83 <para>The DocBook XSL distribution provides admonition graphics in the following formats:</para>
84 <listitem><para>GIF (extension: <filename class="extension">.gif</filename>)</para></listitem>
85 <listitem><para>PNG (extension: <filename class="extension">.png</filename>)</para></listitem>
86 <listitem><para>SVG (extension: <filename class="extension">.svg</filename>)</para></listitem>
87 <listitem><para>TIFF (extension: <filename class="extension">.tif</filename>)</para></listitem>
93 <refentry version="5.0" xml:id="admon.graphics.path">
95 <refentrytitle>admon.graphics.path</refentrytitle>
96 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
99 <refname>admon.graphics.path</refname>
100 <refpurpose>Path to admonition graphics</refpurpose>
104 <programlisting xml:id="admon.graphics.path.frag"><xsl:param name="admon.graphics.path">images/</xsl:param></programlisting>
107 <refsection><info><title>Description</title></info>
109 <para>Sets the path to the directory containing the admonition graphics
110 (caution.png, important.png etc). This location is normally relative
111 to the output html directory. See <parameter>base.dir</parameter></para>
116 <refentry version="5.0" xml:id="admon.textlabel">
118 <refentrytitle>admon.textlabel</refentrytitle>
119 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
122 <refname>admon.textlabel</refname>
123 <refpurpose>Use text label in admonitions?</refpurpose>
127 <programlisting xml:id="admon.textlabel.frag">
128 <xsl:param name="admon.textlabel" select="1"></xsl:param>
132 <refsection><info><title>Description</title></info>
134 <para>If true (non-zero), admonitions are presented with a generated
135 text label such as Note or Warning in the appropriate language.
136 If zero, such labels are turned off, but any title child
137 of the admonition element are still output.
138 The default value is 1.
144 <refentry version="5.0" xml:id="admonition.title.properties">
147 <refentrytitle>admonition.title.properties</refentrytitle>
148 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
151 <refname>admonition.title.properties</refname>
152 <refpurpose>To set the style for admonitions titles.</refpurpose>
156 <programlisting xml:id="admonition.title.properties.frag">
157 <xsl:attribute-set name="admonition.title.properties">
158 <xsl:attribute name="font-size">14pt</xsl:attribute>
159 <xsl:attribute name="font-weight">bold</xsl:attribute>
160 <xsl:attribute name="hyphenate">false</xsl:attribute>
161 <xsl:attribute name="keep-with-next.within-column">always</xsl:attribute>
162 </xsl:attribute-set>
165 <refsection><info><title>Description</title></info>
166 <para>How do you want admonitions titles styled? </para>
167 <para>Set the font-size, weight etc to the style required.</para>
172 <refentry version="5.0" xml:id="admonition.properties">
174 <refentrytitle>admonition.properties</refentrytitle>
175 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
178 <refname>admonition.properties</refname>
179 <refpurpose>To set the style for admonitions.</refpurpose>
183 <programlisting xml:id="admonition.properties.frag"><xsl:attribute-set name="admonition.properties"></xsl:attribute-set>
186 <refsection><info><title>Description</title></info>
187 <para>How do you want admonitions styled? </para>
188 <para>Set the font-size, weight, etc. to the style required</para>
193 <refentry version="5.0" xml:id="graphical.admonition.properties">
195 <refentrytitle>graphical.admonition.properties</refentrytitle>
196 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
199 <refname>graphical.admonition.properties</refname>
200 <refpurpose>To add properties to the outer block of a graphical admonition.</refpurpose>
204 <programlisting xml:id="graphical.admonition.properties.frag"><xsl:attribute-set name="graphical.admonition.properties">
205 <xsl:attribute name="space-before.optimum">1em</xsl:attribute>
206 <xsl:attribute name="space-before.minimum">0.8em</xsl:attribute>
207 <xsl:attribute name="space-before.maximum">1.2em</xsl:attribute>
208 <xsl:attribute name="space-after.optimum">1em</xsl:attribute>
209 <xsl:attribute name="space-after.minimum">0.8em</xsl:attribute>
210 <xsl:attribute name="space-after.maximum">1.2em</xsl:attribute>
211 </xsl:attribute-set>
214 <refsection><info><title>Description</title></info>
215 <para>These properties are added to the outer block containing the
216 entire graphical admonition, including its title.
217 It is used when the parameter
218 <parameter>admon.graphics</parameter> is set to nonzero.
219 Use this attribute-set to set the space above and below,
220 and any indent for the whole admonition.</para>
222 <para>In addition to these properties, a graphical admonition
223 also applies the <parameter>admonition.title.properties</parameter>
224 attribute-set to the title, and applies the
225 <parameter>admonition.properties</parameter> attribute-set
226 to the rest of the content.</para>
231 <refentry version="5.0" xml:id="nongraphical.admonition.properties">
233 <refentrytitle>nongraphical.admonition.properties</refentrytitle>
234 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
237 <refname>nongraphical.admonition.properties</refname>
238 <refpurpose>To add properties to the outer block of a nongraphical admonition.</refpurpose>
242 <programlisting xml:id="nongraphical.admonition.properties.frag"><xsl:attribute-set name="nongraphical.admonition.properties">
243 <xsl:attribute name="space-before.minimum">0.8em</xsl:attribute>
244 <xsl:attribute name="space-before.optimum">1em</xsl:attribute>
245 <xsl:attribute name="space-before.maximum">1.2em</xsl:attribute>
246 <xsl:attribute name="margin-{$direction.align.start}">0.25in</xsl:attribute>
247 <xsl:attribute name="margin-{$direction.align.end}">0.25in</xsl:attribute>
248 </xsl:attribute-set>
251 <refsection><info><title>Description</title></info>
252 <para>These properties are added to the outer block containing the
253 entire nongraphical admonition, including its title.
254 It is used when the parameter
255 <parameter>admon.graphics</parameter> is set to zero.
256 Use this attribute-set to set the space above and below,
257 and any indent for the whole admonition.</para>
259 <para>In addition to these properties, a nongraphical admonition
260 also applies the <parameter>admonition.title.properties</parameter>
261 attribute-set to the title, and the
262 <parameter>admonition.properties</parameter> attribute-set
263 to the rest of the content.</para>
269 <reference xml:id="callouts"><title>Callouts</title>
270 <refentry version="5.0" xml:id="calloutlist.properties">
272 <refentrytitle>calloutlist.properties</refentrytitle>
273 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
276 <refname>calloutlist.properties</refname>
277 <refpurpose>Properties that apply to each list-block generated by calloutlist.</refpurpose>
281 <programlisting xml:id="calloutlist.properties.frag"><xsl:attribute-set name="calloutlist.properties">
282 <xsl:attribute name="space-before.optimum">1em</xsl:attribute>
283 <xsl:attribute name="space-before.minimum">0.8em</xsl:attribute>
284 <xsl:attribute name="space-before.maximum">1.2em</xsl:attribute>
285 <xsl:attribute name="provisional-distance-between-starts">2.2em</xsl:attribute>
286 <xsl:attribute name="provisional-label-separation">0.2em</xsl:attribute>
287 </xsl:attribute-set></programlisting>
289 <refsection><info><title>Description</title></info>
290 <para>Properties that apply to the fo:list-block generated by calloutlist.
291 Typically used to adjust spacing or margins of the entire list.
292 Change the <literal>provisional-distance-between-starts</literal> attribute to
293 change the indent of the list paragraphs relative to the
294 callout numbers.</para>
298 <refentry version="5.0" xml:id="callout.properties">
300 <refentrytitle>callout.properties</refentrytitle>
301 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
304 <refname>callout.properties</refname>
305 <refpurpose>Properties that apply to the list-item generated by each callout within a calloutlist.</refpurpose>
309 <programlisting xml:id="callout.properties.frag"><xsl:attribute-set name="callout.properties">
310 </xsl:attribute-set></programlisting>
312 <refsection><info><title>Description</title></info>
313 <para>Properties that apply to the fo:list-item generated by each callout within a calloutlist. Typically used to add spacing properties.</para>
317 <refentry version="5.0" xml:id="callout.defaultcolumn">
319 <refentrytitle>callout.defaultcolumn</refentrytitle>
320 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
323 <refname>callout.defaultcolumn</refname>
324 <refpurpose>Indicates what column callouts appear in by default</refpurpose>
328 <programlisting xml:id="callout.defaultcolumn.frag">
329 <xsl:param name="callout.defaultcolumn">60</xsl:param>
333 <refsection><info><title>Description</title></info>
335 <para>If a callout does not identify a column (for example, if it uses
336 the <literal>linerange</literal> <tag class="attribute">unit</tag>),
337 it will appear in the default column.
343 <refentry version="5.0" xml:id="callout.graphics">
345 <refentrytitle>callout.graphics</refentrytitle>
346 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
349 <refname>callout.graphics</refname>
350 <refpurpose>Use graphics for callouts?</refpurpose>
354 <programlisting xml:id="callout.graphics.frag">
355 <xsl:param name="callout.graphics" select="1"></xsl:param>
359 <refsection><info><title>Description</title></info>
361 <para>If non-zero, callouts are presented with graphics (e.g., reverse-video
362 circled numbers instead of "(1)", "(2)", etc.).
363 Default graphics are provided in the distribution.
369 <refentry version="5.0" xml:id="callout.graphics.extension">
371 <refentrytitle>callout.graphics.extension</refentrytitle>
372 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
375 <refname>callout.graphics.extension</refname>
376 <refpurpose>Filename extension for callout graphics</refpurpose>
380 <programlisting xml:id="callout.graphics.extension.frag">
382 <xsl:param name="callout.graphics.extension">.svg</xsl:param>
386 <refsection><info><title>Description</title></info>
387 <para>Sets the filename extension to use on callout graphics. </para>
390 <para>The Docbook XSL distribution provides callout graphics in the following formats:</para>
391 <listitem><para>SVG (extension: <filename class="extension">.svg</filename>)</para></listitem>
392 <listitem><para>PNG (extension: <filename class="extension">.png</filename>)</para></listitem>
393 <listitem><para>GIF (extension: <filename class="extension">.gif</filename>)</para></listitem>
398 <refentry version="5.0" xml:id="callout.graphics.number.limit">
400 <refentrytitle>callout.graphics.number.limit</refentrytitle>
401 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
404 <refname>callout.graphics.number.limit</refname>
405 <refpurpose>Number of the largest callout graphic</refpurpose>
409 <programlisting xml:id="callout.graphics.number.limit.frag">
411 <xsl:param name="callout.graphics.number.limit">30</xsl:param>
415 <refsection><info><title>Description</title></info>
417 <para>If <parameter>callout.graphics</parameter> is non-zero, graphics
418 are used to represent callout numbers instead of plain text. The value
419 of <parameter>callout.graphics.number.limit</parameter> is the largest
420 number for which a graphic exists. If the callout number exceeds this
421 limit, the default presentation "(plain text instead of a graphic)"
428 <refentry version="5.0" xml:id="callout.graphics.path">
430 <refentrytitle>callout.graphics.path</refentrytitle>
431 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
434 <refname>callout.graphics.path</refname>
435 <refpurpose>Path to callout graphics</refpurpose>
439 <programlisting xml:id="callout.graphics.path.frag">
440 <xsl:param name="callout.graphics.path">images/callouts/</xsl:param>
444 <refsection><info><title>Description</title></info>
446 <para>Sets the path to the directory holding the callout graphics. his
447 location is normally relative to the output html directory. see
448 base.dir. Always terminate the directory with / since the graphic file
449 is appended to this string, hence needs the separator.
455 <refentry version="5.0" xml:id="callout.icon.size">
457 <refentrytitle>callout.icon.size</refentrytitle>
458 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
461 <refname>callout.icon.size</refname>
462 <refpurpose>Specifies the size of callout marker icons</refpurpose>
466 <programlisting xml:id="callout.icon.size.frag">
467 <xsl:param name="callout.icon.size">7pt</xsl:param>
471 <refsection><info><title>Description</title></info>
473 <para>Specifies the size of the callout marker icons.
474 The default size is 7 points.</para>
479 <refentry version="5.0" xml:id="callout.unicode">
481 <refentrytitle>callout.unicode</refentrytitle>
482 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
485 <refname>callout.unicode</refname>
486 <refpurpose>Use Unicode characters rather than images for callouts.</refpurpose>
490 <programlisting xml:id="callout.unicode.frag"><xsl:param name="callout.unicode" select="0"></xsl:param></programlisting>
493 <refsection><info><title>Description</title></info>
495 <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.
501 <refentry version="5.0" xml:id="callout.unicode.font">
503 <refentrytitle>callout.unicode.font</refentrytitle>
504 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
507 <refname>callout.unicode.font</refname>
508 <refpurpose>Specify a font for Unicode glyphs</refpurpose>
512 <programlisting xml:id="callout.unicode.font.frag">
513 <xsl:param name="callout.unicode.font">ZapfDingbats</xsl:param>
517 <refsection><info><title>Description</title></info>
519 <para>The name of the font to specify around Unicode callout glyphs.
520 If set to the empty string, no font change will occur.
526 <refentry version="5.0" xml:id="callout.unicode.number.limit">
528 <refentrytitle>callout.unicode.number.limit</refentrytitle>
529 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
532 <refname>callout.unicode.number.limit</refname>
533 <refpurpose>Number of the largest unicode callout character</refpurpose>
537 <programlisting xml:id="callout.unicode.number.limit.frag">
538 <xsl:param name="callout.unicode.number.limit">10</xsl:param>
542 <refsection><info><title>Description</title></info>
544 <para>If <parameter>callout.unicode</parameter>
545 is non-zero, unicode characters are used to represent
546 callout numbers. The value of
547 <parameter>callout.unicode.number.limit</parameter>
549 the largest number for which a unicode character exists. If the callout number
550 exceeds this limit, the default presentation "(nnn)" will always
557 <refentry version="5.0" xml:id="callout.unicode.start.character">
559 <refentrytitle>callout.unicode.start.character</refentrytitle>
560 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
563 <refname>callout.unicode.start.character</refname>
564 <refpurpose>First Unicode character to use, decimal value.</refpurpose>
568 <programlisting xml:id="callout.unicode.start.character.frag">
569 <xsl:param name="callout.unicode.start.character">10102</xsl:param>
573 <refsection><info><title>Description</title></info>
575 <para>If <parameter>callout.graphics</parameter> is zero and <parameter>callout.unicode</parameter>
576 is non-zero, unicode characters are used to represent
577 callout numbers. The value of
578 <parameter>callout.unicode.start.character</parameter>
579 is the decimal unicode value used for callout number one. Currently,
580 only values 9312 and 10102 are supported in the stylesheets for this parameter.
586 <refentry version="5.0" xml:id="callouts.extension">
588 <refentrytitle>callouts.extension</refentrytitle>
589 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
592 <refname>callouts.extension</refname>
593 <refpurpose>Enable the callout extension</refpurpose>
597 <programlisting xml:id="callouts.extension.frag">
598 <xsl:param name="callouts.extension" select="1"></xsl:param>
602 <refsection><info><title>Description</title></info>
604 <para>The callouts extension processes <tag>areaset</tag>
605 elements in <tag>programlistingco</tag> and other text-based
613 <reference xml:id="toc_index"><title>ToC/LoT/Index Generation</title>
614 <refentry version="5.0" xml:id="autotoc.label.separator">
616 <refentrytitle>autotoc.label.separator</refentrytitle>
617 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
620 <refname>autotoc.label.separator</refname>
621 <refpurpose>Separator between labels and titles in the ToC</refpurpose>
625 <programlisting xml:id="autotoc.label.separator.frag">
626 <xsl:param name="autotoc.label.separator">. </xsl:param>
630 <refsection><info><title>Description</title></info>
632 <para>String used to separate labels and titles in a table of contents.</para>
637 <refentry version="5.0" xml:id="process.empty.source.toc">
639 <refentrytitle>process.empty.source.toc</refentrytitle>
640 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
643 <refname>process.empty.source.toc</refname>
644 <refpurpose>Generate automated TOC if <tag>toc</tag> element occurs in a source document?</refpurpose>
648 <programlisting xml:id="process.empty.source.toc.frag"><xsl:param name="process.empty.source.toc" select="0"></xsl:param></programlisting>
651 <refsection><info><title>Description</title></info>
653 <para>Specifies that if an empty <tag>toc</tag> element is found in a
654 source document, an automated TOC is generated at this point in the
657 <para>Depending on what the value of the
658 <parameter>generate.toc</parameter> parameter is, setting this
659 parameter to <literal>1</literal> could result in generation of
660 duplicate automated TOCs. So the
661 <parameter>process.empty.source.toc</parameter> is primarily useful
662 as an "override": by placing an empty <tag>toc</tag> in your
663 document and setting this parameter to <literal>1</literal>, you can
664 force a TOC to be generated even if <tag>generate.toc</tag>
672 <refentry version="5.0" xml:id="process.source.toc">
674 <refentrytitle>process.source.toc</refentrytitle>
675 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
678 <refname>process.source.toc</refname>
679 <refpurpose>Process a non-empty <tag>toc</tag> element if it occurs in a source document?</refpurpose>
683 <programlisting xml:id="process.source.toc.frag"><xsl:param name="process.source.toc" select="0"></xsl:param></programlisting>
686 <refsection><info><title>Description</title></info>
688 <para>Specifies that the contents of a non-empty "hard-coded"
689 <tag>toc</tag> element in a source document are processed to
690 generate a TOC in output.
692 <para>This parameter has no effect on automated generation of
693 TOCs. An automated TOC may still be generated along with the
694 "hard-coded" TOC. To suppress automated TOC generation, adjust the
695 value of the <parameter>generate.toc</parameter> paramameter.</para>
697 <para>The <tag>process.source.toc</tag> parameter also has
698 no effect if the <tag>toc</tag> element is empty; handling
699 for empty <tag>toc</tag> is controlled by the
700 <parameter>process.empty.source.toc</parameter> parameter.</para>
707 <refentry version="5.0" xml:id="generate.toc">
709 <refentrytitle>generate.toc</refentrytitle>
710 <refmiscinfo class="other" otherclass="datatype">table</refmiscinfo>
713 <refname>generate.toc</refname>
714 <refpurpose>Control generation of ToCs and LoTs</refpurpose>
718 <programlisting xml:id="generate.toc.frag">
720 <xsl:param name="generate.toc">
724 book toc,title,figure,table,example,equation
740 <refsection><info><title>Description</title></info>
742 <para>This parameter has a structured value. It is a table of space-delimited
743 path/value pairs. Each path identifies some element in the source document
744 using a restricted subset of XPath (only the implicit child axis, no wildcards,
745 no predicates). Paths can be either relative or absolute.</para>
747 <para>When processing a particular element, the stylesheets consult this table to
748 determine if a ToC (or LoT(s)) should be generated.</para>
750 <para>For example, consider the entry:</para>
752 <screen>book toc,figure</screen>
754 <para>This indicates that whenever a <tag>book</tag> is formatted, a
755 Table Of Contents and a List of Figures should be generated. Similarly,</para>
757 <screen>/chapter toc</screen>
759 <para>indicates that whenever a document <emphasis>that has a root
760 of</emphasis> <tag>chapter</tag> is formatted, a Table of
761 Contents should be generated. The entry <literal>chapter</literal> would match
762 all chapters, but <literal>/chapter</literal> matches only <tag>chapter</tag>
763 document elements.</para>
765 <para>Generally, the longest match wins. So, for example, if you want to distinguish
766 articles in books from articles in parts, you could use these two entries:</para>
768 <screen>book/article toc,figure
769 part/article toc</screen>
771 <para>Note that an article in a part can never match a <literal>book/article</literal>,
772 so if you want nothing to be generated for articles in parts, you can simply leave
773 that rule out.</para>
775 <para>If you want to leave the rule in, to make it explicit that you're turning
776 something off, use the value <quote>nop</quote>. For example, the following
777 entry disables ToCs and LoTs for articles:</para>
779 <screen>article nop</screen>
781 <para>Do not simply leave the word <quote>article</quote> in the file
782 without a matching value. That'd be just begging the silly little
783 path/value parser to get confused.</para>
785 <para>Section ToCs are further controlled by the
786 <parameter>generate.section.toc.level</parameter> parameter.
787 For a given section level to have a ToC, it must have both an entry in
788 <parameter>generate.toc</parameter> and be within the range enabled by
789 <parameter>generate.section.toc.level</parameter>.</para>
793 <refentry version="5.0" xml:id="generate.index">
795 <refentrytitle>generate.index</refentrytitle>
796 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
799 <refname>generate.index</refname>
800 <refpurpose>Do you want an index?</refpurpose>
804 <programlisting xml:id="generate.index.frag"><xsl:param name="generate.index" select="1"></xsl:param></programlisting>
807 <refsection><info><title>Description</title></info>
809 <para>Specify if an index should be generated. </para>
814 <refentry version="5.0" xml:id="make.index.markup">
816 <refentrytitle>make.index.markup</refentrytitle>
817 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
820 <refname>make.index.markup</refname>
821 <refpurpose>Generate XML index markup in the index?</refpurpose>
825 <programlisting xml:id="make.index.markup.frag">
826 <xsl:param name="make.index.markup" select="0"></xsl:param>
830 <refsection><info><title>Description</title></info>
832 <para>This parameter enables a very neat trick for getting properly
833 merged, collated back-of-the-book indexes. G. Ken Holman suggested
834 this trick at Extreme Markup Languages 2002 and I'm indebted to him
837 <para>Jeni Tennison's excellent code in
838 <filename>autoidx.xsl</filename> does a great job of merging and
839 sorting <tag>indexterm</tag>s in the document and building a
840 back-of-the-book index. However, there's one thing that it cannot
841 reasonably be expected to do: merge page numbers into ranges. (I would
842 not have thought that it could collate and suppress duplicate page
843 numbers, but in fact it appears to manage that task somehow.)</para>
845 <para>Ken's trick is to produce a document in which the index at the
846 back of the book is <quote>displayed</quote> in XML. Because the index
847 is generated by the FO processor, all of the page numbers have been resolved.
848 It's a bit hard to explain, but what it boils down to is that instead of having
849 an index at the back of the book that looks like this:</para>
852 <formalpara><info><title>A</title></info>
853 <para>ap1, 1, 2, 3</para>
857 <para>you get one that looks like this:</para>
860 <programlisting><indexdiv>A</indexdiv>
862 <primaryie>ap1</primaryie>,
863 <phrase role="pageno">1</phrase>,
864 <phrase role="pageno">2</phrase>,
865 <phrase role="pageno">3</phrase>
866 </indexentry></programlisting>
869 <para>After building a PDF file with this sort of odd-looking index, you can
870 extract the text from the PDF file and the result is a proper index expressed in
873 <para>Now you have data that's amenable to processing and a simple Perl script
874 (such as <filename>fo/pdf2index</filename>) can
875 merge page ranges and generate a proper index.</para>
877 <para>Finally, reformat your original document using this literal index instead of
878 an automatically generated one and <quote>bingo</quote>!</para>
883 <refentry version="5.0" xml:id="index.method">
885 <refentrytitle>index.method</refentrytitle>
886 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
887 <refmiscinfo class="other" otherclass="value">basic</refmiscinfo>
888 <refmiscinfo class="other" otherclass="value">kosek</refmiscinfo>
889 <refmiscinfo class="other" otherclass="value">kimber</refmiscinfo>
892 <refname>index.method</refname>
893 <refpurpose>Select method used to group index entries in an index</refpurpose>
897 <programlisting xml:id="index.method.frag">
898 <xsl:param name="index.method">basic</xsl:param>
902 <refsection><info><title>Description</title></info>
904 <para>This parameter lets you select which method to use for sorting and grouping
905 index entries in an index.
906 Indexes in Latin-based languages that have accented characters typically
907 sort together accented words and unaccented words.
908 Thus <quote>Á</quote> (U+00C1 LATIN CAPITAL LETTER A WITH ACUTE) would sort together
909 with <quote>A</quote> (U+0041 LATIN CAPITAL LETTER A), so both would appear in the <quote>A</quote>
910 section of the index.
911 Languages using other alphabets (such as Russian, which is written in the Cyrillic alphabet)
912 and languages using ideographic chararacters (such as Japanese)
913 require grouping specific to the languages and alphabets.
916 <para>The default indexing method is limited.
917 It can group accented characters in Latin-based languages only.
918 It cannot handle non-Latin alphabets or ideographic languages.
919 The other indexing methods require extensions of one type or
920 another, and do not work with
921 all XSLT processors, which is why they are not used by default.</para>
923 <para>The three choices for indexing method are:</para>
926 <term><literal>basic</literal></term>
929 (default) Sort and groups words based only on the Latin alphabet.
930 Words with accented Latin letters will group and sort with
931 their respective primary letter, but
932 words in non-Latin alphabets will be
933 put in the <quote>Symbols</quote> section of the index.
938 <term><literal>kosek</literal></term>
941 This method sorts and groups words based on letter groups configured in
942 the DocBook locale file for the given language.
943 See, for example, the French locale file <filename>common/fr.xml</filename>.
944 This method requires that the XSLT processor
945 supports the EXSLT extensions (most do).
946 It also requires support for using
947 user-defined functions in xsl:key (xsltproc does not).
949 <para>This method is suitable for any language for which you can
950 list all the individual characters that should appear
951 in each letter group in an index.
952 It is probably not practical to use it for ideographic languages
953 such as Chinese that have hundreds or thousands of characters.
956 <para>To use the kosek method, you must:</para>
960 <para>Use a processor that supports its extensions, such as
961 Saxon 6 or Xalan (xsltproc and Saxon 8 do not).
965 <para>Set the index.method parameter's value to <quote>kosek</quote>.
969 <para>Import the appropriate index extensions stylesheet module
970 <filename>fo/autoidx-kosek.xsl</filename> or
971 <filename>html/autoidx-kosek.xsl</filename> into your
980 <term><literal>kimber</literal></term>
983 This method uses extensions to the Saxon processor to implement
984 sophisticated indexing processes. It uses its own
985 configuration file, which can include information for any number of
986 languages. Each language's configuration can group
987 words using one of two processes. In the
988 enumerated process similar to that used in the kosek method,
989 you indicate the groupings character-by-character.
990 In the between-key process, you specify the
991 break-points in the sort order that should start a new group.
992 The latter configuration is useful for ideographic languages
993 such as Chinese, Japanese, and Korean.
994 You can also define your own collation algorithms and how you
995 want mixed Latin-alphabet words sorted.</para>
998 <para>For a whitepaper describing the extensions, see:
999 <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>.
1003 <para>To download the extension library, see
1004 <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>.
1009 <para>To use the kimber method, you must:</para>
1013 <para>Use Saxon (version 6 or 8) as your XSLT processor.
1017 <para>Install and configure the Innodata Isogen library, using
1018 the documentation that comes with it.
1022 <para>Set the index.method parameter's value to <quote>kimber</quote>.
1026 <para>Import the appropriate index extensions stylesheet module
1027 <filename>fo/autoidx-kimber.xsl</filename> or
1028 <filename>html/autoidx-kimber.xsl</filename> into your
1041 <refentry version="5.0" xml:id="index.on.type">
1043 <refentrytitle>index.on.type</refentrytitle>
1044 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
1047 <refname>index.on.type</refname>
1048 <refpurpose>Select indexterms based on <tag class="attribute">type</tag>
1049 attribute value</refpurpose>
1053 <programlisting xml:id="index.on.type.frag">
1054 <xsl:param name="index.on.type" select="0"></xsl:param>
1058 <refsection><info><title>Description</title></info>
1062 then an <tag>index</tag> element that has a
1063 <tag class="attribute">type</tag> attribute
1064 value will contain only those <tag>indexterm</tag>
1065 elements with a matching <tag class="attribute">type</tag> attribute value.
1066 If an <tag>index</tag> has no <tag class="attribute">type</tag>
1067 attribute or it is blank, then the index will contain
1068 all <tag>indexterm</tag>s in the current scope.
1072 If <literal>index.on.type</literal> is zero, then the
1073 <tag class="attribute">type</tag> attribute has no effect
1074 on selecting indexterms for an index.
1077 <para>For those using DocBook version 4.2 or earlier,
1078 the <tag class="attribute">type</tag> attribute is not available
1079 for index terms. However, you can achieve the same
1080 effect by using the <tag class="attribute">role</tag> attribute
1081 in the same manner on <tag>indexterm</tag>
1082 and <tag>index</tag>, and setting the stylesheet parameter
1083 <parameter>index.on.role</parameter> to a nonzero value.
1089 <refentry version="5.0" xml:id="index.on.role">
1091 <refentrytitle>index.on.role</refentrytitle>
1092 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
1095 <refname>index.on.role</refname>
1096 <refpurpose>Select indexterms based on <tag class="attribute">role</tag> value</refpurpose>
1100 <programlisting xml:id="index.on.role.frag">
1101 <xsl:param name="index.on.role" select="0"></xsl:param>
1105 <refsection><info><title>Description</title></info>
1109 then an <tag>index</tag> element that has a
1110 <tag class="attribute">role</tag> attribute
1111 value will contain only those <tag>indexterm</tag>
1112 elements with a matching role value.
1113 If an <tag>index</tag> has no <tag class="attribute">role</tag>
1114 attribute or it is blank, then the index will contain
1115 all <tag>indexterm</tag>s in the current scope.
1118 If <literal>index.on.role</literal> is zero, then the
1119 <tag class="attribute">role</tag> attribute has no effect
1120 on selecting indexterms for an index.
1123 <para>If you are using DocBook version 4.3 or later, you should
1124 use the <tag class="attribute">type</tag> attribute instead of <tag class="attribute">role</tag>
1125 on <tag>indexterm</tag> and <tag>index</tag>,
1126 and set the <parameter>index.on.type</parameter> to a nonzero
1133 <refentry version="5.0" xml:id="index.preferred.page.properties">
1135 <refentrytitle>index.preferred.page.properties</refentrytitle>
1136 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
1139 <refname>index.preferred.page.properties</refname>
1140 <refpurpose>Properties used to emphasize page number references for
1141 significant index terms</refpurpose>
1145 <programlisting xml:id="index.preferred.page.properties.frag">
1146 <xsl:attribute-set name="index.preferred.page.properties">
1147 <xsl:attribute name="font-weight">bold</xsl:attribute>
1148 </xsl:attribute-set>
1152 <refsection><info><title>Description</title></info>
1154 <para>Properties used to emphasize page number references for
1155 significant index terms (<tag class="attribute">significance</tag>=<tag class="attvalue">preferred</tag>). Currently works only with
1161 <refentry version="5.0" xml:id="index.entry.properties">
1163 <refentrytitle>index.entry.properties</refentrytitle>
1164 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
1167 <refname>index.entry.properties</refname>
1168 <refpurpose>Properties applied to the formatted entries
1169 in an index</refpurpose>
1173 <programlisting xml:id="index.entry.properties.frag">
1174 <xsl:attribute-set name="index.entry.properties">
1175 <xsl:attribute name="start-indent">0pt</xsl:attribute>
1176 </xsl:attribute-set>
1180 <refsection><info><title>Description</title></info>
1182 <para>This attribute set is applied to the block containing
1183 the entries in a letter division in an index. It can be used to set the
1184 font-size, font-family, and other inheritable properties that will be
1185 applied to all index entries.</para>
1190 <refentry version="5.0" xml:id="index.div.title.properties">
1192 <refentrytitle>index.div.title.properties</refentrytitle>
1193 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
1196 <refname>index.div.title.properties</refname>
1197 <refpurpose>Properties associated with the letter headings in an
1202 <programlisting xml:id="index.div.title.properties.frag">
1203 <xsl:attribute-set name="index.div.title.properties">
1204 <xsl:attribute name="margin-{$direction.align.start}">0pt</xsl:attribute>
1205 <xsl:attribute name="font-size">14.4pt</xsl:attribute>
1206 <xsl:attribute name="font-family"><xsl:value-of select="$title.fontset"></xsl:value-of></xsl:attribute>
1207 <xsl:attribute name="font-weight">bold</xsl:attribute>
1208 <xsl:attribute name="keep-with-next.within-column">always</xsl:attribute>
1209 <xsl:attribute name="space-before.optimum"><xsl:value-of select="concat($body.font.master,'pt')"></xsl:value-of></xsl:attribute>
1210 <xsl:attribute name="space-before.minimum"><xsl:value-of select="concat($body.font.master,'pt * 0.8')"></xsl:value-of></xsl:attribute>
1211 <xsl:attribute name="space-before.maximum"><xsl:value-of select="concat($body.font.master,'pt * 1.2')"></xsl:value-of></xsl:attribute>
1212 <xsl:attribute name="start-indent">0pt</xsl:attribute>
1213 </xsl:attribute-set>
1217 <refsection><info><title>Description</title></info>
1219 <para>This attribute set is used on the letter headings that separate
1220 the divisions in an index.</para>
1225 <refentry version="5.0" xml:id="autolink.index.see">
1227 <refentrytitle>autolink.index.see</refentrytitle>
1228 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
1231 <refname>autolink.index.see</refname>
1232 <refpurpose>Link index see and seealso to index primary</refpurpose>
1236 <programlisting xml:id="autolink.index.see.frag"><xsl:param name="autolink.index.see" select="1"></xsl:param></programlisting>
1239 <refsection><info><title>Description</title></info>
1241 <para>If this param is set to a non-zero value,
1242 (default = 1), then the
1243 stylesheet will attempt for form a link between a
1244 <tag>see</tag> or <tag>seealso</tag> element
1245 and a matching indexterm <tag>primary</tag> element.
1248 <para>The stylesheet uses an exact text match after
1249 applying the <literal>normalize-space()</literal> function.
1250 If the <tag>see</tag> or <tag>seealso</tag> text contains a comma,
1251 then only the text prior to the comma is used.
1252 This assumes the author is using the convention "see primary, secondary"
1253 to specify a subentry. Automatic links always land on the primary
1254 entry in the index, so the reader has to look down to see the
1255 secondary entry.</para>
1256 <para>If there is no match on a
1257 <tag>primary</tag>, no link is formed, but the text
1258 still displays.</para>
1260 <para>No attempt is made to automatically link to text in
1261 <tag>secondary</tag> or <tag>tertiary</tag> elements.
1262 If you want to link to such elements, you can form a
1263 manual link by adding a linkend attribute to the
1264 <tag>see</tag> or <tag>seealso</tag> element, where
1265 the linkend references an id or xml:id attribute on
1266 such a subelement. Such manual links take precedence over
1267 any automatic links.
1270 <para>If this parameter is zero, then
1271 no automatic links from see and seealso
1272 are formed within the index. Any manual links are
1273 still processed, however.</para>
1278 <refentry version="5.0" xml:id="index.number.separator">
1280 <refentrytitle>index.number.separator</refentrytitle>
1281 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
1284 <refname>index.number.separator</refname>
1285 <refpurpose>Override for punctuation separating page numbers in index</refpurpose>
1289 <programlisting xml:id="index.number.separator.frag">
1290 <xsl:param name="index.number.separator"></xsl:param>
1294 <refsection><info><title>Description</title></info>
1296 <para>This parameter permits you to override the text to insert between
1297 page references in a formatted index entry. Typically
1298 that would be a comma and a space.
1301 <para>Because this text may be locale dependent,
1302 this parameter's value is normally taken from a gentext
1303 template named 'number-separator' in the
1304 context 'index' in the stylesheet
1305 locale file for the language
1306 of the current document.
1307 This parameter can be used to override the gentext string,
1308 and would typically be used on the command line.
1309 This parameter would apply to all languages.
1312 <para>So this text string can be customized in two ways.
1313 You can reset the default gentext string using
1314 the <parameter>local.l10n.xml</parameter> parameter, or you can
1315 override the gentext with the content of this parameter.
1316 The content can be a simple string, or it can be
1317 something more complex such as a call-template.
1320 <para>In HTML index output, section title references are used instead of
1321 page number references. This punctuation appears between
1322 such section titles in an HTML index.
1328 <refentry version="5.0" xml:id="index.range.separator">
1330 <refentrytitle>index.range.separator</refentrytitle>
1331 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
1334 <refname>index.range.separator</refname>
1335 <refpurpose>Override for punctuation separating the two numbers
1336 in a page range in index</refpurpose>
1340 <programlisting xml:id="index.range.separator.frag">
1341 <xsl:param name="index.range.separator"></xsl:param>
1345 <refsection><info><title>Description</title></info>
1347 <para>This parameter permits you
1348 to override the text to insert between
1349 the two numbers of a page range in an index.
1350 This parameter is only used by those XSL-FO processors
1351 that support an extension for generating such page ranges
1352 (such as XEP).</para>
1354 <para>Because this text may be locale dependent,
1355 this parameter's value is normally taken from a gentext
1356 template named 'range-separator' in the
1357 context 'index' in the stylesheet
1358 locale file for the language
1359 of the current document.
1360 This parameter can be used to override the gentext string,
1361 and would typically be used on the command line.
1362 This parameter would apply to all languages.
1365 <para>So this text string can be customized in two ways.
1366 You can reset the default gentext string using
1367 the <parameter>local.l10n.xml</parameter> parameter, or you can
1368 override the gentext with the content of this parameter.
1369 The content can be a simple string, or it can be
1370 something more complex such as a call-template.
1373 <para>In HTML index output, section title references are used instead of
1374 page number references. So there are no page ranges
1375 and this parameter has no effect.
1381 <refentry version="5.0" xml:id="index.term.separator">
1383 <refentrytitle>index.term.separator</refentrytitle>
1384 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
1387 <refname>index.term.separator</refname>
1388 <refpurpose>Override for punctuation separating an index term
1389 from its list of page references in an index</refpurpose>
1393 <programlisting xml:id="index.term.separator.frag">
1394 <xsl:param name="index.term.separator"></xsl:param>
1398 <refsection><info><title>Description</title></info>
1400 <para>This parameter permits you to override
1401 the text to insert between
1402 the end of an index term and its list of page references.
1403 Typically that might be a comma and a space.
1406 <para>Because this text may be locale dependent,
1407 this parameter's value is normally taken from a gentext
1408 template named 'term-separator' in the
1409 context 'index' in the stylesheet
1410 locale file for the language
1411 of the current document.
1412 This parameter can be used to override the gentext string,
1413 and would typically be used on the command line.
1414 This parameter would apply to all languages.
1417 <para>So this text string can be customized in two ways.
1418 You can reset the default gentext string using
1419 the <parameter>local.l10n.xml</parameter> parameter, or you can
1420 fill in the content for this normally empty
1422 The content can be a simple string, or it can be
1423 something more complex such as a call-template.
1424 For fo output, it could be an <tag>fo:leader</tag>
1425 element to provide space of a specific length, or a dot leader.
1431 <refentry version="5.0" xml:id="xep.index.item.properties">
1433 <refentrytitle>xep.index.item.properties</refentrytitle>
1434 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
1437 <refname>xep.index.item.properties</refname>
1438 <refpurpose>Properties associated with XEP index-items</refpurpose>
1442 <programlisting xml:id="xep.index.item.properties.frag">
1443 <xsl:attribute-set name="xep.index.item.properties" use-attribute-sets="index.page.number.properties">
1444 <xsl:attribute name="merge-subsequent-page-numbers">true</xsl:attribute>
1445 <xsl:attribute name="link-back">true</xsl:attribute>
1446 </xsl:attribute-set>
1450 <refsection><info><title>Description</title></info>
1452 <para>Properties associated with XEP index-items, which generate
1453 page numbers in an index processed by XEP. For more info see
1454 the XEP documentation section "Indexes" in
1455 <uri xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://www.renderx.com/reference.html#Indexes">http://www.renderx.com/reference.html#Indexes</uri>.</para>
1457 <para>This attribute-set also adds by default any properties from the
1458 <tag class="attribute">index.page.number.properties</tag>
1459 attribute-set.</para>
1463 <refentry version="5.0" xml:id="toc.section.depth">
1465 <refentrytitle>toc.section.depth</refentrytitle>
1466 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
1469 <refname>toc.section.depth</refname>
1470 <refpurpose>How deep should recursive <tag>section</tag>s appear
1471 in the TOC?</refpurpose>
1475 <programlisting xml:id="toc.section.depth.frag"><xsl:param name="toc.section.depth">2</xsl:param></programlisting>
1478 <refsection><info><title>Description</title></info>
1480 <para>Specifies the depth to which recursive sections should appear in the
1487 <refentry version="5.0" xml:id="toc.max.depth">
1489 <refentrytitle>toc.max.depth</refentrytitle>
1490 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
1493 <refname>toc.max.depth</refname>
1494 <refpurpose>How many levels should be created for each TOC?</refpurpose>
1498 <programlisting xml:id="toc.max.depth.frag"><xsl:param name="toc.max.depth">8</xsl:param></programlisting>
1501 <refsection><info><title>Description</title></info>
1503 <para>Specifies the maximal depth of TOC on all levels.</para>
1508 <refentry version="5.0" xml:id="toc.indent.width">
1510 <refentrytitle>toc.indent.width</refentrytitle>
1511 <refmiscinfo class="other" otherclass="datatype">float</refmiscinfo>
1514 <refname>toc.indent.width</refname>
1515 <refpurpose>Amount of indentation for TOC entries</refpurpose>
1519 <programlisting xml:id="toc.indent.width.frag">
1520 <xsl:param name="toc.indent.width">24</xsl:param>
1521 <!-- inconsistant point specification? -->
1525 <refsection><info><title>Description</title></info>
1527 <para>Specifies, in points, the distance by which each level of the
1528 TOC is indented from its parent.</para>
1530 <para>This value is expressed in points, without
1531 a unit (in other words, it is a bare number). Using a bare number allows the stylesheet
1532 to perform calculations that would otherwise have to be performed by the FO processor
1533 because not all processors support expressions.</para>
1538 <refentry version="5.0" xml:id="toc.line.properties">
1540 <refentrytitle>toc.line.properties</refentrytitle>
1541 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
1544 <refname>toc.line.properties</refname>
1545 <refpurpose>Properties for lines in ToCs and LoTs</refpurpose>
1549 <programlisting xml:id="toc.line.properties.frag">
1550 <xsl:attribute-set name="toc.line.properties">
1551 <xsl:attribute name="text-align-last">justify</xsl:attribute>
1552 <xsl:attribute name="text-align">start</xsl:attribute>
1553 <xsl:attribute name="end-indent"><xsl:value-of select="concat($toc.indent.width, 'pt')"></xsl:value-of></xsl:attribute>
1554 <xsl:attribute name="last-line-end-indent"><xsl:value-of select="concat('-', $toc.indent.width, 'pt')"></xsl:value-of></xsl:attribute>
1555 </xsl:attribute-set>
1559 <refsection><info><title>Description</title></info>
1561 <para>Properties which are applied to every line in ToC (or LoT). You can
1562 modify them in order to change appearance of all, or some lines. For
1563 example, in order to make lines for chapters bold, specify the
1564 following in your customization layer:</para>
1566 <programlisting><xsl:attribute-set name="toc.line.properties">
1567 <xsl:attribute name="font-weight">
1569 <xsl:when test="self::chapter">bold</xsl:when>
1570 <xsl:otherwise>normal</xsl:otherwise>
1572 </xsl:attribute>
1573 </xsl:attribute-set></programlisting>
1578 <refentry version="5.0" xml:id="toc.leader.properties">
1580 <refentrytitle>toc.leader.properties</refentrytitle>
1581 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
1584 <refname>toc.leader.properties</refname>
1585 <refpurpose>How the leaders (rows of dots) are going to look like in ToC?</refpurpose>
1589 <programlisting xml:id="toc.leader.properties.frag">
1590 <xsl:attribute-set name="toc.leader.properties">
1591 <xsl:attribute name="leader-pattern">dots</xsl:attribute>
1592 <xsl:attribute name="leader-pattern-width">3pt</xsl:attribute>
1593 <xsl:attribute name="leader-alignment">reference-area</xsl:attribute>
1594 <xsl:attribute name="padding-left">3pt</xsl:attribute>
1595 <xsl:attribute name="padding-right">3pt</xsl:attribute>
1596 </xsl:attribute-set>
1599 <refsection><info><title>Description</title></info>
1600 <para>Specify leader pattern, </para>
1605 <refentry version="5.0" xml:id="toc.margin.properties">
1607 <refentrytitle>toc.margin.properties</refentrytitle>
1608 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
1611 <refname>toc.margin.properties</refname>
1612 <refpurpose>Margin properties used on Tables of Contents</refpurpose>
1616 <programlisting xml:id="toc.margin.properties.frag">
1617 <xsl:attribute-set name="toc.margin.properties">
1618 <xsl:attribute name="space-before.minimum">0.5em</xsl:attribute>
1619 <xsl:attribute name="space-before.optimum">1em</xsl:attribute>
1620 <xsl:attribute name="space-before.maximum">2em</xsl:attribute>
1621 <xsl:attribute name="space-after.minimum">0.5em</xsl:attribute>
1622 <xsl:attribute name="space-after.optimum">1em</xsl:attribute>
1623 <xsl:attribute name="space-after.maximum">2em</xsl:attribute>
1624 </xsl:attribute-set>
1628 <refsection><info><title>Description</title></info>
1629 <para>This attribute set is used on Tables of Contents. These attributes are set
1630 on the wrapper that surrounds the ToC block, not on each individual lines.</para>
1634 <refentry version="5.0" xml:id="bridgehead.in.toc">
1636 <refentrytitle>bridgehead.in.toc</refentrytitle>
1637 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
1640 <refname>bridgehead.in.toc</refname>
1641 <refpurpose>Should bridgehead elements appear in the TOC?</refpurpose>
1645 <programlisting xml:id="bridgehead.in.toc.frag"><xsl:param name="bridgehead.in.toc" select="0"></xsl:param></programlisting>
1648 <refsection><info><title>Description</title></info>
1650 <para>If non-zero, <tag>bridgehead</tag>s appear in the TOC. Note that
1651 this option is not fully supported and may be removed in a future
1652 version of the stylesheets.
1658 <refentry version="5.0" xml:id="simplesect.in.toc">
1660 <refentrytitle>simplesect.in.toc</refentrytitle>
1661 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
1664 <refname>simplesect.in.toc</refname>
1665 <refpurpose>Should <tag>simplesect</tag> elements appear in the TOC?</refpurpose>
1669 <programlisting xml:id="simplesect.in.toc.frag"><xsl:param name="simplesect.in.toc" select="0"></xsl:param></programlisting>
1672 <refsection><info><title>Description</title></info>
1674 <para>If non-zero, <tag>simplesect</tag>s will be included in the TOC.
1680 <refentry version="5.0" xml:id="generate.section.toc.level">
1682 <refentrytitle>generate.section.toc.level</refentrytitle>
1683 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
1686 <refname>generate.section.toc.level</refname>
1687 <refpurpose>Control depth of TOC generation in sections</refpurpose>
1691 <programlisting xml:id="generate.section.toc.level.frag">
1692 <xsl:param name="generate.section.toc.level" select="0"></xsl:param>
1696 <refsection><info><title>Description</title></info>
1698 <para>The <parameter>generate.section.toc.level</parameter> parameter
1699 controls the depth of <tag>section</tag> in which TOCs will be generated. Note
1700 that this is related to, but not the same as
1701 <parameter>toc.section.depth</parameter>, which controls the depth to
1702 which TOC entries will be generated in a given TOC.</para>
1703 <para>If, for example, <parameter>generate.section.toc.level</parameter>
1704 is <literal>3</literal>, TOCs will be generated in first, second, and third
1705 level sections, but not in fourth level sections.
1715 <reference xml:id="fo_ext"><title>Processor Extensions</title>
1716 <refentry version="5.0" xml:id="arbortext.extensions">
1718 <refentrytitle>arbortext.extensions</refentrytitle>
1719 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
1722 <refname>arbortext.extensions</refname>
1723 <refpurpose>Enable Arbortext extensions?</refpurpose>
1727 <programlisting xml:id="arbortext.extensions.frag"><xsl:param name="arbortext.extensions" select="0"></xsl:param></programlisting>
1730 <refsection><info><title>Description</title></info>
1733 <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://www.arbortext.com/">Arbortext</link>
1734 extensions will be used.
1736 <para>This parameter can also affect which graphics file formats
1737 are supported</para>
1742 <refentry version="5.0" xml:id="axf.extensions">
1744 <refentrytitle>axf.extensions</refentrytitle>
1745 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
1748 <refname>axf.extensions</refname>
1749 <refpurpose>Enable XSL Formatter extensions?</refpurpose>
1753 <programlisting xml:id="axf.extensions.frag">
1754 <xsl:param name="axf.extensions" select="0"></xsl:param>
1758 <refsection><info><title>Description</title></info>
1761 <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://www.antennahouse.com/">XSL Formatter</link>
1762 extensions will be used. XSL Formatter extensions consists of PDF bookmarks,
1763 document information and better index processing.</para>
1765 <para>This parameter can also affect which graphics file formats
1766 are supported</para>
1771 <refentry version="5.0" xml:id="fop.extensions">
1773 <refentrytitle>fop.extensions</refentrytitle>
1774 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
1777 <refname>fop.extensions</refname>
1778 <refpurpose>Enable extensions for FOP version 0.20.5 and earlier</refpurpose>
1782 <programlisting xml:id="fop.extensions.frag"><xsl:param name="fop.extensions" select="0"></xsl:param></programlisting>
1785 <refsection><info><title>Description</title></info>
1787 <para>If non-zero, extensions intended for
1788 <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://xml.apache.org/fop/">FOP</link>
1789 version 0.20.5 and earlier will be used.
1790 At present, this consists of PDF bookmarks.
1793 <para>This parameter can also affect which graphics file formats
1794 are supported.</para>
1796 <para>If you are using a version of FOP beyond
1797 version 0.20.5, then use the <parameter>fop1.extensions</parameter> parameter
1803 <refentry version="5.0" xml:id="fop1.extensions">
1805 <refentrytitle>fop1.extensions</refentrytitle>
1806 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
1809 <refname>fop1.extensions</refname>
1810 <refpurpose>Enable extensions for FOP version 0.90 and later</refpurpose>
1814 <programlisting xml:id="fop1.extensions.frag"><xsl:param name="fop1.extensions" select="0"></xsl:param></programlisting>
1817 <refsection><info><title>Description</title></info>
1819 <para>If non-zero, extensions for
1820 <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://xml.apache.org/fop/">FOP</link>
1821 version 0.90 and later will be used.
1824 <para>This parameter can also affect which graphics file formats
1825 are supported.</para>
1827 <para>The original <parameter>fop.extensions</parameter> parameter
1828 should still be used for FOP version 0.20.5 and earlier.
1833 <refentry version="5.0" xml:id="passivetex.extensions">
1835 <refentrytitle>passivetex.extensions</refentrytitle>
1836 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
1839 <refname>passivetex.extensions</refname>
1840 <refpurpose>Enable PassiveTeX extensions?</refpurpose>
1844 <programlisting xml:id="passivetex.extensions.frag"><xsl:param name="passivetex.extensions" select="0"></xsl:param></programlisting>
1847 <refsection><info><title>Description</title></info>
1849 <important><para>The PassiveTeX XSL-FO processor is
1850 no longer supported by DocBook XSL, beginning with version 1.78.</para></important>
1852 <para>PassiveTeX was never a complete implementation of
1853 XSL-FO, and development has ceased. Setting this parameter will
1854 have no effect on the output.</para>
1859 <refentry version="5.0" xml:id="tex.math.in.alt">
1861 <refentrytitle>tex.math.in.alt</refentrytitle>
1862 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
1863 <refmiscinfo class="other" otherclass="value">plain</refmiscinfo>
1864 <refmiscinfo class="other" otherclass="value">latex</refmiscinfo>
1867 <refname>tex.math.in.alt</refname>
1868 <refpurpose>TeX notation used for equations</refpurpose>
1872 <programlisting xml:id="tex.math.in.alt.frag">
1873 <xsl:param name="tex.math.in.alt"></xsl:param>
1877 <refsection><info><title>Description</title></info>
1879 <para>If you want type math directly in TeX notation in equations,
1880 this parameter specifies notation used. Currently are supported two
1881 values -- <literal>plain</literal> and <literal>latex</literal>. Empty
1882 value means that you are not using TeX math at all.</para>
1884 <para>Preferred way for including TeX alternative of math is inside of
1885 <tag>textobject</tag> element. Eg.:</para>
1887 <programlisting><inlineequation>
1888 <inlinemediaobject>
1890 <imagedata fileref="eq1.gif"/>
1891 </imageobject>
1892 <textobject><phrase>E=mc squared</phrase></textobject>
1893 <textobject role="tex"><phrase>E=mc^2</phrase></textobject>
1894 </inlinemediaobject>
1895 </inlineequation></programlisting>
1897 <para>If you are using <tag>graphic</tag> element, you can
1898 store TeX inside <tag>alt</tag> element:</para>
1900 <programlisting><inlineequation>
1901 <alt role="tex">a^2+b^2=c^2</alt>
1902 <graphic fileref="a2b2c2.gif"/>
1903 </inlineequation></programlisting>
1905 <para>If you want use this feature, you should process your FO with
1906 PassiveTeX, which only supports TeX math notation. When calling
1907 stylsheet, don't forget to specify also
1908 passivetex.extensions=1.</para>
1910 <para>If you want equations in HTML, just process generated file
1911 <filename>tex-math-equations.tex</filename> by TeX or LaTeX. Then run
1912 dvi2bitmap program on result DVI file. You will get images for
1913 equations in your document.</para>
1916 <para>This feature is useful for print/PDF output only if you
1917 use the obsolete and now unsupported PassiveTeX XSL-FO
1923 <refsection><info><title>Related Parameters</title></info>
1924 <para><parameter>tex.math.delims</parameter>,
1925 <parameter>passivetex.extensions</parameter>,
1926 <parameter>tex.math.file</parameter></para>
1931 <refentry version="5.0" xml:id="tex.math.delims">
1933 <refentrytitle>tex.math.delims</refentrytitle>
1934 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
1937 <refname>tex.math.delims</refname>
1938 <refpurpose>Should equations output for processing by TeX be
1939 surrounded by math mode delimiters?</refpurpose>
1943 <programlisting xml:id="tex.math.delims.frag">
1944 <xsl:param name="tex.math.delims" select="1"></xsl:param>
1948 <refsection><info><title>Description</title></info>
1950 <para>For compatibility with DSSSL based DBTeXMath from Allin Cottrell
1951 you should set this parameter to 0.</para>
1954 <para>This feature is useful for print/PDF output only if you
1955 use the obsolete and now unsupported PassiveTeX XSL-FO
1960 <refsection><info><title>Related Parameters</title></info>
1961 <para><parameter>tex.math.in.alt</parameter>,
1962 <parameter>passivetex.extensions</parameter></para>
1965 <refsection><info><title>See Also</title></info>
1966 <para>You can also use the <tag class="xmlpi">dbtex delims</tag> processing
1967 instruction to control whether delimiters are output.</para>
1973 <refentry version="5.0" xml:id="xep.extensions">
1975 <refentrytitle>xep.extensions</refentrytitle>
1976 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
1979 <refname>xep.extensions</refname>
1980 <refpurpose>Enable XEP extensions?</refpurpose>
1984 <programlisting xml:id="xep.extensions.frag"><xsl:param name="xep.extensions" select="0"></xsl:param></programlisting>
1987 <refsection><info><title>Description</title></info>
1990 <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://www.renderx.com/">XEP</link>
1991 extensions will be used. XEP extensions consists of PDF bookmarks,
1992 document information and better index processing.
1995 <para>This parameter can also affect which graphics file formats
1996 are supported</para>
2001 <reference xml:id="dbk_ext"><title>Stylesheet Extensions</title>
2002 <refentry version="5.0" xml:id="linenumbering.everyNth">
2004 <refentrytitle>linenumbering.everyNth</refentrytitle>
2005 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
2008 <refname>linenumbering.everyNth</refname>
2009 <refpurpose>Indicate which lines should be numbered</refpurpose>
2013 <programlisting xml:id="linenumbering.everyNth.frag">
2014 <xsl:param name="linenumbering.everyNth">5</xsl:param>
2018 <refsection><info><title>Description</title></info>
2020 <para>If line numbering is enabled, everyNth line will be
2021 numbered. Note that numbering is one based, not zero based.
2023 <para>See also <parameter>linenumbering.extension</parameter>,
2024 <parameter>linenumbering.separator</parameter>,
2025 <parameter>linenumbering.width</parameter> and
2026 <parameter>use.extensions</parameter></para>
2031 <refentry version="5.0" xml:id="linenumbering.extension">
2033 <refentrytitle>linenumbering.extension</refentrytitle>
2034 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
2037 <refname>linenumbering.extension</refname>
2038 <refpurpose>Enable the line numbering extension</refpurpose>
2042 <programlisting xml:id="linenumbering.extension.frag">
2043 <xsl:param name="linenumbering.extension" select="1"></xsl:param>
2047 <refsection><info><title>Description</title></info>
2049 <para>If non-zero, verbatim environments (<tag>address</tag>, <tag>literallayout</tag>,
2050 <tag>programlisting</tag>, <tag>screen</tag>, <tag>synopsis</tag>) that specify line numbering will
2057 <refentry version="5.0" xml:id="linenumbering.separator">
2059 <refentrytitle>linenumbering.separator</refentrytitle>
2060 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
2063 <refname>linenumbering.separator</refname>
2064 <refpurpose>Specify a separator between line numbers and lines</refpurpose>
2068 <programlisting xml:id="linenumbering.separator.frag">
2069 <xsl:param name="linenumbering.separator"><xsl:text> </xsl:text></xsl:param>
2073 <refsection><info><title>Description</title></info>
2075 <para>The separator is inserted between line numbers and lines in the
2076 verbatim environment. The default value is a single white space.
2077 Note the interaction with <parameter>linenumbering.width</parameter>
2083 <refentry version="5.0" xml:id="linenumbering.width">
2085 <refentrytitle>linenumbering.width</refentrytitle>
2086 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
2089 <refname>linenumbering.width</refname>
2090 <refpurpose>Indicates the width of line numbers</refpurpose>
2094 <programlisting xml:id="linenumbering.width.frag">
2095 <xsl:param name="linenumbering.width">3</xsl:param>
2099 <refsection><info><title>Description</title></info>
2101 <para>If line numbering is enabled, line numbers will appear right
2102 justified in a field "width" characters wide.
2108 <refentry version="5.0" xml:id="tablecolumns.extension">
2110 <refentrytitle>tablecolumns.extension</refentrytitle>
2111 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
2114 <refname>tablecolumns.extension</refname>
2115 <refpurpose>Enable the table columns extension function</refpurpose>
2119 <programlisting xml:id="tablecolumns.extension.frag">
2120 <xsl:param name="tablecolumns.extension" select="1"></xsl:param>
2124 <refsection><info><title>Description</title></info>
2126 <para>The table columns extension function adjusts the widths of table
2127 columns in the HTML result to more accurately reflect the specifications
2134 <refentry version="5.0" xml:id="textinsert.extension">
2136 <refentrytitle>textinsert.extension</refentrytitle>
2137 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
2140 <refname>textinsert.extension</refname>
2141 <refpurpose>Enables the textinsert extension element</refpurpose>
2144 <programlisting xml:id="textinsert.extension.frag">
2145 <xsl:param name="textinsert.extension" select="1"></xsl:param>
2148 <refsection><info><title>Description</title></info>
2149 <para>The textinsert extension element inserts the contents of
2150 a file into the result tree (as text).</para>
2152 <para>To use the textinsert extension element, you must use
2153 either Saxon or Xalan as your XSLT processor (it doesn’t
2154 work with xsltproc), along with either the DocBook Saxon
2155 extensions or DocBook Xalan extensions (for more
2156 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
2157 the <parameter>use.extensions</parameter> and
2158 <parameter>textinsert.extension</parameter> parameters to
2159 <literal>1</literal>.</para>
2160 <para>As an alternative to using the textinsert element,
2161 consider using an Xinclude element with the
2162 <literal>parse="text"</literal> attribute and value
2163 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>
2166 <refsection><info><title>See Also</title></info>
2167 <para>You can also use the <tag class="xmlpi">dbhtml-include href</tag> processing
2168 instruction to insert external files — both files containing
2169 plain text and files with markup content (including HTML
2172 <refsection><info><title>More information</title></info>
2173 <para>For how-to documentation on inserting contents of
2174 external code files and other text files into output, see
2175 <link xmlns:xlink="http://www.w3.org/1999/xlink" role="tcg" xlink:href="ExternalCode.html">External code files</link>.</para>
2176 <para>For guidelines on inserting contents of
2177 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>
2181 <refentry version="5.0" xml:id="textdata.default.encoding">
2183 <refentrytitle>textdata.default.encoding</refentrytitle>
2184 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
2187 <refname>textdata.default.encoding</refname>
2188 <refpurpose>Default encoding of external text files which are included
2189 using textdata element</refpurpose>
2193 <programlisting xml:id="textdata.default.encoding.frag">
2194 <xsl:param name="textdata.default.encoding"></xsl:param>
2198 <refsection><info><title>Description</title></info>
2200 <para>Specifies the encoding of any external text files included using
2201 <tag>textdata</tag> element. This value is used only when you do
2202 not specify encoding by the appropriate attribute
2203 directly on textdata. An empty string is interpreted as the system
2204 default encoding.</para>
2209 <refentry version="5.0" xml:id="use.extensions">
2211 <refentrytitle>use.extensions</refentrytitle>
2212 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
2215 <refname>use.extensions</refname>
2216 <refpurpose>Enable extensions</refpurpose>
2220 <programlisting xml:id="use.extensions.frag">
2221 <xsl:param name="use.extensions" select="0"></xsl:param>
2225 <refsection><info><title>Description</title></info>
2227 <para>If non-zero, extensions may be used. Each extension is
2228 further controlled by its own parameter. But if
2229 <parameter>use.extensions</parameter> is zero, no extensions will
2237 <reference xml:id="labels"><title>Automatic labelling</title>
2238 <refentry version="5.0" xml:id="appendix.autolabel">
2240 <refentrytitle>appendix.autolabel</refentrytitle>
2241 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
2242 <refmiscinfo class="other" otherclass="value">0<alt>none</alt></refmiscinfo>
2243 <refmiscinfo class="other" otherclass="value">1<alt>1,2,3...</alt></refmiscinfo>
2244 <refmiscinfo class="other" otherclass="value">A<alt>A,B,C...</alt></refmiscinfo>
2245 <refmiscinfo class="other" otherclass="value">a<alt>a,b,c...</alt></refmiscinfo>
2246 <refmiscinfo class="other" otherclass="value">i<alt>i,ii,iii...</alt></refmiscinfo>
2247 <refmiscinfo class="other" otherclass="value">I<alt>I,II,III...</alt></refmiscinfo>
2250 <refname>appendix.autolabel</refname>
2251 <refpurpose>Specifies the labeling format for Appendix titles</refpurpose>
2255 <programlisting xml:id="appendix.autolabel.frag">
2256 <xsl:param name="appendix.autolabel">A</xsl:param>
2260 <refsection><info><title>Description</title></info>
2262 <para>If non-zero, then appendices will be numbered using the
2263 parameter value as the number format if the value matches one of the
2269 <term>1 or arabic</term>
2271 <para>Arabic numeration (1, 2, 3 ...).</para>
2275 <term>A or upperalpha</term>
2277 <para>Uppercase letter numeration (A, B, C ...).</para>
2281 <term>a or loweralpha</term>
2283 <para>Lowercase letter numeration (a, b, c ...).</para>
2287 <term>I or upperroman</term>
2289 <para>Uppercase roman numeration (I, II, III ...).</para>
2293 <term>i or lowerroman</term>
2295 <para>Lowercase roman letter numeration (i, ii, iii ...).</para>
2300 <para>Any nonzero value other than the above will generate
2301 the default number format (upperalpha).
2307 <refentry version="5.0" xml:id="chapter.autolabel">
2309 <refentrytitle>chapter.autolabel</refentrytitle>
2310 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
2311 <refmiscinfo class="other" otherclass="value">0<alt>none</alt></refmiscinfo>
2312 <refmiscinfo class="other" otherclass="value">1<alt>1,2,3...</alt></refmiscinfo>
2313 <refmiscinfo class="other" otherclass="value">A<alt>A,B,C...</alt></refmiscinfo>
2314 <refmiscinfo class="other" otherclass="value">a<alt>a,b,c...</alt></refmiscinfo>
2315 <refmiscinfo class="other" otherclass="value">i<alt>i,ii,iii...</alt></refmiscinfo>
2316 <refmiscinfo class="other" otherclass="value">I<alt>I,II,III...</alt></refmiscinfo>
2319 <refname>chapter.autolabel</refname>
2320 <refpurpose>Specifies the labeling format for Chapter titles</refpurpose>
2324 <programlisting xml:id="chapter.autolabel.frag">
2325 <xsl:param name="chapter.autolabel" select="1"></xsl:param></programlisting>
2328 <refsection><info><title>Description</title></info>
2330 <para>If non-zero, then chapters will be numbered using the parameter
2331 value as the number format if the value matches one of the following:
2336 <term>1 or arabic</term>
2338 <para>Arabic numeration (1, 2, 3 ...).</para>
2342 <term>A or upperalpha</term>
2344 <para>Uppercase letter numeration (A, B, C ...).</para>
2348 <term>a or loweralpha</term>
2350 <para>Lowercase letter numeration (a, b, c ...).</para>
2354 <term>I or upperroman</term>
2356 <para>Uppercase roman numeration (I, II, III ...).</para>
2360 <term>i or lowerroman</term>
2362 <para>Lowercase roman letter numeration (i, ii, iii ...).</para>
2367 <para>Any nonzero value other than the above will generate
2368 the default number format (arabic).
2374 <refentry version="5.0" xml:id="part.autolabel">
2376 <refentrytitle>part.autolabel</refentrytitle>
2377 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
2378 <refmiscinfo class="other" otherclass="value">0<alt>none</alt></refmiscinfo>
2379 <refmiscinfo class="other" otherclass="value">1<alt>1,2,3...</alt></refmiscinfo>
2380 <refmiscinfo class="other" otherclass="value">A<alt>A,B,C...</alt></refmiscinfo>
2381 <refmiscinfo class="other" otherclass="value">a<alt>a,b,c...</alt></refmiscinfo>
2382 <refmiscinfo class="other" otherclass="value">i<alt>i,ii,iii...</alt></refmiscinfo>
2383 <refmiscinfo class="other" otherclass="value">I<alt>I,II,III...</alt></refmiscinfo>
2386 <refname>part.autolabel</refname>
2387 <refpurpose>Specifies the labeling format for Part titles</refpurpose>
2391 <programlisting xml:id="part.autolabel.frag">
2392 <xsl:param name="part.autolabel">I</xsl:param>
2396 <refsection><info><title>Description</title></info>
2398 <para>If non-zero, then parts will be numbered using the parameter
2399 value as the number format if the value matches one of the following:
2404 <term>1 or arabic</term>
2406 <para>Arabic numeration (1, 2, 3 ...).</para>
2410 <term>A or upperalpha</term>
2412 <para>Uppercase letter numeration (A, B, C ...).</para>
2416 <term>a or loweralpha</term>
2418 <para>Lowercase letter numeration (a, b, c ...).</para>
2422 <term>I or upperroman</term>
2424 <para>Uppercase roman numeration (I, II, III ...).</para>
2428 <term>i or lowerroman</term>
2430 <para>Lowercase roman letter numeration (i, ii, iii ...).</para>
2435 <para>Any nonzero value other than the above will generate
2436 the default number format (upperroman).
2443 <refentry version="5.0" xml:id="reference.autolabel">
2445 <refentrytitle>reference.autolabel</refentrytitle>
2446 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
2447 <refmiscinfo class="other" otherclass="value">0<alt>none</alt></refmiscinfo>
2448 <refmiscinfo class="other" otherclass="value">1<alt>1,2,3...</alt></refmiscinfo>
2449 <refmiscinfo class="other" otherclass="value">A<alt>A,B,C...</alt></refmiscinfo>
2450 <refmiscinfo class="other" otherclass="value">a<alt>a,b,c...</alt></refmiscinfo>
2451 <refmiscinfo class="other" otherclass="value">i<alt>i,ii,iii...</alt></refmiscinfo>
2452 <refmiscinfo class="other" otherclass="value">I<alt>I,II,III...</alt></refmiscinfo>
2455 <refname>reference.autolabel</refname>
2456 <refpurpose>Specifies the labeling format for Reference titles</refpurpose>
2459 <programlisting xml:id="reference.autolabel.frag">
2460 <xsl:param name="reference.autolabel">I</xsl:param>
2463 <refsection><info><title>Description</title></info>
2464 <para>If non-zero, references will be numbered using the parameter
2465 value as the number format if the value matches one of the
2470 <term>1 or arabic</term>
2472 <para>Arabic numeration (1, 2, 3 ...).</para>
2476 <term>A or upperalpha</term>
2478 <para>Uppercase letter numeration (A, B, C ...).</para>
2482 <term>a or loweralpha</term>
2484 <para>Lowercase letter numeration (a, b, c ...).</para>
2488 <term>I or upperroman</term>
2490 <para>Uppercase roman numeration (I, II, III ...).</para>
2494 <term>i or lowerroman</term>
2496 <para>Lowercase roman letter numeration (i, ii, iii ...).</para>
2500 <para>Any non-zero value other than the above will generate
2501 the default number format (upperroman).
2506 <refentry version="5.0" xml:id="preface.autolabel">
2508 <refentrytitle>preface.autolabel</refentrytitle>
2509 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
2510 <refmiscinfo class="other" otherclass="value">0<alt>none</alt></refmiscinfo>
2511 <refmiscinfo class="other" otherclass="value">1<alt>1,2,3...</alt></refmiscinfo>
2512 <refmiscinfo class="other" otherclass="value">A<alt>A,B,C...</alt></refmiscinfo>
2513 <refmiscinfo class="other" otherclass="value">a<alt>a,b,c...</alt></refmiscinfo>
2514 <refmiscinfo class="other" otherclass="value">i<alt>i,ii,iii...</alt></refmiscinfo>
2515 <refmiscinfo class="other" otherclass="value">I<alt>I,II,III...</alt></refmiscinfo>
2518 <refname>preface.autolabel</refname>
2519 <refpurpose>Specifices the labeling format for Preface titles</refpurpose>
2523 <programlisting xml:id="preface.autolabel.frag"><xsl:param name="preface.autolabel" select="0"></xsl:param></programlisting>
2526 <refsection><info><title>Description</title></info>
2528 <para>If non-zero then prefaces will be numbered using the parameter
2529 value as the number format if the value matches one of the following:
2534 <term>1 or arabic</term>
2536 <para>Arabic numeration (1, 2, 3 ...).</para>
2540 <term>A or upperalpha</term>
2542 <para>Uppercase letter numeration (A, B, C ...).</para>
2546 <term>a or loweralpha</term>
2548 <para>Lowercase letter numeration (a, b, c ...).</para>
2552 <term>I or upperroman</term>
2554 <para>Uppercase roman numeration (I, II, III ...).</para>
2558 <term>i or lowerroman</term>
2560 <para>Lowercase roman letter numeration (i, ii, iii ...).</para>
2565 <para>Any nonzero value other than the above will generate
2566 the default number format (arabic).
2573 <refentry version="5.0" xml:id="section.autolabel">
2575 <refentrytitle>section.autolabel</refentrytitle>
2576 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
2579 <refname>section.autolabel</refname>
2580 <refpurpose>Are sections enumerated?</refpurpose>
2584 <programlisting xml:id="section.autolabel.frag"><xsl:param name="section.autolabel" select="0"></xsl:param></programlisting>
2587 <refsection><info><title>Description</title></info>
2589 <para>If true (non-zero), unlabeled sections will be enumerated.
2595 <refentry version="5.0" xml:id="section.autolabel.max.depth">
2597 <refentrytitle>section.autolabel.max.depth</refentrytitle>
2598 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
2601 <refname>section.autolabel.max.depth</refname>
2602 <refpurpose>The deepest level of sections that are numbered.</refpurpose>
2606 <programlisting xml:id="section.autolabel.max.depth.frag">
2607 <xsl:param name="section.autolabel.max.depth">8</xsl:param>
2611 <refsection><info><title>Description</title></info>
2613 <para>When section numbering is turned on by the
2614 <parameter>section.autolabel</parameter> parameter, then this
2615 parameter controls the depth of <tag>section</tag> nesting that is
2616 numbered. Sections nested to a level deeper than this value will not
2623 <refentry version="5.0" xml:id="section.label.includes.component.label">
2625 <refentrytitle>section.label.includes.component.label</refentrytitle>
2626 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
2629 <refname>section.label.includes.component.label</refname>
2630 <refpurpose>Do section labels include the component label?</refpurpose>
2634 <programlisting xml:id="section.label.includes.component.label.frag"><xsl:param name="section.label.includes.component.label" select="0"></xsl:param></programlisting>
2637 <refsection><info><title>Description</title></info>
2639 <para>If non-zero, section labels are prefixed with the label of the
2640 component that contains them.
2646 <refentry version="5.0" xml:id="label.from.part">
2648 <refentrytitle>label.from.part</refentrytitle>
2649 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
2652 <refname>label.from.part</refname>
2653 <refpurpose>Renumber components in each part?</refpurpose>
2657 <programlisting xml:id="label.from.part.frag">
2658 <xsl:param name="label.from.part" select="0"></xsl:param>
2662 <refsection><info><title>Description</title></info>
2664 <para>If <parameter>label.from.part</parameter> is non-zero, then
2665 numbering of components — <tag>preface</tag>,
2666 <tag>chapter</tag>, <tag>appendix</tag>, and
2667 <tag>reference</tag> (when <tag>reference</tag> occurs at the
2668 component level) — is re-started within each
2669 <tag>part</tag>.</para>
2670 <para>If <parameter>label.from.part</parameter> is zero (the
2671 default), numbering of components is <emphasis>not</emphasis>
2672 re-started within each <tag>part</tag>; instead, components are
2673 numbered sequentially throughout each <tag>book</tag>,
2674 regardless of whether or not they occur within <tag>part</tag>
2680 <refentry version="5.0" xml:id="component.label.includes.part.label">
2682 <refentrytitle>component.label.includes.part.label</refentrytitle>
2683 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
2686 <refname>component.label.includes.part.label</refname>
2687 <refpurpose>Do component labels include the part label?</refpurpose>
2691 <programlisting xml:id="component.label.includes.part.label.frag"><xsl:param name="component.label.includes.part.label" select="0"></xsl:param></programlisting>
2694 <refsection><info><title>Description</title></info>
2696 <para>If non-zero, number labels for <tag>chapter</tag>,
2697 <tag>appendix</tag>, and other component elements are prefixed with
2698 the label of the part element that contains them. So you might see
2699 Chapter II.3 instead of Chapter 3. Also, the labels for formal
2700 elements such as <tag>table</tag> and <tag>figure</tag> will include
2701 the part label. If there is no part element container, then no prefix
2705 This feature is most useful when the
2706 <parameter>label.from.part</parameter> parameter is turned on.
2707 In that case, there would be more than one <tag>chapter</tag>
2708 <quote>1</quote>, and the extra part label prefix will identify
2709 each chapter unambiguously.
2716 <reference xml:id="xslt"><title>XSLT Processing</title>
2717 <refentry version="5.0" xml:id="rootid">
2719 <refentrytitle>rootid</refentrytitle>
2720 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
2723 <refname>rootid</refname>
2724 <refpurpose>Specify the root element to format</refpurpose>
2728 <programlisting xml:id="rootid.frag">
2729 <xsl:param name="rootid"></xsl:param></programlisting>
2732 <refsection><info><title>Description</title></info>
2734 <para>If <parameter>rootid</parameter> is not empty, it must be the
2735 value of an ID that occurs in the document being formatted. The entire
2736 document will be loaded and parsed, but formatting will begin at the
2737 element identified, rather than at the root. For example, this allows
2738 you to process only <tag>chapter</tag> 4 of a <tag>book</tag>.</para>
2739 <para>Because the entire document is available to the processor, automatic
2740 numbering, cross references, and other dependencies are correctly
2747 <reference xml:id="meta"><title>Meta/*Info</title>
2748 <refentry version="5.0" xml:id="make.single.year.ranges">
2750 <refentrytitle>make.single.year.ranges</refentrytitle>
2751 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
2754 <refname>make.single.year.ranges</refname>
2755 <refpurpose>Print single-year ranges (e.g., 1998-1999)</refpurpose>
2759 <programlisting xml:id="make.single.year.ranges.frag">
2760 <xsl:param name="make.single.year.ranges" select="0"></xsl:param></programlisting>
2763 <refsection><info><title>Description</title></info>
2765 <para>If non-zero, year ranges that span a single year will be printed
2766 in range notation (1998-1999) instead of discrete notation
2767 (1998, 1999).</para>
2772 <refentry version="5.0" xml:id="make.year.ranges">
2774 <refentrytitle>make.year.ranges</refentrytitle>
2775 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
2778 <refname>make.year.ranges</refname>
2779 <refpurpose>Collate copyright years into ranges?</refpurpose>
2783 <programlisting xml:id="make.year.ranges.frag"><xsl:param name="make.year.ranges" select="0"></xsl:param></programlisting>
2786 <refsection><info><title>Description</title></info>
2788 <para>If non-zero, multiple copyright <tag>year</tag> elements will be
2789 collated into ranges.
2790 This works only if each year number is put into a separate
2791 year element. The copyright element permits multiple
2792 year elements. If a year element contains a dash or
2793 a comma, then that year element will not be merged into
2800 <refentry version="5.0" xml:id="author.othername.in.middle">
2802 <refentrytitle>author.othername.in.middle</refentrytitle>
2803 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
2806 <refname>author.othername.in.middle</refname>
2807 <refpurpose>Is <tag>othername</tag> in <tag>author</tag> a
2808 middle name?</refpurpose>
2812 <programlisting xml:id="author.othername.in.middle.frag">
2813 <xsl:param name="author.othername.in.middle" select="1"></xsl:param></programlisting>
2816 <refsection><info><title>Description</title></info>
2818 <para>If non-zero, the <tag>othername</tag> of an <tag>author</tag>
2819 appears between the <tag>firstname</tag> and
2820 <tag>surname</tag>. Otherwise, <tag>othername</tag>
2828 <reference xml:id="refentry"><title>Reference Pages</title>
2829 <refentry version="5.0" xml:id="funcsynopsis.decoration">
2831 <refentrytitle>funcsynopsis.decoration</refentrytitle>
2832 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
2835 <refname>funcsynopsis.decoration</refname>
2836 <refpurpose>Decorate elements of a <tag>funcsynopsis</tag>?</refpurpose>
2840 <programlisting xml:id="funcsynopsis.decoration.frag">
2841 <xsl:param name="funcsynopsis.decoration" select="1"></xsl:param>
2845 <refsection><info><title>Description</title></info>
2847 <para>If non-zero, elements of the <tag>funcsynopsis</tag> will be
2848 decorated (e.g. rendered as bold or italic text). The decoration is controlled by
2849 templates that can be redefined in a customization layer.
2855 <refentry version="5.0" xml:id="funcsynopsis.style">
2857 <refentrytitle>funcsynopsis.style</refentrytitle>
2858 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
2859 <refmiscinfo class="other" otherclass="value">ansi</refmiscinfo>
2860 <refmiscinfo class="other" otherclass="value">kr</refmiscinfo>
2863 <refname>funcsynopsis.style</refname>
2864 <refpurpose>What style of <tag>funcsynopsis</tag> should be generated?</refpurpose>
2868 <programlisting xml:id="funcsynopsis.style.frag"><xsl:param name="funcsynopsis.style">kr</xsl:param></programlisting>
2871 <refsection><info><title>Description</title></info>
2873 <para>If <parameter>funcsynopsis.style</parameter> is <literal>ansi</literal>,
2874 ANSI-style function synopses are generated for a
2875 <tag>funcsynopsis</tag>, otherwise K&R-style
2876 function synopses are generated.
2882 <refentry version="5.0" xml:id="function.parens">
2884 <refentrytitle>function.parens</refentrytitle>
2885 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
2888 <refname>function.parens</refname>
2889 <refpurpose>Generate parens after a function?</refpurpose>
2893 <programlisting xml:id="function.parens.frag">
2894 <xsl:param name="function.parens" select="0"></xsl:param>
2898 <refsection><info><title>Description</title></info>
2900 <para>If non-zero, the formatting of a <tag>function</tag> element
2901 will include generated parentheses.
2907 <refentry version="5.0" xml:id="refentry.generate.name">
2909 <refentrytitle>refentry.generate.name</refentrytitle>
2910 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
2913 <refname>refentry.generate.name</refname>
2914 <refpurpose>Output NAME header before <tag>refname</tag>s?</refpurpose>
2918 <programlisting xml:id="refentry.generate.name.frag">
2919 <xsl:param name="refentry.generate.name" select="1"></xsl:param>
2923 <refsection><info><title>Description</title></info>
2925 <para>If non-zero, a "NAME" section title is output before the list
2926 of <tag>refname</tag>s. This parameter and
2927 <parameter>refentry.generate.title</parameter> are mutually
2928 exclusive. This means that if you change this parameter to zero, you
2929 should set <parameter>refentry.generate.title</parameter> to non-zero unless
2930 you want get quite strange output.
2936 <refentry version="5.0" xml:id="refentry.generate.title">
2938 <refentrytitle>refentry.generate.title</refentrytitle>
2939 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
2942 <refname>refentry.generate.title</refname>
2943 <refpurpose>Output title before <tag>refname</tag>s?</refpurpose>
2947 <programlisting xml:id="refentry.generate.title.frag">
2948 <xsl:param name="refentry.generate.title" select="0"></xsl:param>
2952 <refsection><info><title>Description</title></info>
2954 <para>If non-zero, the reference page title or first name is
2955 output before the list of <tag>refname</tag>s. This parameter and
2956 <parameter>refentry.generate.name</parameter> are mutually exclusive.
2957 This means that if you change this parameter to non-zero, you
2958 should set <parameter>refentry.generate.name</parameter> to zero unless
2959 you want get quite strange output.</para>
2965 <refentry version="5.0" xml:id="refentry.pagebreak">
2967 <refentrytitle>refentry.pagebreak</refentrytitle>
2968 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
2971 <refname>refentry.pagebreak</refname>
2972 <refpurpose>Start each refentry on a new page</refpurpose>
2976 <programlisting xml:id="refentry.pagebreak.frag"><xsl:param name="refentry.pagebreak" select="1"></xsl:param></programlisting>
2979 <refsection><info><title>Description</title></info>
2981 <para>If non-zero (the default), each <tag>refentry</tag>
2982 element will start on a new page. If zero, a page
2983 break will not be generated between <tag>refentry</tag> elements.
2984 The exception is when the <tag>refentry</tag> elements are children of
2985 a <tag>part</tag> element, in which case the page breaks are always
2986 retained. That is because a <tag>part</tag> element does not generate
2987 a page-sequence for its children, so each <tag>refentry</tag> must
2988 start its own page-sequence.
2994 <refentry version="5.0" xml:id="refentry.title.properties">
2996 <refentrytitle>refentry.title.properties</refentrytitle>
2997 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
3000 <refname>refentry.title.properties</refname>
3001 <refpurpose>Title properties for a refentry title</refpurpose>
3005 <programlisting xml:id="refentry.title.properties.frag">
3006 <xsl:attribute-set name="refentry.title.properties">
3007 <xsl:attribute name="font-family">
3008 <xsl:value-of select="$title.fontset"></xsl:value-of>
3009 </xsl:attribute>
3010 <xsl:attribute name="font-size">18pt</xsl:attribute>
3011 <xsl:attribute name="font-weight">bold</xsl:attribute>
3012 <xsl:attribute name="space-after">1em</xsl:attribute>
3013 <xsl:attribute name="hyphenate">false</xsl:attribute>
3014 <xsl:attribute name="keep-with-next.within-column">always</xsl:attribute>
3015 <xsl:attribute name="space-before.minimum">0.8em</xsl:attribute>
3016 <xsl:attribute name="space-before.optimum">1.0em</xsl:attribute>
3017 <xsl:attribute name="space-before.maximum">1.2em</xsl:attribute>
3018 <xsl:attribute name="space-after.optimum">0.5em</xsl:attribute>
3019 <xsl:attribute name="space-after.minimum">0.4em</xsl:attribute>
3020 <xsl:attribute name="space-after.maximum">0.6em</xsl:attribute>
3021 <xsl:attribute name="start-indent"><xsl:value-of select="$title.margin.left"></xsl:value-of></xsl:attribute>
3022 </xsl:attribute-set>
3026 <refsection><info><title>Description</title></info>
3028 <para>Formatting properties applied to the title generated for the
3029 <tag>refnamediv</tag> part of output for
3030 <tag>refentry</tag> when the value of the
3031 <parameter>refentry.generate.title</parameter> parameter is
3032 non-zero. The font size is supplied by the appropriate <parameter>section.level<replaceable>X</replaceable>.title.properties</parameter>
3033 attribute-set, computed from the location of the
3034 <tag>refentry</tag> in the section hierarchy.</para>
3037 <para>This parameter has no effect on the the title generated for
3038 the <tag>refnamediv</tag> part of output for
3039 <tag>refentry</tag> when the value of the
3040 <parameter>refentry.generate.name</parameter> parameter is
3041 non-zero. By default, that title is formatted with the same
3042 properties as the titles for all other first-level children of
3043 <tag>refentry</tag>.</para>
3049 <refentry version="5.0" xml:id="refentry.xref.manvolnum">
3051 <refentrytitle>refentry.xref.manvolnum</refentrytitle>
3052 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3055 <refname>refentry.xref.manvolnum</refname>
3056 <refpurpose>Output <tag>manvolnum</tag> as part of
3057 <tag>refentry</tag> cross-reference?</refpurpose>
3061 <programlisting xml:id="refentry.xref.manvolnum.frag">
3062 <xsl:param name="refentry.xref.manvolnum" select="1"></xsl:param>
3066 <refsection><info><title>Description</title></info>
3068 <para>if non-zero, the <tag>manvolnum</tag> is used when cross-referencing
3069 <tag>refentry</tag>s, either with <tag>xref</tag>
3070 or <tag>citerefentry</tag>.
3076 <refentry version="5.0" xml:id="refclass.suppress">
3078 <refentrytitle>refclass.suppress</refentrytitle>
3079 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3082 <refname>refclass.suppress</refname>
3083 <refpurpose>Suppress display of refclass contents?</refpurpose>
3087 <programlisting xml:id="refclass.suppress.frag">
3088 <xsl:param name="refclass.suppress" select="0"></xsl:param></programlisting>
3091 <refsection><info><title>Description</title></info>
3093 <para>If the value of <parameter>refclass.suppress</parameter> is
3094 non-zero, then display of <tag>refclass</tag> contents is
3095 suppressed in output.</para>
3101 <reference xml:id="tables"><title>Tables</title>
3102 <refentry version="5.0" xml:id="default.table.width">
3104 <refentrytitle>default.table.width</refentrytitle>
3105 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
3108 <refname>default.table.width</refname>
3109 <refpurpose>The default width of tables</refpurpose>
3112 <programlisting xml:id="default.table.width.frag">
3113 <xsl:param name="default.table.width"></xsl:param>
3116 <refsection><info><title>Description</title></info>
3117 <para>If non-zero, this value will be used for the
3118 <literal>width</literal> attribute on <tag>table</tag>s that do not specify an
3119 alternate width (with the <tag class="xmlpi">dbhtml table-width</tag> or
3120 <tag class="xmlpi">dbfo table-width</tag> processing instruction).</para>
3124 <refentry version="5.0" xml:id="nominal.table.width">
3126 <refentrytitle>nominal.table.width</refentrytitle>
3127 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
3130 <refname>nominal.table.width</refname>
3131 <refpurpose>The (absolute) nominal width of tables</refpurpose>
3135 <programlisting xml:id="nominal.table.width.frag">
3136 <xsl:param name="nominal.table.width">6in</xsl:param>
3140 <refsection><info><title>Description</title></info>
3142 <para>In order to convert CALS column widths into HTML column widths, it
3143 is sometimes necessary to have an absolute table width to use for conversion
3144 of mixed absolute and relative widths. This value must be an absolute
3145 length (not a percentage).</para>
3150 <refentry version="5.0" xml:id="default.table.frame">
3152 <refentrytitle>default.table.frame</refentrytitle>
3153 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
3156 <refname>default.table.frame</refname>
3157 <refpurpose>The default framing of tables</refpurpose>
3161 <programlisting xml:id="default.table.frame.frag">
3162 <xsl:param name="default.table.frame">all</xsl:param>
3166 <refsection><info><title>Description</title></info>
3168 <para>This value will be used when there is no frame attribute on the
3174 <refentry version="5.0" xml:id="default.table.rules">
3176 <refentrytitle>default.table.rules</refentrytitle>
3177 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
3180 <refname>default.table.rules</refname>
3181 <refpurpose>The default column and row rules for tables using HTML markup</refpurpose>
3185 <programlisting xml:id="default.table.rules.frag">
3186 <xsl:param name="default.table.rules">none</xsl:param>
3190 <refsection><info><title>Description</title></info>
3192 <para>Tables using HTML markup elements can use an attribute
3193 named <tag class="attribute">rules</tag> on the <tag>table</tag> or
3194 <tag>informaltable</tag> element
3195 to specify whether column and row border rules should be
3196 displayed. This parameter lets you specify a global default
3197 style for all HTML tables that don't otherwise have
3198 that attribute.</para>
3199 <para>These are the supported values:</para>
3202 <varlistentry><term>all</term>
3204 <para>Rules will appear between all rows and columns.</para>
3208 <varlistentry><term>rows</term>
3210 <para>Rules will appear between rows only.</para>
3214 <varlistentry><term>cols</term>
3216 <para>Rules will appear between columns only.</para>
3220 <varlistentry><term>groups</term>
3222 <para>Rules will appear between row groups (thead, tfoot, tbody).
3223 No support for rules between column groups yet.
3228 <varlistentry><term>none</term>
3230 <para>No rules. This is the default value.
3237 <para>The border after the last row and the border after
3238 the last column are not affected by
3239 this setting. Those borders are controlled by
3240 the <tag class="attribute">frame</tag> attribute on the table element.
3246 <refentry version="5.0" xml:id="table.cell.padding">
3248 <refentrytitle>table.cell.padding</refentrytitle>
3249 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
3252 <refname>table.cell.padding</refname>
3253 <refpurpose>Specifies the padding of table cells</refpurpose>
3257 <programlisting xml:id="table.cell.padding.frag">
3258 <xsl:attribute-set name="table.cell.padding">
3259 <xsl:attribute name="padding-start">2pt</xsl:attribute>
3260 <xsl:attribute name="padding-end">2pt</xsl:attribute>
3261 <xsl:attribute name="padding-top">2pt</xsl:attribute>
3262 <xsl:attribute name="padding-bottom">2pt</xsl:attribute>
3263 </xsl:attribute-set>
3267 <refsection><info><title>Description</title></info>
3269 <para>Specifies the padding of table cells.</para>
3274 <refentry version="5.0" xml:id="table.frame.border.thickness">
3276 <refentrytitle>table.frame.border.thickness</refentrytitle>
3277 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
3280 <refname>table.frame.border.thickness</refname>
3281 <refpurpose>Specifies the thickness of the frame border</refpurpose>
3285 <programlisting xml:id="table.frame.border.thickness.frag">
3286 <xsl:param name="table.frame.border.thickness">
3288 <xsl:when test="contains($stylesheet.result.type,'html')">1px</xsl:when>
3289 <xsl:otherwise>0.5pt</xsl:otherwise>
3295 <refsection><info><title>Description</title></info>
3297 <para>Specifies the thickness of the border on the table's frame.</para>
3302 <refentry version="5.0" xml:id="table.frame.border.style">
3304 <refentrytitle>table.frame.border.style</refentrytitle>
3305 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
3306 <refmiscinfo class="other" otherclass="value">none</refmiscinfo>
3307 <refmiscinfo class="other" otherclass="value">solid</refmiscinfo>
3308 <refmiscinfo class="other" otherclass="value">dotted</refmiscinfo>
3309 <refmiscinfo class="other" otherclass="value">dashed</refmiscinfo>
3310 <refmiscinfo class="other" otherclass="value">double</refmiscinfo>
3311 <refmiscinfo class="other" otherclass="value">groove</refmiscinfo>
3312 <refmiscinfo class="other" otherclass="value">ridge</refmiscinfo>
3313 <refmiscinfo class="other" otherclass="value">inset</refmiscinfo>
3314 <refmiscinfo class="other" otherclass="value">outset</refmiscinfo>
3315 <refmiscinfo class="other" otherclass="value">solid</refmiscinfo>
3318 <refname>table.frame.border.style</refname>
3319 <refpurpose>Specifies the border style of table frames</refpurpose>
3323 <programlisting xml:id="table.frame.border.style.frag">
3324 <xsl:param name="table.frame.border.style">solid</xsl:param>
3328 <refsection><info><title>Description</title></info>
3330 <para>Specifies the border style of table frames.</para>
3335 <refentry version="5.0" xml:id="table.frame.border.color">
3337 <refentrytitle>table.frame.border.color</refentrytitle>
3338 <refmiscinfo class="other" otherclass="datatype">color</refmiscinfo>
3341 <refname>table.frame.border.color</refname>
3342 <refpurpose>Specifies the border color of table frames</refpurpose>
3346 <programlisting xml:id="table.frame.border.color.frag">
3348 <xsl:param name="table.frame.border.color">black</xsl:param>
3352 <refsection><info><title>Description</title></info>
3354 <para>Specifies the border color of table frames.</para>
3359 <refentry version="5.0" xml:id="table.cell.border.thickness">
3361 <refentrytitle>table.cell.border.thickness</refentrytitle>
3362 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
3365 <refname>table.cell.border.thickness</refname>
3366 <refpurpose>Specifies the thickness of table cell borders</refpurpose>
3370 <programlisting xml:id="table.cell.border.thickness.frag">
3371 <xsl:param name="table.cell.border.thickness">
3373 <xsl:when test="contains($stylesheet.result.type,'html')">1px</xsl:when>
3374 <xsl:otherwise>0.5pt</xsl:otherwise>
3380 <refsection><info><title>Description</title></info>
3382 <para>If non-zero, specifies the thickness of borders on table
3383 cells. See <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://www.w3.org/TR/CSS21/box.html#border-width-properties">
3387 <para>To control properties of cell borders in HTML output, you must also turn on the
3388 <parameter>table.borders.with.css</parameter> parameter.</para>
3394 <refentry version="5.0" xml:id="table.cell.border.style">
3396 <refentrytitle>table.cell.border.style</refentrytitle>
3397 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
3398 <refmiscinfo class="other" otherclass="value">none</refmiscinfo>
3399 <refmiscinfo class="other" otherclass="value">solid</refmiscinfo>
3400 <refmiscinfo class="other" otherclass="value">dotted</refmiscinfo>
3401 <refmiscinfo class="other" otherclass="value">dashed</refmiscinfo>
3402 <refmiscinfo class="other" otherclass="value">double</refmiscinfo>
3403 <refmiscinfo class="other" otherclass="value">groove</refmiscinfo>
3404 <refmiscinfo class="other" otherclass="value">ridge</refmiscinfo>
3405 <refmiscinfo class="other" otherclass="value">inset</refmiscinfo>
3406 <refmiscinfo class="other" otherclass="value">outset</refmiscinfo>
3407 <refmiscinfo class="other" otherclass="value">solid</refmiscinfo>
3410 <refname>table.cell.border.style</refname>
3411 <refpurpose>Specifies the border style of table cells</refpurpose>
3415 <programlisting xml:id="table.cell.border.style.frag">
3416 <xsl:param name="table.cell.border.style">solid</xsl:param>
3420 <refsection><info><title>Description</title></info>
3422 <para>Specifies the border style of table cells.</para>
3425 <para>To control properties of cell borders in HTML output, you must also turn on the
3426 <parameter>table.borders.with.css</parameter> parameter.</para>
3432 <refentry version="5.0" xml:id="table.cell.border.color">
3434 <refentrytitle>table.cell.border.color</refentrytitle>
3435 <refmiscinfo class="other" otherclass="datatype">color</refmiscinfo>
3438 <refname>table.cell.border.color</refname>
3439 <refpurpose>Specifies the border color of table cells</refpurpose>
3443 <programlisting xml:id="table.cell.border.color.frag">
3445 <xsl:param name="table.cell.border.color">black</xsl:param>
3449 <refsection><info><title>Description</title></info>
3451 <para>Set the color of table cell borders. If non-zero, the value is used
3452 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
3453 <literal>color</literal> is either a keyword or a numerical RGB specification.
3454 Keywords are aqua, black, blue, fuchsia, gray, green, lime, maroon,
3455 navy, olive, orange, purple, red, silver, teal, white, and
3459 <para>To control properties of cell borders in HTML output, you must also turn on the
3460 <parameter>table.borders.with.css</parameter> parameter.</para>
3466 <refentry version="5.0" xml:id="table.table.properties">
3468 <refentrytitle>table.table.properties</refentrytitle>
3469 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
3472 <refname>table.table.properties</refname>
3473 <refpurpose>Properties associated with a table</refpurpose>
3477 <programlisting xml:id="table.table.properties.frag">
3478 <xsl:attribute-set name="table.table.properties">
3479 <xsl:attribute name="border-before-width.conditionality">retain</xsl:attribute>
3480 <xsl:attribute name="border-collapse">collapse</xsl:attribute>
3481 </xsl:attribute-set>
3485 <refsection><info><title>Description</title></info>
3487 <para>The styling for tables. This parameter should really
3488 have been called <literal>table.properties</literal>, but that parameter
3489 name was inadvertently established for the block-level properties
3490 of the table as a whole.
3493 <para>See also <parameter>table.properties</parameter>.</para>
3498 <refentry version="5.0" xml:id="table.caption.properties">
3500 <refentrytitle>table.caption.properties</refentrytitle>
3501 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
3504 <refname>table.caption.properties</refname>
3505 <refpurpose>Properties associated with a table caption</refpurpose>
3509 <programlisting xml:id="table.caption.properties.frag">
3510 <xsl:attribute-set name="table.caption.properties">
3511 <xsl:attribute name="keep-together.within-column">always</xsl:attribute>
3512 </xsl:attribute-set>
3516 <refsection><info><title>Description</title></info>
3518 <para>The styling for table caption element (not the table title).</para>
3520 <para>See also <parameter>table.properties</parameter>.</para>
3526 <reference xml:id="links"><title>Linking</title>
3527 <refentry version="5.0" xml:id="current.docid">
3529 <refentrytitle>current.docid</refentrytitle>
3530 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
3533 <refname>current.docid</refname>
3534 <refpurpose>targetdoc identifier for the document being
3535 processed</refpurpose>
3537 <refsynopsisdiv> <programlisting xml:id="current.docid.frag">
3538 <xsl:param name="current.docid"></xsl:param>
3541 <refsection><info><title>Description</title></info>
3543 <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
3544 the targetdoc identifier of the current document, since that
3545 identifier does not appear in the document itself. </para>
3546 <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>
3550 <refentry version="5.0" xml:id="activate.external.olinks">
3552 <refentrytitle>activate.external.olinks</refentrytitle>
3553 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3556 <refname>activate.external.olinks</refname>
3557 <refpurpose>Make external olinks into active links</refpurpose>
3561 <programlisting xml:id="activate.external.olinks.frag">
3562 <xsl:param name="activate.external.olinks" select="1"></xsl:param>
3566 <refsection><info><title>Description</title></info>
3568 <para>If <parameter>activate.external.olinks</parameter> is nonzero
3569 (the default), then any olinks that reference another document
3570 become active links that can be clicked on to follow the link.
3571 If the parameter is set to zero, then external olinks
3572 will have the appropriate link text generated, but the link is
3573 not made active. Olinks to destinations in
3574 the current document remain active.</para>
3576 <para>To make an external olink active for HTML
3577 outputs, the link text is wrapped in an <tag>a</tag>
3578 element with an <tag>href</tag> attribute. To
3579 make an external olink active for FO outputs, the link text is
3580 wrapped in an <tag>fo:basic-link</tag> element with an
3581 <tag>external-destination</tag> attribute.</para>
3583 <para>This parameter is useful when you need external olinks
3584 to resolve but not be clickable. For example, if documents
3585 in a collection are available independently of each other,
3586 then having active links between them could lead to
3587 unresolved links when a given target document is missing.</para>
3589 <para>The epub stylesheets set this parameter to zero by default
3590 because there is no standard linking mechanism between Epub documents.</para>
3592 <para>If external links are made inactive, you should
3593 consider setting the
3594 stylesheet parameter <parameter>olink.doctitle</parameter>
3595 to <literal>yes</literal>. That will append the external document's
3596 title to the link text, making it easier for the user to
3597 locate the other document.</para>
3599 <para>An olink is considered external when the
3600 <parameter>current.docid</parameter> stylesheet parameter
3601 is set to some value, and the olink's <tag>targetdoc</tag>
3602 attribute has a different value. If the two values
3603 match, then the link is considered internal. If the
3604 <parameter>current.docid</parameter> parameter is blank, or
3605 the <tag>olink</tag> element does not have a <tag>targetdoc</tag> attribute,
3606 then the link is considered to be internal and will become
3607 an active link.</para>
3609 <para>See also <parameter>olink.doctitle</parameter>,
3610 <parameter>prefer.internal.olink</parameter>.</para>
3615 <refentry version="5.0" xml:id="collect.xref.targets">
3617 <refentrytitle>collect.xref.targets</refentrytitle>
3618 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
3619 <refmiscinfo class="other" otherclass="value">no</refmiscinfo>
3620 <refmiscinfo class="other" otherclass="value">yes</refmiscinfo>
3621 <refmiscinfo class="other" otherclass="value">only</refmiscinfo>
3624 <refname>collect.xref.targets</refname>
3625 <refpurpose>Controls whether cross reference data is
3626 collected</refpurpose>
3628 <refsynopsisdiv> <programlisting xml:id="collect.xref.targets.frag">
3629 <xsl:param name="collect.xref.targets">no</xsl:param>
3632 <refsection><info><title>Description</title></info>
3635 In order to resolve olinks efficiently, the stylesheets can
3636 generate an external data file containing information about
3637 all potential cross reference endpoints in a document.
3638 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.
3639 See also <parameter>targets.filename</parameter>.
3644 <refentry version="5.0" xml:id="insert.olink.page.number">
3646 <refentrytitle>insert.olink.page.number</refentrytitle>
3647 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
3648 <refmiscinfo class="other" otherclass="value">no</refmiscinfo>
3649 <refmiscinfo class="other" otherclass="value">yes</refmiscinfo>
3650 <refmiscinfo class="other" otherclass="value">maybe</refmiscinfo>
3653 <refname>insert.olink.page.number</refname>
3654 <refpurpose>Turns page numbers in olinks on and off</refpurpose>
3658 <programlisting xml:id="insert.olink.page.number.frag">
3659 <xsl:param name="insert.olink.page.number">no</xsl:param>
3663 <refsection><info><title>Description</title></info>
3665 <para>The value of this parameter determines if
3666 cross references made between documents with
3667 <tag>olink</tag> will
3668 include page number citations.
3669 In most cases this is only applicable to references in printed output.
3671 <para>The parameter has three possible values.
3676 <listitem><para>No page number references will be generated for olinks.
3681 <listitem><para>Page number references will be generated
3682 for all <tag>olink</tag> references.
3683 The style of page reference may be changed
3684 if an <tag class="attribute">xrefstyle</tag>
3690 <listitem><para>Page number references will not be generated
3691 for an <tag>olink</tag> element unless
3693 <tag class="attribute">xrefstyle</tag>
3694 attribute whose value specifies a page reference.
3698 <para>Olinks that point to targets within the same document
3699 are treated as <tag>xref</tag>s, and controlled by
3700 the <parameter>insert.xref.page.number</parameter> parameter.
3703 <para>Page number references for olinks to
3704 external documents can only be inserted if the
3705 information exists in the olink database.
3706 This means each olink target element
3707 (<tag>div</tag> or <tag>obj</tag>)
3708 must have a <tag class="attribute">page</tag> attribute
3709 whose value is its page number in the target document.
3710 The XSL stylesheets are not able to extract that information
3711 during processing because pages have not yet been created in
3712 XSLT transformation. Only the XSL-FO processor knows what
3713 page each element is placed on.
3714 Therefore some postprocessing must take place to populate
3715 page numbers in the olink database.
3723 <refentry version="5.0" xml:id="insert.olink.pdf.frag">
3725 <refentrytitle>insert.olink.pdf.frag</refentrytitle>
3726 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3729 <refname>insert.olink.pdf.frag</refname>
3730 <refpurpose>Add fragment identifiers for links into PDF files</refpurpose>
3734 <programlisting xml:id="insert.olink.pdf.frag.frag">
3735 <xsl:param name="insert.olink.pdf.frag" select="0"></xsl:param>
3739 <refsection><info><title>Description</title></info>
3741 <para>The value of this parameter determines whether
3742 the cross reference URIs to PDF documents made with
3743 <tag>olink</tag> will
3744 include fragment identifiers.
3747 <para>When forming a URI to link to a PDF document,
3748 a fragment identifier (typically a '#' followed by an
3749 id value) appended to the PDF filename can be used by
3750 the PDF viewer to open
3751 the PDF file to a location within the document instead of
3753 However, not all PDF files have id
3754 values embedded in them, and not all PDF viewers can
3755 handle fragment identifiers.
3758 <para>If <parameter>insert.olink.pdf.frag</parameter> is set
3759 to a non-zero value, then any olink targeting a
3760 PDF file will have the fragment identifier appended to the URI.
3761 The URI is formed by concatenating the value of the
3762 <parameter>olink.base.uri</parameter> parameter, the
3763 value of the <tag class="attribute">baseuri</tag>
3764 attribute from the <tag class="element">document</tag>
3765 element in the olink database with the matching
3766 <tag class="attribute">targetdoc</tag> value,
3767 and the value of the <tag class="attribute">href</tag>
3768 attribute for the targeted element in the olink database.
3769 The <tag class="attribute">href</tag> attribute
3770 contains the fragment identifier.
3773 <para>If <parameter>insert.olink.pdf.frag</parameter> is set
3774 to zero (the default value), then
3775 the <tag class="attribute">href</tag> attribute
3776 from the olink database
3777 is not appended to PDF olinks, so the fragment identifier is left off.
3778 A PDF olink is any olink for which the
3779 <tag class="attribute">baseuri</tag> attribute
3780 from the matching <tag class="element">document</tag>
3781 element in the olink database ends with '.pdf'.
3782 Any other olinks will still have the fragment identifier added.
3787 <refentry version="5.0" xml:id="olink.base.uri">
3789 <refentrytitle>olink.base.uri</refentrytitle>
3790 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
3793 <refname>olink.base.uri</refname>
3794 <refpurpose>Base URI used in olink hrefs</refpurpose>
3796 <refsynopsisdiv> <programlisting xml:id="olink.base.uri.frag">
3797 <xsl:param name="olink.base.uri"></xsl:param>
3800 <refsection><info><title>Description</title></info>
3802 <para>When cross reference data is collected for resolving olinks, it
3803 may be necessary to prepend a base URI to each target's href. This
3804 parameter lets you set that base URI when cross reference data is
3805 collected. This feature is needed when you want to link to a document
3806 that is processed without chunking. The output filename for such a
3807 document is not known to the XSL stylesheet; the only target
3808 information consists of fragment identifiers such as
3809 <literal>#idref</literal>. To enable the resolution of olinks between
3810 documents, you should pass the name of the HTML output file as the
3811 value of this parameter. Then the hrefs recorded in the cross
3812 reference data collection look like
3813 <literal>outfile.html#idref</literal>, which can be reached as links
3814 from other documents.</para>
3818 <refentry version="5.0" xml:id="olink.debug">
3820 <refentrytitle>olink.debug</refentrytitle>
3821 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3824 <refname>olink.debug</refname>
3825 <refpurpose>Turn on debugging messages for olinks</refpurpose>
3829 <programlisting xml:id="olink.debug.frag">
3830 <xsl:param name="olink.debug" select="0"></xsl:param>
3834 <refsection><info><title>Description</title></info>
3836 <para>If non-zero, then each olink will generate several
3837 messages about how it is being resolved during processing.
3838 This is useful when an olink does not resolve properly
3839 and the standard error messages are not sufficient to
3843 <para>You may need to read through the olink XSL templates
3844 to understand the context for some of the debug messages.
3850 <refentry version="5.0" xml:id="olink.doctitle">
3852 <refentrytitle>olink.doctitle</refentrytitle>
3853 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
3854 <refmiscinfo class="other" otherclass="value">no</refmiscinfo>
3855 <refmiscinfo class="other" otherclass="value">yes</refmiscinfo>
3856 <refmiscinfo class="other" otherclass="value">maybe</refmiscinfo>
3859 <refname>olink.doctitle</refname>
3860 <refpurpose>show the document title for external olinks?</refpurpose>
3863 <refsynopsisdiv> <programlisting xml:id="olink.doctitle.frag">
3864 <xsl:param name="olink.doctitle">no</xsl:param>
3867 <refsection><info><title>Description</title></info>
3869 <para>When olinks between documents are resolved, the generated text
3870 may not make it clear that the reference is to another document.
3871 It is possible for the stylesheets to append the other document's
3872 title to external olinks. For this to happen, two parameters must
3876 <para>This <parameter>olink.doctitle</parameter> parameter
3877 should be set to either <literal>yes</literal> or <literal>maybe</literal>
3878 to enable this feature.
3882 <para>And you should also set the <parameter>current.docid</parameter>
3883 parameter to the document id for the document currently
3884 being processed for output.
3890 Then if an olink's <literal>targetdoc</literal> id differs from
3891 the <literal>current.docid</literal> value, the stylesheet knows
3892 that it is a reference to another document and can
3893 append the target document's
3894 title to the generated olink text. </para>
3896 <para>The text for the target document's title is copied from the
3897 olink database from the <tag>ttl</tag> element
3898 of the top-level <tag>div</tag> for that document.
3899 If that <tag>ttl</tag> element is missing or empty,
3903 <para>The supported values for <parameter>olink.doctitle</parameter> are:
3907 <term><literal>yes</literal></term>
3910 Always insert the title to the target document if it is not
3911 the current document.
3916 <term><literal>no</literal></term>
3919 Never insert the title to the target document, even if requested
3920 in an <tag class="attribute">xrefstyle</tag> attribute.
3925 <term><literal>maybe</literal></term>
3928 Only insert the title to the target document, if requested
3929 in an <tag class="attribute">xrefstyle</tag> attribute.
3934 <para>An <tag class="attribute">xrefstyle</tag> attribute
3935 may override the global setting for individual olinks.
3936 The following values are supported in an
3937 <tag class="attribute">xrefstyle</tag>
3938 attribute using the <literal>select:</literal> syntax:
3943 <term><literal>docname</literal></term>
3946 Insert the target document name for this olink using the
3947 <literal>docname</literal> gentext template, but only
3948 if the value of <parameter>olink.doctitle</parameter>
3949 is not <literal>no</literal>.
3954 <term><literal>docnamelong</literal></term>
3957 Insert the target document name for this olink using the
3958 <literal>docnamelong</literal> gentext template, but only
3959 if the value of <parameter>olink.doctitle</parameter>
3960 is not <literal>no</literal>.
3965 <term><literal>nodocname</literal></term>
3968 Omit the target document name even if
3969 the value of <parameter>olink.doctitle</parameter>
3970 is <literal>yes</literal>.
3975 <para>Another way of inserting the target document name
3976 for a single olink is to employ an
3977 <tag class="attribute">xrefstyle</tag>
3978 attribute using the <literal>template:</literal> syntax.
3979 The <literal>%o</literal> placeholder (the letter o, not zero)
3981 will be filled in with the target document's title when it is processed.
3982 This will occur regardless of
3983 the value of <parameter>olink.doctitle</parameter>.
3985 <para>Note that prior to version 1.66 of the XSL stylesheets,
3986 the allowed values for this parameter were 0 and 1. Those
3987 values are still supported and mapped to 'no' and 'yes', respectively.
3992 <refentry version="5.0" xml:id="olink.lang.fallback.sequence">
3994 <refentrytitle>olink.lang.fallback.sequence</refentrytitle>
3995 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
3998 <refname>olink.lang.fallback.sequence</refname>
3999 <refpurpose>look up translated documents if olink not found?</refpurpose>
4002 <refsynopsisdiv> <programlisting xml:id="olink.lang.fallback.sequence.frag">
4003 <xsl:param name="olink.lang.fallback.sequence"></xsl:param>
4006 <refsection><info><title>Description</title></info>
4009 <para>This parameter defines a list of lang values
4010 to search among to resolve olinks.
4013 <para>Normally an olink tries to resolve to a document in the same
4014 language as the olink itself. The language of an olink
4015 is determined by its nearest ancestor element with a
4016 <tag class="attribute">lang</tag> attribute, otherwise the
4017 value of the <parameter>l10n.gentext.default.lang</parameter>
4021 <para>An olink database can contain target data for the same
4022 document in multiple languages. Each set of data has the
4023 same value for the <tag>targetdoc</tag> attribute in
4024 the <tag>document</tag> element in the database, but with a
4025 different <tag>lang</tag> attribute value.
4028 <para>When an olink is being resolved, the target is first
4029 sought in the document with the same language as the olink.
4030 If no match is found there, then this parameter is consulted
4031 for additional languages to try.</para>
4033 <para>The <parameter>olink.lang.fallback.sequence</parameter>
4034 must be a whitespace separated list of lang values to
4035 try. The first one with a match in the olink database is used.
4036 The default value is empty.</para>
4038 <para>For example, a document might be written in German
4039 and contain an olink with
4040 <literal>targetdoc="adminguide"</literal>.
4041 When the document is processed, the processor
4042 first looks for a target dataset in the
4043 olink database starting with:</para>
4045 <literallayout><literal><document targetdoc="adminguide" lang="de"></literal>.
4048 <para>If there is no such element, then the
4049 <parameter>olink.lang.fallback.sequence</parameter>
4050 parameter is consulted.
4051 If its value is, for example, <quote>fr en</quote>, then the processor next
4052 looks for <literal>targetdoc="adminguide" lang="fr"</literal>, and
4053 then for <literal>targetdoc="adminguide" lang="en"</literal>.
4054 If there is still no match, it looks for
4055 <literal>targetdoc="adminguide"</literal> with no
4059 <para>This parameter is useful when a set of documents is only
4060 partially translated, or is in the process of being translated.
4061 If a target of an olink has not yet been translated, then this
4062 parameter permits the processor to look for the document in
4063 other languages. This assumes the reader would rather have
4064 a link to a document in a different language than to have
4071 <refentry version="5.0" xml:id="olink.properties">
4073 <refentrytitle>olink.properties</refentrytitle>
4074 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
4077 <refname>olink.properties</refname>
4078 <refpurpose>Properties associated with the cross-reference
4079 text of an olink.</refpurpose>
4083 <programlisting xml:id="olink.properties.frag">
4084 <xsl:attribute-set name="olink.properties">
4085 <xsl:attribute name="show-destination">replace</xsl:attribute>
4086 </xsl:attribute-set>
4090 <refsection><info><title>Description</title></info>
4092 <para>This <literal>attribute set</literal> is applied to the
4093 <literal>fo:basic-link</literal> element of an olink. It is not applied to the
4094 optional page number or optional title of the external
4100 <refentry version="5.0" xml:id="prefer.internal.olink">
4102 <refentrytitle>prefer.internal.olink</refentrytitle>
4103 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
4106 <refname>prefer.internal.olink</refname>
4107 <refpurpose>Prefer a local olink reference to an external reference</refpurpose>
4111 <programlisting xml:id="prefer.internal.olink.frag">
4112 <xsl:param name="prefer.internal.olink" select="0"></xsl:param>
4116 <refsection><info><title>Description</title></info>
4118 <para>If you are re-using XML content modules in multiple documents,
4119 you may want to redirect some of your olinks. This parameter
4120 permits you to redirect an olink to the current document.
4123 <para>For example: you are writing documentation for a product,
4124 which includes 3 manuals: a little installation
4125 booklet (booklet.xml), a user
4126 guide (user.xml), and a reference manual (reference.xml).
4127 All 3 documents begin with the same introduction section (intro.xml) that
4128 contains a reference to the customization section (custom.xml) which is
4129 included in both user.xml and reference.xml documents.
4132 <para>How do you write the link to custom.xml in intro.xml
4133 so that it is interpreted correctly in all 3 documents?</para>
4135 <listitem><para>If you use xref, it will fail in booklet.xml.</para>
4137 <listitem><para>If you use olink (pointing to reference.xml),
4138 the reference in user.xml
4139 will point to the customization section of the reference manual, while it is
4140 actually available in user.xml.</para>
4144 <para>If you set the <parameter>prefer.internal.olink</parameter>
4145 parameter to a non-zero value, then the processor will
4146 first look in the olink database
4147 for the olink's <tag>targetptr</tag> attribute value
4148 in document matching the <parameter>current.docid</parameter>
4149 parameter value. If it isn't found there, then
4150 it tries the document in the database
4151 with the <tag>targetdoc</tag>
4152 value that matches the olink's <tag>targetdoc</tag>
4156 <para>This feature permits an olink reference to resolve to
4157 the current document if there is an element
4158 with an id matching the olink's <tag>targetptr</tag>
4159 value. The current document's olink data must be
4160 included in the target database for this to work.</para>
4163 <para>There is a potential for incorrect links if
4164 the same <tag>id</tag> attribute value is used for different
4165 content in different documents.
4166 Some of your olinks may be redirected to the current document
4167 when they shouldn't be. It is not possible to control
4168 individual olink instances.</para>
4174 <refentry version="5.0" xml:id="target.database.document">
4176 <refentrytitle>target.database.document</refentrytitle>
4177 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
4180 <refname>target.database.document</refname>
4181 <refpurpose>Name of master database file for resolving
4185 <programlisting xml:id="target.database.document.frag">
4186 <xsl:param name="target.database.document">olinkdb.xml</xsl:param>
4189 <refsection><info><title>Description</title></info>
4192 To resolve olinks between documents, the stylesheets use a master
4193 database document that identifies the target datafiles for all the
4194 documents within the scope of the olinks. This parameter value is the
4195 URI of the master document to be read during processing to resolve
4196 olinks. The default value is <filename>olinkdb.xml</filename>.</para>
4198 <para>The data structure of the file is defined in the
4199 <filename>targetdatabase.dtd</filename> DTD. The database file
4200 provides the high level elements to record the identifiers, locations,
4201 and relationships of documents. The cross reference data for
4202 individual documents is generally pulled into the database using
4203 system entity references or XIncludes. See also
4204 <parameter>targets.filename</parameter>. </para> </refsection>
4207 <refentry version="5.0" xml:id="targets.filename">
4209 <refentrytitle>targets.filename</refentrytitle>
4210 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
4213 <refname>targets.filename</refname>
4214 <refpurpose>Name of cross reference targets data file</refpurpose>
4216 <refsynopsisdiv> <programlisting xml:id="targets.filename.frag">
4217 <xsl:param name="targets.filename">target.db</xsl:param>
4220 <refsection><info><title>Description</title></info>
4223 In order to resolve olinks efficiently, the stylesheets can
4224 generate an external data file containing information about
4225 all potential cross reference endpoints in a document.
4226 This parameter lets you change the name of the generated
4227 file from the default name <filename>target.db</filename>.
4228 The name must agree with that used in the target database
4229 used to resolve olinks during processing.
4230 See also <parameter>target.database.document</parameter>.
4235 <refentry version="5.0" xml:id="use.local.olink.style">
4237 <refentrytitle>use.local.olink.style</refentrytitle>
4238 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
4241 <refname>use.local.olink.style</refname>
4242 <refpurpose>Process olinks using xref style of current
4243 document</refpurpose>
4245 <refsynopsisdiv> <programlisting xml:id="use.local.olink.style.frag">
4246 <xsl:param name="use.local.olink.style" select="0"></xsl:param> </programlisting>
4248 <refsection><info><title>Description</title></info>
4250 <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
4251 reference string is formed again from the target title, number, and
4252 element name, using the stylesheet processing the targeting document.
4253 Then olinks will match the xref style in the targeting document
4254 rather than in the target document. If both documents are processed
4255 with the same stylesheet, then the results will be the same.</para>
4260 <reference xml:id="xrefs"><title>Cross References</title>
4261 <refentry version="5.0" xml:id="insert.xref.page.number">
4263 <refentrytitle>insert.xref.page.number</refentrytitle>
4264 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
4265 <refmiscinfo class="other" otherclass="value">no</refmiscinfo>
4266 <refmiscinfo class="other" otherclass="value">yes</refmiscinfo>
4267 <refmiscinfo class="other" otherclass="value">maybe</refmiscinfo>
4270 <refname>insert.xref.page.number</refname>
4271 <refpurpose>Turns page numbers in xrefs on and off</refpurpose>
4275 <programlisting xml:id="insert.xref.page.number.frag">
4276 <xsl:param name="insert.xref.page.number">no</xsl:param>
4280 <refsection><info><title>Description</title></info>
4282 <para>The value of this parameter determines if
4283 cross references (<tag>xref</tag>s) in
4285 include page number citations.
4286 It has three possible values.
4291 <listitem><para>No page number references will be generated.
4296 <listitem><para>Page number references will be generated
4297 for all <tag>xref</tag> elements.
4298 The style of page reference may be changed
4299 if an <tag class="attribute">xrefstyle</tag>
4305 <listitem><para>Page number references will not be generated
4306 for an <tag>xref</tag> element unless
4308 <tag class="attribute">xrefstyle</tag>
4309 attribute whose value specifies a page reference.
4317 <refentry version="5.0" xml:id="insert.xref.page.number.para">
4319 <refentrytitle>insert.xref.page.number.para</refentrytitle>
4320 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
4321 <refmiscinfo class="other" otherclass="value">yes</refmiscinfo>
4322 <refmiscinfo class="other" otherclass="value">maybe</refmiscinfo>
4325 <refname>insert.xref.page.number.para</refname>
4326 <refpurpose>Turns page numbers in xrefs to paragraphs on and off</refpurpose>
4330 <programlisting xml:id="insert.xref.page.number.para.frag">
4331 <xsl:param name="insert.xref.page.number.para">yes</xsl:param>
4335 <refsection><info><title>Description</title></info>
4337 <para>The value of this parameter determines if
4338 cross references (<tag>xref</tag>s) to paragraphs in
4339 printed output will include page number citations.
4341 <para>Historically, cross references to paragraphs
4342 included page number citations unconditionally, regardless
4343 of the <parameter>insert.xref.page.number</parameter>
4348 <listitem><para>Page number references will be generated
4349 for paragraphs.</para></listitem>
4353 <listitem><para>Whether page number references are generated
4354 for an <tag>xref</tag> element referring to a paragraph will
4355 be controlled by the <parameter>insert.xref.page.number</parameter>
4356 rules.</para></listitem>
4364 <refentry version="5.0" xml:id="xref.properties">
4366 <refentrytitle>xref.properties</refentrytitle>
4367 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
4370 <refname>xref.properties</refname>
4371 <refpurpose>Properties associated with cross-reference text</refpurpose>
4375 <programlisting xml:id="xref.properties.frag">
4376 <xsl:attribute-set name="xref.properties">
4377 </xsl:attribute-set>
4381 <refsection><info><title>Description</title></info>
4383 <para>This attribute set is used to set properties
4384 on cross reference text.</para>
4389 <refentry version="5.0" xml:id="xref.label-title.separator">
4391 <refentrytitle>xref.label-title.separator</refentrytitle>
4392 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
4395 <refname>xref.label-title.separator</refname>
4396 <refpurpose>Punctuation or space separating label from title in xref</refpurpose>
4400 <programlisting xml:id="xref.label-title.separator.frag"><xsl:param name="xref.label-title.separator">: </xsl:param></programlisting>
4403 <refsection><info><title>Description</title></info>
4406 This parameter allows you to control the punctuation of certain
4407 types of generated cross reference text.
4408 When cross reference text is generated for an
4409 <tag class="element">xref</tag> or
4410 <tag class="element">olink</tag> element
4411 using an <tag class="attribute">xrefstyle</tag> attribute
4412 that makes use of the <literal>select:</literal> feature,
4413 and the selected components include both label and title,
4414 then the value of this parameter is inserted between
4415 label and title in the output.
4421 <refentry version="5.0" xml:id="xref.label-page.separator">
4423 <refentrytitle>xref.label-page.separator</refentrytitle>
4424 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
4427 <refname>xref.label-page.separator</refname>
4428 <refpurpose>Punctuation or space separating label from page number in xref</refpurpose>
4432 <programlisting xml:id="xref.label-page.separator.frag"><xsl:param name="xref.label-page.separator"><xsl:text> </xsl:text></xsl:param></programlisting>
4435 <refsection><info><title>Description</title></info>
4438 This parameter allows you to control the punctuation of certain
4439 types of generated cross reference text.
4440 When cross reference text is generated for an
4441 <tag class="element">xref</tag> or
4442 <tag class="element">olink</tag> element
4443 using an <tag class="attribute">xrefstyle</tag> attribute
4444 that makes use of the <literal>select:</literal> feature,
4445 and the selected components include both label and page
4447 then the value of this parameter is inserted between
4448 label and page number in the output.
4449 If a title is included, then other separators are used.
4455 <refentry version="5.0" xml:id="xref.title-page.separator">
4457 <refentrytitle>xref.title-page.separator</refentrytitle>
4458 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
4461 <refname>xref.title-page.separator</refname>
4462 <refpurpose>Punctuation or space separating title from page number in xref</refpurpose>
4466 <programlisting xml:id="xref.title-page.separator.frag"><xsl:param name="xref.title-page.separator"><xsl:text> </xsl:text></xsl:param></programlisting>
4469 <refsection><info><title>Description</title></info>
4472 This parameter allows you to control the punctuation of certain
4473 types of generated cross reference text.
4474 When cross reference text is generated for an
4475 <tag class="element">xref</tag> or
4476 <tag class="element">olink</tag> element
4477 using an <tag class="attribute">xrefstyle</tag> attribute
4478 that makes use of the <literal>select:</literal> feature,
4479 and the selected components include both title and page number,
4480 then the value of this parameter is inserted between
4481 title and page number in the output.
4487 <refentry version="5.0" xml:id="insert.link.page.number">
4489 <refentrytitle>insert.link.page.number</refentrytitle>
4490 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
4491 <refmiscinfo class="other" otherclass="value">no</refmiscinfo>
4492 <refmiscinfo class="other" otherclass="value">yes</refmiscinfo>
4493 <refmiscinfo class="other" otherclass="value">maybe</refmiscinfo>
4496 <refname>insert.link.page.number</refname>
4497 <refpurpose>Turns page numbers in link elements on and off</refpurpose>
4501 <programlisting xml:id="insert.link.page.number.frag">
4502 <xsl:param name="insert.link.page.number">no</xsl:param>
4506 <refsection><info><title>Description</title></info>
4508 <para>The value of this parameter determines if
4509 cross references using the <tag>link</tag> element in
4511 include standard page number citations.
4512 It has three possible values.
4517 <listitem><para>No page number references will be generated.
4522 <listitem><para>Page number references will be generated
4523 for all <tag>link</tag> elements.
4524 The style of page reference may be changed
4525 if an <tag class="attribute">xrefstyle</tag>
4531 <listitem><para>Page number references will not be generated
4532 for a <tag>link</tag> element unless
4534 <tag class="attribute">xrefstyle</tag>
4535 attribute whose value specifies a page reference.
4540 <para>Although the <tag>xrefstyle</tag> attribute
4541 can be used to turn the page reference on or off, it cannot be
4542 used to control the formatting of the page number as it
4543 can in <tag>xref</tag>.
4544 In <tag>link</tag> it will always format with
4545 the style established by the
4546 gentext template with <literal>name="page.citation"</literal>
4547 in the <literal>l:context name="xref"</literal>.
4553 <reference xml:id="lists"><title>Lists</title>
4554 <refentry version="5.0" xml:id="compact.list.item.spacing">
4556 <refentrytitle>compact.list.item.spacing</refentrytitle>
4557 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
4560 <refname>compact.list.item.spacing</refname>
4561 <refpurpose>What space do you want between list items (when spacing="compact")?</refpurpose>
4565 <programlisting xml:id="compact.list.item.spacing.frag"><xsl:attribute-set name="compact.list.item.spacing">
4566 <xsl:attribute name="space-before.optimum">0em</xsl:attribute>
4567 <xsl:attribute name="space-before.minimum">0em</xsl:attribute>
4568 <xsl:attribute name="space-before.maximum">0.2em</xsl:attribute>
4569 </xsl:attribute-set></programlisting>
4571 <refsection><info><title>Description</title></info>
4572 <para>Specify what spacing you want between each list item when
4573 <tag class="attribute">spacing</tag> is
4574 <quote><literal>compact</literal></quote>.</para>
4578 <refentry version="5.0" xml:id="itemizedlist.properties">
4580 <refentrytitle>itemizedlist.properties</refentrytitle>
4581 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
4584 <refname>itemizedlist.properties</refname>
4585 <refpurpose>Properties that apply to each list-block generated by itemizedlist.</refpurpose>
4589 <programlisting xml:id="itemizedlist.properties.frag"><xsl:attribute-set name="itemizedlist.properties" use-attribute-sets="list.block.properties">
4590 </xsl:attribute-set></programlisting>
4592 <refsection><info><title>Description</title></info>
4593 <para>Properties that apply to each fo:list-block generated by itemizedlist.</para>
4597 <refentry version="5.0" xml:id="itemizedlist.label.properties">
4599 <refentrytitle>itemizedlist.label.properties</refentrytitle>
4600 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
4603 <refname>itemizedlist.label.properties</refname>
4604 <refpurpose>Properties that apply to each label inside itemized list.</refpurpose>
4608 <programlisting xml:id="itemizedlist.label.properties.frag"><xsl:attribute-set name="itemizedlist.label.properties">
4609 </xsl:attribute-set></programlisting>
4611 <refsection><info><title>Description</title></info>
4612 <para>Properties that apply to each label inside itemized list. E.g.:</para>
4613 <programlisting><xsl:attribute-set name="itemizedlist.label.properties">
4614 <xsl:attribute name="text-align">right</xsl:attribute>
4615 </xsl:attribute-set></programlisting>
4619 <refentry version="5.0" xml:id="itemizedlist.label.width">
4621 <refentrytitle>itemizedlist.label.width</refentrytitle>
4622 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
4625 <refname>itemizedlist.label.width</refname>
4626 <refpurpose>The default width of the label (bullet) in an itemized list.</refpurpose>
4630 <programlisting xml:id="itemizedlist.label.width.frag">
4631 <xsl:param name="itemizedlist.label.width">1.0em</xsl:param>
4635 <refsection><info><title>Description</title></info>
4636 <para>Specifies the default width of the label (usually a bullet or other
4637 symbol) in an itemized list. You can override the default value on any
4638 particular list with the “dbfo” processing instruction using the
4639 “label-width” pseudoattribute.</para>
4643 <refentry version="5.0" xml:id="list.block.properties">
4645 <refentrytitle>list.block.properties</refentrytitle>
4646 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
4649 <refname>list.block.properties</refname>
4650 <refpurpose>Properties that apply to each list-block generated by list.</refpurpose>
4654 <programlisting xml:id="list.block.properties.frag"><xsl:attribute-set name="list.block.properties">
4655 <xsl:attribute name="provisional-label-separation">0.2em</xsl:attribute>
4656 <xsl:attribute name="provisional-distance-between-starts">1.5em</xsl:attribute>
4657 </xsl:attribute-set></programlisting>
4659 <refsection><info><title>Description</title></info>
4660 <para>Properties that apply to each fo:list-block generated by itemizedlist/orderedlist.</para>
4664 <refentry version="5.0" xml:id="list.block.spacing">
4666 <refentrytitle>list.block.spacing</refentrytitle>
4667 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
4670 <refname>list.block.spacing</refname>
4671 <refpurpose>What spacing do you want before and after lists?</refpurpose>
4675 <programlisting xml:id="list.block.spacing.frag"><xsl:attribute-set name="list.block.spacing">
4676 <xsl:attribute name="space-before.optimum">1em</xsl:attribute>
4677 <xsl:attribute name="space-before.minimum">0.8em</xsl:attribute>
4678 <xsl:attribute name="space-before.maximum">1.2em</xsl:attribute>
4679 <xsl:attribute name="space-after.optimum">1em</xsl:attribute>
4680 <xsl:attribute name="space-after.minimum">0.8em</xsl:attribute>
4681 <xsl:attribute name="space-after.maximum">1.2em</xsl:attribute>
4682 </xsl:attribute-set></programlisting>
4684 <refsection><info><title>Description</title></info>
4685 <para>Specify the spacing required before and after a list. It is necessary to specify the space after a list block because lists can come inside of paras. </para>
4686 <para>This attribute set is not applied to nested lists, so that only the
4687 <parameter>list.item.spacing</parameter> attribute-set is used, which provides
4688 consistent spacing.</para>
4692 <refentry version="5.0" xml:id="list.item.spacing">
4694 <refentrytitle>list.item.spacing</refentrytitle>
4695 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
4698 <refname>list.item.spacing</refname>
4699 <refpurpose>What space do you want between list items?</refpurpose>
4703 <programlisting xml:id="list.item.spacing.frag"><xsl:attribute-set name="list.item.spacing">
4704 <xsl:attribute name="space-before.optimum">1em</xsl:attribute>
4705 <xsl:attribute name="space-before.minimum">0.8em</xsl:attribute>
4706 <xsl:attribute name="space-before.maximum">1.2em</xsl:attribute>
4707 </xsl:attribute-set></programlisting>
4709 <refsection><info><title>Description</title></info>
4710 <para>Specify what spacing you want before (and optionally after) each list item.</para>
4711 <para>See also <parameter>list.block.spacing</parameter>, which sets
4712 the spacing before and after an entire list.</para>
4716 <refentry version="5.0" xml:id="mark.optional.procedure.steps">
4718 <refentrytitle>mark.optional.procedure.steps</refentrytitle>
4719 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
4722 <refname>mark.optional.procedure.steps</refname>
4723 <refpurpose>Specifies whether to mark optional procedure steps</refpurpose>
4727 <programlisting xml:id="mark.optional.procedure.steps.frag">
4728 <xsl:param name="mark.optional.procedure.steps">1</xsl:param>
4732 <refsection><info><title>Description</title></info>
4734 <para>This parameter specifies whether a procedure step
4735 with attribute <tag>performance</tag> set to <literal>optional</literal>
4736 should be marked. If set to 1 (the default value), then the
4737 text "(Optional)" appears at the start of the first paragraph.
4738 If set to zero, then no text is generated.</para>
4740 <para>The text can be customized in the gentext element with
4741 key="optional-step".</para>
4746 <refentry version="5.0" xml:id="orderedlist.properties">
4748 <refentrytitle>orderedlist.properties</refentrytitle>
4749 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
4752 <refname>orderedlist.properties</refname>
4753 <refpurpose>Properties that apply to each list-block generated by orderedlist.</refpurpose>
4757 <programlisting xml:id="orderedlist.properties.frag"><xsl:attribute-set name="orderedlist.properties" use-attribute-sets="list.block.properties">
4758 <xsl:attribute name="provisional-distance-between-starts">2em</xsl:attribute>
4759 </xsl:attribute-set></programlisting>
4761 <refsection><info><title>Description</title></info>
4762 <para>Properties that apply to each fo:list-block generated by orderedlist.</para>
4766 <refentry version="5.0" xml:id="orderedlist.label.properties">
4768 <refentrytitle>orderedlist.label.properties</refentrytitle>
4769 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
4772 <refname>orderedlist.label.properties</refname>
4773 <refpurpose>Properties that apply to each label inside ordered list.</refpurpose>
4777 <programlisting xml:id="orderedlist.label.properties.frag"><xsl:attribute-set name="orderedlist.label.properties">
4778 </xsl:attribute-set></programlisting>
4780 <refsection><info><title>Description</title></info>
4781 <para>Properties that apply to each label inside ordered list. E.g.:</para>
4782 <programlisting><xsl:attribute-set name="orderedlist.label.properties">
4783 <xsl:attribute name="text-align">right</xsl:attribute>
4784 </xsl:attribute-set></programlisting>
4788 <refentry version="5.0" xml:id="orderedlist.label.width">
4790 <refentrytitle>orderedlist.label.width</refentrytitle>
4791 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
4794 <refname>orderedlist.label.width</refname>
4795 <refpurpose>The default width of the label (number) in an ordered list.</refpurpose>
4799 <programlisting xml:id="orderedlist.label.width.frag">
4800 <xsl:param name="orderedlist.label.width">1.2em</xsl:param>
4804 <refsection><info><title>Description</title></info>
4805 <para>Specifies the default width of the label (usually a number or
4806 sequence of numbers) in an ordered list. You can override the default
4807 value on any particular list with the “dbfo” processing instruction
4808 using the “label-width” pseudoattribute.</para>
4812 <refentry version="5.0" xml:id="variablelist.max.termlength">
4814 <refentrytitle>variablelist.max.termlength</refentrytitle>
4815 <refmiscinfo class="other" otherclass="datatype">number</refmiscinfo>
4818 <refname>variablelist.max.termlength</refname>
4819 <refpurpose>Specifies the longest term in variablelists</refpurpose>
4823 <programlisting xml:id="variablelist.max.termlength.frag">
4824 <xsl:param name="variablelist.max.termlength">24</xsl:param>
4828 <refsection><info><title>Description</title></info>
4830 <para>In variablelists, the <tag>listitem</tag>
4831 is indented to leave room for the
4832 <tag>term</tag> elements. That indent may be computed
4833 if it is not specified with a <tag class="attribute">termlength</tag>
4834 attribute on the <tag>variablelist</tag> element.
4837 The computation counts characters in the
4838 <tag>term</tag> elements in the list
4839 to find the longest term. However, some terms are very long
4840 and would produce extreme indents. This parameter lets you
4841 set a maximum character count. Any terms longer than the maximum
4842 would line wrap. The default value is 24.
4845 The character counts are converted to physical widths
4846 by multiplying by 0.50em. There will be some variability
4847 in how many actual characters fit in the space
4848 since some characters are wider than others.
4854 <refentry version="5.0" xml:id="variablelist.term.separator">
4856 <refentrytitle>variablelist.term.separator</refentrytitle>
4857 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
4860 <refname>variablelist.term.separator</refname>
4861 <refpurpose>Text to separate <tag>term</tag>s within a multi-term
4862 <tag>varlistentry</tag></refpurpose>
4866 <programlisting xml:id="variablelist.term.separator.frag">
4867 <xsl:param name="variablelist.term.separator">, </xsl:param></programlisting>
4870 <refsection><info><title>Description</title></info>
4872 <para>When a <tag>varlistentry</tag> contains multiple <tag>term</tag>
4873 elements, the string specified in the value of the
4874 <parameter>variablelist.term.separator</parameter> parameter is placed
4875 after each <tag>term</tag> except the last.</para>
4878 <para>To generate a line break between multiple <tag>term</tag>s in
4879 a <tag>varlistentry</tag>, set a non-zero value for the
4880 <parameter>variablelist.term.break.after</parameter> parameter. If
4881 you do so, you may also want to set the value of the
4882 <parameter>variablelist.term.separator</parameter> parameter to an
4883 empty string (to suppress rendering of the default comma and space
4884 after each <tag>term</tag>).</para>
4890 <refentry version="5.0" xml:id="variablelist.term.properties">
4892 <refentrytitle>variablelist.term.properties</refentrytitle>
4893 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
4896 <refname>variablelist.term.properties</refname>
4897 <refpurpose>To add properties to the term elements in a variablelist.</refpurpose>
4901 <programlisting xml:id="variablelist.term.properties.frag">
4902 <xsl:attribute-set name="variablelist.term.properties">
4903 </xsl:attribute-set>
4906 <refsection><info><title>Description</title></info>
4907 <para>These properties are added to the block containing a
4908 term in a variablelist.
4909 Use this attribute-set to set
4910 font properties or alignment, for example.</para>
4915 <refentry version="5.0" xml:id="variablelist.term.break.after">
4917 <refentrytitle>variablelist.term.break.after</refentrytitle>
4918 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
4921 <refname>variablelist.term.break.after</refname>
4922 <refpurpose>Generate line break after each <tag>term</tag> within a
4923 multi-term <tag>varlistentry</tag>?</refpurpose>
4927 <programlisting xml:id="variablelist.term.break.after.frag">
4928 <xsl:param name="variablelist.term.break.after">0</xsl:param></programlisting>
4931 <refsection><info><title>Description</title></info>
4933 <para>Set a non-zero value for the
4934 <parameter>variablelist.term.break.after</parameter> parameter to
4935 generate a line break between <tag>term</tag>s in a
4936 multi-term <tag>varlistentry</tag>.</para>
4939 <para>If you set a non-zero value for
4940 <parameter>variablelist.term.break.after</parameter>, you may also
4941 want to set the value of the
4942 <parameter>variablelist.term.separator</parameter> parameter to an
4943 empty string (to suppress rendering of the default comma and space
4944 after each <tag>term</tag>).</para>
4951 <reference xml:id="qa"><title>QAndASet</title>
4952 <refentry version="5.0" xml:id="qandadiv.autolabel">
4954 <refentrytitle>qandadiv.autolabel</refentrytitle>
4955 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
4958 <refname>qandadiv.autolabel</refname>
4959 <refpurpose>Are divisions in QAndASets enumerated?</refpurpose>
4963 <programlisting xml:id="qandadiv.autolabel.frag"><xsl:param name="qandadiv.autolabel" select="1"></xsl:param></programlisting>
4966 <refsection><info><title>Description</title></info>
4968 <para>If non-zero, unlabeled qandadivs will be enumerated.
4974 <refentry version="5.0" xml:id="qanda.inherit.numeration">
4976 <refentrytitle>qanda.inherit.numeration</refentrytitle>
4977 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
4980 <refname>qanda.inherit.numeration</refname>
4981 <refpurpose>Does enumeration of QandASet components inherit the numeration of parent elements?</refpurpose>
4985 <programlisting xml:id="qanda.inherit.numeration.frag">
4986 <xsl:param name="qanda.inherit.numeration" select="1"></xsl:param>
4990 <refsection><info><title>Description</title></info>
4992 <para>If non-zero, numbered <tag>qandadiv</tag> elements and
4993 <tag>question</tag> and <tag>answer</tag> inherit the enumeration of
4994 the ancestors of the <tag>qandaset</tag>.
5000 <refentry version="5.0" xml:id="qanda.defaultlabel">
5002 <refentrytitle>qanda.defaultlabel</refentrytitle>
5003 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
5004 <refmiscinfo class="other" otherclass="value">number</refmiscinfo>
5005 <refmiscinfo class="other" otherclass="value">qanda</refmiscinfo>
5006 <refmiscinfo class="other" otherclass="value">none</refmiscinfo>
5009 <refname>qanda.defaultlabel</refname>
5010 <refpurpose>Sets the default for defaultlabel on QandASet.</refpurpose>
5014 <programlisting xml:id="qanda.defaultlabel.frag">
5015 <xsl:param name="qanda.defaultlabel">number</xsl:param>
5019 <refsection><info><title>Description</title></info>
5021 <para>If no <literal>defaultlabel</literal> attribute is specified on
5022 a <tag>qandaset</tag>, this value is used. It is generally one of the legal
5023 values for the defaultlabel attribute (<literal>none</literal>,
5024 <literal>number</literal> or
5025 <literal>qanda</literal>), or one of the additional stylesheet-specific values
5026 (<literal>qnumber</literal> or <literal>qnumberanda</literal>).
5027 The default value is 'number'.
5029 <para>The values are rendered as follows:</para>
5031 <varlistentry><term><literal>qanda</literal></term>
5033 <para><tag>question</tag>s are labeled "Q:" and
5034 <tag>answer</tag>s are labeled "A:". </para>
5038 <varlistentry><term><literal>number</literal></term>
5040 <para>The questions are enumerated and the answers
5041 are not labeled. </para>
5045 <varlistentry><term><literal>qnumber</literal></term>
5047 <para>The questions are labeled "Q:" followed by a number, and answers are not
5049 When sections are numbered, adding a label
5050 to the number distinguishes the question numbers
5051 from the section numbers.
5052 This value is not allowed in the
5053 <tag class="attribute">defaultlabel</tag> attribute
5054 of a <tag>qandaset</tag> element.</para>
5058 <varlistentry><term><literal>qnumberanda</literal></term>
5060 <para>The questions are labeled "Q:" followed by a number, and
5061 the answers are labeled "A:".
5062 When sections are numbered, adding a label
5063 to the number distinguishes the question numbers
5064 from the section numbers.
5065 This value is not allowed in the
5066 <tag class="attribute">defaultlabel</tag> attribute
5067 of a <tag>qandaset</tag> element.</para>
5071 <varlistentry><term><literal>none</literal></term>
5073 <para>No distinguishing label precedes Questions or Answers.
5082 <refentry version="5.0" xml:id="qanda.in.toc">
5084 <refentrytitle>qanda.in.toc</refentrytitle>
5085 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
5088 <refname>qanda.in.toc</refname>
5089 <refpurpose>Should qandaentry questions appear in
5090 the document table of contents?</refpurpose>
5094 <programlisting xml:id="qanda.in.toc.frag"><xsl:param name="qanda.in.toc" select="0"></xsl:param></programlisting>
5097 <refsection><info><title>Description</title></info>
5099 <para>If true (non-zero), then the generated table of contents
5100 for a document will include <tag>qandaset</tag> titles,
5101 <tag>qandadiv</tag> titles,
5102 and <tag>question</tag> elements. The default value (zero) excludes
5105 <para>This parameter does not affect any tables of contents
5106 that may be generated inside a qandaset or qandadiv.
5112 <refentry version="5.0" xml:id="qanda.nested.in.toc">
5114 <refentrytitle>qanda.nested.in.toc</refentrytitle>
5115 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
5118 <refname>qanda.nested.in.toc</refname>
5119 <refpurpose>Should nested answer/qandaentry instances appear in TOC?</refpurpose>
5123 <programlisting xml:id="qanda.nested.in.toc.frag">
5124 <xsl:param name="qanda.nested.in.toc" select="0"></xsl:param>
5128 <refsection><info><title>Description</title></info>
5130 <para>If non-zero, instances of <tag>qandaentry</tag>
5131 that are children of <tag>answer</tag> elements are shown in
5138 <reference xml:id="biblio"><title>Bibliography</title>
5139 <refentry version="5.0" xml:id="bibliography.style">
5141 <refentrytitle>bibliography.style</refentrytitle>
5142 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
5143 <refmiscinfo class="other" otherclass="value">normal</refmiscinfo>
5144 <refmiscinfo class="other" otherclass="value">iso690</refmiscinfo>
5147 <refname>bibliography.style</refname>
5148 <refpurpose>Style used for formatting of biblioentries.</refpurpose>
5152 <programlisting xml:id="bibliography.style.frag">
5153 <xsl:param name="bibliography.style">normal</xsl:param>
5157 <refsection><info><title>Description</title></info>
5159 <para>Currently only <literal>normal</literal> and
5160 <literal>iso690</literal> styles are supported.</para>
5162 <para>In order to use ISO690 style to the full extent you might need
5163 to use additional markup described on <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://wiki.docbook.org/topic/ISO690Bibliography">the
5164 following WiKi page</link>.</para>
5169 <refentry version="5.0" xml:id="biblioentry.item.separator">
5171 <refentrytitle>biblioentry.item.separator</refentrytitle>
5172 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
5175 <refname>biblioentry.item.separator</refname>
5176 <refpurpose>Text to separate bibliography entries</refpurpose>
5180 <programlisting xml:id="biblioentry.item.separator.frag"><xsl:param name="biblioentry.item.separator">. </xsl:param></programlisting>
5183 <refsection><info><title>Description</title></info>
5185 <para>Text to separate bibliography entries
5191 <refentry version="5.0" xml:id="bibliography.collection">
5193 <refentrytitle>bibliography.collection</refentrytitle>
5194 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
5197 <refname>bibliography.collection</refname>
5198 <refpurpose>Name of the bibliography collection file</refpurpose>
5202 <programlisting xml:id="bibliography.collection.frag">
5203 <xsl:param name="bibliography.collection">http://docbook.sourceforge.net/release/bibliography/bibliography.xml</xsl:param>
5208 <refsection><info><title>Description</title></info>
5210 <para>Maintaining bibliography entries across a set of documents is tedious, time
5211 consuming, and error prone. It makes much more sense, usually, to store all of
5212 the bibliography entries in a single place and simply <quote>extract</quote>
5213 the ones you need in each document.</para>
5215 <para>That's the purpose of the
5216 <parameter>bibliography.collection</parameter> parameter. To setup a global
5217 bibliography <quote>database</quote>, follow these steps:</para>
5219 <para>First, create a stand-alone bibliography document that contains all of
5220 the documents that you wish to reference. Make sure that each bibliography
5221 entry (whether you use <tag>biblioentry</tag> or <tag>bibliomixed</tag>)
5224 <para>My global bibliography, <filename>~/bibliography.xml</filename> begins
5228 <programlisting><!DOCTYPE bibliography
5229 PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
5230 "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
5231 <bibliography><title>References</title>
5233 <bibliomixed id="xml-rec"><abbrev>XML 1.0</abbrev>Tim Bray,
5234 Jean Paoli, C. M. Sperberg-McQueen, and Eve Maler, editors.
5235 <citetitle><ulink url="http://www.w3.org/TR/REC-xml">Extensible Markup
5236 Language (XML) 1.0 Second Edition</ulink></citetitle>.
5237 World Wide Web Consortium, 2000.
5238 </bibliomixed>
5240 <bibliomixed id="xml-names"><abbrev>Namespaces</abbrev>Tim Bray,
5242 and Andrew Layman, editors.
5243 <citetitle><ulink url="http://www.w3.org/TR/REC-xml-names/">Namespaces in
5244 XML</ulink></citetitle>.
5245 World Wide Web Consortium, 1999.
5246 </bibliomixed>
5249 </bibliography>
5253 <para>When you create a bibliography in your document, simply
5254 provide <emphasis>empty</emphasis> <tag>bibliomixed</tag>
5255 entries for each document that you wish to cite. Make sure that these
5256 elements have the same ID as the corresponding <quote>real</quote>
5257 entry in your global bibliography.</para>
5259 <para>For example:</para>
5262 <programlisting><bibliography><title>Bibliography</title>
5264 <bibliomixed id="xml-rec"/>
5265 <bibliomixed id="xml-names"/>
5266 <bibliomixed id="DKnuth86">Donald E. Knuth. <citetitle>Computers and
5267 Typesetting: Volume B, TeX: The Program</citetitle>. Addison-Wesley,
5268 1986. ISBN 0-201-13437-3.
5269 </bibliomixed>
5270 <bibliomixed id="relaxng"/>
5272 </bibliography></programlisting>
5275 <para>Note that it's perfectly acceptable to mix entries from your
5276 global bibliography with <quote>normal</quote> entries. You can use
5277 <tag>xref</tag> or other elements to cross-reference your
5278 bibliography entries in exactly the same way you do now.</para>
5280 <para>Finally, when you are ready to format your document, simply set the
5281 <parameter>bibliography.collection</parameter> parameter (in either a
5282 customization layer or directly through your processor's interface) to
5283 point to your global bibliography.</para>
5285 <para>A relative path in the parameter is interpreted in one
5287 <orderedlist numeration="loweralpha">
5289 <para>If your document contains no links to empty bibliographic elements,
5290 then the path is relative to the file containing
5291 the first <tag>bibliomixed</tag> element in the document.</para>
5294 <para>If your document does contain links to empty bibliographic elements,
5295 then the path is relative to the file containing
5296 the first such link element in the document.</para>
5299 <para>Once the collection file is opened by the first instance described
5300 above, it stays open for the current document
5301 and the relative path is not reinterpreted again.</para>
5303 <para>The stylesheets will format the bibliography in your document as if
5304 all of the entries referenced appeared there literally.</para>
5309 <refentry version="5.0" xml:id="bibliography.numbered">
5311 <refentrytitle>bibliography.numbered</refentrytitle>
5312 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
5315 <refname>bibliography.numbered</refname>
5316 <refpurpose>Should bibliography entries be numbered?</refpurpose>
5320 <programlisting xml:id="bibliography.numbered.frag">
5321 <xsl:param name="bibliography.numbered" select="0"></xsl:param>
5325 <refsection><info><title>Description</title></info>
5327 <para>If non-zero bibliography entries will be numbered</para>
5332 <refentry version="5.0" xml:id="biblioentry.properties">
5334 <refentrytitle>biblioentry.properties</refentrytitle>
5335 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
5338 <refname>biblioentry.properties</refname>
5339 <refpurpose>To set the style for biblioentry.</refpurpose>
5343 <programlisting xml:id="biblioentry.properties.frag"><xsl:attribute-set name="biblioentry.properties" use-attribute-sets="normal.para.spacing">
5344 <xsl:attribute name="start-indent">0.5in</xsl:attribute>
5345 <xsl:attribute name="text-indent">-0.5in</xsl:attribute>
5346 </xsl:attribute-set>
5349 <refsection><info><title>Description</title></info>
5350 <para>How do you want biblioentry styled? </para>
5351 <para>Set the font-size, weight, space-above and space-below, indents, etc. to the style required</para>
5357 <reference xml:id="glossary"><title>Glossary</title>
5358 <refentry version="5.0" xml:id="glossterm.auto.link">
5360 <refentrytitle>glossterm.auto.link</refentrytitle>
5361 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
5364 <refname>glossterm.auto.link</refname>
5365 <refpurpose>Generate links from glossterm to glossentry automatically?</refpurpose>
5369 <programlisting xml:id="glossterm.auto.link.frag">
5370 <xsl:param name="glossterm.auto.link" select="0"></xsl:param>
5374 <refsection><info><title>Description</title></info>
5376 <para>If non-zero, links from inline <tag>glossterm</tag>s to the corresponding
5377 <tag>glossentry</tag> elements in a <tag>glossary</tag> or <tag>glosslist</tag>
5378 will be automatically generated. This is useful when your glossterms are consistent
5379 and you don't want to add links manually.</para>
5381 <para>The automatic link generation feature is not used on <tag>glossterm</tag> elements
5382 that have a <tag class="attribute">linkend</tag> attribute.</para>
5387 <refentry version="5.0" xml:id="firstterm.only.link">
5389 <refentrytitle>firstterm.only.link</refentrytitle>
5390 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
5393 <refname>firstterm.only.link</refname>
5394 <refpurpose>Does automatic glossterm linking only apply to firstterms?</refpurpose>
5398 <programlisting xml:id="firstterm.only.link.frag">
5399 <xsl:param name="firstterm.only.link" select="0"></xsl:param>
5403 <refsection><info><title>Description</title></info>
5405 <para>If non-zero, only <tag>firstterm</tag>s will be automatically linked
5406 to the glossary. If glossary linking is not enabled, this parameter
5407 has no effect.</para>
5412 <refentry version="5.0" xml:id="glossary.collection">
5414 <refentrytitle>glossary.collection</refentrytitle>
5415 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
5418 <refname>glossary.collection</refname>
5419 <refpurpose>Name of the glossary collection file</refpurpose>
5423 <programlisting xml:id="glossary.collection.frag">
5424 <xsl:param name="glossary.collection"></xsl:param>
5428 <refsection><info><title>Description</title></info>
5430 <para>Glossaries maintained independently across a set of documents
5431 are likely to become inconsistent unless considerable effort is
5432 expended to keep them in sync. It makes much more sense, usually, to
5433 store all of the glossary entries in a single place and simply
5434 <quote>extract</quote> the ones you need in each document.</para>
5436 <para>That's the purpose of the
5437 <parameter>glossary.collection</parameter> parameter. To setup a global
5438 glossary <quote>database</quote>, follow these steps:</para>
5440 <refsection><info><title>Setting Up the Glossary Database</title></info>
5442 <para>First, create a stand-alone glossary document that contains all of
5443 the entries that you wish to reference. Make sure that each glossary
5444 entry has an ID.</para>
5446 <para>Here's an example glossary:</para>
5450 <?xml version="1.0" encoding="utf-8"?>
5451 <!DOCTYPE glossary
5452 PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
5453 "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
5455 <glossaryinfo>
5456 <editor><firstname>Eric</firstname><surname>Raymond</surname></editor>
5457 <title>Jargon File 4.2.3 (abridged)</title>
5458 <releaseinfo>Just some test data</releaseinfo>
5459 </glossaryinfo>
5461 <glossdiv><title>0</title>
5464 <glossterm>0</glossterm>
5466 <para>Numeric zero, as opposed to the letter `O' (the 15th letter of
5467 the English alphabet). In their unmodified forms they look a lot
5468 alike, and various kluges invented to make them visually distinct have
5469 compounded the confusion. If your zero is center-dotted and letter-O
5470 is not, or if letter-O looks almost rectangular but zero looks more
5471 like an American football stood on end (or the reverse), you're
5472 probably looking at a modern character display (though the dotted zero
5473 seems to have originated as an option on IBM 3270 controllers). If
5474 your zero is slashed but letter-O is not, you're probably looking at
5475 an old-style ASCII graphic set descended from the default typewheel on
5476 the venerable ASR-33 Teletype (Scandinavians, for whom /O is a letter,
5477 curse this arrangement). (Interestingly, the slashed zero long
5478 predates computers; Florian Cajori's monumental "A History of
5479 Mathematical Notations" notes that it was used in the twelfth and
5480 thirteenth centuries.) If letter-O has a slash across it and the zero
5481 does not, your display is tuned for a very old convention used at IBM
5482 and a few other early mainframe makers (Scandinavians curse <emphasis>this</emphasis>
5483 arrangement even more, because it means two of their letters collide).
5484 Some Burroughs/Unisys equipment displays a zero with a <emphasis>reversed</emphasis>
5485 slash. Old CDC computers rendered letter O as an unbroken oval and 0
5486 as an oval broken at upper right and lower left. And yet another
5487 convention common on early line printers left zero unornamented but
5488 added a tail or hook to the letter-O so that it resembled an inverted
5489 Q or cursive capital letter-O (this was endorsed by a draft ANSI
5490 standard for how to draw ASCII characters, but the final standard
5491 changed the distinguisher to a tick-mark in the upper-left corner).
5492 Are we sufficiently confused yet?</para>
5497 <glossterm>1TBS</glossterm>
5499 <para role="accidence">
5500 <phrase role="pronounce"></phrase>
5501 <phrase role="partsofspeach">n</phrase>
5503 <para>The "One True Brace Style"</para>
5504 <glossseealso>indent style</glossseealso>
5514 </glossary></programlisting>
5519 <refsection><info><title>Marking Up Glossary Terms</title></info>
5521 <para>That takes care of the glossary database, now you have to get the entries
5522 into your document. Unlike bibliography entries, which can be empty, creating
5523 <quote>placeholder</quote> glossary entries would be very tedious. So instead,
5524 support for <parameter>glossary.collection</parameter> relies on implicit linking.</para>
5526 <para>In your source document, simply use <tag>firstterm</tag> and
5527 <tag>glossterm</tag> to identify the terms you wish to have included
5528 in the glossary. The stylesheets assume that you will either set the
5529 <tag class="attribute">baseform</tag> attribute correctly, or that the
5530 content of the element exactly matches a term in your glossary.</para>
5532 <para>If you're using a <parameter>glossary.collection</parameter>, don't
5533 make explicit links on the terms in your document.</para>
5535 <para>So, in your document, you might write things like this:</para>
5538 <programlisting><para>This is dummy text, without any real meaning.
5539 The point is simply to reference glossary terms like <glossterm>0</glossterm>
5540 and the <firstterm baseform="1TBS">One True Brace Style (1TBS)</firstterm>.
5541 The <glossterm>1TBS</glossterm>, as you can probably imagine, is a nearly
5542 religious issue.</para></programlisting>
5545 <para>If you set the <parameter>firstterm.only.link</parameter> parameter,
5546 only the terms marked with <tag>firstterm</tag> will be links.
5547 Otherwise, all the terms will be linked.</para>
5551 <refsection><info><title>Marking Up the Glossary</title></info>
5553 <para>The glossary itself has to be identified for the stylesheets. For lack
5554 of a better choice, the <tag class="attribute">role</tag> is used.
5555 To identify the glossary as the target for automatic processing, set
5556 the role to <quote><literal>auto</literal></quote>. The title of this
5557 glossary (and any other information from the <tag>glossaryinfo</tag>
5558 that's rendered by your stylesheet) will be displayed, but the entries will
5559 come from the database.
5562 <para>Unfortunately, the glossary can't be empty, so you must put in
5563 at least one <tag>glossentry</tag>. The content of this entry
5564 is irrelevant, it will not be rendered:</para>
5567 <programlisting><glossary role="auto">
5569 <glossterm>Irrelevant</glossterm>
5571 <para>If you can see this, the document was processed incorrectly. Use
5572 the <parameter>glossary.collection</parameter> parameter.</para>
5575 </glossary></programlisting>
5578 <para>What about glossary divisions? If your glossary database has glossary
5579 divisions <emphasis>and</emphasis> your automatic glossary contains at least
5580 one <tag>glossdiv</tag>, the automic glossary will have divisions.
5581 If the <tag>glossdiv</tag> is missing from either location, no divisions
5582 will be rendered.</para>
5584 <para>Glossary entries (and divisions, if appropriate) in the glossary will
5585 occur in precisely the order they occur in your database.</para>
5589 <refsection><info><title>Formatting the Document</title></info>
5591 <para>Finally, when you are ready to format your document, simply set the
5592 <parameter>glossary.collection</parameter> parameter (in either a
5593 customization layer or directly through your processor's interface) to
5594 point to your global glossary.</para>
5596 <para>A relative path in the parameter is interpreted in one
5598 <orderedlist numeration="loweralpha">
5600 <para>If the parameter <literal>glossterm.auto.link</literal>
5601 is set to zero, then the path is relative to the file containing
5602 the empty <tag>glossary</tag> element in the document.</para>
5605 <para>If the parameter <literal>glossterm.auto.link</literal>
5606 is set to non-zero, then the path is relative to the file containing
5607 the first inline <tag>glossterm</tag> or
5608 <tag>firstterm</tag> in the document to be linked.</para>
5611 <para>Once the collection file is opened by the first instance described
5612 above, it stays open for the current document
5613 and the relative path is not reinterpreted again.</para>
5615 <para>The stylesheets will format the glossary in your document as if
5616 all of the entries implicilty referenced appeared there literally.</para>
5619 <refsection><info><title>Limitations</title></info>
5621 <para>Glossary cross-references <emphasis>within the glossary</emphasis> are
5622 not supported. For example, this <emphasis>will not</emphasis> work:</para>
5625 <programlisting><glossentry>
5626 <glossterm>gloss-1</glossterm>
5627 <glossdef><para>A description that references <glossterm>gloss-2</glossterm>.</para>
5628 <glossseealso>gloss-2</glossseealso>
5630 </glossentry></programlisting>
5633 <para>If you put glossary cross-references in your glossary that way,
5634 you'll get the cryptic error: <computeroutput>Warning:
5635 glossary.collection specified, but there are 0 automatic
5636 glossaries</computeroutput>.</para>
5638 <para>Instead, you must do two things:</para>
5642 <para>Markup your glossary using <tag>glossseealso</tag>:</para>
5645 <programlisting><glossentry>
5646 <glossterm>gloss-1</glossterm>
5647 <glossdef><para>A description that references <glossterm>gloss-2</glossterm>.</para>
5648 <glossseealso>gloss-2</glossseealso>
5650 </glossentry></programlisting>
5655 <para>Make sure there is at least one <tag>glossterm</tag> reference to
5656 <glossterm>gloss-2</glossterm> <emphasis>in your document</emphasis>. The
5657 easiest way to do that is probably within a <tag>remark</tag> in your
5658 automatic glossary:</para>
5661 <programlisting><glossary role="auto">
5662 <remark>Make sure there's a reference to <glossterm>gloss-2</glossterm>.</remark>
5664 <glossterm>Irrelevant</glossterm>
5666 <para>If you can see this, the document was processed incorrectly. Use
5667 the <parameter>glossary.collection</parameter> parameter.</para>
5670 </glossary></programlisting>
5679 <refentry version="5.0" xml:id="glossary.as.blocks">
5681 <refentrytitle>glossary.as.blocks</refentrytitle>
5682 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
5685 <refname>glossary.as.blocks</refname>
5686 <refpurpose>Present glossarys using blocks instead of lists?</refpurpose>
5690 <programlisting xml:id="glossary.as.blocks.frag">
5691 <xsl:param name="glossary.as.blocks" select="0"></xsl:param>
5695 <refsection><info><title>Description</title></info>
5697 <para>If non-zero, <tag>glossary</tag>s will be formatted as
5700 <para>If you have long <tag>glossterm</tag>s, proper list
5701 markup in the FO case may produce unattractive lists. By setting this
5702 parameter, you can force the stylesheets to produce block markup
5703 instead of proper lists.</para>
5705 <para>You can override this setting with a processing instruction as the
5706 child of <tag>glossary</tag>: <tag class="xmlpi">dbfo
5707 glossary-presentation="blocks"</tag> or <tag class="xmlpi">dbfo
5708 glossary-presentation="list"</tag></para>
5713 <refentry version="5.0" xml:id="glosslist.as.blocks">
5715 <refentrytitle>glosslist.as.blocks</refentrytitle>
5716 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
5719 <refname>glosslist.as.blocks</refname>
5720 <refpurpose>Use blocks for glosslists?</refpurpose>
5724 <programlisting xml:id="glosslist.as.blocks.frag">
5725 <xsl:param name="glosslist.as.blocks" select="0"></xsl:param>
5729 <refsection><info><title>Description</title></info>
5731 <para>See <parameter>glossary.as.blocks</parameter>.</para>
5736 <refentry version="5.0" xml:id="glossentry.list.item.properties">
5738 <refentrytitle>glossentry.list.item.properties</refentrytitle>
5739 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
5742 <refname>glossentry.list.item.properties</refname>
5743 <refpurpose>To add properties to each glossentry in a list.</refpurpose>
5747 <programlisting xml:id="glossentry.list.item.properties.frag"><xsl:attribute-set name="glossentry.list.item.properties">
5748 <xsl:attribute name="space-before.optimum">1em</xsl:attribute>
5749 <xsl:attribute name="space-before.minimum">0.8em</xsl:attribute>
5750 <xsl:attribute name="space-before.maximum">1.2em</xsl:attribute>
5751 </xsl:attribute-set>
5754 <refsection><info><title>Description</title></info>
5755 <para>These properties are added to the fo:list-item containing a
5756 glossentry in a glossary when the <parameter>glossary.as.blocks</parameter> parameter
5758 Use this attribute-set to set
5759 spacing between entries, for example.</para>
5764 <refentry version="5.0" xml:id="glossterm.block.properties">
5766 <refentrytitle>glossterm.block.properties</refentrytitle>
5767 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
5770 <refname>glossterm.block.properties</refname>
5771 <refpurpose>To add properties to the block of a glossentry's glossterm.</refpurpose>
5775 <programlisting xml:id="glossterm.block.properties.frag"><xsl:attribute-set name="glossterm.block.properties">
5776 <xsl:attribute name="space-before.optimum">1em</xsl:attribute>
5777 <xsl:attribute name="space-before.minimum">0.8em</xsl:attribute>
5778 <xsl:attribute name="space-before.maximum">1.2em</xsl:attribute>
5779 <xsl:attribute name="keep-with-next.within-column">always</xsl:attribute>
5780 <xsl:attribute name="keep-together.within-column">always</xsl:attribute>
5781 </xsl:attribute-set>
5784 <refsection><info><title>Description</title></info>
5785 <para>These properties are added to the block containing a
5786 glossary term in a glossary when the <parameter>glossary.as.blocks</parameter> parameter
5788 Use this attribute-set to set the space above and below,
5790 and any indent for the glossary term.</para>
5795 <refentry version="5.0" xml:id="glossdef.block.properties">
5797 <refentrytitle>glossdef.block.properties</refentrytitle>
5798 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
5801 <refname>glossdef.block.properties</refname>
5802 <refpurpose>To add properties to the block of a glossary definition.</refpurpose>
5806 <programlisting xml:id="glossdef.block.properties.frag"><xsl:attribute-set name="glossdef.block.properties">
5807 <xsl:attribute name="margin-{$direction.align.start}">.25in</xsl:attribute>
5808 </xsl:attribute-set>
5811 <refsection><info><title>Description</title></info>
5812 <para>These properties are added to the block containing a
5813 glossary definition in a glossary when
5814 the <parameter>glossary.as.blocks</parameter> parameter
5816 Use this attribute-set to set the space above and below,
5817 any font properties,
5818 and any indent for the glossary definition.</para>
5823 <refentry version="5.0" xml:id="glossterm.list.properties">
5825 <refentrytitle>glossterm.list.properties</refentrytitle>
5826 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
5829 <refname>glossterm.list.properties</refname>
5830 <refpurpose>To add properties to the glossterm in a list.</refpurpose>
5834 <programlisting xml:id="glossterm.list.properties.frag">
5835 <xsl:attribute-set name="glossterm.list.properties">
5836 </xsl:attribute-set>
5839 <refsection><info><title>Description</title></info>
5840 <para>These properties are added to the block containing a
5841 glossary term in a glossary when the <parameter>glossary.as.blocks</parameter> parameter
5843 Use this attribute-set to set
5844 font properties, for example.</para>
5849 <refentry version="5.0" xml:id="glossdef.list.properties">
5851 <refentrytitle>glossdef.list.properties</refentrytitle>
5852 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
5855 <refname>glossdef.list.properties</refname>
5856 <refpurpose>To add properties to the glossary definition in a list.</refpurpose>
5860 <programlisting xml:id="glossdef.list.properties.frag">
5861 <xsl:attribute-set name="glossdef.list.properties">
5862 </xsl:attribute-set>
5865 <refsection><info><title>Description</title></info>
5866 <para>These properties are added to the block containing a
5867 glossary definition in a glossary when
5868 the <parameter>glossary.as.blocks</parameter> parameter
5870 Use this attribute-set to set font properties, for example.</para>
5875 <refentry version="5.0" xml:id="glossterm.width">
5877 <refentrytitle>glossterm.width</refentrytitle>
5878 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
5881 <refname>glossterm.width</refname>
5882 <refpurpose>Width of glossterm in list presentation mode</refpurpose>
5886 <programlisting xml:id="glossterm.width.frag">
5887 <xsl:param name="glossterm.width">2in</xsl:param>
5891 <refsection><info><title>Description</title></info>
5893 <para>This parameter specifies the width reserved for glossary terms when
5894 a list presentation is used.</para>
5899 <refentry version="5.0" xml:id="glossterm.separation">
5901 <refentrytitle>glossterm.separation</refentrytitle>
5902 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
5905 <refname>glossterm.separation</refname>
5906 <refpurpose>Separation between glossary terms and descriptions in list mode</refpurpose>
5910 <programlisting xml:id="glossterm.separation.frag">
5911 <xsl:param name="glossterm.separation">0.25in</xsl:param>
5915 <refsection><info><title>Description</title></info>
5917 <para>Specifies the miminum horizontal
5918 separation between glossary terms and descriptions when
5919 they are presented side-by-side using lists
5920 when the <parameter>glossary.as.blocks</parameter>
5926 <refentry version="5.0" xml:id="glossentry.show.acronym">
5928 <refentrytitle>glossentry.show.acronym</refentrytitle>
5929 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
5930 <refmiscinfo class="other" otherclass="value">no</refmiscinfo>
5931 <refmiscinfo class="other" otherclass="value">yes</refmiscinfo>
5932 <refmiscinfo class="other" otherclass="value">primary</refmiscinfo>
5935 <refname>glossentry.show.acronym</refname>
5936 <refpurpose>Display <tag>glossentry</tag> acronyms?</refpurpose>
5940 <programlisting xml:id="glossentry.show.acronym.frag">
5941 <xsl:param name="glossentry.show.acronym">no</xsl:param>
5945 <refsection><info><title>Description</title></info>
5947 <para>A setting of <quote>yes</quote> means they should be displayed;
5948 <quote>no</quote> means they shouldn't. If <quote>primary</quote> is used,
5949 then they are shown as the primary text for the entry.</para>
5952 <para>This setting controls both <tag>acronym</tag> and
5953 <tag>abbrev</tag> elements in the <tag>glossentry</tag>.</para>
5959 <refentry version="5.0" xml:id="glossary.sort">
5961 <refentrytitle>glossary.sort</refentrytitle>
5962 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
5965 <refname>glossary.sort</refname>
5966 <refpurpose>Sort glossentry elements?</refpurpose>
5970 <programlisting xml:id="glossary.sort.frag">
5971 <xsl:param name="glossary.sort" select="0"></xsl:param>
5975 <refsection><info><title>Description</title></info>
5977 <para>If non-zero, then the glossentry elements within a
5978 glossary, glossdiv, or glosslist are sorted on the glossterm, using
5979 the current lang setting. If zero (the default), then
5980 glossentry elements are not sorted and are presented
5988 <reference xml:id="misc"><title>Miscellaneous</title>
5989 <refentry version="5.0" xml:id="formal.procedures">
5991 <refentrytitle>formal.procedures</refentrytitle>
5992 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
5995 <refname>formal.procedures</refname>
5996 <refpurpose>Selects formal or informal procedures</refpurpose>
6000 <programlisting xml:id="formal.procedures.frag">
6001 <xsl:param name="formal.procedures" select="1"></xsl:param>
6005 <refsection><info><title>Description</title></info>
6007 <para>Formal procedures are numbered and always have a title.
6013 <refentry version="5.0" xml:id="formal.title.placement">
6015 <refentrytitle>formal.title.placement</refentrytitle>
6016 <refmiscinfo class="other" otherclass="datatype">table</refmiscinfo>
6019 <refname>formal.title.placement</refname>
6020 <refpurpose>Specifies where formal object titles should occur</refpurpose>
6024 <programlisting xml:id="formal.title.placement.frag">
6025 <xsl:param name="formal.title.placement">
6036 <refsection><info><title>Description</title></info>
6038 <para>Specifies where formal object titles should occur. For each formal object
6039 type (<tag>figure</tag>,
6041 <tag>equation</tag>,
6042 <tag>table</tag>, and <tag>procedure</tag>)
6043 you can specify either the keyword
6044 <quote><literal>before</literal></quote> or
6045 <quote><literal>after</literal></quote>.</para>
6050 <refentry version="5.0" xml:id="runinhead.default.title.end.punct">
6052 <refentrytitle>runinhead.default.title.end.punct</refentrytitle>
6053 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
6056 <refname>runinhead.default.title.end.punct</refname>
6057 <refpurpose>Default punctuation character on a run-in-head</refpurpose>
6061 <programlisting xml:id="runinhead.default.title.end.punct.frag"><xsl:param name="runinhead.default.title.end.punct">.</xsl:param>
6065 <refsection><info><title>Description</title></info>
6067 <para>If non-zero, For a <tag>formalpara</tag>, use the specified
6068 string as the separator between the title and following text. The period is the default value.</para>
6073 <refentry version="5.0" xml:id="runinhead.title.end.punct">
6075 <refentrytitle>runinhead.title.end.punct</refentrytitle>
6076 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
6079 <refname>runinhead.title.end.punct</refname>
6080 <refpurpose>Characters that count as punctuation on a run-in-head</refpurpose>
6084 <programlisting xml:id="runinhead.title.end.punct.frag">
6085 <xsl:param name="runinhead.title.end.punct">.!?:</xsl:param>
6089 <refsection><info><title>Description</title></info>
6091 <para>Specify which characters are to be counted as punctuation. These
6092 characters are checked for a match with the last character of the
6093 title. If no match is found, the
6094 <parameter>runinhead.default.title.end.punct</parameter> contents are
6095 inserted. This is to avoid duplicated punctuation in the output.
6101 <refentry version="5.0" xml:id="show.comments">
6103 <refentrytitle>show.comments</refentrytitle>
6104 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
6107 <refname>show.comments</refname>
6108 <refpurpose>Display <tag>remark</tag> elements?</refpurpose>
6112 <programlisting xml:id="show.comments.frag">
6113 <xsl:param name="show.comments" select="1"></xsl:param>
6117 <refsection><info><title>Description</title></info>
6119 <para>If non-zero, comments will be displayed, otherwise they
6120 are suppressed. Comments here refers to the <tag>remark</tag> element
6121 (which was called <literal>comment</literal> prior to DocBook
6122 4.0), not XML comments (<-- like this -->) which are
6129 <refentry version="5.0" xml:id="punct.honorific">
6131 <refentrytitle>punct.honorific</refentrytitle>
6132 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
6135 <refname>punct.honorific</refname>
6136 <refpurpose>Punctuation after an honorific in a personal name.</refpurpose>
6140 <programlisting xml:id="punct.honorific.frag">
6141 <xsl:param name="punct.honorific">.</xsl:param>
6145 <refsection><info><title>Description</title></info>
6147 <para>This parameter specifies the punctuation that should be added after an
6148 honorific in a personal name.</para>
6153 <refentry version="5.0" xml:id="segmentedlist.as.table">
6155 <refentrytitle>segmentedlist.as.table</refentrytitle>
6156 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
6159 <refname>segmentedlist.as.table</refname>
6160 <refpurpose>Format segmented lists as tables?</refpurpose>
6164 <programlisting xml:id="segmentedlist.as.table.frag">
6165 <xsl:param name="segmentedlist.as.table" select="0"></xsl:param>
6169 <refsection><info><title>Description</title></info>
6171 <para>If non-zero, <tag>segmentedlist</tag>s will be formatted as
6177 <refentry version="5.0" xml:id="variablelist.as.blocks">
6179 <refentrytitle>variablelist.as.blocks</refentrytitle>
6180 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
6183 <refname>variablelist.as.blocks</refname>
6184 <refpurpose>Format <tag>variablelist</tag>s lists as blocks?</refpurpose>
6188 <programlisting xml:id="variablelist.as.blocks.frag">
6189 <xsl:param name="variablelist.as.blocks" select="0"></xsl:param>
6193 <refsection><info><title>Description</title></info>
6195 <para>If non-zero, <tag>variablelist</tag>s will be formatted as
6198 <para>If you have long terms, proper list markup in the FO case may produce
6199 unattractive lists. By setting this parameter, you can force the stylesheets
6200 to produce block markup instead of proper lists.</para>
6202 <para>You can override this setting with a processing instruction as the
6203 child of <tag>variablelist</tag>: <tag class="xmlpi">dbfo
6204 list-presentation="blocks"</tag> or <tag class="xmlpi">dbfo
6205 list-presentation="list"</tag>.</para>
6207 <para>When using <literal>list-presentation="list"</literal>,
6208 you can also control the amount of space used for the <tag>term</tag>s with
6209 the <tag class="xmlpi">dbfo term-width=".25in"</tag> processing instruction,
6210 the <tag class="attribute">termlength</tag> attribute on <tag>variablelist</tag>,
6211 or allow the stylesheets to attempt to calculate the amount of space to leave based on the
6212 number of letters in the longest term.
6215 <programlisting> <variablelist>
6216 <?dbfo list-presentation="list"?>
6217 <?dbfo term-width="1.5in"?>
6218 <?dbhtml list-presentation="table"?>
6219 <?dbhtml term-width="1.5in"?>
6220 <varlistentry>
6221 <term>list</term>
6224 Formatted as a list even if variablelist.as.blocks is set to 1.
6227 </varlistentry>
6228 </variablelist></programlisting>
6235 <refentry version="5.0" xml:id="blockquote.properties">
6237 <refentrytitle>blockquote.properties</refentrytitle>
6238 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
6241 <refname>blockquote.properties</refname>
6242 <refpurpose>To set the style for block quotations.</refpurpose>
6246 <programlisting xml:id="blockquote.properties.frag">
6247 <xsl:attribute-set name="blockquote.properties">
6248 <xsl:attribute name="margin-{$direction.align.start}">0.5in</xsl:attribute>
6249 <xsl:attribute name="margin-{$direction.align.end}">0.5in</xsl:attribute>
6250 <xsl:attribute name="space-after.minimum">0.5em</xsl:attribute>
6251 <xsl:attribute name="space-after.optimum">1em</xsl:attribute>
6252 <xsl:attribute name="space-after.maximum">2em</xsl:attribute>
6253 </xsl:attribute-set>
6257 <refsection><info><title>Description</title></info>
6259 <para>The <parameter>blockquote.properties</parameter> attribute set specifies
6260 the formating properties of block quotations.</para>
6265 <refentry version="5.0" xml:id="ulink.show">
6267 <refentrytitle>ulink.show</refentrytitle>
6268 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
6271 <refname>ulink.show</refname>
6272 <refpurpose>Display URLs after <tag>ulink</tag>s?</refpurpose>
6276 <programlisting xml:id="ulink.show.frag">
6277 <xsl:param name="ulink.show" select="1"></xsl:param>
6281 <refsection><info><title>Description</title></info>
6283 <para>If non-zero, the URL of each <tag>ulink</tag> will
6284 appear after the text of the link. If the text of the link and the URL
6285 are identical, the URL is suppressed. </para>
6287 <para>See also <parameter>ulink.footnotes</parameter>.</para>
6289 <note><para>DocBook 5 does not have an <tag>ulink</tag> element. When processing
6290 DocBoook 5 documents, <parameter>ulink.show</parameter> applies to all inline
6291 elements that are marked up with <tag class="attribute">xlink:href</tag> attributes
6292 that point to external resources.</para>
6298 <refentry version="5.0" xml:id="ulink.footnotes">
6300 <refentrytitle>ulink.footnotes</refentrytitle>
6301 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
6304 <refname>ulink.footnotes</refname>
6305 <refpurpose>Generate footnotes for <tag>ulink</tag>s?</refpurpose>
6309 <programlisting xml:id="ulink.footnotes.frag">
6310 <xsl:param name="ulink.footnotes" select="0"></xsl:param>
6314 <refsection><info><title>Description</title></info>
6316 <para>If non-zero, and if <parameter>ulink.show</parameter> also is non-zero,
6317 the URL of each <tag>ulink</tag> will appear as a footnote.</para>
6319 <note><para>DocBook 5 does not have an <tag>ulink</tag> element. When processing
6320 DocBoook 5 documents, <parameter>ulink.footnotes</parameter> applies to all inline
6321 elements that are marked up with <tag class="attribute">xlink:href</tag> attributes
6322 that point to external resources.</para>
6328 <refentry version="5.0" xml:id="ulink.hyphenate">
6330 <refentrytitle>ulink.hyphenate</refentrytitle>
6331 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
6334 <refname>ulink.hyphenate</refname>
6335 <refpurpose>Allow URLs to be automatically hyphenated</refpurpose>
6339 <programlisting xml:id="ulink.hyphenate.frag">
6340 <xsl:param name="ulink.hyphenate"></xsl:param>
6344 <refsection><info><title>Description</title></info>
6346 <para>If not empty, the specified character (or more generally,
6347 content) is added to URLs after every character included in the string
6348 in the <parameter>ulink.hyphenate.chars</parameter> parameter (default
6349 is <quote>/</quote>) to enable hyphenation of ulinks. If the character
6350 in this parameter is a Unicode soft hyphen (0x00AD) or Unicode
6351 zero-width space (0x200B), some FO processors will be able to
6352 reasonably hyphenate long URLs.</para>
6354 <para>Note that this hyphenation process is only applied when the
6355 ulink element is empty and the url attribute is reused as the link
6356 text. It is not applied if the ulink has literal text content. The
6357 same applies in in DocBook 5, where ulink was replaced with link with
6358 an xlink:href attribute.</para>
6363 <refentry version="5.0" xml:id="ulink.hyphenate.chars">
6365 <refentrytitle>ulink.hyphenate.chars</refentrytitle>
6366 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
6369 <refname>ulink.hyphenate.chars</refname>
6370 <refpurpose>List of characters to allow ulink URLs to be automatically
6371 hyphenated on</refpurpose>
6375 <programlisting xml:id="ulink.hyphenate.chars.frag">
6376 <xsl:param name="ulink.hyphenate.chars">/</xsl:param>
6380 <refsection><info><title>Description</title></info>
6382 <para>If the <parameter>ulink.hyphenate</parameter> parameter is not
6383 empty, then hyphenation of ulinks is turned on, and any character
6384 contained in this parameter is treated as an allowable hyphenation
6385 point. This and <parameter>ulink.hyphenate</parameter> work together,
6386 one is pointless without the other being set to a non-empty value</para>
6388 <para>The default value is <quote>/</quote>, but the parameter could
6389 be customized to contain other URL characters, as for example:</para>
6391 <xsl:param name="ulink.hyphenate.chars">:/@&?.#</xsl:param>
6397 <refentry version="5.0" xml:id="shade.verbatim">
6399 <refentrytitle>shade.verbatim</refentrytitle>
6400 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
6403 <refname>shade.verbatim</refname>
6404 <refpurpose>Should verbatim environments be shaded?</refpurpose>
6408 <programlisting xml:id="shade.verbatim.frag"><xsl:param name="shade.verbatim" select="0"></xsl:param></programlisting>
6411 <refsection><info><title>Description</title></info>
6413 <para>In the FO stylesheet, if this parameter is non-zero then the
6414 <property>shade.verbatim.style</property> properties will be applied
6415 to verbatim environments.</para>
6417 <para>In the HTML stylesheet, this parameter is now deprecated. Use
6423 <refentry version="5.0" xml:id="shade.verbatim.style">
6425 <refentrytitle>shade.verbatim.style</refentrytitle>
6426 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
6429 <refname>shade.verbatim.style</refname>
6430 <refpurpose>Properties that specify the style of shaded verbatim listings</refpurpose>
6434 <programlisting xml:id="shade.verbatim.style.frag">
6436 <xsl:attribute-set name="shade.verbatim.style">
6437 <xsl:attribute name="background-color">#E0E0E0</xsl:attribute>
6438 </xsl:attribute-set>
6442 <refsection><info><title>Description</title></info>
6444 <para>Properties that specify the style of shaded verbatim listings. The
6445 parameters specified (the border and background color) are added to
6446 the styling of the xsl-fo output. A border might be specified as "thin
6447 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>
6452 <refentry version="5.0" xml:id="hyphenate.verbatim">
6454 <refentrytitle>hyphenate.verbatim</refentrytitle>
6455 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
6458 <refname>hyphenate.verbatim</refname>
6459 <refpurpose>Should verbatim environments be hyphenated on space characters?</refpurpose>
6463 <programlisting xml:id="hyphenate.verbatim.frag"><xsl:param name="hyphenate.verbatim" select="0"></xsl:param></programlisting>
6466 <refsection><info><title>Description</title></info>
6468 <para>If the lines of program listing are too long to fit into one
6469 line it is quite common to split them at space and indicite by hook
6470 arrow that code continues on the next line. You can turn on this
6471 behaviour for <tag>programlisting</tag>,
6472 <tag>screen</tag> and <tag>synopsis</tag> elements by
6473 using this parameter.</para>
6475 <para>Note that you must also enable line wrapping for verbatim environments and
6476 select appropriate hyphenation character (e.g. hook arrow). This can
6477 be done using <parameter>monospace.verbatim.properties</parameter>
6478 attribute set:</para>
6480 <programlisting><xsl:attribute-set name="monospace.verbatim.properties"
6481 use-attribute-sets="verbatim.properties monospace.properties">
6482 <xsl:attribute name="wrap-option">wrap</xsl:attribute>
6483 <xsl:attribute name="hyphenation-character">&#x25BA;</xsl:attribute>
6484 </xsl:attribute-set></programlisting>
6486 <para>For a list of arrows available in Unicode see <uri xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://www.unicode.org/charts/PDF/U2190.pdf">http://www.unicode.org/charts/PDF/U2190.pdf</uri> and <uri xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://www.unicode.org/charts/PDF/U2900.pdf">http://www.unicode.org/charts/PDF/U2900.pdf</uri> and make sure that
6487 selected character is available in the font you are using for verbatim
6488 environments.</para>
6493 <refentry version="5.0" xml:id="hyphenate.verbatim.characters">
6495 <refentrytitle>hyphenate.verbatim.characters</refentrytitle>
6496 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
6499 <refname>hyphenate.verbatim.characters</refname>
6500 <refpurpose>List of characters after which a line break can occur in listings</refpurpose>
6504 <programlisting xml:id="hyphenate.verbatim.characters.frag">
6505 <xsl:param name="hyphenate.verbatim.characters"></xsl:param>
6509 <refsection><info><title>Description</title></info>
6511 <para>If you enable <parameter>hyphenate.verbatim</parameter> line
6512 breaks are allowed only on space characters. If this is not enough for
6513 your document, you can specify list of additional characters after
6514 which line break is allowed in this parameter.</para>
6519 <refentry version="5.0" xml:id="use.svg">
6521 <refentrytitle>use.svg</refentrytitle>
6522 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
6525 <refname>use.svg</refname>
6526 <refpurpose>Allow SVG in the result tree?</refpurpose>
6530 <programlisting xml:id="use.svg.frag">
6531 <xsl:param name="use.svg" select="1"></xsl:param>
6535 <refsection><info><title>Description</title></info>
6537 <para>If non-zero, SVG will be considered an acceptable image format. SVG
6538 is passed through to the result tree, so correct rendering of the resulting
6539 diagram depends on the formatter (FO processor or web browser) that is used
6540 to process the output from the stylesheet.</para>
6545 <refentry version="5.0" xml:id="use.role.as.xrefstyle">
6547 <refentrytitle>use.role.as.xrefstyle</refentrytitle>
6548 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
6551 <refname>use.role.as.xrefstyle</refname>
6552 <refpurpose>Use <tag class="attribute">role</tag> attribute for
6553 <tag class="attribute">xrefstyle</tag> on <tag>xref</tag>?</refpurpose>
6557 <programlisting xml:id="use.role.as.xrefstyle.frag">
6558 <xsl:param name="use.role.as.xrefstyle" select="1"></xsl:param>
6562 <refsection><info><title>Description</title></info>
6564 <para>In DocBook documents that conform to a schema older than V4.3, this parameter allows
6565 <tag class="attribute">role</tag> to serve the purpose of specifying the cross reference style.</para>
6567 <para>If non-zero, the <tag class="attribute">role</tag> attribute on
6568 <tag>xref</tag> will be used to select the cross reference style.
6569 In DocBook V4.3, the <tag class="attribute">xrefstyle</tag> attribute was added for this purpose.
6570 If the <tag class="attribute">xrefstyle</tag> attribute is present,
6571 <tag class="attribute">role</tag> will be ignored, regardless of the setting
6572 of this parameter.</para>
6576 <refsection><info><title>Example</title></info>
6578 <para>The following small stylesheet shows how to configure the
6579 stylesheets to make use of the cross reference style:</para>
6581 <programlisting><?xml version="1.0"?>
6582 <xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
6585 <xsl:import href="../xsl/html/docbook.xsl"/>
6587 <xsl:output method="html"/>
6589 <xsl:param name="local.l10n.xml" select="document('')"/>
6590 <l:i18n xmlns:l="http://docbook.sourceforge.net/xmlns/l10n/1.0">
6591 <l:l10n xmlns:l="http://docbook.sourceforge.net/xmlns/l10n/1.0" language="en">
6592 <l:context name="xref">
6593 <l:template name="chapter" style="title" text="Chapter %n, %t"/>
6594 <l:template name="chapter" text="Chapter %n"/>
6599 </xsl:stylesheet></programlisting>
6601 <para>With this stylesheet, the cross references in the following document:</para>
6603 <programlisting><?xml version="1.0" encoding="utf-8"?>
6604 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
6605 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
6606 <book id="book"><title>Book</title>
6609 <title>Preface</title>
6611 <para>Normal: <xref linkend="ch1"/>.</para>
6612 <para>Title: <xref xrefstyle="title" linkend="ch1"/>.</para>
6616 <chapter id="ch1">
6617 <title>First Chapter</title>
6619 <para>Irrelevant.</para>
6622 </book></programlisting>
6624 <para>will appear as:</para>
6627 <para>Normal: Chapter 1.</para>
6628 <para>Title: Chapter 1, <emphasis>First Chapter</emphasis>.</para>
6634 <refentry version="5.0" xml:id="menuchoice.separator">
6636 <refentrytitle>menuchoice.separator</refentrytitle>
6637 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
6640 <refname>menuchoice.separator</refname>
6641 <refpurpose>Separator between items of a <tag>menuchoice</tag>
6642 other than <tag>guimenuitem</tag> and
6643 <tag>guisubmenu</tag></refpurpose>
6647 <programlisting xml:id="menuchoice.separator.frag">
6648 <xsl:param name="menuchoice.separator">+</xsl:param>
6652 <refsection><info><title>Description</title></info>
6654 <para>Separator used to connect items of a <tag>menuchoice</tag> other
6655 than <tag>guimenuitem</tag> and <tag>guisubmenu</tag>. The latter
6656 elements are linked with <parameter>menuchoice.menu.separator</parameter>.
6662 <refentry version="5.0" xml:id="menuchoice.menu.separator">
6664 <refentrytitle>menuchoice.menu.separator</refentrytitle>
6665 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
6668 <refname>menuchoice.menu.separator</refname>
6669 <refpurpose>Separator between items of a <tag>menuchoice</tag>
6670 with <tag>guimenuitem</tag> or
6671 <tag>guisubmenu</tag></refpurpose>
6675 <programlisting xml:id="menuchoice.menu.separator.frag">
6676 <xsl:param name="menuchoice.menu.separator"> → </xsl:param>
6680 <refsection><info><title>Description</title></info>
6682 <para>Separator used to connect items of a <tag>menuchoice</tag> with
6683 <tag>guimenuitem</tag> or <tag>guisubmenu</tag>. Other elements
6684 are linked with <parameter>menuchoice.separator</parameter>.
6686 <para>The default value is &#x2192;, which is the
6687 &rarr; (right arrow) character entity.
6688 The current FOP (0.20.5) requires setting the font-family
6691 <para>The default value also includes spaces around the arrow,
6692 which will allow a line to break. Replace the spaces with
6693 &#xA0; (nonbreaking space) if you don't want those
6700 <refentry version="5.0" xml:id="default.float.class">
6702 <refentrytitle>default.float.class</refentrytitle>
6703 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
6706 <refname>default.float.class</refname>
6707 <refpurpose>Specifies the default float class</refpurpose>
6711 <programlisting xml:id="default.float.class.frag">
6712 <xsl:param name="default.float.class">
6714 <xsl:when test="contains($stylesheet.result.type,'html')">left</xsl:when>
6715 <xsl:otherwise>before</xsl:otherwise>
6721 <refsection><info><title>Description</title></info>
6723 <para>Selects the direction in which a float should be placed. for
6724 xsl-fo this is before, for html it is left. For Western texts, the
6725 before direction is the top of the page.</para>
6730 <refentry version="5.0" xml:id="footnote.number.format">
6732 <refentrytitle>footnote.number.format</refentrytitle>
6733 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
6734 <refmiscinfo class="other" otherclass="value">1<alt>1,2,3...</alt></refmiscinfo>
6735 <refmiscinfo class="other" otherclass="value">A<alt>A,B,C...</alt></refmiscinfo>
6736 <refmiscinfo class="other" otherclass="value">a<alt>a,b,c...</alt></refmiscinfo>
6737 <refmiscinfo class="other" otherclass="value">i<alt>i,ii,iii...</alt></refmiscinfo>
6738 <refmiscinfo class="other" otherclass="value">I<alt>I,II,III...</alt></refmiscinfo>
6741 <refname>footnote.number.format</refname>
6742 <refpurpose>Identifies the format used for footnote numbers</refpurpose>
6746 <programlisting xml:id="footnote.number.format.frag">
6747 <xsl:param name="footnote.number.format">1</xsl:param>
6751 <refsection><info><title>Description</title></info>
6753 <para>The <parameter>footnote.number.format</parameter> specifies the format
6754 to use for footnote numeration (1, i, I, a, or A).</para>
6759 <refentry version="5.0" xml:id="table.footnote.number.format">
6761 <refentrytitle>table.footnote.number.format</refentrytitle>
6762 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
6763 <refmiscinfo class="other" otherclass="value">1<alt>1,2,3...</alt></refmiscinfo>
6764 <refmiscinfo class="other" otherclass="value">A<alt>A,B,C...</alt></refmiscinfo>
6765 <refmiscinfo class="other" otherclass="value">a<alt>a,b,c...</alt></refmiscinfo>
6766 <refmiscinfo class="other" otherclass="value">i<alt>i,ii,iii...</alt></refmiscinfo>
6767 <refmiscinfo class="other" otherclass="value">I<alt>I,II,III...</alt></refmiscinfo>
6770 <refname>table.footnote.number.format</refname>
6771 <refpurpose>Identifies the format used for footnote numbers in tables</refpurpose>
6775 <programlisting xml:id="table.footnote.number.format.frag">
6776 <xsl:param name="table.footnote.number.format">a</xsl:param>
6780 <refsection><info><title>Description</title></info>
6782 <para>The <parameter>table.footnote.number.format</parameter> specifies the format
6783 to use for footnote numeration (1, i, I, a, or A) in tables.</para>
6788 <refentry version="5.0" xml:id="footnote.number.symbols">
6790 <refentrytitle>footnote.number.symbols</refentrytitle>
6791 <refmiscinfo class="other" otherclass="datatype"/>
6794 <refname>footnote.number.symbols</refname>
6795 <refpurpose>Special characters to use as footnote markers</refpurpose>
6799 <programlisting xml:id="footnote.number.symbols.frag">
6800 <xsl:param name="footnote.number.symbols"></xsl:param>
6804 <refsection><info><title>Description</title></info>
6806 <para>If <parameter>footnote.number.symbols</parameter> is not the empty string,
6807 footnotes will use the characters it contains as footnote symbols. For example,
6808 <quote>*&#x2020;&#x2021;&#x25CA;&#x2720;</quote> will identify
6809 footnotes with <quote>*</quote>, <quote>†</quote>, <quote>‡</quote>,
6810 <quote>◊</quote>, and <quote>✠</quote>. If there are more footnotes
6811 than symbols, the stylesheets will fall back to numbered footnotes using
6812 <parameter>footnote.number.format</parameter>.</para>
6814 <para>The use of symbols for footnotes depends on the ability of your
6815 processor (or browser) to render the symbols you select. Not all systems are
6816 capable of displaying the full range of Unicode characters. If the quoted characters
6817 in the preceding paragraph are not displayed properly, that's a good indicator
6818 that you may have trouble using those symbols for footnotes.</para>
6823 <refentry version="5.0" xml:id="table.footnote.number.symbols">
6825 <refentrytitle>table.footnote.number.symbols</refentrytitle>
6826 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
6829 <refname>table.footnote.number.symbols</refname>
6830 <refpurpose>Special characters to use a footnote markers in tables</refpurpose>
6834 <programlisting xml:id="table.footnote.number.symbols.frag">
6835 <xsl:param name="table.footnote.number.symbols"></xsl:param>
6839 <refsection><info><title>Description</title></info>
6841 <para>If <parameter>table.footnote.number.symbols</parameter> is not the empty string,
6842 table footnotes will use the characters it contains as footnote symbols. For example,
6843 <quote>*&#x2020;&#x2021;&#x25CA;&#x2720;</quote> will identify
6844 footnotes with <quote>*</quote>, <quote>†</quote>, <quote>‡</quote>,
6845 <quote>◊</quote>, and <quote>✠</quote>. If there are more footnotes
6846 than symbols, the stylesheets will fall back to numbered footnotes using
6847 <parameter>table.footnote.number.format</parameter>.</para>
6849 <para>The use of symbols for footnotes depends on the ability of your
6850 processor (or browser) to render the symbols you select. Not all systems are
6851 capable of displaying the full range of Unicode characters. If the quoted characters
6852 in the preceding paragraph are not displayed properly, that's a good indicator
6853 that you may have trouble using those symbols for footnotes.</para>
6858 <refentry version="5.0" xml:id="footnote.properties">
6860 <refentrytitle>footnote.properties</refentrytitle>
6861 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
6864 <refname>footnote.properties</refname>
6865 <refpurpose>Properties applied to each footnote body
6870 <programlisting xml:id="footnote.properties.frag">
6871 <xsl:attribute-set name="footnote.properties">
6872 <xsl:attribute name="font-family"><xsl:value-of select="$body.fontset"></xsl:value-of></xsl:attribute>
6873 <xsl:attribute name="font-size"><xsl:value-of select="$footnote.font.size"></xsl:value-of></xsl:attribute>
6874 <xsl:attribute name="font-weight">normal</xsl:attribute>
6875 <xsl:attribute name="font-style">normal</xsl:attribute>
6876 <xsl:attribute name="text-align"><xsl:value-of select="$alignment"></xsl:value-of></xsl:attribute>
6877 <xsl:attribute name="start-indent">0pt</xsl:attribute>
6878 <xsl:attribute name="end-indent">0pt</xsl:attribute>
6879 <xsl:attribute name="text-indent">0pt</xsl:attribute>
6880 <xsl:attribute name="hyphenate"><xsl:value-of select="$hyphenate"></xsl:value-of></xsl:attribute>
6881 <xsl:attribute name="wrap-option">wrap</xsl:attribute>
6882 <xsl:attribute name="linefeed-treatment">treat-as-space</xsl:attribute>
6883 </xsl:attribute-set>
6887 <refsection><info><title>Description</title></info>
6889 <para>This attribute set is applied to the footnote-block
6891 It can be used to set the
6892 font-size, font-family, and other inheritable properties that will be
6893 applied to all footnotes.</para>
6898 <refentry version="5.0" xml:id="table.footnote.properties">
6900 <refentrytitle>table.footnote.properties</refentrytitle>
6901 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
6904 <refname>table.footnote.properties</refname>
6905 <refpurpose>Properties applied to each table footnote body
6910 <programlisting xml:id="table.footnote.properties.frag">
6911 <xsl:attribute-set name="table.footnote.properties">
6912 <xsl:attribute name="font-family"><xsl:value-of select="$body.fontset"></xsl:value-of></xsl:attribute>
6913 <xsl:attribute name="font-size"><xsl:value-of select="$footnote.font.size"></xsl:value-of></xsl:attribute>
6914 <xsl:attribute name="font-weight">normal</xsl:attribute>
6915 <xsl:attribute name="font-style">normal</xsl:attribute>
6916 <xsl:attribute name="space-before">2pt</xsl:attribute>
6917 <xsl:attribute name="text-align"><xsl:value-of select="$alignment"></xsl:value-of></xsl:attribute>
6918 </xsl:attribute-set>
6922 <refsection><info><title>Description</title></info>
6924 <para>This attribute set is applied to the footnote-block
6925 for each table footnote.
6926 It can be used to set the
6927 font-size, font-family, and other inheritable properties that will be
6928 applied to all table footnotes.</para>
6933 <refentry version="5.0" xml:id="footnote.mark.properties">
6935 <refentrytitle>footnote.mark.properties</refentrytitle>
6936 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
6939 <refname>footnote.mark.properties</refname>
6940 <refpurpose>Properties applied to each footnote mark
6945 <programlisting xml:id="footnote.mark.properties.frag">
6946 <xsl:attribute-set name="footnote.mark.properties">
6947 <xsl:attribute name="font-family"><xsl:value-of select="$body.fontset"></xsl:value-of></xsl:attribute>
6948 <xsl:attribute name="font-size">75%</xsl:attribute>
6949 <xsl:attribute name="font-weight">normal</xsl:attribute>
6950 <xsl:attribute name="font-style">normal</xsl:attribute>
6951 </xsl:attribute-set>
6955 <refsection><info><title>Description</title></info>
6957 <para>This attribute set is applied to the footnote mark used
6959 It should contain only inline properties.
6962 <para>The property to make the mark a superscript is contained in the
6963 footnote template itself, because the current version of FOP reports
6964 an error if baseline-shift is used.
6970 <refentry version="5.0" xml:id="footnote.sep.leader.properties">
6972 <refentrytitle>footnote.sep.leader.properties</refentrytitle>
6973 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
6976 <refname>footnote.sep.leader.properties</refname>
6977 <refpurpose>Properties associated with footnote separators</refpurpose>
6981 <programlisting xml:id="footnote.sep.leader.properties.frag">
6982 <xsl:attribute-set name="footnote.sep.leader.properties">
6983 <xsl:attribute name="color">black</xsl:attribute>
6984 <xsl:attribute name="leader-pattern">rule</xsl:attribute>
6985 <xsl:attribute name="leader-length">1in</xsl:attribute>
6986 </xsl:attribute-set>
6990 <refsection><info><title>Description</title></info>
6992 <para>The styling for the rule line that separates the
6993 footnotes from the body text.
6994 These are properties applied to the fo:leader used as
6997 <para>If you want to do more than just set properties on
6998 the leader element, then you can customize the template
6999 named <literal>footnote.separator</literal> in
7000 <filename>fo/pagesetup.xsl</filename>.</para>
7005 <refentry version="5.0" xml:id="xref.with.number.and.title">
7007 <refentrytitle>xref.with.number.and.title</refentrytitle>
7008 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
7011 <refname>xref.with.number.and.title</refname>
7012 <refpurpose>Use number and title in cross references</refpurpose>
7016 <programlisting xml:id="xref.with.number.and.title.frag">
7017 <xsl:param name="xref.with.number.and.title" select="1"></xsl:param>
7021 <refsection><info><title>Description</title></info>
7023 <para>A cross reference may include the number (for example, the number of
7024 an example or figure) and the <tag>title</tag> which is a required child of some
7025 targets. This parameter inserts both the relevant number as well as
7026 the title into the link. </para>
7031 <refentry version="5.0" xml:id="superscript.properties">
7033 <refentrytitle>superscript.properties</refentrytitle>
7034 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
7037 <refname>superscript.properties</refname>
7038 <refpurpose>Properties associated with superscripts</refpurpose>
7042 <programlisting xml:id="superscript.properties.frag">
7043 <xsl:attribute-set name="superscript.properties">
7044 <xsl:attribute name="font-size">75%</xsl:attribute>
7045 </xsl:attribute-set>
7049 <refsection><info><title>Description</title></info>
7051 <para>Specifies styling properties for superscripts.</para>
7056 <refentry version="5.0" xml:id="subscript.properties">
7058 <refentrytitle>subscript.properties</refentrytitle>
7059 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
7062 <refname>subscript.properties</refname>
7063 <refpurpose>Properties associated with subscripts</refpurpose>
7067 <programlisting xml:id="subscript.properties.frag">
7068 <xsl:attribute-set name="subscript.properties">
7069 <xsl:attribute name="font-size">75%</xsl:attribute>
7070 </xsl:attribute-set>
7074 <refsection><info><title>Description</title></info>
7076 <para>Specifies styling properties for subscripts.</para>
7081 <refentry version="5.0" xml:id="pgwide.properties">
7083 <refentrytitle>pgwide.properties</refentrytitle>
7084 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
7087 <refname>pgwide.properties</refname>
7088 <refpurpose>Properties to make a figure or table page wide.
7093 <programlisting xml:id="pgwide.properties.frag">
7094 <xsl:attribute-set name="pgwide.properties">
7095 <xsl:attribute name="start-indent">0pt</xsl:attribute>
7096 </xsl:attribute-set>
7100 <refsection><info><title>Description</title></info>
7102 <para>This attribute set is used to set the properties
7103 that make a figure or table "page wide" in fo output.
7104 It comes into effect when an attribute <literal>pgwide="1"</literal>
7109 By default, it sets <parameter>start-indent</parameter>
7110 to <literal>0pt</literal>.
7111 In a stylesheet that sets the parameter
7112 <parameter>body.start.indent</parameter>
7113 to a non-zero value in order to indent body text,
7114 this attribute set can be used to outdent pgwide
7115 figures to the start margin.
7118 <para>If a document uses a multi-column page layout,
7119 then this attribute set could try setting <parameter>span</parameter>
7120 to a value of <literal>all</literal>. However, this may
7121 not work with some processors because a span property must be on an
7122 fo:block that is a direct child of fo:flow. It may work in
7123 some processors anyway.
7129 <refentry version="5.0" xml:id="highlight.source">
7131 <refentrytitle>highlight.source</refentrytitle>
7132 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
7135 <refname>highlight.source</refname>
7136 <refpurpose>Should the content of <tag>programlisting</tag>
7137 be syntactically highlighted?</refpurpose>
7141 <programlisting xml:id="highlight.source.frag">
7142 <xsl:param name="highlight.source" select="0"></xsl:param>
7146 <refsection><info><title>Description</title></info>
7148 <para>When this parameter is non-zero, the stylesheets will try to do syntax highlighting of the
7149 content of <tag>programlisting</tag> elements. You specify the language for each programlisting
7150 by using the <tag class="attribute">language</tag> attribute. The <parameter>highlight.default.language</parameter>
7151 parameter can be used to specify the language for programlistings without a <tag class="attribute">language</tag>
7152 attribute. Syntax highlighting also works for <tag>screen</tag> and <tag>synopsis</tag> elements.</para>
7154 <para>The actual highlighting work is done by the XSLTHL extension module. This is an external Java library that has to be
7155 downloaded separately (see below).</para>
7158 <para>In order to use this extension, you must</para>
7160 <listitem><para>add <filename>xslthl-2.x.x.jar</filename> to your Java classpath. The latest version is available
7161 from <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://sourceforge.net/projects/xslthl">the XSLT syntax highlighting project</link>
7162 at SourceForge.</para>
7165 <para>use a customization layer in which you import one of the following stylesheet modules:
7168 <para><filename>html/highlight.xsl</filename>
7172 <para><filename>xhtml/highlight.xsl</filename>
7176 <para><filename>xhtml-1_1/highlight.xsl</filename>
7180 <para><filename>fo/highlight.xsl</filename>
7186 <listitem><para>let either the <literal>xslthl.config</literal> Java system property or the
7187 <parameter>highlight.xslthl.config</parameter> parameter point to the configuration file for syntax
7188 highlighting (using URL syntax). DocBook XSL comes with a ready-to-use configuration file,
7189 <filename>highlighting/xslthl-config.xml</filename>.</para>
7193 <para>The extension works with Saxon 6.5.x and Xalan-J. (Saxon 8.5 or later is also supported, but since it is
7194 an XSLT 2.0 processor it is not guaranteed to work with DocBook XSL in all circumstances.)</para>
7196 <para>The following is an example of a Saxon 6 command adapted for syntax highlighting, to be used on Windows:</para>
7199 <para><command>java -cp c:/Java/saxon.jar;c:/Java/xslthl-2.0.1.jar
7200 -Dxslthl.config=file:///c:/docbook-xsl/highlighting/xslthl-config.xml com.icl.saxon.StyleSheet
7201 -o test.html test.xml myhtml.xsl</command></para>
7207 <refentry version="5.0" xml:id="highlight.xslthl.config">
7209 <refentrytitle>highlight.xslthl.config</refentrytitle>
7210 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
7213 <refname>highlight.xslthl.config</refname>
7214 <refpurpose>Location of XSLTHL configuration file</refpurpose>
7218 <programlisting xml:id="highlight.xslthl.config.frag">
7219 <xsl:param name="highlight.xslthl.config"></xsl:param>
7223 <refsection><info><title>Description</title></info>
7225 <para>This location has precedence over the corresponding Java property.</para>
7227 <para>Please note that usually you have to specify location as URL not
7228 just as a simple path on the local
7229 filesystem. E.g. <filename>file:///home/user/xslthl/my-xslthl-config.xml</filename>.</para>
7236 <refentry version="5.0" xml:id="highlight.default.language">
7238 <refentrytitle>highlight.default.language</refentrytitle>
7239 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
7242 <refname>highlight.default.language</refname>
7243 <refpurpose>Default language of programlisting</refpurpose>
7247 <programlisting xml:id="highlight.default.language.frag">
7248 <xsl:param name="highlight.default.language"></xsl:param>
7252 <refsection><info><title>Description</title></info>
7254 <para>This language is used when there is no language attribute on programlisting.</para>
7259 <refentry version="5.0" xml:id="email.delimiters.enabled">
7261 <refentrytitle>email.delimiters.enabled</refentrytitle>
7262 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
7265 <refname>email.delimiters.enabled</refname>
7266 <refpurpose>Generate delimiters around email addresses?</refpurpose>
7270 <programlisting xml:id="email.delimiters.enabled.frag">
7271 <xsl:param name="email.delimiters.enabled" select="1"></xsl:param>
7275 <refsection><info><title>Description</title></info>
7277 <para>If non-zero, delimiters
7279 <footnote><para>For delimiters, the
7280 stylesheets are currently hard-coded to output angle
7281 brackets.</para></footnote>
7283 are generated around e-mail addresses
7284 (the output of the <tag>email</tag> element).</para>
7289 <refentry version="5.0" xml:id="email.mailto.enabled">
7291 <refentrytitle>email.mailto.enabled</refentrytitle>
7292 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
7295 <refname>email.mailto.enabled</refname>
7296 <refpurpose>Generate mailto: links for email addresses?</refpurpose>
7300 <programlisting xml:id="email.mailto.enabled.frag">
7301 <xsl:param name="email.mailto.enabled" select="0"></xsl:param>
7305 <refsection><info><title>Description</title></info>
7307 <para>If non-zero the generated output for the <tag>email</tag> element
7308 will be a clickable mailto: link that brings up the default mail client
7309 on the system.</para>
7314 <refentry version="5.0" xml:id="section.container.element">
7316 <refentrytitle>section.container.element</refentrytitle>
7317 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
7318 <refmiscinfo class="other" otherclass="value">block</refmiscinfo>
7319 <refmiscinfo class="other" otherclass="value">wrapper</refmiscinfo>
7322 <refname>section.container.element</refname>
7323 <refpurpose>Select XSL-FO element name to contain sections</refpurpose>
7327 <programlisting xml:id="section.container.element.frag">
7328 <xsl:param name="section.container.element">block</xsl:param>
7332 <refsection><info><title>Description</title></info>
7334 <para>Selects the element name for outer container of
7335 each section. The choices are <literal>block</literal> (default)
7336 or <literal>wrapper</literal>.
7337 The <literal>fo:</literal> namespace prefix is added
7338 by the stylesheet to form the full element name.
7341 <para>This element receives the section <literal>id</literal>
7342 attribute and the appropriate section level attribute-set.
7345 <para>Changing this parameter to <literal>wrapper</literal>
7346 is only necessary when producing multi-column output
7347 that contains page-wide spans. Using <literal>fo:wrapper</literal>
7348 avoids the nesting of <literal>fo:block</literal>
7349 elements that prevents spans from working (the standard says
7350 a span must be on a block that is a direct child of
7351 <literal>fo:flow</literal>).
7354 <para>If set to <literal>wrapper</literal>, the
7355 section attribute-sets only support properties
7356 that are inheritable. That's because there is no
7357 block to apply them to. Properties such as
7358 font-family are inheritable, but properties such as
7362 <para>Only some XSL-FO processors need to use this parameter.
7363 The Antenna House processor, for example, will handle
7364 spans in nested blocks without changing the element name.
7365 The RenderX XEP product and FOP follow the XSL-FO standard
7366 and need to use <literal>wrapper</literal>.
7372 <refentry version="5.0" xml:id="monospace.verbatim.font.width">
7374 <refentrytitle>monospace.verbatim.font.width</refentrytitle>
7375 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
7378 <refname>monospace.verbatim.font.width</refname>
7379 <refpurpose>Width of a single monospace font character</refpurpose>
7383 <programlisting xml:id="monospace.verbatim.font.width.frag">
7384 <xsl:param name="monospace.verbatim.font.width">0.60em</xsl:param>
7388 <refsection><info><title>Description</title></info>
7390 <para>Specifies with em units the width of a single character
7391 of the monospace font. The default value is <literal>0.6em</literal>.</para>
7393 <para>This parameter is only used when a <tag>screen</tag>
7394 or <tag>programlisting</tag> element has a
7395 <tag class="attribute">width</tag> attribute, which is
7396 expressed as a plain integer to indicate the maximum character count
7398 To convert this character count to an actual maximum width
7399 measurement, the width of the font characters must be provided.
7400 Different monospace fonts have different character width,
7401 so this parameter should be adjusted to fit the
7402 monospace font being used.
7408 <refentry version="5.0" xml:id="exsl.node.set.available">
7410 <refentrytitle>exsl.node.set.available</refentrytitle>
7411 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
7414 <refname>exsl.node.set.available</refname>
7415 <refpurpose>Is the test function-available('exsl:node-set') true?</refpurpose>
7419 <programlisting xml:id="exsl.node.set.available.frag"><xsl:param name="exsl.node.set.available">
7421 <xsl:when exsl:foo="" test="function-available('exsl:node-set') or contains(system-property('xsl:vendor'), 'Apache Software Foundation')">1</xsl:when>
7422 <xsl:otherwise>0</xsl:otherwise>
7428 <refsection><info><title>Description</title></info>
7431 then the exsl:node-set() function is available to be used in
7433 If zero, then the function is not available.
7434 This param automatically detects the presence of
7435 the function and does not normally need to be set manually.</para>
7437 <para>This param was created to handle a long-standing
7438 bug in the Xalan processor that fails to detect the
7439 function even though it is available.</para>
7444 <refentry version="5.0" xml:id="show.bookmarks">
7446 <refentrytitle>show.bookmarks</refentrytitle>
7447 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
7450 <refname>show.bookmarks</refname>
7451 <refpurpose>Display bookmarks in PDF output</refpurpose>
7455 <programlisting xml:id="show.bookmarks.frag">
7456 <xsl:param name="show.bookmarks" select="1"></xsl:param>
7460 <refsection><info><title>Description</title></info>
7462 <para>If non-zero (default), then bookmarks are generated in PDF
7463 output. If set to zero, bookmarks are turned off.
7465 <para>See also <parameter>xsl1.1.bookmarks</parameter>.</para>
7470 <refentry version="5.0" xml:id="bookmarks.collapse">
7472 <refentrytitle>bookmarks.collapse</refentrytitle>
7473 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
7476 <refname>bookmarks.collapse</refname>
7477 <refpurpose>Specifies the initial state of bookmarks</refpurpose>
7481 <programlisting xml:id="bookmarks.collapse.frag">
7482 <xsl:param name="bookmarks.collapse" select="1"></xsl:param>
7486 <refsection><info><title>Description</title></info>
7488 <para>If non-zero, the bookmark tree is collapsed so that only the
7489 top-level bookmarks are displayed initially. Otherwise, the whole tree
7490 of bookmarks is displayed.</para>
7492 <para>This parameter currently works with FOP 0.93 or later.</para>
7497 <refentry version="5.0" xml:id="xsl1.1.bookmarks">
7499 <refentrytitle>xsl1.1.bookmarks</refentrytitle>
7500 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
7503 <refname>xsl1.1.bookmarks</refname>
7504 <refpurpose>Use standard XSL 1.1 bookmark elements</refpurpose>
7508 <programlisting xml:id="xsl1.1.bookmarks.frag"><xsl:param name="xsl1.1.bookmarks">
7510 <xsl:when test="$fop1.extensions != 0">1</xsl:when>
7511 <xsl:when test="$xep.extensions != 0">1</xsl:when>
7512 <xsl:when test="$axf.extensions != 0">1</xsl:when>
7513 <xsl:otherwise>0</xsl:otherwise>
7514 </xsl:choose></xsl:param></programlisting>
7517 <refsection><info><title>Description</title></info>
7519 <para>If non-zero (default),
7520 the stylesheet uses the
7521 <tag>fo:bookmark-tree</tag>
7523 <tag>fo:bookmark</tag> elements that are
7524 standard in XSL 1.1, instead of each XSL-FO processor's proprietary
7526 If zero, then the stylesheet uses the proprietary bookmark elements that
7533 <refentry version="5.0" xml:id="generate.consistent.ids">
7535 <refentrytitle>generate.consistent.ids</refentrytitle>
7536 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
7539 <refname>generate.consistent.ids</refname>
7540 <refpurpose>Generate consistent id values if document is unchanged</refpurpose>
7544 <programlisting xml:id="generate.consistent.ids.frag">
7545 <xsl:param name="generate.consistent.ids" select="0"></xsl:param>
7549 <refsection><info><title>Description</title></info>
7551 <para>When the stylesheet assigns an id value to an output element,
7552 the generate-id() function may be used. That function may not
7553 produce consistent values between runs. Version control
7554 systems may misidentify the changing id values as changes
7555 to the document.</para>
7557 <para>If you set this parameter's value to 1, then the
7558 template named <literal>object.id</literal> will replace
7559 the use of the function generate-id() with
7560 <literal><xsl:number level="multiple" count="*"/></literal>.
7561 This counts preceding elements to generate a unique number for
7562 the id value.</para>
7565 <para>This param does not associate permanent unique id values
7566 with particular elements.
7567 The id values are consistent only as long as the document
7568 structure does not change.
7569 If the document structure changes, then the counting
7570 of elements changes, and all id values after
7571 the first such change may be different, even when there is
7572 no change to the element itself or its output.
7576 <para>The default value of this parameter is zero, so generate-id() is used
7582 <refentry version="5.0" xml:id="base.dir">
7584 <refentrytitle>base.dir</refentrytitle>
7585 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
7588 <refname>base.dir</refname>
7589 <refpurpose>The base directory of chunks</refpurpose>
7593 <programlisting xml:id="base.dir.frag">
7594 <xsl:param name="base.dir"></xsl:param>
7598 <refsection><info><title>Description</title></info>
7600 <para>If specified, the <parameter>base.dir</parameter> parameter identifies
7601 the output directory for chunks. (If not specified, the output directory
7602 is system dependent.)</para>
7604 <para>Starting with version 1.77 of the stylesheets,
7605 the param's value will have a trailing slash added if it does
7606 not already have one.</para>
7608 <caution><para>Do not use <parameter>base.dir</parameter>
7609 to add a filename prefix string to chunked files.
7610 Instead, use the <parameter>chunked.filename.prefix</parameter>
7611 parameter.</para></caution>
7616 <refentry version="5.0" xml:id="chunk.quietly">
7618 <refentrytitle>chunk.quietly</refentrytitle>
7619 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
7622 <refname>chunk.quietly</refname>
7623 <refpurpose>Omit the chunked filename messages.</refpurpose>
7627 <programlisting xml:id="chunk.quietly.frag">
7628 <xsl:param name="chunk.quietly" select="0"></xsl:param>
7632 <refsection><info><title>Description</title></info>
7634 <para>If zero (the default), the XSL processor emits a message naming
7635 each separate chunk filename as it is being output.
7636 If nonzero, then the messages are suppressed.
7643 <reference xml:id="graphics"><title>Graphics</title>
7644 <refentry version="5.0" xml:id="graphic.default.extension">
7646 <refentrytitle>graphic.default.extension</refentrytitle>
7647 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
7650 <refname>graphic.default.extension</refname>
7651 <refpurpose>Default extension for graphic filenames</refpurpose>
7655 <programlisting xml:id="graphic.default.extension.frag"><xsl:param name="graphic.default.extension"></xsl:param></programlisting>
7658 <refsection><info><title>Description</title></info>
7660 <para>If a <tag>graphic</tag> or <tag>mediaobject</tag>
7661 includes a reference to a filename that does not include an extension,
7662 and the <tag class="attribute">format</tag> attribute is
7663 <emphasis>unspecified</emphasis>, the default extension will be used.
7669 <refentry version="5.0" xml:id="default.image.width">
7671 <refentrytitle>default.image.width</refentrytitle>
7672 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
7675 <refname>default.image.width</refname>
7676 <refpurpose>The default width of images</refpurpose>
7680 <programlisting xml:id="default.image.width.frag">
7681 <xsl:param name="default.image.width"></xsl:param>
7685 <refsection><info><title>Description</title></info>
7687 <para>If specified, this value will be used for the
7688 <tag class="attribute">width</tag> attribute on images that do not specify any
7689 <emphasis xmlns:xlink="http://www.w3.org/1999/xlink" xlink:title="DocBook 5: The Definitive Guide" xlink:href="http://docbook.org/tdg5/en/html/imagedata.html#viewport.area">viewport dimensions</emphasis>.</para>
7694 <refentry version="5.0" xml:id="preferred.mediaobject.role">
7696 <refentrytitle>preferred.mediaobject.role</refentrytitle>
7697 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
7700 <refname>preferred.mediaobject.role</refname>
7701 <refpurpose>Select which mediaobject to use based on
7702 this value of an object's <tag class="attribute">role</tag> attribute.
7707 <programlisting xml:id="preferred.mediaobject.role.frag">
7708 <xsl:param name="preferred.mediaobject.role"></xsl:param>
7712 <refsection><info><title>Description</title></info>
7714 <para>A mediaobject may contain several objects such as imageobjects.
7715 If the parameter <parameter>use.role.for.mediaobject</parameter> is
7716 non-zero, then the <literal>role</literal> attribute on
7717 <tag>imageobject</tag>s and other objects within a
7718 <tag>mediaobject</tag> container will be used to select which object
7719 will be used. If one of the objects has a role value that matches the
7720 <parameter>preferred.mediaobject.role</parameter> parameter, then it
7721 has first priority for selection. If more than one has such a role
7722 value, the first one is used.
7725 See the <parameter>use.role.for.mediaobject</parameter> parameter
7726 for the sequence of selection.</para>
7730 <refentry version="5.0" xml:id="use.role.for.mediaobject">
7732 <refentrytitle>use.role.for.mediaobject</refentrytitle>
7733 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
7736 <refname>use.role.for.mediaobject</refname>
7737 <refpurpose>Use <tag class="attribute">role</tag> attribute
7738 value for selecting which of several objects within a mediaobject to use.
7743 <programlisting xml:id="use.role.for.mediaobject.frag">
7744 <xsl:param name="use.role.for.mediaobject" select="1"></xsl:param>
7748 <refsection><info><title>Description</title></info>
7750 <para>If non-zero, the <tag class="attribute">role</tag> attribute on
7751 <tag>imageobject</tag>s or other objects within a <tag>mediaobject</tag> container will be used to select which object will be
7755 The order of selection when then parameter is non-zero is:
7759 <para>If the stylesheet parameter <parameter>preferred.mediaobject.role</parameter> has a value, then the object whose role equals that value is selected.</para>
7762 <para>Else if an object's role attribute has a value of
7763 <literal>html</literal> for HTML processing or
7764 <literal>fo</literal> for FO output, then the first
7765 of such objects is selected.
7769 <para>Else the first suitable object is selected.</para>
7774 <parameter>use.role.for.mediaobject</parameter>
7775 is zero, then role attributes are not considered
7776 and the first suitable object
7777 with or without a role value is used.
7782 <refentry version="5.0" xml:id="ignore.image.scaling">
7784 <refentrytitle>ignore.image.scaling</refentrytitle>
7785 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
7788 <refname>ignore.image.scaling</refname>
7789 <refpurpose>Tell the stylesheets to ignore the author's image scaling attributes</refpurpose>
7793 <programlisting xml:id="ignore.image.scaling.frag">
7794 <xsl:param name="ignore.image.scaling" select="0"></xsl:param>
7798 <refsection><info><title>Description</title></info>
7800 <para>If non-zero, the scaling attributes on graphics and media objects are
7806 <refentry version="5.0" xml:id="img.src.path">
7808 <refentrytitle>img.src.path</refentrytitle>
7809 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
7812 <refname>img.src.path</refname>
7813 <refpurpose>Path to HTML/FO image files</refpurpose>
7817 <programlisting xml:id="img.src.path.frag"><xsl:param name="img.src.path"></xsl:param></programlisting>
7820 <refsection><info><title>Description</title></info>
7822 <para>Add a path prefix to the value of the <tag class="attribute">fileref</tag>
7823 attribute of <tag>graphic</tag>, <tag>inlinegraphic</tag>, and <tag>imagedata</tag> elements. The resulting
7824 compound path is used in the output as the value of the <tag class="attribute">src</tag>
7825 attribute of <tag class="element">img</tag> (HTML) or <tag class="element">external-graphic</tag> (FO).
7829 The path given by <literal>img.src.path</literal> could be relative to the directory where the HTML/FO
7830 files are created, or it could be an absolute URI.
7831 The default value is empty.
7832 Be sure to include a trailing slash if needed.
7835 <para>This prefix is not applied to any filerefs that start
7836 with "/" or contain "//:".
7842 <refentry version="5.0" xml:id="keep.relative.image.uris">
7844 <refentrytitle>keep.relative.image.uris</refentrytitle>
7845 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
7848 <refname>keep.relative.image.uris</refname>
7849 <refpurpose>Should image URIs be resolved against xml:base?</refpurpose>
7853 <programlisting xml:id="keep.relative.image.uris.frag">
7855 <xsl:param name="keep.relative.image.uris" select="0"></xsl:param>
7859 <refsection><info><title>Description</title></info>
7861 <para>If non-zero, relative URIs (in, for example
7862 <literal>fileref</literal> attributes) will be used in the generated
7863 output. Otherwise, the URIs will be made absolute with respect to the
7866 <para>Note that the stylesheets calculate (and use) the absolute form
7867 for some purposes, this only applies to the resulting output.</para>
7873 <reference xml:id="general"><title>Pagination and General Styles</title>
7874 <partintro xml:id="margins_partintro">
7875 <section xml:id="margins_intro"><title>Understanding XSL FO Margins</title>
7877 <para>To make sense of the parameters in this section, it's useful to
7878 consider <xref linkend="fig.pagemodel"/>.</para>
7880 <figure xml:id="fig.pagemodel">
7881 <title>Page Model</title>
7882 <mediaobject xml:id="fo-pageregions-image">
7883 <imageobject role="html">
7884 <imagedata fileref="page.png"/>
7886 <imageobject role="fo">
7887 <imagedata fileref="fo/page.png"/>
7889 <textobject><phrase>Figure showing page margins</phrase></textobject>
7891 <para>This figure shows the physical page with the various FO page regions
7897 <para>First, let's consider the regions on the page.</para>
7899 <para>The white region is the physical page. Its dimensions are determined by
7900 the <parameter>page.height</parameter> and <parameter>page.width</parameter>
7903 <para>The yellow region is the region-body. The size and placement of
7904 the region body is constrained by the dimensions labelled in the
7907 <para>The pink region at the top of the page is the region-before. The
7908 darker area inside the region-before is the header text. In XSL, the default
7909 display alignment for a region is <literal>before</literal>, but the
7910 DocBook stylesheets still explicitly make it <literal>before</literal>. That's
7911 why the darker area is at the top.</para>
7913 <para>The pink region at the bottom of the page is the region-after.
7914 The darker area is the footer text. In XSL, the default display
7915 alignment for a region is <literal>before</literal>,
7916 but the DocBook stylesheets explicitly make it
7917 <literal>after</literal>. That's why the darker area is at the bottom.</para>
7919 <para>The dimensions in the figure are:</para>
7921 <orderedlist numeration="upperalpha">
7922 <listitem><para>The page-master margin-top.
7924 <listitem><para>The region-before extent.
7926 <listitem><para>The region-body margin-top.
7928 <listitem><para>The region-after extent.
7930 <listitem><para>The page-master margin-bottom.
7932 <listitem><para>The region-body margin-bottom.
7934 <listitem><para>The sum of the page-master margin-left and the
7935 region-body margin-left. In DocBook, the region-body margin-left is
7936 zero by default, so this is simply the page-master margin-left.
7938 <listitem><para>The sum of the page-master margin-right and the
7939 region-body margin-right. In DocBook, the region-body margin-right is
7940 zero by default, so this is simply the page-master margin-right.
7947 <refentry version="5.0" xml:id="page.height">
7949 <refentrytitle>page.height</refentrytitle>
7950 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
7953 <refname>page.height</refname>
7954 <refpurpose>The height of the physical page</refpurpose>
7958 <programlisting xml:id="page.height.frag"><xsl:param name="page.height">
7960 <xsl:when test="$page.orientation = 'portrait'">
7961 <xsl:value-of select="$page.height.portrait"></xsl:value-of>
7963 <xsl:otherwise>
7964 <xsl:value-of select="$page.width.portrait"></xsl:value-of>
7965 </xsl:otherwise>
7967 </xsl:param></programlisting>
7970 <refsection><info><title>Description</title></info>
7972 <para>The page height is generally calculated from the
7973 <parameter>paper.type</parameter> and
7974 <parameter>page.orientation</parameter> parameters.
7980 <refentry version="5.0" xml:id="page.height.portrait">
7982 <refentrytitle>page.height.portrait</refentrytitle>
7983 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
7986 <refname>page.height.portrait</refname>
7987 <refpurpose>Specify the physical size of the long edge of the page</refpurpose>
7991 <programlisting xml:id="page.height.portrait.frag"><xsl:param name="page.height.portrait">
7993 <xsl:when test="$paper.type = 'A4landscape'">210mm</xsl:when>
7994 <xsl:when test="$paper.type = 'USletter'">11in</xsl:when>
7995 <xsl:when test="$paper.type = 'USlandscape'">8.5in</xsl:when>
7996 <xsl:when test="$paper.type = 'USlegal'">14in</xsl:when>
7997 <xsl:when test="$paper.type = 'USlegallandscape'">8.5in</xsl:when>
7998 <xsl:when test="$paper.type = '4A0'">2378mm</xsl:when>
7999 <xsl:when test="$paper.type = '2A0'">1682mm</xsl:when>
8000 <xsl:when test="$paper.type = 'A0'">1189mm</xsl:when>
8001 <xsl:when test="$paper.type = 'A1'">841mm</xsl:when>
8002 <xsl:when test="$paper.type = 'A2'">594mm</xsl:when>
8003 <xsl:when test="$paper.type = 'A3'">420mm</xsl:when>
8004 <xsl:when test="$paper.type = 'A4'">297mm</xsl:when>
8005 <xsl:when test="$paper.type = 'A5'">210mm</xsl:when>
8006 <xsl:when test="$paper.type = 'A6'">148mm</xsl:when>
8007 <xsl:when test="$paper.type = 'A7'">105mm</xsl:when>
8008 <xsl:when test="$paper.type = 'A8'">74mm</xsl:when>
8009 <xsl:when test="$paper.type = 'A9'">52mm</xsl:when>
8010 <xsl:when test="$paper.type = 'A10'">37mm</xsl:when>
8011 <xsl:when test="$paper.type = 'B0'">1414mm</xsl:when>
8012 <xsl:when test="$paper.type = 'B1'">1000mm</xsl:when>
8013 <xsl:when test="$paper.type = 'B2'">707mm</xsl:when>
8014 <xsl:when test="$paper.type = 'B3'">500mm</xsl:when>
8015 <xsl:when test="$paper.type = 'B4'">353mm</xsl:when>
8016 <xsl:when test="$paper.type = 'B5'">250mm</xsl:when>
8017 <xsl:when test="$paper.type = 'B6'">176mm</xsl:when>
8018 <xsl:when test="$paper.type = 'B7'">125mm</xsl:when>
8019 <xsl:when test="$paper.type = 'B8'">88mm</xsl:when>
8020 <xsl:when test="$paper.type = 'B9'">62mm</xsl:when>
8021 <xsl:when test="$paper.type = 'B10'">44mm</xsl:when>
8022 <xsl:when test="$paper.type = 'C0'">1297mm</xsl:when>
8023 <xsl:when test="$paper.type = 'C1'">917mm</xsl:when>
8024 <xsl:when test="$paper.type = 'C2'">648mm</xsl:when>
8025 <xsl:when test="$paper.type = 'C3'">458mm</xsl:when>
8026 <xsl:when test="$paper.type = 'C4'">324mm</xsl:when>
8027 <xsl:when test="$paper.type = 'C5'">229mm</xsl:when>
8028 <xsl:when test="$paper.type = 'C6'">162mm</xsl:when>
8029 <xsl:when test="$paper.type = 'C7'">114mm</xsl:when>
8030 <xsl:when test="$paper.type = 'C8'">81mm</xsl:when>
8031 <xsl:when test="$paper.type = 'C9'">57mm</xsl:when>
8032 <xsl:when test="$paper.type = 'C10'">40mm</xsl:when>
8033 <xsl:otherwise>11in</xsl:otherwise>
8035 </xsl:param></programlisting>
8038 <refsection><info><title>Description</title></info>
8040 <para>The portrait page height is the length of the long
8041 edge of the physical page.
8047 <refentry version="5.0" xml:id="page.margin.bottom">
8049 <refentrytitle>page.margin.bottom</refentrytitle>
8050 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
8053 <refname>page.margin.bottom</refname>
8054 <refpurpose>The bottom margin of the page</refpurpose>
8058 <programlisting xml:id="page.margin.bottom.frag">
8059 <xsl:param name="page.margin.bottom">0.5in</xsl:param>
8063 <refsection><info><title>Description</title></info>
8065 <para>The bottom page margin is the distance from the bottom of the region-after
8066 to the physical bottom of the page.
8072 <refentry version="5.0" xml:id="page.margin.inner">
8074 <refentrytitle>page.margin.inner</refentrytitle>
8075 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
8078 <refname>page.margin.inner</refname>
8079 <refpurpose>The inner page margin</refpurpose>
8083 <programlisting xml:id="page.margin.inner.frag"><xsl:param name="page.margin.inner">
8085 <xsl:when test="$double.sided != 0">1.25in</xsl:when>
8086 <xsl:otherwise>1in</xsl:otherwise>
8088 </xsl:param></programlisting>
8091 <refsection><info><title>Description</title></info>
8093 <para>The inner page margin is the distance from bound edge of the
8094 page to the first column of text. </para>
8096 <para>The inner page margin is the distance from bound edge of the
8097 page to the outer edge of the first column of text.</para>
8099 <para>In left-to-right text direction,
8100 this is the left margin of recto (front side) pages.
8101 For single-sided output, it is the left margin
8102 of all pages.</para>
8104 <para>In right-to-left text direction,
8105 this is the right margin of recto pages.
8106 For single-sided output, this is the
8107 right margin of all pages.</para>
8110 <para>Current versions (at least as of version 4.13)
8111 of the XEP XSL-FO processor do not
8112 correctly handle these margin settings for documents
8113 with right-to-left text direction.
8114 The workaround in that situation is to reverse
8115 the values for <parameter>page.margin.inner</parameter>
8116 and <parameter>page.margin.outer</parameter>, until
8117 this bug is fixed by RenderX. It does not affect documents
8118 with left-to-right text direction.</para>
8121 <para>See also <parameter>writing.mode</parameter>.</para>
8126 <refentry version="5.0" xml:id="page.margin.outer">
8128 <refentrytitle>page.margin.outer</refentrytitle>
8129 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
8132 <refname>page.margin.outer</refname>
8133 <refpurpose>The outer page margin</refpurpose>
8137 <programlisting xml:id="page.margin.outer.frag"><xsl:param name="page.margin.outer">
8139 <xsl:when test="$double.sided != 0">0.75in</xsl:when>
8140 <xsl:otherwise>1in</xsl:otherwise>
8142 </xsl:param></programlisting>
8145 <refsection><info><title>Description</title></info>
8147 <para>The outer page margin is the distance from non-bound edge of the
8148 page to the outer edge of the last column of text.</para>
8150 <para>In left-to-right text direction,
8151 this is the right margin of recto (front side) pages.
8152 For single-sided output, it is the right margin
8153 of all pages.</para>
8155 <para>In right-to-left text direction,
8156 this is the left margin of recto pages.
8157 For single-sided output, this is the
8158 left margin of all pages.</para>
8161 <para>Current versions (at least as of version 4.13)
8162 of the XEP XSL-FO processor do not
8163 correctly handle these margin settings for documents
8164 with right-to-left text direction.
8165 The workaround in that situation is to reverse
8166 the values for <parameter>page.margin.inner</parameter>
8167 and <parameter>page.margin.outer</parameter>, until
8168 this bug is fixed by RenderX. It does not affect documents
8169 with left-to-right text direction.</para>
8172 <para>See also <parameter>writing.mode</parameter>.</para>
8177 <refentry version="5.0" xml:id="page.margin.top">
8179 <refentrytitle>page.margin.top</refentrytitle>
8180 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
8183 <refname>page.margin.top</refname>
8184 <refpurpose>The top margin of the page</refpurpose>
8188 <programlisting xml:id="page.margin.top.frag">
8189 <xsl:param name="page.margin.top">0.5in</xsl:param>
8193 <refsection><info><title>Description</title></info>
8195 <para>The top page margin is the distance from the physical top of the
8196 page to the top of the region-before.</para>
8201 <refentry version="5.0" xml:id="page.orientation">
8203 <refentrytitle>page.orientation</refentrytitle>
8204 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
8205 <refmiscinfo class="other" otherclass="value">portrait</refmiscinfo>
8206 <refmiscinfo class="other" otherclass="value">landscape</refmiscinfo>
8209 <refname>page.orientation</refname>
8210 <refpurpose>Select the page orientation</refpurpose>
8214 <programlisting xml:id="page.orientation.frag">
8215 <xsl:param name="page.orientation">portrait</xsl:param>
8219 <refsection><info><title>Description</title></info>
8221 <para> Select one from portrait or landscape.
8222 In portrait orientation, the short edge is horizontal; in
8223 landscape orientation, it is vertical.
8229 <refentry version="5.0" xml:id="page.width">
8231 <refentrytitle>page.width</refentrytitle>
8232 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
8235 <refname>page.width</refname>
8236 <refpurpose>The width of the physical page</refpurpose>
8240 <programlisting xml:id="page.width.frag"><xsl:param name="page.width">
8242 <xsl:when test="$page.orientation = 'portrait'">
8243 <xsl:value-of select="$page.width.portrait"></xsl:value-of>
8245 <xsl:otherwise>
8246 <xsl:value-of select="$page.height.portrait"></xsl:value-of>
8247 </xsl:otherwise>
8249 </xsl:param></programlisting>
8252 <refsection><info><title>Description</title></info>
8254 <para>The page width is generally calculated from the
8255 <parameter>paper.type</parameter> and
8256 <parameter>page.orientation</parameter> parameters.</para>
8261 <refentry version="5.0" xml:id="page.width.portrait">
8263 <refentrytitle>page.width.portrait</refentrytitle>
8264 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
8267 <refname>page.width.portrait</refname>
8268 <refpurpose>Specify the physical size of the short edge of the page</refpurpose>
8272 <programlisting xml:id="page.width.portrait.frag"><xsl:param name="page.width.portrait">
8274 <xsl:when test="$paper.type = 'USletter'">8.5in</xsl:when>
8275 <xsl:when test="$paper.type = 'USlandscape'">11in</xsl:when>
8276 <xsl:when test="$paper.type = 'USlegal'">8.5in</xsl:when>
8277 <xsl:when test="$paper.type = 'USlegallandscape'">14in</xsl:when>
8278 <xsl:when test="$paper.type = '4A0'">1682mm</xsl:when>
8279 <xsl:when test="$paper.type = '2A0'">1189mm</xsl:when>
8280 <xsl:when test="$paper.type = 'A0'">841mm</xsl:when>
8281 <xsl:when test="$paper.type = 'A1'">594mm</xsl:when>
8282 <xsl:when test="$paper.type = 'A2'">420mm</xsl:when>
8283 <xsl:when test="$paper.type = 'A3'">297mm</xsl:when>
8284 <xsl:when test="$paper.type = 'A4'">210mm</xsl:when>
8285 <xsl:when test="$paper.type = 'A5'">148mm</xsl:when>
8286 <xsl:when test="$paper.type = 'A6'">105mm</xsl:when>
8287 <xsl:when test="$paper.type = 'A7'">74mm</xsl:when>
8288 <xsl:when test="$paper.type = 'A8'">52mm</xsl:when>
8289 <xsl:when test="$paper.type = 'A9'">37mm</xsl:when>
8290 <xsl:when test="$paper.type = 'A10'">26mm</xsl:when>
8291 <xsl:when test="$paper.type = 'B0'">1000mm</xsl:when>
8292 <xsl:when test="$paper.type = 'B1'">707mm</xsl:when>
8293 <xsl:when test="$paper.type = 'B2'">500mm</xsl:when>
8294 <xsl:when test="$paper.type = 'B3'">353mm</xsl:when>
8295 <xsl:when test="$paper.type = 'B4'">250mm</xsl:when>
8296 <xsl:when test="$paper.type = 'B5'">176mm</xsl:when>
8297 <xsl:when test="$paper.type = 'B6'">125mm</xsl:when>
8298 <xsl:when test="$paper.type = 'B7'">88mm</xsl:when>
8299 <xsl:when test="$paper.type = 'B8'">62mm</xsl:when>
8300 <xsl:when test="$paper.type = 'B9'">44mm</xsl:when>
8301 <xsl:when test="$paper.type = 'B10'">31mm</xsl:when>
8302 <xsl:when test="$paper.type = 'C0'">917mm</xsl:when>
8303 <xsl:when test="$paper.type = 'C1'">648mm</xsl:when>
8304 <xsl:when test="$paper.type = 'C2'">458mm</xsl:when>
8305 <xsl:when test="$paper.type = 'C3'">324mm</xsl:when>
8306 <xsl:when test="$paper.type = 'C4'">229mm</xsl:when>
8307 <xsl:when test="$paper.type = 'C5'">162mm</xsl:when>
8308 <xsl:when test="$paper.type = 'C6'">114mm</xsl:when>
8309 <xsl:when test="$paper.type = 'C7'">81mm</xsl:when>
8310 <xsl:when test="$paper.type = 'C8'">57mm</xsl:when>
8311 <xsl:when test="$paper.type = 'C9'">40mm</xsl:when>
8312 <xsl:when test="$paper.type = 'C10'">28mm</xsl:when>
8313 <xsl:otherwise>8.5in</xsl:otherwise>
8315 </xsl:param></programlisting>
8318 <refsection><info><title>Description</title></info>
8320 <para>The portrait page width is the length of the short
8321 edge of the physical page.
8327 <refentry version="5.0" xml:id="paper.type">
8329 <refentrytitle>paper.type</refentrytitle>
8330 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
8331 <refmiscinfo class="other" otherclass="list-type">open</refmiscinfo>
8332 <refmiscinfo class="other" otherclass="list-type">open</refmiscinfo>
8333 <refmiscinfo class="other" otherclass="value">USletter<alt>8.5x11in</alt></refmiscinfo>
8334 <refmiscinfo class="other" otherclass="value">USlandscape<alt>11x8.5in</alt></refmiscinfo>
8335 <refmiscinfo class="other" otherclass="value">USlegal<alt>8.5inx14in</alt></refmiscinfo>
8336 <refmiscinfo class="other" otherclass="value">USlegallandscape<alt>14inx8.5in</alt></refmiscinfo>
8337 <refmiscinfo class="other" otherclass="value">4A0<alt>2378x1682mm</alt></refmiscinfo>
8338 <refmiscinfo class="other" otherclass="value">2A0<alt>1682x1189mm</alt></refmiscinfo>
8339 <refmiscinfo class="other" otherclass="value">A0<alt>1189x841mm</alt></refmiscinfo>
8340 <refmiscinfo class="other" otherclass="value">A1<alt>841x594mm</alt></refmiscinfo>
8341 <refmiscinfo class="other" otherclass="value">A2<alt>594x420mm</alt></refmiscinfo>
8342 <refmiscinfo class="other" otherclass="value">A3<alt>420x297mm</alt></refmiscinfo>
8343 <refmiscinfo class="other" otherclass="value">A4<alt>297x210mm</alt></refmiscinfo>
8344 <refmiscinfo class="other" otherclass="value">A5<alt>210x148mm</alt></refmiscinfo>
8345 <refmiscinfo class="other" otherclass="value">A6<alt>148x105mm</alt></refmiscinfo>
8346 <refmiscinfo class="other" otherclass="value">A7<alt>105x74mm</alt></refmiscinfo>
8347 <refmiscinfo class="other" otherclass="value">A8<alt>74x52mm</alt></refmiscinfo>
8348 <refmiscinfo class="other" otherclass="value">A9<alt>52x37mm</alt></refmiscinfo>
8349 <refmiscinfo class="other" otherclass="value">A10<alt>37x26mm</alt></refmiscinfo>
8350 <refmiscinfo class="other" otherclass="value">B0<alt>1414x1000mm</alt></refmiscinfo>
8351 <refmiscinfo class="other" otherclass="value">B1<alt>1000x707mm</alt></refmiscinfo>
8352 <refmiscinfo class="other" otherclass="value">B2<alt>707x500mm</alt></refmiscinfo>
8353 <refmiscinfo class="other" otherclass="value">B3<alt>500x353mm</alt></refmiscinfo>
8354 <refmiscinfo class="other" otherclass="value">B4<alt>353x250mm</alt></refmiscinfo>
8355 <refmiscinfo class="other" otherclass="value">B5<alt>250x176mm</alt></refmiscinfo>
8356 <refmiscinfo class="other" otherclass="value">B6<alt>176x125mm</alt></refmiscinfo>
8357 <refmiscinfo class="other" otherclass="value">B7<alt>125x88mm</alt></refmiscinfo>
8358 <refmiscinfo class="other" otherclass="value">B8<alt>88x62mm</alt></refmiscinfo>
8359 <refmiscinfo class="other" otherclass="value">B9<alt>62x44mm</alt></refmiscinfo>
8360 <refmiscinfo class="other" otherclass="value">B10<alt>44x31mm</alt></refmiscinfo>
8361 <refmiscinfo class="other" otherclass="value">C0<alt>1297x917mm</alt></refmiscinfo>
8362 <refmiscinfo class="other" otherclass="value">C1<alt>917x648mm</alt></refmiscinfo>
8363 <refmiscinfo class="other" otherclass="value">C2<alt>648x458mm</alt></refmiscinfo>
8364 <refmiscinfo class="other" otherclass="value">C3<alt>458x324mm</alt></refmiscinfo>
8365 <refmiscinfo class="other" otherclass="value">C4<alt>324x229mm</alt></refmiscinfo>
8366 <refmiscinfo class="other" otherclass="value">C5<alt>229x162mm</alt></refmiscinfo>
8367 <refmiscinfo class="other" otherclass="value">C6<alt>162x114mm</alt></refmiscinfo>
8368 <refmiscinfo class="other" otherclass="value">C7<alt>114x81mm</alt></refmiscinfo>
8369 <refmiscinfo class="other" otherclass="value">C8<alt>81x57mm</alt></refmiscinfo>
8370 <refmiscinfo class="other" otherclass="value">C9<alt>57x40mm</alt></refmiscinfo>
8371 <refmiscinfo class="other" otherclass="value">C10<alt>40x28mm</alt></refmiscinfo>
8374 <refname>paper.type</refname>
8375 <refpurpose>Select the paper type</refpurpose>
8379 <programlisting xml:id="paper.type.frag">
8380 <xsl:param name="paper.type">USletter</xsl:param>
8384 <refsection><info><title>Description</title></info>
8386 <para>The paper type is a convenient way to specify the paper size.
8387 The list of known paper sizes includes USletter and most of the A,
8388 B, and C sizes. See <parameter>page.width.portrait</parameter>, for example.
8396 <refentry version="5.0" xml:id="double.sided">
8398 <refentrytitle>double.sided</refentrytitle>
8399 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
8402 <refname>double.sided</refname>
8403 <refpurpose>Is the document to be printed double sided?</refpurpose>
8407 <programlisting xml:id="double.sided.frag">
8408 <xsl:param name="double.sided" select="0"></xsl:param>
8412 <refsection><info><title>Description</title></info>
8414 <para>This parameter is useful when printing a document
8415 on both sides of the paper.</para>
8417 <para>if set to non-zero, documents are formatted using different page-masters
8418 for odd and even pages. These can differ by using a slightly wider margin
8419 on the binding edge of the page, and alternating left-right
8420 positions of header or footer elements.
8423 <para>If set to zero (the default), then only the 'odd' page masters
8424 are used for both even and odd numbered pages.</para>
8426 <para>See also <parameter>force.blank.pages</parameter>,
8427 <parameter>page.margin.inner</parameter> and
8428 <parameter>page.margin.outer</parameter>.</para>
8433 <refentry version="5.0" xml:id="force.blank.pages">
8435 <refentrytitle>force.blank.pages</refentrytitle>
8436 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
8439 <refname>force.blank.pages</refname>
8440 <refpurpose>Generate blank page to end on even page number</refpurpose>
8444 <programlisting xml:id="force.blank.pages.frag">
8445 <xsl:param name="force.blank.pages" select="1"></xsl:param>
8449 <refsection><info><title>Description</title></info>
8451 <para>If non-zero (the default), then each page sequence will be forced to
8452 end on an even-numbered page, by inserting a blank page
8453 if necessary. This will force the next page sequence to start
8454 on an odd-numbered page, which is a standard convention
8455 for printed and bound books.</para>
8457 <para>If zero, then such blank pages will not be inserted.
8458 Chapters will start on the next available page,
8459 regardless of whether it is an even or odd number.
8460 This is useful when publishing online where blank
8461 pages are not needed.
8464 <para>This param is independent of the
8465 <parameter>double.sided</parameter> parameter, which
8466 just triggers the use of even and odd page sequence
8467 masters that differ in their header and footer placement.
8468 So you can combine the two params for alternating
8469 headers/footers and no blank pages.
8475 <refentry version="5.0" xml:id="body.margin.bottom">
8477 <refentrytitle>body.margin.bottom</refentrytitle>
8478 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
8481 <refname>body.margin.bottom</refname>
8482 <refpurpose>The bottom margin of the body text</refpurpose>
8486 <programlisting xml:id="body.margin.bottom.frag">
8487 <xsl:param name="body.margin.bottom">0.5in</xsl:param>
8491 <refsection><info><title>Description</title></info>
8493 <para>The body bottom margin is the distance from the last line of text
8494 in the page body to the bottom of the region-after.
8500 <refentry version="5.0" xml:id="body.margin.top">
8502 <refentrytitle>body.margin.top</refentrytitle>
8503 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
8506 <refname>body.margin.top</refname>
8507 <refpurpose>To specify the size of the top margin of a page</refpurpose>
8511 <programlisting xml:id="body.margin.top.frag">
8512 <xsl:param name="body.margin.top">0.5in</xsl:param>
8516 <refsection><info><title>Description</title></info>
8518 <para>The body top margin is the distance from the top of the
8519 region-before to the first line of text in the page body.</para>
8524 <refentry version="5.0" xml:id="body.margin.inner">
8526 <refentrytitle>body.margin.inner</refentrytitle>
8527 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
8530 <refname>body.margin.inner</refname>
8531 <refpurpose>Specify the size of the inner margin of the body region</refpurpose>
8535 <programlisting xml:id="body.margin.inner.frag">
8536 <xsl:param name="body.margin.inner">0in</xsl:param>
8540 <refsection><info><title>Description</title></info>
8542 <para>The inner body margin is the extra inner side
8543 (binding side) margin taken from the body
8544 region in addition to the inner page margin.
8545 It makes room for a side region for text content whose width is
8546 specified by the <parameter>region.inner.extent</parameter>
8549 <para>For double-sided output,
8551 is <literal>fo:region-start</literal> on a odd-numbered page,
8552 and <literal>fo:region-end</literal> on an even-numbered page.</para>
8554 <para>For single-sided output,
8556 is <literal>fo:region-start</literal> for all pages.</para>
8558 <para>This correspondence applies to all languages,
8559 both left-to-right and right-to-left writing modes.</para>
8561 <para>The default value is zero.</para>
8564 <parameter>region.inner.extent</parameter>,
8565 <parameter>region.outer.extent</parameter>,
8566 <parameter>body.margin.outer</parameter>,
8567 <parameter>side.region.precedence</parameter>.
8572 <refentry version="5.0" xml:id="body.margin.outer">
8574 <refentrytitle>body.margin.outer</refentrytitle>
8575 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
8578 <refname>body.margin.outer</refname>
8579 <refpurpose>Specify the size of the outer margin of the body region</refpurpose>
8583 <programlisting xml:id="body.margin.outer.frag">
8584 <xsl:param name="body.margin.outer">0in</xsl:param>
8588 <refsection><info><title>Description</title></info>
8590 <para>The outer body margin is the extra outer side
8591 (opposite the binding side) margin taken
8593 region in addition to the outer page margin.
8594 It makes room for a side region for text content whose width is
8595 specified by the <parameter>region.outer.extent</parameter>
8598 <para>For double-sided output,
8600 is <literal>fo:region-end</literal> on a odd-numbered page,
8601 and <literal>fo:region-start</literal> on an even-numbered page.</para>
8603 <para>For single-sided output,
8605 is <literal>fo:region-end</literal> for all pages.</para>
8607 <para>This correspondence applies to all languages,
8608 both left-to-right and right-to-left writing modes.</para>
8610 <para>The default value is zero.</para>
8613 <parameter>region.inner.extent</parameter>,
8614 <parameter>region.outer.extent</parameter>,
8615 <parameter>body.margin.inner</parameter>,
8616 <parameter>side.region.precedence</parameter>.
8621 <refentry version="5.0" xml:id="body.start.indent">
8623 <refentrytitle>body.start.indent</refentrytitle>
8624 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
8627 <refname>body.start.indent</refname>
8628 <refpurpose>The start-indent for the body text</refpurpose>
8632 <programlisting xml:id="body.start.indent.frag">
8633 <xsl:param name="body.start.indent">
8635 <xsl:when test="$fop.extensions != 0">0pt</xsl:when>
8636 <xsl:when test="$passivetex.extensions != 0">0pt</xsl:when>
8637 <xsl:otherwise>4pc</xsl:otherwise>
8643 <refsection><info><title>Description</title></info>
8645 <para>This parameter provides
8646 the means of indenting the body text relative to
8648 For left-to-right text direction, it indents the left side.
8649 For right-to-left text direction, it indents the right side.
8650 It is used in place of the
8651 <parameter>title.margin.left</parameter> for
8652 all XSL-FO processors except FOP 0.25.
8653 It enables support for side floats to appear
8654 in the indented margin area.
8656 <para>This start-indent property is added to the fo:flow
8657 for certain page sequences. Which page-sequences it is
8658 applied to is determined by the template named
8659 <literal>set.flow.properties</literal>.
8660 By default, that template adds it to the flow
8661 for page-sequences using the <quote>body</quote>
8662 master-reference, as well as appendixes and prefaces.
8664 <para>If this parameter is used, section titles should have
8665 a start-indent value of 0pt if they are to be
8666 outdented relative to the body text.
8669 <para>If you are using FOP, then set this parameter to a zero
8670 width value and set the <parameter>title.margin.left</parameter>
8671 parameter to the negative value of the desired indent.
8674 <para>See also <parameter>body.end.indent</parameter> and
8675 <parameter>title.margin.left</parameter>.
8681 <refentry version="5.0" xml:id="body.end.indent">
8683 <refentrytitle>body.end.indent</refentrytitle>
8684 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
8687 <refname>body.end.indent</refname>
8688 <refpurpose>The end-indent for the body text</refpurpose>
8692 <programlisting xml:id="body.end.indent.frag">
8693 <xsl:param name="body.end.indent">0pt</xsl:param>
8697 <refsection><info><title>Description</title></info>
8699 <para>This end-indent property is added to the fo:flow
8700 for certain page sequences. Which page-sequences it is
8701 applied to is determined by the template named
8702 <literal>set.flow.properties</literal>.
8703 By default, that template adds it to the flow
8704 for page-sequences using the <quote>body</quote>
8705 master-reference, as well as appendixes and prefaces.
8708 <para>See also <parameter>body.start.indent</parameter>.
8714 <refentry version="5.0" xml:id="alignment">
8716 <refentrytitle>alignment</refentrytitle>
8717 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
8718 <refmiscinfo class="other" otherclass="list-type">open</refmiscinfo>
8719 <refmiscinfo class="other" otherclass="value">left</refmiscinfo>
8720 <refmiscinfo class="other" otherclass="value">start</refmiscinfo>
8721 <refmiscinfo class="other" otherclass="value">right</refmiscinfo>
8722 <refmiscinfo class="other" otherclass="value">end</refmiscinfo>
8723 <refmiscinfo class="other" otherclass="value">center</refmiscinfo>
8724 <refmiscinfo class="other" otherclass="value">justify</refmiscinfo>
8727 <refname>alignment</refname>
8728 <refpurpose>Specify the default text alignment</refpurpose>
8732 <programlisting xml:id="alignment.frag"><xsl:param name="alignment">justify</xsl:param></programlisting>
8735 <refsection><info><title>Description</title></info>
8737 <para>The default text alignment is used for most body text.
8739 <literal>left</literal>,
8740 <literal>right</literal>,
8741 <literal>start</literal>,
8742 <literal>end</literal>,
8743 <literal>center</literal>,
8744 <literal>justify</literal>.
8745 The default value is <literal>justify</literal>.
8751 <refentry version="5.0" xml:id="hyphenate">
8753 <refentrytitle>hyphenate</refentrytitle>
8754 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
8755 <refmiscinfo class="other" otherclass="list-type">closed</refmiscinfo>
8756 <refmiscinfo class="other" otherclass="value">true</refmiscinfo>
8757 <refmiscinfo class="other" otherclass="value">false</refmiscinfo>
8760 <refname>hyphenate</refname>
8761 <refpurpose>Specify hyphenation behavior</refpurpose>
8765 <programlisting xml:id="hyphenate.frag"><xsl:param name="hyphenate">true</xsl:param></programlisting>
8768 <refsection><info><title>Description</title></info>
8770 <para>If true, words may be hyphenated. Otherwise, they may not.</para>
8771 <para>See also <parameter>ulink.hyphenate.chars</parameter> </para>
8776 <refentry version="5.0" xml:id="line-height">
8778 <refentrytitle>line-height</refentrytitle>
8779 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
8782 <refname>line-height</refname>
8783 <refpurpose>Specify the line-height property</refpurpose>
8787 <programlisting xml:id="line-height.frag">
8788 <xsl:param name="line-height">normal</xsl:param>
8792 <refsection><info><title>Description</title></info>
8794 <para>Sets the line-height property.</para>
8799 <refentry version="5.0" xml:id="column.count.back">
8801 <refentrytitle>column.count.back</refentrytitle>
8802 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
8805 <refname>column.count.back</refname>
8806 <refpurpose>Number of columns on back matter pages</refpurpose>
8810 <programlisting xml:id="column.count.back.frag">
8811 <xsl:param name="column.count.back" select="1"></xsl:param>
8815 <refsection><info><title>Description</title></info>
8817 <para>Number of columns on back matter (appendix, glossary, etc.) pages.</para>
8822 <refentry version="5.0" xml:id="column.count.body">
8824 <refentrytitle>column.count.body</refentrytitle>
8825 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
8828 <refname>column.count.body</refname>
8829 <refpurpose>Number of columns on body pages</refpurpose>
8833 <programlisting xml:id="column.count.body.frag">
8834 <xsl:param name="column.count.body" select="1"></xsl:param>
8838 <refsection><info><title>Description</title></info>
8840 <para>Number of columns on body pages.</para>
8845 <refentry version="5.0" xml:id="column.count.front">
8847 <refentrytitle>column.count.front</refentrytitle>
8848 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
8851 <refname>column.count.front</refname>
8852 <refpurpose>Number of columns on front matter pages</refpurpose>
8856 <programlisting xml:id="column.count.front.frag">
8857 <xsl:param name="column.count.front" select="1"></xsl:param>
8861 <refsection><info><title>Description</title></info>
8863 <para>Number of columns on front matter (dedication, preface, etc.) pages.</para>
8868 <refentry version="5.0" xml:id="column.count.index">
8870 <refentrytitle>column.count.index</refentrytitle>
8871 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
8874 <refname>column.count.index</refname>
8875 <refpurpose>Number of columns on index pages</refpurpose>
8879 <programlisting xml:id="column.count.index.frag">
8880 <xsl:param name="column.count.index">2</xsl:param>
8884 <refsection><info><title>Description</title></info>
8886 <para>Number of columns on index pages.</para>
8891 <refentry version="5.0" xml:id="column.count.lot">
8893 <refentrytitle>column.count.lot</refentrytitle>
8894 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
8897 <refname>column.count.lot</refname>
8898 <refpurpose>Number of columns on a 'List-of-Titles' page</refpurpose>
8902 <programlisting xml:id="column.count.lot.frag">
8903 <xsl:param name="column.count.lot" select="1"></xsl:param>
8907 <refsection><info><title>Description</title></info>
8909 <para>Number of columns on a page sequence containing the Table of Contents,
8910 List of Figures, etc.</para>
8915 <refentry version="5.0" xml:id="column.count.titlepage">
8917 <refentrytitle>column.count.titlepage</refentrytitle>
8918 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
8921 <refname>column.count.titlepage</refname>
8922 <refpurpose>Number of columns on a title page</refpurpose>
8926 <programlisting xml:id="column.count.titlepage.frag">
8927 <xsl:param name="column.count.titlepage" select="1"></xsl:param>
8931 <refsection><info><title>Description</title></info>
8933 <para>Number of columns on a title page</para>
8938 <refentry version="5.0" xml:id="column.gap.back">
8940 <refentrytitle>column.gap.back</refentrytitle>
8941 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
8944 <refname>column.gap.back</refname>
8945 <refpurpose>Gap between columns in back matter</refpurpose>
8949 <programlisting xml:id="column.gap.back.frag">
8950 <xsl:param name="column.gap.back">12pt</xsl:param>
8954 <refsection><info><title>Description</title></info>
8956 <para>Specifies the gap between columns in back matter (if
8957 <parameter>column.count.back</parameter> is greater than one).</para>
8962 <refentry version="5.0" xml:id="column.gap.body">
8964 <refentrytitle>column.gap.body</refentrytitle>
8965 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
8968 <refname>column.gap.body</refname>
8969 <refpurpose>Gap between columns in the body</refpurpose>
8973 <programlisting xml:id="column.gap.body.frag">
8974 <xsl:param name="column.gap.body">12pt</xsl:param>
8978 <refsection><info><title>Description</title></info>
8980 <para>Specifies the gap between columns in body matter (if
8981 <parameter>column.count.body</parameter> is greater than one).</para>
8986 <refentry version="5.0" xml:id="column.gap.front">
8988 <refentrytitle>column.gap.front</refentrytitle>
8989 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
8992 <refname>column.gap.front</refname>
8993 <refpurpose>Gap between columns in the front matter</refpurpose>
8997 <programlisting xml:id="column.gap.front.frag">
8998 <xsl:param name="column.gap.front">12pt</xsl:param>
9002 <refsection><info><title>Description</title></info>
9004 <para>Specifies the gap between columns in front matter (if
9005 <parameter>column.count.front</parameter> is greater than one).</para>
9010 <refentry version="5.0" xml:id="column.gap.index">
9012 <refentrytitle>column.gap.index</refentrytitle>
9013 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
9016 <refname>column.gap.index</refname>
9017 <refpurpose>Gap between columns in the index</refpurpose>
9021 <programlisting xml:id="column.gap.index.frag">
9022 <xsl:param name="column.gap.index">12pt</xsl:param>
9026 <refsection><info><title>Description</title></info>
9028 <para>Specifies the gap between columns in indexes (if
9029 <parameter>column.count.index</parameter> is greater than one).</para>
9034 <refentry version="5.0" xml:id="column.gap.lot">
9036 <refentrytitle>column.gap.lot</refentrytitle>
9037 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
9040 <refname>column.gap.lot</refname>
9041 <refpurpose>Gap between columns on a 'List-of-Titles' page</refpurpose>
9045 <programlisting xml:id="column.gap.lot.frag">
9046 <xsl:param name="column.gap.lot">12pt</xsl:param>
9050 <refsection><info><title>Description</title></info>
9052 <para>Specifies the gap between columns on 'List-of-Titles' pages (if
9053 <parameter>column.count.lot</parameter> is greater than one).</para>
9058 <refentry version="5.0" xml:id="column.gap.titlepage">
9060 <refentrytitle>column.gap.titlepage</refentrytitle>
9061 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
9064 <refname>column.gap.titlepage</refname>
9065 <refpurpose>Gap between columns on title pages</refpurpose>
9069 <programlisting xml:id="column.gap.titlepage.frag">
9070 <xsl:param name="column.gap.titlepage">12pt</xsl:param>
9074 <refsection><info><title>Description</title></info>
9076 <para>Specifies the gap between columns on title pages (if
9077 <parameter>column.count.titlepage</parameter> is greater than one).</para>
9083 <refentry version="5.0" xml:id="region.after.extent">
9085 <refentrytitle>region.after.extent</refentrytitle>
9086 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
9089 <refname>region.after.extent</refname>
9090 <refpurpose>Specifies the height of the footer.</refpurpose>
9094 <programlisting xml:id="region.after.extent.frag">
9095 <xsl:param name="region.after.extent">0.4in</xsl:param>
9099 <refsection><info><title>Description</title></info>
9101 <para>The region after extent is the height of the area where footers
9108 <refentry version="5.0" xml:id="region.before.extent">
9110 <refentrytitle>region.before.extent</refentrytitle>
9111 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
9114 <refname>region.before.extent</refname>
9115 <refpurpose>Specifies the height of the header</refpurpose>
9119 <programlisting xml:id="region.before.extent.frag">
9120 <xsl:param name="region.before.extent">0.4in</xsl:param>
9124 <refsection><info><title>Description</title></info>
9126 <para>The region before extent is the height of the area where headers
9133 <refentry version="5.0" xml:id="region.inner.extent">
9135 <refentrytitle>region.inner.extent</refentrytitle>
9136 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
9139 <refname>region.inner.extent</refname>
9140 <refpurpose>Specifies the width of the inner side region</refpurpose>
9144 <programlisting xml:id="region.inner.extent.frag">
9145 <xsl:param name="region.inner.extent">0in</xsl:param>
9149 <refsection><info><title>Description</title></info>
9151 <para>The region inner extent is the width of the optional
9152 text area next to the inner side (binding side) of the
9153 body region. </para>
9155 <para>For double-sided output, this side region
9156 is <literal>fo:region-start</literal> on a odd-numbered page,
9157 and <literal>fo:region-end</literal> on an even-numbered page.</para>
9159 <para>For single-sided output, this side region
9160 is <literal>fo:region-start</literal> for all pages.</para>
9162 <para>This correspondence applies to all languages,
9163 both left-to-right and right-to-left writing modes.</para>
9165 <para>The default value of this parameter is zero. If you enlarge this extent,
9166 be sure to also enlarge the <parameter>body.margin.inner</parameter>
9167 parameter to make room for its content, otherwise any text in
9168 the side region may overlap with the body text.</para>
9171 <parameter>region.outer.extent</parameter>,
9172 <parameter>body.margin.inner</parameter>,
9173 <parameter>body.margin.outer</parameter>,
9174 <parameter>side.region.precedence</parameter>.
9180 <refentry version="5.0" xml:id="region.outer.extent">
9182 <refentrytitle>region.outer.extent</refentrytitle>
9183 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
9186 <refname>region.outer.extent</refname>
9187 <refpurpose>Specifies the width of the outer side region</refpurpose>
9191 <programlisting xml:id="region.outer.extent.frag">
9192 <xsl:param name="region.outer.extent">0in</xsl:param>
9196 <refsection><info><title>Description</title></info>
9198 <para>The region outer extent is the width of the optional
9199 text area next to the outer side (opposite the binding side) of the
9200 body region. </para>
9202 <para>For double-sided output, this side region
9203 is <literal>fo:region-end</literal> on a odd-numbered page,
9204 and <literal>fo:region-start</literal> on an even-numbered page.</para>
9206 <para>For single-sided output, this side region
9207 is <literal>fo:region-end</literal> for all pages.</para>
9209 <para>This correspondence applies to all languages,
9210 both left-to-right and right-to-left writing modes.</para>
9212 <para>The default value of this parameter is zero. If you enlarge this extent,
9213 be sure to also enlarge the <parameter>body.margin.outer</parameter>
9214 parameter to make room for its content, otherwise any text in
9215 the side region may overlap with the body text.</para>
9218 <parameter>region.inner.extent</parameter>,
9219 <parameter>body.margin.inner</parameter>,
9220 <parameter>body.margin.outer</parameter>,
9221 <parameter>side.region.precedence</parameter>.
9226 <refentry version="5.0" xml:id="default.units">
9228 <refentrytitle>default.units</refentrytitle>
9229 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
9230 <refmiscinfo class="other" otherclass="value">cm</refmiscinfo>
9231 <refmiscinfo class="other" otherclass="value">mm</refmiscinfo>
9232 <refmiscinfo class="other" otherclass="value">in</refmiscinfo>
9233 <refmiscinfo class="other" otherclass="value">pt</refmiscinfo>
9234 <refmiscinfo class="other" otherclass="value">pc</refmiscinfo>
9235 <refmiscinfo class="other" otherclass="value">px</refmiscinfo>
9236 <refmiscinfo class="other" otherclass="value">em</refmiscinfo>
9239 <refname>default.units</refname>
9240 <refpurpose>Default units for an unqualified dimension</refpurpose>
9244 <programlisting xml:id="default.units.frag">
9245 <xsl:param name="default.units">pt</xsl:param>
9249 <refsection><info><title>Description</title></info>
9251 <para>If an unqualified dimension is encountered (for example, in a
9252 graphic width), the <parameter>default.units</parameter> will be used for the
9253 units. Unqualified dimensions are not allowed in XSL Formatting Objects.
9259 <refentry version="5.0" xml:id="normal.para.spacing">
9261 <refentrytitle>normal.para.spacing</refentrytitle>
9262 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
9265 <refname>normal.para.spacing</refname>
9266 <refpurpose>What space do you want between normal paragraphs</refpurpose>
9270 <programlisting xml:id="normal.para.spacing.frag"><xsl:attribute-set name="normal.para.spacing">
9271 <xsl:attribute name="space-before.optimum">1em</xsl:attribute>
9272 <xsl:attribute name="space-before.minimum">0.8em</xsl:attribute>
9273 <xsl:attribute name="space-before.maximum">1.2em</xsl:attribute>
9274 </xsl:attribute-set></programlisting>
9276 <refsection><info><title>Description</title></info>
9277 <para>Specify the spacing required between normal paragraphs as well as
9278 the following block-level elements:
9280 <literallayout>ackno
9288 <para>To customize the spacing, you need to reset all three attributes.</para>
9290 <para>To specify properties on just <tag>para</tag> elements without
9291 affecting these other elements,
9293 <link linkend="para.properties">para.properties</link>
9294 attribute-set. </para>
9298 <refentry version="5.0" xml:id="para.properties">
9300 <refentrytitle>para.properties</refentrytitle>
9301 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
9304 <refname>para.properties</refname>
9305 <refpurpose>Properties to apply to para elements</refpurpose>
9309 <programlisting xml:id="para.properties.frag"><xsl:attribute-set name="para.properties" use-attribute-sets="normal.para.spacing">
9310 </xsl:attribute-set></programlisting>
9312 <refsection><info><title>Description</title></info>
9313 <para>Specify properties to apply to the fo:block of a para element,
9314 such as <literal>text-indent</literal>.
9315 Although the default attribute-set is empty, it uses the attribute-set
9316 named <literal>normal.para.spacing</literal> to add vertical space before
9317 each para. The <literal>para.properties</literal> attribute-set can override those
9318 spacing properties for para only.</para>
9320 <link linkend="normal.para.spacing">normal.para.spacing</link>.
9325 <refentry version="5.0" xml:id="body.font.master">
9327 <refentrytitle>body.font.master</refentrytitle>
9328 <refmiscinfo class="other" otherclass="datatype">number</refmiscinfo>
9331 <refname>body.font.master</refname>
9332 <refpurpose>Specifies the default point size for body text</refpurpose>
9336 <programlisting xml:id="body.font.master.frag">
9337 <xsl:param name="body.font.master">10</xsl:param>
9341 <refsection><info><title>Description</title></info>
9343 <para>The body font size is specified in two parameters
9344 (<parameter>body.font.master</parameter> and <parameter>body.font.size</parameter>)
9345 so that math can be performed on the font size by XSLT.
9351 <refentry version="5.0" xml:id="body.font.size">
9353 <refentrytitle>body.font.size</refentrytitle>
9354 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
9357 <refname>body.font.size</refname>
9358 <refpurpose>Specifies the default font size for body text</refpurpose>
9362 <programlisting xml:id="body.font.size.frag">
9363 <xsl:param name="body.font.size">
9364 <xsl:value-of select="$body.font.master"></xsl:value-of><xsl:text>pt</xsl:text>
9365 </xsl:param></programlisting>
9368 <refsection><info><title>Description</title></info>
9370 <para>The body font size is specified in two parameters
9371 (<parameter>body.font.master</parameter> and <parameter>body.font.size</parameter>)
9372 so that math can be performed on the font size by XSLT.
9378 <refentry version="5.0" xml:id="footnote.font.size">
9380 <refentrytitle>footnote.font.size</refentrytitle>
9381 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
9384 <refname>footnote.font.size</refname>
9385 <refpurpose>The font size for footnotes</refpurpose>
9389 <programlisting xml:id="footnote.font.size.frag"><xsl:param name="footnote.font.size">
9390 <xsl:value-of select="$body.font.master * 0.8"></xsl:value-of><xsl:text>pt</xsl:text>
9391 </xsl:param></programlisting>
9394 <refsection><info><title>Description</title></info>
9396 <para>The footnote font size is used for...footnotes!
9402 <refentry version="5.0" xml:id="title.margin.left">
9404 <refentrytitle>title.margin.left</refentrytitle>
9405 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
9408 <refname>title.margin.left</refname>
9409 <refpurpose>Adjust the left margin for titles</refpurpose>
9413 <programlisting xml:id="title.margin.left.frag">
9414 <xsl:param name="title.margin.left">
9416 <xsl:when test="$fop.extensions != 0">-4pc</xsl:when>
9417 <xsl:when test="$passivetex.extensions != 0">0pt</xsl:when>
9418 <xsl:otherwise>0pt</xsl:otherwise>
9424 <refsection><info><title>Description</title></info>
9426 <para>This parameter provides
9427 the means of adjusting the left margin for titles
9428 when the XSL-FO processor being used is
9429 an old version of FOP (0.25 and earlier).
9430 It is only useful when the <parameter>fop.extensions</parameter>
9433 <para>The left margin of the body region
9434 is calculated to include this space,
9435 and titles are outdented to the left outside
9436 the body region by this amount,
9437 effectively leaving titles at the intended left margin
9438 and the body text indented.
9439 Currently this method is only used for old FOP because
9440 it cannot properly use the <parameter>body.start.indent</parameter>
9444 The default value when the <parameter>fop.extensions</parameter>
9445 parameter is nonzero is -4pc, which means the
9446 body text is indented 4 picas relative to
9448 The default value when the <parameter>fop.extensions</parameter>
9449 parameter equals zero is 0pt, and
9450 the body indent should instead be specified
9451 using the <parameter>body.start.indent</parameter>
9455 If you set the value to zero, be sure to still include
9456 a unit indicator such as <literal>0pt</literal>, or
9457 the FO processor will report errors.
9463 <refentry version="5.0" xml:id="draft.mode">
9465 <refentrytitle>draft.mode</refentrytitle>
9466 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
9467 <refmiscinfo class="other" otherclass="value">no</refmiscinfo>
9468 <refmiscinfo class="other" otherclass="value">yes</refmiscinfo>
9469 <refmiscinfo class="other" otherclass="value">maybe</refmiscinfo>
9472 <refname>draft.mode</refname>
9473 <refpurpose>Select draft mode</refpurpose>
9477 <programlisting xml:id="draft.mode.frag">
9478 <xsl:param name="draft.mode">no</xsl:param>
9482 <refsection><info><title>Description</title></info>
9484 <para>Selects draft mode. If <parameter>draft.mode</parameter> is
9485 <quote><literal>yes</literal></quote>, the entire document will be treated
9486 as a draft. If it is <quote><literal>no</literal></quote>, the entire document
9487 will be treated as a final copy. If it is <quote><literal>maybe</literal></quote>,
9488 individual sections will be treated as draft or final independently, depending
9489 on how their <literal>status</literal> attribute is set.
9495 <refentry version="5.0" xml:id="draft.watermark.image">
9497 <refentrytitle>draft.watermark.image</refentrytitle>
9498 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
9501 <refname>draft.watermark.image</refname>
9502 <refpurpose>The URI of the image to be used for draft watermarks</refpurpose>
9506 <programlisting xml:id="draft.watermark.image.frag">
9507 <xsl:param name="draft.watermark.image">images/draft.png</xsl:param>
9511 <refsection><info><title>Description</title></info>
9513 <para>The image to be used for draft watermarks.</para>
9518 <refentry version="5.0" xml:id="headers.on.blank.pages">
9520 <refentrytitle>headers.on.blank.pages</refentrytitle>
9521 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
9524 <refname>headers.on.blank.pages</refname>
9525 <refpurpose>Put headers on blank pages?</refpurpose>
9529 <programlisting xml:id="headers.on.blank.pages.frag">
9530 <xsl:param name="headers.on.blank.pages" select="1"></xsl:param>
9534 <refsection><info><title>Description</title></info>
9536 <para>If non-zero, headers will be placed on blank pages.</para>
9541 <refentry version="5.0" xml:id="footers.on.blank.pages">
9543 <refentrytitle>footers.on.blank.pages</refentrytitle>
9544 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
9547 <refname>footers.on.blank.pages</refname>
9548 <refpurpose>Put footers on blank pages?</refpurpose>
9552 <programlisting xml:id="footers.on.blank.pages.frag">
9553 <xsl:param name="footers.on.blank.pages" select="1"></xsl:param>
9557 <refsection><info><title>Description</title></info>
9559 <para>If non-zero, footers will be placed on blank pages.</para>
9564 <refentry version="5.0" xml:id="header.rule">
9566 <refentrytitle>header.rule</refentrytitle>
9567 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
9570 <refname>header.rule</refname>
9571 <refpurpose>Rule under headers?</refpurpose>
9575 <programlisting xml:id="header.rule.frag">
9576 <xsl:param name="header.rule" select="1"></xsl:param>
9580 <refsection><info><title>Description</title></info>
9582 <para>If non-zero, a rule will be drawn below the page headers.</para>
9587 <refentry version="5.0" xml:id="footer.rule">
9589 <refentrytitle>footer.rule</refentrytitle>
9590 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
9593 <refname>footer.rule</refname>
9594 <refpurpose>Rule over footers?</refpurpose>
9598 <programlisting xml:id="footer.rule.frag">
9599 <xsl:param name="footer.rule" select="1"></xsl:param>
9603 <refsection><info><title>Description</title></info>
9605 <para>If non-zero, a rule will be drawn above the page footers.</para>
9610 <refentry version="5.0" xml:id="header.column.widths">
9612 <refentrytitle>header.column.widths</refentrytitle>
9613 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
9616 <refname>header.column.widths</refname>
9617 <refpurpose>Specify relative widths of header areas</refpurpose>
9620 <refsynopsisdiv><programlisting xml:id="header.column.widths.frag">
9621 <xsl:param name="header.column.widths">1 1 1</xsl:param>
9622 </programlisting></refsynopsisdiv>
9624 <refsection><info><title>Description</title></info>
9626 <para>Page headers in print output use a three column table
9627 to position text at the left, center, and right side of
9628 the header on the page.
9629 This parameter lets you specify the relative sizes of the
9630 three columns. The default value is
9633 <para>The parameter value must be three numbers, separated
9634 by white space. The first number represents the relative
9635 width of the inside header for
9636 double-sided output. The second number is the relative
9637 width of the center header. The third number is the
9638 relative width of the outside header for
9639 double-sided output.
9641 <para>For single-sided output, the first number is the
9642 relative width of left header for left-to-right
9643 text direction, or the right header for right-to-left
9645 The third number is the
9646 relative width of right header for left-to-right
9647 text direction, or the left header for right-to-left
9648 text direction.</para>
9650 <para>The numbers are used to specify the column widths
9651 for the table that makes up the header area.
9652 In the FO output, this looks like:
9656 <fo:table-column column-number="1"
9657 column-width="proportional-column-width(1)"/>
9661 The <literal>proportional-column-width()</literal>
9662 function computes a column width by dividing its
9663 argument by the total of the arguments for all the columns, and
9664 then multiplying the result by the width of the whole table
9665 (assuming all the column specs use the function).
9666 Its argument can be any positive integer or floating point number.
9667 Zero is an acceptable value, although some FO processors
9668 may warn about it, in which case using a very small number might
9669 be more satisfactory.
9672 <para>For example, the value "1 2 1" means the center
9673 header should have twice the width of the other areas.
9674 A value of "0 0 1" means the entire header area
9675 is reserved for the right (or outside) header text.
9676 Note that to keep the center area centered on
9677 the page, the left and right values must be
9678 the same. A specification like "1 2 3" means the
9679 center area is no longer centered on the page
9680 since the right area is three times the width of the left area.
9686 <refentry version="5.0" xml:id="footer.column.widths">
9688 <refentrytitle>footer.column.widths</refentrytitle>
9689 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
9692 <refname>footer.column.widths</refname>
9693 <refpurpose>Specify relative widths of footer areas</refpurpose>
9696 <refsynopsisdiv><programlisting xml:id="footer.column.widths.frag">
9697 <xsl:param name="footer.column.widths">1 1 1</xsl:param>
9698 </programlisting></refsynopsisdiv>
9700 <refsection><info><title>Description</title></info>
9702 <para>Page footers in print output use a three column table
9703 to position text at the left, center, and right side of
9704 the footer on the page.
9705 This parameter lets you specify the relative sizes of the
9706 three columns. The default value is
9709 <para>The parameter value must be three numbers, separated
9710 by white space. The first number represents the relative
9711 width of the inside footer for
9712 double-sided output. The second number is the relative
9713 width of the center footer. The third number is the
9714 relative width of the outside footer for
9715 double-sided output.
9717 <para>For single-sided output, the first number is the
9718 relative width of left footer for left-to-right
9719 text direction, or the right footer for right-to-left
9721 The third number is the
9722 relative width of right footer for left-to-right
9723 text direction, or the left footer for right-to-left
9724 text direction.</para>
9726 <para>The numbers are used to specify the column widths
9727 for the table that makes up the footer area.
9728 In the FO output, this looks like:
9732 <fo:table-column column-number="1"
9733 column-width="proportional-column-width(1)"/>
9737 The <literal>proportional-column-width()</literal>
9738 function computes a column width by dividing its
9739 argument by the total of the arguments for all the columns, and
9740 then multiplying the result by the width of the whole table
9741 (assuming all the column specs use the function).
9742 Its argument can be any positive integer or floating point number.
9743 Zero is an acceptable value, although some FO processors
9744 may warn about it, in which case using a very small number might
9745 be more satisfactory.
9748 <para>For example, the value "1 2 1" means the center
9749 footer should have twice the width of the other areas.
9750 A value of "0 0 1" means the entire footer area
9751 is reserved for the right (or outside) footer text.
9752 Note that to keep the center area centered on
9753 the page, the left and right values must be
9754 the same. A specification like "1 2 3" means the
9755 center area is no longer centered on the page
9756 since the right area is three times the width of the left area.
9762 <refentry version="5.0" xml:id="header.table.properties">
9764 <refentrytitle>header.table.properties</refentrytitle>
9765 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
9768 <refname>header.table.properties</refname>
9769 <refpurpose>Apply properties to the header layout table</refpurpose>
9773 <programlisting xml:id="header.table.properties.frag">
9774 <xsl:attribute-set name="header.table.properties">
9775 <xsl:attribute name="table-layout">fixed</xsl:attribute>
9776 <xsl:attribute name="width">100%</xsl:attribute>
9777 </xsl:attribute-set>
9781 <refsection><info><title>Description</title></info>
9783 <para>Properties applied to the table that lays out the page header.</para>
9788 <refentry version="5.0" xml:id="header.table.height">
9790 <refentrytitle>header.table.height</refentrytitle>
9791 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
9794 <refname>header.table.height</refname>
9795 <refpurpose>Specify the minimum height of the table containing the running page headers</refpurpose>
9798 <refsynopsisdiv><programlisting xml:id="header.table.height.frag">
9799 <xsl:param name="header.table.height">14pt</xsl:param>
9800 </programlisting></refsynopsisdiv>
9802 <refsection><info><title>Description</title></info>
9804 <para>Page headers in print output use a three column table
9805 to position text at the left, center, and right side of
9806 the header on the page.
9807 This parameter lets you specify the minimum height
9808 of the single row in the table.
9809 Since this specifies only the minimum height,
9810 the table should automatically grow to fit taller content.
9811 The default value is "14pt".</para>
9816 <refentry version="5.0" xml:id="footer.table.properties">
9818 <refentrytitle>footer.table.properties</refentrytitle>
9819 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
9822 <refname>footer.table.properties</refname>
9823 <refpurpose>Apply properties to the footer layout table</refpurpose>
9827 <programlisting xml:id="footer.table.properties.frag">
9828 <xsl:attribute-set name="footer.table.properties">
9829 <xsl:attribute name="table-layout">fixed</xsl:attribute>
9830 <xsl:attribute name="width">100%</xsl:attribute>
9831 </xsl:attribute-set>
9835 <refsection><info><title>Description</title></info>
9837 <para>Properties applied to the table that lays out the page footer.</para>
9842 <refentry version="5.0" xml:id="footer.table.height">
9844 <refentrytitle>footer.table.height</refentrytitle>
9845 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
9848 <refname>footer.table.height</refname>
9849 <refpurpose>Specify the minimum height of the table containing the running page footers</refpurpose>
9852 <refsynopsisdiv><programlisting xml:id="footer.table.height.frag">
9853 <xsl:param name="footer.table.height">14pt</xsl:param>
9854 </programlisting></refsynopsisdiv>
9856 <refsection><info><title>Description</title></info>
9858 <para>Page footers in print output use a three column table
9859 to position text at the left, center, and right side of
9860 the footer on the page.
9861 This parameter lets you specify the minimum height
9862 of the single row in the table.
9863 Since this specifies only the minimum height,
9864 the table should automatically grow to fit taller content.
9865 The default value is "14pt".</para>
9870 <refentry version="5.0" xml:id="header.content.properties">
9872 <refentrytitle>header.content.properties</refentrytitle>
9873 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
9876 <refname>header.content.properties</refname>
9877 <refpurpose>Properties of page header content</refpurpose>
9881 <programlisting xml:id="header.content.properties.frag">
9882 <xsl:attribute-set name="header.content.properties">
9883 <xsl:attribute name="font-family">
9884 <xsl:value-of select="$body.fontset"></xsl:value-of>
9885 </xsl:attribute>
9886 <xsl:attribute name="margin-left">
9887 <xsl:value-of select="$title.margin.left"></xsl:value-of>
9888 </xsl:attribute>
9889 </xsl:attribute-set>
9893 <refsection><info><title>Description</title></info>
9895 <para>Properties of page header content.</para>
9900 <refentry version="5.0" xml:id="footer.content.properties">
9902 <refentrytitle>footer.content.properties</refentrytitle>
9903 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
9906 <refname>footer.content.properties</refname>
9907 <refpurpose>Properties of page footer content</refpurpose>
9911 <programlisting xml:id="footer.content.properties.frag">
9912 <xsl:attribute-set name="footer.content.properties">
9913 <xsl:attribute name="font-family">
9914 <xsl:value-of select="$body.fontset"></xsl:value-of>
9915 </xsl:attribute>
9916 <xsl:attribute name="margin-left">
9917 <xsl:value-of select="$title.margin.left"></xsl:value-of>
9918 </xsl:attribute>
9919 </xsl:attribute-set>
9923 <refsection><info><title>Description</title></info>
9925 <para>Properties of page footer content.</para>
9930 <refentry version="5.0" xml:id="marker.section.level">
9932 <refentrytitle>marker.section.level</refentrytitle>
9933 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
9936 <refname>marker.section.level</refname>
9937 <refpurpose>Control depth of sections shown in running headers or footers</refpurpose>
9941 <programlisting xml:id="marker.section.level.frag">
9942 <xsl:param name="marker.section.level">2</xsl:param>
9946 <refsection><info><title>Description</title></info>
9948 <para>The <parameter>marker.section.level</parameter> parameter
9949 controls the depth of section levels that may be displayed
9950 in running headers and footers. For example, if the value
9951 is 2 (the default), then titles from <tag>sect1</tag> and
9952 <tag>sect2</tag> or equivalent <tag>section</tag>
9953 elements are candidates for use in running headers and
9956 <para>Each candidate title is marked in the FO output with a
9957 <tag><fo:marker marker-class-name="section.head.marker"></tag>
9960 <para>In order for such titles to appear in headers
9961 or footers, the <literal>header.content</literal>
9962 or <literal>footer.content</literal> template
9963 must be customized to retrieve the marker using
9964 an output element such as:
9967 <fo:retrieve-marker retrieve-class-name="section.head.marker"
9968 retrieve-position="first-including-carryover"
9969 retrieve-boundary="page-sequence"/>
9976 <refentry version="5.0" xml:id="side.region.precedence">
9978 <refentrytitle>side.region.precedence</refentrytitle>
9979 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
9982 <refname>side.region.precedence</refname>
9983 <refpurpose>Determines side region page layout precedence</refpurpose>
9985 <refsynopsisdiv> <programlisting xml:id="side.region.precedence.frag">
9986 <xsl:param name="side.region.precedence">false</xsl:param>
9989 <refsection><info><title>Description</title></info>
9991 <para>If optional side regions on a page
9992 are established using parameters such as
9993 <parameter>body.margin.inner</parameter>,
9994 <parameter>region.inner.extent</parameter>, etc., then this
9995 parameter determines what happens at the corners where the
9996 side regions meet the header and footer regions.</para>
9998 <para>If the value of this parameter is <literal>true</literal>,
9999 then the side regions have precedence and extend higher
10000 and lower, while the header and footer regions are narrower
10001 and fit inside the side regions.</para>
10003 <para>If the value of this parameter is <literal>false</literal>
10004 (the default value), then the header and footer regions
10005 have precedence and extend over and below the side regions.
10006 Any value other than <literal>true</literal> or
10007 <literal>false</literal> is taken to be <literal>false</literal>.</para>
10009 <para>If you need to set precedence separately for
10010 individual regions, then you can set four
10011 parameters that are normally internal to the stylesheet.
10012 These four parameters are normally set based
10013 on the value from <parameter>side.region.precedence</parameter>:</para>
10015 <programlisting>region.before.precedence
10016 region.after.precedence
10017 region.start.precedence
10018 region.end.precedence</programlisting>
10021 <parameter>region.inner.extent</parameter>,
10022 <parameter>region.outer.extent</parameter>,
10023 <parameter>body.margin.inner</parameter>,
10024 <parameter>body.margin.outer</parameter>.
10026 </refsection> </refentry>
10028 <refentry version="5.0" xml:id="region.inner.properties">
10030 <refentrytitle>region.inner.properties</refentrytitle>
10031 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
10034 <refname>region.inner.properties</refname>
10035 <refpurpose>Properties of running inner side region</refpurpose>
10039 <programlisting xml:id="region.inner.properties.frag">
10040 <xsl:attribute-set name="region.inner.properties">
10041 <xsl:attribute name="border-width">0</xsl:attribute>
10042 <xsl:attribute name="padding">0</xsl:attribute>
10043 <xsl:attribute name="reference-orientation">90</xsl:attribute>
10044 </xsl:attribute-set>
10048 <refsection><info><title>Description</title></info>
10050 <para>The FO stylesheet supports optional side regions
10051 similar to the header and footer regions.
10052 Any attributes declared in this attribute-set
10053 are applied to the region element in the page master
10054 on the inner side (binding side) of the page.
10055 This corresponds to <literal><fo:regin-start></literal>
10056 on odd-numbered pages and <literal><fo:region-end></literal>
10057 on even-numbered pages.
10058 For single-sided output, it always corresponds to
10059 <literal><fo:regin-start></literal>.</para>
10061 <para>You can customize the template named
10062 <literal>inner.region.content</literal> to specify
10063 the content of the inner side region.</para>
10066 <parameter>inner.region.content.properties</parameter>,
10067 <parameter>page.margin.inner</parameter>,
10068 <parameter>body.margin.inner</parameter>,
10069 and the corresponding <literal>outer</literal>
10075 <refentry version="5.0" xml:id="region.outer.properties">
10077 <refentrytitle>region.outer.properties</refentrytitle>
10078 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
10081 <refname>region.outer.properties</refname>
10082 <refpurpose>Properties of running outer side region</refpurpose>
10086 <programlisting xml:id="region.outer.properties.frag">
10087 <xsl:attribute-set name="region.outer.properties">
10088 <xsl:attribute name="border-width">0</xsl:attribute>
10089 <xsl:attribute name="padding">0</xsl:attribute>
10090 <xsl:attribute name="reference-orientation">90</xsl:attribute>
10091 </xsl:attribute-set>
10095 <refsection><info><title>Description</title></info>
10097 <para>The FO stylesheet supports optional side regions
10098 similar to the header and footer regions.
10099 Any attributes declared in this attribute-set
10100 are applied to the region element in the page master
10101 on the outer side (opposite the binding side) of the page.
10102 This corresponds to <literal><fo:regin-start></literal>
10103 on odd-numbered pages and <literal><fo:region-end></literal>
10104 on even-numbered pages.
10105 For single-sided output, it always corresponds to
10106 <literal><fo:regin-start></literal>.</para>
10108 <para>You can customize the template named
10109 <literal>outer.region.content</literal> to specify
10110 the content of the outer side region.</para>
10113 <parameter>outer.region.content.properties</parameter>,
10114 <parameter>page.margin.outer</parameter>,
10115 <parameter>body.margin.outer</parameter>,
10116 and the corresponding <literal>inner</literal>
10122 <refentry version="5.0" xml:id="inner.region.content.properties">
10124 <refentrytitle>inner.region.content.properties</refentrytitle>
10125 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
10128 <refname>inner.region.content.properties</refname>
10129 <refpurpose>Properties of running inner side content</refpurpose>
10133 <programlisting xml:id="inner.region.content.properties.frag">
10134 <xsl:attribute-set name="inner.region.content.properties">
10135 </xsl:attribute-set>
10139 <refsection><info><title>Description</title></info>
10141 <para>The FO stylesheet supports optional side regions
10142 similar to the header and footer regions.
10143 Any attributes declared in this attribute-set
10144 are applied to the fo:block in the side region
10145 on the inner side (binding side) of the page.
10146 This corresponds to the <literal>start</literal>
10147 region on odd-numbered pages and the <literal>end</literal>
10148 region on even-numbered pages.
10149 For single-sided output, it always corresponds to
10150 the <literal>start</literal> region.</para>
10152 <para>You can customize the template named
10153 <literal>inner.region.content</literal> to specify
10154 the content of the inner side region.</para>
10157 <parameter>region.inner.properties</parameter>,
10158 <parameter>page.margin.inner</parameter>,
10159 <parameter>body.margin.inner</parameter>,
10160 and the corresponding <literal>outer</literal>
10166 <refentry version="5.0" xml:id="outer.region.content.properties">
10168 <refentrytitle>outer.region.content.properties</refentrytitle>
10169 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
10172 <refname>outer.region.content.properties</refname>
10173 <refpurpose>Properties of running outer side content</refpurpose>
10177 <programlisting xml:id="outer.region.content.properties.frag">
10178 <xsl:attribute-set name="outer.region.content.properties">
10179 </xsl:attribute-set>
10183 <refsection><info><title>Description</title></info>
10185 <para>The FO stylesheet supports optional side regions
10186 similar to the header and footer regions.
10187 Any attributes declared in this attribute-set
10188 are applied to the fo:block in the side region
10189 on the outer side (opposite the binding side) of the page.
10190 This corresponds to the <literal>start</literal>
10191 region on odd-numbered pages and the <literal>end</literal>
10192 region on even-numbered pages.
10193 For single-sided output, it always corresponds to
10194 the <literal>start</literal> region.</para>
10196 <para>You can customize the template named
10197 <literal>outer.region.content</literal> to specify
10198 the content of the outer side region.</para>
10201 <parameter>region.outer.properties</parameter>,
10202 <parameter>page.margin.outer</parameter>,
10203 <parameter>body.margin.outer</parameter>,
10204 and the corresponding <literal>inner</literal>
10210 <reference xml:id="fonts"><title>Font Families</title>
10211 <refentry version="5.0" xml:id="body.font.family">
10213 <refentrytitle>body.font.family</refentrytitle>
10214 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
10215 <refmiscinfo class="other" otherclass="list-type">open</refmiscinfo>
10216 <refmiscinfo class="other" otherclass="value">serif</refmiscinfo>
10217 <refmiscinfo class="other" otherclass="value">sans-serif</refmiscinfo>
10218 <refmiscinfo class="other" otherclass="value">monospace</refmiscinfo>
10221 <refname>body.font.family</refname>
10222 <refpurpose>The default font family for body text</refpurpose>
10226 <programlisting xml:id="body.font.family.frag">
10227 <xsl:param name="body.font.family">serif</xsl:param>
10231 <refsection><info><title>Description</title></info>
10233 <para>The body font family is the default font used for text in the page body.</para>
10234 <para>If more than one font is required, enter the font names,
10235 separated by a comma, e.g.</para>
10237 <xsl:param name="body.font.family">Arial, SimSun, serif</xsl:param>
10244 <refentry version="5.0" xml:id="dingbat.font.family">
10246 <refentrytitle>dingbat.font.family</refentrytitle>
10247 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
10248 <refmiscinfo class="other" otherclass="list-type">open</refmiscinfo>
10249 <refmiscinfo class="other" otherclass="value">serif</refmiscinfo>
10250 <refmiscinfo class="other" otherclass="value">sans-serif</refmiscinfo>
10251 <refmiscinfo class="other" otherclass="value">monospace</refmiscinfo>
10254 <refname>dingbat.font.family</refname>
10255 <refpurpose>The font family for copyright, quotes, and other symbols</refpurpose>
10259 <programlisting xml:id="dingbat.font.family.frag">
10260 <xsl:param name="dingbat.font.family">serif</xsl:param>
10264 <refsection><info><title>Description</title></info>
10266 <para>The dingbat font family is used for dingbats. If it is defined
10267 as the empty string, no font change is effected around dingbats.
10273 <refentry version="5.0" xml:id="monospace.font.family">
10275 <refentrytitle>monospace.font.family</refentrytitle>
10276 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
10279 <refname>monospace.font.family</refname>
10280 <refpurpose>The default font family for monospace environments</refpurpose>
10284 <programlisting xml:id="monospace.font.family.frag">
10285 <xsl:param name="monospace.font.family">monospace</xsl:param>
10289 <refsection><info><title>Description</title></info>
10291 <para>The monospace font family is used for verbatim environments
10292 (program listings, screens, etc.).
10294 <para>If more than one font is required, enter the font names,
10295 separated by a comma, e.g.</para>
10297 <xsl:param name="body.font.family">Arial, SimSun, serif</xsl:param>
10303 <refentry version="5.0" xml:id="sans.font.family">
10305 <refentrytitle>sans.font.family</refentrytitle>
10306 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
10309 <refname>sans.font.family</refname>
10310 <refpurpose>The default sans-serif font family</refpurpose>
10314 <programlisting xml:id="sans.font.family.frag">
10315 <xsl:param name="sans.font.family">sans-serif</xsl:param>
10319 <refsection><info><title>Description</title></info>
10321 <para>The default sans-serif font family. At the present, this isn't
10322 actually used by the stylesheets.
10328 <refentry version="5.0" xml:id="title.font.family">
10330 <refentrytitle>title.font.family</refentrytitle>
10331 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
10332 <refmiscinfo class="other" otherclass="list-type">open</refmiscinfo>
10333 <refmiscinfo class="other" otherclass="value">serif</refmiscinfo>
10334 <refmiscinfo class="other" otherclass="value">sans-serif</refmiscinfo>
10335 <refmiscinfo class="other" otherclass="value">monospace</refmiscinfo>
10338 <refname>title.font.family</refname>
10339 <refpurpose>The default font family for titles</refpurpose>
10343 <programlisting xml:id="title.font.family.frag">
10344 <xsl:param name="title.font.family">sans-serif</xsl:param>
10348 <refsection><info><title>Description</title></info>
10350 <para>The title font family is used for titles (chapter, section, figure,
10353 <para>If more than one font is required, enter the font names,
10354 separated by a comma, e.g.</para>
10356 <xsl:param name="body.font.family">Arial, SimSun, serif</xsl:param>
10362 <refentry version="5.0" xml:id="symbol.font.family">
10364 <refentrytitle>symbol.font.family</refentrytitle>
10365 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
10366 <refmiscinfo class="other" otherclass="list-type">open</refmiscinfo>
10367 <refmiscinfo class="other" otherclass="value">serif</refmiscinfo>
10368 <refmiscinfo class="other" otherclass="value">sans-serif</refmiscinfo>
10369 <refmiscinfo class="other" otherclass="value">monospace</refmiscinfo>
10372 <refname>symbol.font.family</refname>
10373 <refpurpose>The font families to be searched for symbols outside
10374 of the body font</refpurpose>
10378 <programlisting xml:id="symbol.font.family.frag">
10379 <xsl:param name="symbol.font.family">Symbol,ZapfDingbats</xsl:param>
10383 <refsection><info><title>Description</title></info>
10385 <para>A typical body or title font does not contain all
10386 the character glyphs that DocBook supports. This parameter
10387 specifies additional fonts that should be searched for
10388 special characters not in the normal font.
10389 These symbol font names are automatically appended
10390 to the body or title font family name when fonts
10392 <tag class="attribute">font-family</tag>
10393 property in the FO output.
10395 <para>The symbol font names should be entered as a
10396 comma-separated list. The default value is
10397 <literal>Symbol,ZapfDingbats</literal>.
10404 <reference xml:id="propsets"><title>Property Sets</title>
10405 <refentry version="5.0" xml:id="formal.object.properties">
10407 <refentrytitle>formal.object.properties</refentrytitle>
10408 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
10411 <refname>formal.object.properties</refname>
10412 <refpurpose>Properties associated with a formal object such as a figure, or other component that has a title</refpurpose>
10416 <programlisting xml:id="formal.object.properties.frag">
10417 <xsl:attribute-set name="formal.object.properties">
10418 <xsl:attribute name="space-before.minimum">0.5em</xsl:attribute>
10419 <xsl:attribute name="space-before.optimum">1em</xsl:attribute>
10420 <xsl:attribute name="space-before.maximum">2em</xsl:attribute>
10421 <xsl:attribute name="space-after.minimum">0.5em</xsl:attribute>
10422 <xsl:attribute name="space-after.optimum">1em</xsl:attribute>
10423 <xsl:attribute name="space-after.maximum">2em</xsl:attribute>
10424 <xsl:attribute name="keep-together.within-column">always</xsl:attribute>
10425 </xsl:attribute-set>
10429 <refsection><info><title>Description</title></info>
10431 <para>The styling for formal objects in docbook. Specify the spacing
10432 before and after the object.</para>
10437 <refentry version="5.0" xml:id="formal.title.properties">
10439 <refentrytitle>formal.title.properties</refentrytitle>
10440 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
10443 <refname>formal.title.properties</refname>
10444 <refpurpose>Style the title element of formal object such as a figure.</refpurpose>
10448 <programlisting xml:id="formal.title.properties.frag">
10449 <xsl:attribute-set name="formal.title.properties" use-attribute-sets="normal.para.spacing">
10450 <xsl:attribute name="font-weight">bold</xsl:attribute>
10451 <xsl:attribute name="font-size">
10452 <xsl:value-of select="$body.font.master * 1.2"></xsl:value-of>
10453 <xsl:text>pt</xsl:text>
10454 </xsl:attribute>
10455 <xsl:attribute name="hyphenate">false</xsl:attribute>
10456 <xsl:attribute name="space-after.minimum">0.4em</xsl:attribute>
10457 <xsl:attribute name="space-after.optimum">0.6em</xsl:attribute>
10458 <xsl:attribute name="space-after.maximum">0.8em</xsl:attribute>
10459 </xsl:attribute-set>
10462 <refsection><info><title>Description</title></info>
10463 <para>Specify how the title should be styled. Specify the font size and weight of the title of the formal object.</para>
10467 <refentry version="5.0" xml:id="informal.object.properties">
10469 <refentrytitle>informal.object.properties</refentrytitle>
10470 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
10473 <refname>informal.object.properties</refname>
10474 <refpurpose>Properties associated with an informal (untitled) object, such as an informalfigure</refpurpose>
10478 <programlisting xml:id="informal.object.properties.frag"><xsl:attribute-set name="informal.object.properties">
10479 <xsl:attribute name="space-before.minimum">0.5em</xsl:attribute>
10480 <xsl:attribute name="space-before.optimum">1em</xsl:attribute>
10481 <xsl:attribute name="space-before.maximum">2em</xsl:attribute>
10482 <xsl:attribute name="space-after.minimum">0.5em</xsl:attribute>
10483 <xsl:attribute name="space-after.optimum">1em</xsl:attribute>
10484 <xsl:attribute name="space-after.maximum">2em</xsl:attribute>
10485 </xsl:attribute-set></programlisting>
10487 <refsection><info><title>Description</title></info>
10488 <para>The styling for informal objects in docbook. Specify the spacing before and after the object.</para>
10492 <refentry version="5.0" xml:id="monospace.properties">
10494 <refentrytitle>monospace.properties</refentrytitle>
10495 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
10498 <refname>monospace.properties</refname>
10499 <refpurpose>Properties of monospaced content</refpurpose>
10503 <programlisting xml:id="monospace.properties.frag">
10504 <xsl:attribute-set name="monospace.properties">
10505 <xsl:attribute name="font-family">
10506 <xsl:value-of select="$monospace.font.family"></xsl:value-of>
10507 </xsl:attribute>
10508 </xsl:attribute-set>
10512 <refsection><info><title>Description</title></info>
10514 <para>Specifies the font name for monospaced output. This property set
10515 used to set the font-size as well, but that doesn't work very well
10516 when different fonts are used (as they are in titles and paragraphs,
10517 for example).</para>
10519 <para>If you want to set the font-size in a customization layer, it's
10520 probably going to be more appropriate to set font-size-adjust, if your
10521 formatter supports it.</para>
10526 <refentry version="5.0" xml:id="verbatim.properties">
10528 <refentrytitle>verbatim.properties</refentrytitle>
10529 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
10532 <refname>verbatim.properties</refname>
10533 <refpurpose>Properties associated with verbatim text</refpurpose>
10537 <programlisting xml:id="verbatim.properties.frag">
10538 <xsl:attribute-set name="verbatim.properties">
10539 <xsl:attribute name="space-before.minimum">0.8em</xsl:attribute>
10540 <xsl:attribute name="space-before.optimum">1em</xsl:attribute>
10541 <xsl:attribute name="space-before.maximum">1.2em</xsl:attribute>
10542 <xsl:attribute name="space-after.minimum">0.8em</xsl:attribute>
10543 <xsl:attribute name="space-after.optimum">1em</xsl:attribute>
10544 <xsl:attribute name="space-after.maximum">1.2em</xsl:attribute>
10545 <xsl:attribute name="hyphenate">false</xsl:attribute>
10546 <xsl:attribute name="wrap-option">no-wrap</xsl:attribute>
10547 <xsl:attribute name="white-space-collapse">false</xsl:attribute>
10548 <xsl:attribute name="white-space-treatment">preserve</xsl:attribute>
10549 <xsl:attribute name="linefeed-treatment">preserve</xsl:attribute>
10550 <xsl:attribute name="text-align">start</xsl:attribute>
10551 </xsl:attribute-set></programlisting>
10554 <refsection><info><title>Description</title></info>
10555 <para>This attribute set is used on all verbatim environments.</para>
10560 <refentry version="5.0" xml:id="monospace.verbatim.properties">
10562 <refentrytitle>monospace.verbatim.properties</refentrytitle>
10563 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
10566 <refname>monospace.verbatim.properties</refname>
10567 <refpurpose>What font and size do you want for monospaced content?</refpurpose>
10571 <programlisting xml:id="monospace.verbatim.properties.frag">
10572 <xsl:attribute-set name="monospace.verbatim.properties" use-attribute-sets="verbatim.properties monospace.properties">
10573 <xsl:attribute name="text-align">start</xsl:attribute>
10574 <xsl:attribute name="wrap-option">no-wrap</xsl:attribute>
10575 </xsl:attribute-set>
10578 <refsection><info><title>Description</title></info>
10579 <para>Specify the font name and size you want for monospaced output</para>
10583 <refentry version="5.0" xml:id="sidebar.properties">
10585 <refentrytitle>sidebar.properties</refentrytitle>
10586 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
10589 <refname>sidebar.properties</refname>
10590 <refpurpose>Attribute set for sidebar properties</refpurpose>
10594 <programlisting xml:id="sidebar.properties.frag">
10595 <xsl:attribute-set name="sidebar.properties" use-attribute-sets="formal.object.properties">
10596 <xsl:attribute name="border-style">solid</xsl:attribute>
10597 <xsl:attribute name="border-width">1pt</xsl:attribute>
10598 <xsl:attribute name="border-color">black</xsl:attribute>
10599 <xsl:attribute name="background-color">#DDDDDD</xsl:attribute>
10600 <xsl:attribute name="padding-start">12pt</xsl:attribute>
10601 <xsl:attribute name="padding-end">12pt</xsl:attribute>
10602 <xsl:attribute name="padding-top">6pt</xsl:attribute>
10603 <xsl:attribute name="padding-bottom">6pt</xsl:attribute>
10604 <xsl:attribute name="margin-{$direction.align.start}">0pt</xsl:attribute>
10605 <xsl:attribute name="margin-{$direction.align.end}">0pt</xsl:attribute>
10607 <xsl:attribute name="margin-top">6pt</xsl:attribute>
10608 <xsl:attribute name="margin-bottom">6pt</xsl:attribute>
10610 </xsl:attribute-set>
10614 <refsection><info><title>Description</title></info>
10616 <para>The styling for sidebars.</para>
10621 <refentry version="5.0" xml:id="sidebar.title.properties">
10623 <refentrytitle>sidebar.title.properties</refentrytitle>
10624 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
10627 <refname>sidebar.title.properties</refname>
10628 <refpurpose>Attribute set for sidebar titles</refpurpose>
10632 <programlisting xml:id="sidebar.title.properties.frag">
10633 <xsl:attribute-set name="sidebar.title.properties">
10634 <xsl:attribute name="font-weight">bold</xsl:attribute>
10635 <xsl:attribute name="hyphenate">false</xsl:attribute>
10636 <xsl:attribute name="text-align">start</xsl:attribute>
10637 <xsl:attribute name="keep-with-next.within-column">always</xsl:attribute>
10638 </xsl:attribute-set>
10642 <refsection><info><title>Description</title></info>
10644 <para>The styling for sidebars titles.</para>
10649 <refentry version="5.0" xml:id="sidebar.float.type">
10651 <refentrytitle>sidebar.float.type</refentrytitle>
10652 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
10653 <refmiscinfo class="other" otherclass="value">none</refmiscinfo>
10654 <refmiscinfo class="other" otherclass="value">before</refmiscinfo>
10655 <refmiscinfo class="other" otherclass="value">left</refmiscinfo>
10656 <refmiscinfo class="other" otherclass="value">start</refmiscinfo>
10657 <refmiscinfo class="other" otherclass="value">right</refmiscinfo>
10658 <refmiscinfo class="other" otherclass="value">end</refmiscinfo>
10659 <refmiscinfo class="other" otherclass="value">inside</refmiscinfo>
10660 <refmiscinfo class="other" otherclass="value">outside</refmiscinfo>
10663 <refname>sidebar.float.type</refname>
10664 <refpurpose>Select type of float for sidebar elements</refpurpose>
10668 <programlisting xml:id="sidebar.float.type.frag">
10669 <xsl:param name="sidebar.float.type">none</xsl:param>
10673 <refsection><info><title>Description</title></info>
10675 <para>Selects the type of float for sidebar elements.
10679 <para>If <parameter>sidebar.float.type</parameter> is
10680 <quote><literal>none</literal></quote>, then
10685 <para>If <parameter>sidebar.float.type</parameter> is
10686 <quote><literal>before</literal></quote>, then
10687 the float appears at the top of the page. On some processors,
10688 that may be the next page rather than the current page.
10693 <para>If <parameter>sidebar.float.type</parameter> is
10694 <quote><literal>left</literal></quote>,
10695 then a left side float is used.
10700 <para>If <parameter>sidebar.float.type</parameter> is
10701 <quote><literal>start</literal></quote>,
10702 then when the text direction is left-to-right a left side float is used.
10703 When the text direction is right-to-left, a right side float is used.
10708 <para>If <parameter>sidebar.float.type</parameter> is
10709 <quote><literal>right</literal></quote>,
10710 then a right side float is used.
10715 <para>If <parameter>sidebar.float.type</parameter> is
10716 <quote><literal>end</literal></quote>,
10717 then when the text direction is left-to-right a right side float is used.
10718 When the text direction is right-to-left, a left side float is used.
10723 <para>If your XSL-FO processor supports floats positioned on the
10724 <quote><literal>inside</literal></quote> or
10725 <quote><literal>outside</literal></quote>
10726 of double-sided pages, then you have those two
10727 options for side floats as well.
10735 <refentry version="5.0" xml:id="sidebar.float.width">
10737 <refentrytitle>sidebar.float.width</refentrytitle>
10738 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
10741 <refname>sidebar.float.width</refname>
10742 <refpurpose>Set the default width for sidebars</refpurpose>
10746 <programlisting xml:id="sidebar.float.width.frag">
10747 <xsl:param name="sidebar.float.width">1in</xsl:param>
10751 <refsection><info><title>Description</title></info>
10753 <para>Sets the default width for sidebars when used as a side float.
10754 The width determines the degree to which the sidebar block intrudes into
10757 <para>If <parameter>sidebar.float.type</parameter> is
10758 <quote><literal>before</literal></quote> or
10759 <quote><literal>none</literal></quote>, then
10760 this parameter is ignored.
10766 <refentry version="5.0" xml:id="margin.note.properties">
10768 <refentrytitle>margin.note.properties</refentrytitle>
10769 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
10772 <refname>margin.note.properties</refname>
10773 <refpurpose>Attribute set for margin.note properties</refpurpose>
10777 <programlisting xml:id="margin.note.properties.frag">
10778 <xsl:attribute-set name="margin.note.properties">
10779 <xsl:attribute name="font-size">90%</xsl:attribute>
10780 <xsl:attribute name="text-align">start</xsl:attribute>
10781 </xsl:attribute-set>
10785 <refsection><info><title>Description</title></info>
10787 <para>The styling for margin notes.
10788 By default, margin notes are not implemented for any
10789 element. A stylesheet customization is needed to make
10790 use of this attribute-set.</para>
10792 <para>You can use a template named <quote>floater</quote>
10793 to create the customization.
10794 That template can create side floats by specifying the
10795 content and characteristics as template parameters.
10798 <para>For example:</para>
10799 <programlisting><xsl:template match="para[@role='marginnote']">
10800 <xsl:call-template name="floater">
10801 <xsl:with-param name="position">
10802 <xsl:value-of select="$margin.note.float.type"/>
10803 </xsl:with-param>
10804 <xsl:with-param name="width">
10805 <xsl:value-of select="$margin.note.width"/>
10806 </xsl:with-param>
10807 <xsl:with-param name="content">
10808 <xsl:apply-imports/>
10809 </xsl:with-param>
10810 </xsl:call-template>
10811 </xsl:template></programlisting>
10816 <refentry version="5.0" xml:id="margin.note.title.properties">
10818 <refentrytitle>margin.note.title.properties</refentrytitle>
10819 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
10822 <refname>margin.note.title.properties</refname>
10823 <refpurpose>Attribute set for margin note titles</refpurpose>
10827 <programlisting xml:id="margin.note.title.properties.frag">
10828 <xsl:attribute-set name="margin.note.title.properties">
10829 <xsl:attribute name="font-weight">bold</xsl:attribute>
10830 <xsl:attribute name="hyphenate">false</xsl:attribute>
10831 <xsl:attribute name="text-align">start</xsl:attribute>
10832 <xsl:attribute name="keep-with-next.within-column">always</xsl:attribute>
10833 </xsl:attribute-set>
10837 <refsection><info><title>Description</title></info>
10839 <para>The styling for margin note titles.</para>
10844 <refentry version="5.0" xml:id="margin.note.float.type">
10846 <refentrytitle>margin.note.float.type</refentrytitle>
10847 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
10848 <refmiscinfo class="other" otherclass="value">none</refmiscinfo>
10849 <refmiscinfo class="other" otherclass="value">before</refmiscinfo>
10850 <refmiscinfo class="other" otherclass="value">left</refmiscinfo>
10851 <refmiscinfo class="other" otherclass="value">start</refmiscinfo>
10852 <refmiscinfo class="other" otherclass="value">right</refmiscinfo>
10853 <refmiscinfo class="other" otherclass="value">end</refmiscinfo>
10854 <refmiscinfo class="other" otherclass="value">inside</refmiscinfo>
10855 <refmiscinfo class="other" otherclass="value">outside</refmiscinfo>
10858 <refname>margin.note.float.type</refname>
10859 <refpurpose>Select type of float for margin note customizations</refpurpose>
10863 <programlisting xml:id="margin.note.float.type.frag">
10864 <xsl:param name="margin.note.float.type">none</xsl:param>
10868 <refsection><info><title>Description</title></info>
10870 <para>Selects the type of float for margin notes.
10871 DocBook does not define a margin note element, so this
10872 feature must be implemented as a customization of the stylesheet.
10873 See <parameter>margin.note.properties</parameter> for
10878 <para>If <parameter>margin.note.float.type</parameter> is
10879 <quote><literal>none</literal></quote>, then
10884 <para>If <parameter>margin.note.float.type</parameter> is
10885 <quote><literal>before</literal></quote>, then
10886 the float appears at the top of the page. On some processors,
10887 that may be the next page rather than the current page.
10891 <para>If <parameter>margin.note.float.type</parameter> is
10892 <quote><literal>left</literal></quote> or
10893 <quote><literal>start</literal></quote>, then
10894 a left side float is used.
10898 <para>If <parameter>margin.note.float.type</parameter> is
10899 <quote><literal>right</literal></quote> or
10900 <quote><literal>end</literal></quote>, then
10901 a right side float is used.
10905 <para>If your XSL-FO processor supports floats positioned on the
10906 <quote><literal>inside</literal></quote> or
10907 <quote><literal>outside</literal></quote>
10908 of double-sided pages, then you have those two
10909 options for side floats as well.
10917 <refentry version="5.0" xml:id="margin.note.width">
10919 <refentrytitle>margin.note.width</refentrytitle>
10920 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
10923 <refname>margin.note.width</refname>
10924 <refpurpose>Set the default width for margin notes</refpurpose>
10928 <programlisting xml:id="margin.note.width.frag">
10929 <xsl:param name="margin.note.width">1in</xsl:param>
10933 <refsection><info><title>Description</title></info>
10935 <para>Sets the default width for margin notes when used as a side
10936 float. The width determines the degree to which the margin note block
10937 intrudes into the text area.
10939 <para>If <parameter>margin.note.float.type</parameter> is
10940 <quote><literal>before</literal></quote> or
10941 <quote><literal>none</literal></quote>, then
10942 this parameter is ignored.
10948 <refentry version="5.0" xml:id="component.title.properties">
10950 <refentrytitle>component.title.properties</refentrytitle>
10951 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
10954 <refname>component.title.properties</refname>
10955 <refpurpose>Properties for component titles</refpurpose>
10959 <programlisting xml:id="component.title.properties.frag">
10960 <xsl:attribute-set name="component.title.properties">
10961 <xsl:attribute name="keep-with-next.within-column">always</xsl:attribute>
10962 <xsl:attribute name="space-before.optimum"><xsl:value-of select="concat($body.font.master, 'pt')"></xsl:value-of></xsl:attribute>
10963 <xsl:attribute name="space-before.minimum"><xsl:value-of select="concat($body.font.master, 'pt * 0.8')"></xsl:value-of></xsl:attribute>
10964 <xsl:attribute name="space-before.maximum"><xsl:value-of select="concat($body.font.master, 'pt * 1.2')"></xsl:value-of></xsl:attribute>
10965 <xsl:attribute name="hyphenate">false</xsl:attribute>
10966 <xsl:attribute name="text-align">
10968 <xsl:when test="((parent::article | parent::articleinfo | parent::info/parent::article) and not(ancestor::book) and not(self::bibliography)) or (parent::slides | parent::slidesinfo)">center</xsl:when>
10969 <xsl:otherwise>start</xsl:otherwise>
10970 </xsl:choose>
10971 </xsl:attribute>
10972 <xsl:attribute name="start-indent"><xsl:value-of select="$title.margin.left"></xsl:value-of></xsl:attribute>
10973 </xsl:attribute-set>
10977 <refsection><info><title>Description</title></info>
10979 <para>The properties common to all component titles.</para>
10984 <refentry version="5.0" xml:id="component.titlepage.properties">
10986 <refentrytitle>component.titlepage.properties</refentrytitle>
10987 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
10990 <refname>component.titlepage.properties</refname>
10991 <refpurpose>Properties for component titlepages</refpurpose>
10995 <programlisting xml:id="component.titlepage.properties.frag">
10996 <xsl:attribute-set name="component.titlepage.properties">
10997 </xsl:attribute-set>
11001 <refsection><info><title>Description</title></info>
11003 <para>The properties that are applied to the outer block containing
11004 all the component title page information.
11005 Its main use is to set a <literal>span="all"</literal>
11006 property on the block that is a direct child of the flow.</para>
11008 <para>This attribute-set also applies to index titlepages. It is empty by default.</para>
11013 <refentry version="5.0" xml:id="section.title.properties">
11015 <refentrytitle>section.title.properties</refentrytitle>
11016 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
11019 <refname>section.title.properties</refname>
11020 <refpurpose>Properties for section titles</refpurpose>
11024 <programlisting xml:id="section.title.properties.frag">
11025 <xsl:attribute-set name="section.title.properties">
11026 <xsl:attribute name="font-family">
11027 <xsl:value-of select="$title.fontset"></xsl:value-of>
11028 </xsl:attribute>
11029 <xsl:attribute name="font-weight">bold</xsl:attribute>
11030 <!-- font size is calculated dynamically by section.heading template -->
11031 <xsl:attribute name="keep-with-next.within-column">always</xsl:attribute>
11032 <xsl:attribute name="space-before.minimum">0.8em</xsl:attribute>
11033 <xsl:attribute name="space-before.optimum">1.0em</xsl:attribute>
11034 <xsl:attribute name="space-before.maximum">1.2em</xsl:attribute>
11035 <xsl:attribute name="text-align">start</xsl:attribute>
11036 <xsl:attribute name="start-indent"><xsl:value-of select="$title.margin.left"></xsl:value-of></xsl:attribute>
11037 </xsl:attribute-set>
11041 <refsection><info><title>Description</title></info>
11043 <para>The properties common to all section titles.</para>
11048 <refentry version="5.0" xml:id="section.title.level1.properties">
11050 <refentrytitle>section.title.level1.properties</refentrytitle>
11051 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
11054 <refname>section.title.level1.properties</refname>
11055 <refpurpose>Properties for level-1 section titles</refpurpose>
11059 <programlisting xml:id="section.title.level1.properties.frag">
11060 <xsl:attribute-set name="section.title.level1.properties">
11061 <xsl:attribute name="font-size">
11062 <xsl:value-of select="$body.font.master * 2.0736"></xsl:value-of>
11063 <xsl:text>pt</xsl:text>
11064 </xsl:attribute>
11065 </xsl:attribute-set>
11069 <refsection><info><title>Description</title></info>
11071 <para>The properties of level-1 section titles.</para>
11077 <refentry version="5.0" xml:id="section.title.level2.properties">
11079 <refentrytitle>section.title.level2.properties</refentrytitle>
11080 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
11083 <refname>section.title.level2.properties</refname>
11084 <refpurpose>Properties for level-2 section titles</refpurpose>
11088 <programlisting xml:id="section.title.level2.properties.frag">
11089 <xsl:attribute-set name="section.title.level2.properties">
11090 <xsl:attribute name="font-size">
11091 <xsl:value-of select="$body.font.master * 1.728"></xsl:value-of>
11092 <xsl:text>pt</xsl:text>
11093 </xsl:attribute>
11094 </xsl:attribute-set>
11098 <refsection><info><title>Description</title></info>
11100 <para>The properties of level-2 section titles.</para>
11105 <refentry version="5.0" xml:id="section.title.level3.properties">
11107 <refentrytitle>section.title.level3.properties</refentrytitle>
11108 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
11111 <refname>section.title.level3.properties</refname>
11112 <refpurpose>Properties for level-3 section titles</refpurpose>
11116 <programlisting xml:id="section.title.level3.properties.frag">
11117 <xsl:attribute-set name="section.title.level3.properties">
11118 <xsl:attribute name="font-size">
11119 <xsl:value-of select="$body.font.master * 1.44"></xsl:value-of>
11120 <xsl:text>pt</xsl:text>
11121 </xsl:attribute>
11122 </xsl:attribute-set>
11126 <refsection><info><title>Description</title></info>
11128 <para>The properties of level-3 section titles.</para>
11133 <refentry version="5.0" xml:id="section.title.level4.properties">
11135 <refentrytitle>section.title.level4.properties</refentrytitle>
11136 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
11139 <refname>section.title.level4.properties</refname>
11140 <refpurpose>Properties for level-4 section titles</refpurpose>
11144 <programlisting xml:id="section.title.level4.properties.frag">
11145 <xsl:attribute-set name="section.title.level4.properties">
11146 <xsl:attribute name="font-size">
11147 <xsl:value-of select="$body.font.master * 1.2"></xsl:value-of>
11148 <xsl:text>pt</xsl:text>
11149 </xsl:attribute>
11150 </xsl:attribute-set>
11154 <refsection><info><title>Description</title></info>
11156 <para>The properties of level-4 section titles.</para>
11161 <refentry version="5.0" xml:id="section.title.level5.properties">
11163 <refentrytitle>section.title.level5.properties</refentrytitle>
11164 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
11167 <refname>section.title.level5.properties</refname>
11168 <refpurpose>Properties for level-5 section titles</refpurpose>
11172 <programlisting xml:id="section.title.level5.properties.frag">
11173 <xsl:attribute-set name="section.title.level5.properties">
11174 <xsl:attribute name="font-size">
11175 <xsl:value-of select="$body.font.master"></xsl:value-of>
11176 <xsl:text>pt</xsl:text>
11177 </xsl:attribute>
11178 </xsl:attribute-set>
11182 <refsection><info><title>Description</title></info>
11184 <para>The properties of level-5 section titles.</para>
11189 <refentry version="5.0" xml:id="section.title.level6.properties">
11191 <refentrytitle>section.title.level6.properties</refentrytitle>
11192 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
11195 <refname>section.title.level6.properties</refname>
11196 <refpurpose>Properties for level-6 section titles</refpurpose>
11200 <programlisting xml:id="section.title.level6.properties.frag">
11201 <xsl:attribute-set name="section.title.level6.properties">
11202 <xsl:attribute name="font-size">
11203 <xsl:value-of select="$body.font.master"></xsl:value-of>
11204 <xsl:text>pt</xsl:text>
11205 </xsl:attribute>
11206 </xsl:attribute-set>
11210 <refsection><info><title>Description</title></info>
11212 <para>The properties of level-6 section titles. This property set is actually
11213 used for all titles below level 5.</para>
11218 <refentry version="5.0" xml:id="section.properties">
11220 <refentrytitle>section.properties</refentrytitle>
11221 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
11224 <refname>section.properties</refname>
11225 <refpurpose>Properties for all section levels</refpurpose>
11229 <programlisting xml:id="section.properties.frag">
11230 <xsl:attribute-set name="section.properties">
11231 </xsl:attribute-set>
11235 <refsection><info><title>Description</title></info>
11237 <para>The properties that apply to the containing
11238 block of all section levels, and therefore apply to
11240 This attribute set is inherited by the
11241 more specific attribute sets such as
11242 <tag>section.level1.properties</tag>.
11243 The default is empty.
11249 <refentry version="5.0" xml:id="section.level1.properties">
11251 <refentrytitle>section.level1.properties</refentrytitle>
11252 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
11255 <refname>section.level1.properties</refname>
11256 <refpurpose>Properties for level-1 sections</refpurpose>
11260 <programlisting xml:id="section.level1.properties.frag">
11261 <xsl:attribute-set name="section.level1.properties" use-attribute-sets="section.properties">
11262 </xsl:attribute-set>
11266 <refsection><info><title>Description</title></info>
11268 <para>The properties that apply to the containing
11269 block of a level-1 section, and therefore apply to
11270 the whole section. This includes <tag>sect1</tag>
11271 elements and <tag>section</tag> elements at level 1.
11274 <para>For example, you could start each level-1 section on
11275 a new page by using:</para>
11276 <programlisting><xsl:attribute-set name="section.level1.properties">
11277 <xsl:attribute name="break-before">page</xsl:attribute>
11278 </xsl:attribute-set>
11281 <para>This attribute set inherits attributes from the
11282 general <tag>section.properties</tag> attribute set.
11288 <refentry version="5.0" xml:id="section.level2.properties">
11290 <refentrytitle>section.level2.properties</refentrytitle>
11291 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
11294 <refname>section.level2.properties</refname>
11295 <refpurpose>Properties for level-2 sections</refpurpose>
11299 <programlisting xml:id="section.level2.properties.frag">
11300 <xsl:attribute-set name="section.level2.properties" use-attribute-sets="section.properties">
11301 </xsl:attribute-set>
11305 <refsection><info><title>Description</title></info>
11307 <para>The properties that apply to the containing
11308 block of a level-2 section, and therefore apply to
11309 the whole section. This includes <tag>sect2</tag>
11310 elements and <tag>section</tag> elements at level 2.
11313 <para>For example, you could start each level-2 section on
11314 a new page by using:</para>
11315 <programlisting><xsl:attribute-set name="section.level2.properties">
11316 <xsl:attribute name="break-before">page</xsl:attribute>
11317 </xsl:attribute-set>
11320 <para>This attribute set inherits attributes from the
11321 general <tag>section.properties</tag> attribute set.
11327 <refentry version="5.0" xml:id="section.level3.properties">
11329 <refentrytitle>section.level3.properties</refentrytitle>
11330 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
11333 <refname>section.level3.properties</refname>
11334 <refpurpose>Properties for level-3 sections</refpurpose>
11338 <programlisting xml:id="section.level3.properties.frag">
11339 <xsl:attribute-set name="section.level3.properties" use-attribute-sets="section.properties">
11340 </xsl:attribute-set>
11344 <refsection><info><title>Description</title></info>
11346 <para>The properties that apply to the containing
11347 block of a level-3 section, and therefore apply to
11348 the whole section. This includes <tag>sect3</tag>
11349 elements and <tag>section</tag> elements at level 3.
11352 <para>For example, you could start each level-3 section on
11353 a new page by using:</para>
11354 <programlisting><xsl:attribute-set name="section.level3.properties">
11355 <xsl:attribute name="break-before">page</xsl:attribute>
11356 </xsl:attribute-set>
11359 <para>This attribute set inherits attributes from the
11360 general <tag>section.properties</tag> attribute set.
11366 <refentry version="5.0" xml:id="section.level4.properties">
11368 <refentrytitle>section.level4.properties</refentrytitle>
11369 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
11372 <refname>section.level4.properties</refname>
11373 <refpurpose>Properties for level-4 sections</refpurpose>
11377 <programlisting xml:id="section.level4.properties.frag">
11378 <xsl:attribute-set name="section.level4.properties" use-attribute-sets="section.properties">
11379 </xsl:attribute-set>
11383 <refsection><info><title>Description</title></info>
11385 <para>The properties that apply to the containing
11386 block of a level-4 section, and therefore apply to
11387 the whole section. This includes <tag>sect4</tag>
11388 elements and <tag>section</tag> elements at level 4.
11391 <para>For example, you could start each level-4 section on
11392 a new page by using:</para>
11393 <programlisting><xsl:attribute-set name="section.level4.properties">
11394 <xsl:attribute name="break-before">page</xsl:attribute>
11395 </xsl:attribute-set>
11398 <para>This attribute set inherits attributes from the
11399 general <tag>section.properties</tag> attribute set.
11405 <refentry version="5.0" xml:id="section.level5.properties">
11407 <refentrytitle>section.level5.properties</refentrytitle>
11408 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
11411 <refname>section.level5.properties</refname>
11412 <refpurpose>Properties for level-5 sections</refpurpose>
11416 <programlisting xml:id="section.level5.properties.frag">
11417 <xsl:attribute-set name="section.level5.properties" use-attribute-sets="section.properties">
11418 </xsl:attribute-set>
11422 <refsection><info><title>Description</title></info>
11424 <para>The properties that apply to the containing
11425 block of a level-5 section, and therefore apply to
11426 the whole section. This includes <tag>sect5</tag>
11427 elements and <tag>section</tag> elements at level 5.
11430 <para>For example, you could start each level-5 section on
11431 a new page by using:</para>
11432 <programlisting><xsl:attribute-set name="section.level5.properties">
11433 <xsl:attribute name="break-before">page</xsl:attribute>
11434 </xsl:attribute-set>
11437 <para>This attribute set inherits attributes from the
11438 general <tag>section.properties</tag> attribute set.
11444 <refentry version="5.0" xml:id="section.level6.properties">
11446 <refentrytitle>section.level6.properties</refentrytitle>
11447 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
11450 <refname>section.level6.properties</refname>
11451 <refpurpose>Properties for level-6 sections</refpurpose>
11455 <programlisting xml:id="section.level6.properties.frag">
11456 <xsl:attribute-set name="section.level6.properties" use-attribute-sets="section.properties">
11457 </xsl:attribute-set>
11461 <refsection><info><title>Description</title></info>
11463 <para>The properties that apply to the containing
11464 block of a level 6 or lower section, and therefore apply to
11465 the whole section. This includes
11466 <tag>section</tag> elements at level 6 and lower.
11469 <para>For example, you could start each level-6 section on
11470 a new page by using:</para>
11471 <programlisting><xsl:attribute-set name="section.level6.properties">
11472 <xsl:attribute name="break-before">page</xsl:attribute>
11473 </xsl:attribute-set>
11476 <para>This attribute set inherits attributes from the
11477 general <tag>section.properties</tag> attribute set.
11483 <refentry version="5.0" xml:id="figure.properties">
11485 <refentrytitle>figure.properties</refentrytitle>
11486 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
11489 <refname>figure.properties</refname>
11490 <refpurpose>Properties associated with a figure</refpurpose>
11494 <programlisting xml:id="figure.properties.frag">
11495 <xsl:attribute-set name="figure.properties" use-attribute-sets="formal.object.properties"></xsl:attribute-set>
11499 <refsection><info><title>Description</title></info>
11501 <para>The styling for figures.</para>
11506 <refentry version="5.0" xml:id="example.properties">
11508 <refentrytitle>example.properties</refentrytitle>
11509 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
11512 <refname>example.properties</refname>
11513 <refpurpose>Properties associated with a example</refpurpose>
11517 <programlisting xml:id="example.properties.frag">
11518 <xsl:attribute-set name="example.properties" use-attribute-sets="formal.object.properties">
11519 <xsl:attribute name="keep-together.within-column">auto</xsl:attribute>
11520 </xsl:attribute-set>
11524 <refsection><info><title>Description</title></info>
11526 <para>The styling for examples.</para>
11531 <refentry version="5.0" xml:id="equation.properties">
11533 <refentrytitle>equation.properties</refentrytitle>
11534 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
11537 <refname>equation.properties</refname>
11538 <refpurpose>Properties associated with a equation</refpurpose>
11542 <programlisting xml:id="equation.properties.frag">
11543 <xsl:attribute-set name="equation.properties" use-attribute-sets="formal.object.properties"></xsl:attribute-set>
11547 <refsection><info><title>Description</title></info>
11549 <para>The styling for equations.</para>
11554 <refentry version="5.0" xml:id="equation.number.properties">
11556 <refentrytitle>equation.number.properties</refentrytitle>
11557 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
11560 <refname>equation.number.properties</refname>
11561 <refpurpose>Properties that apply to the <tag>fo:table-cell</tag> containing the number
11562 of an <tag>equation</tag> that does not have a title.</refpurpose>
11566 <programlisting xml:id="equation.number.properties.frag"><xsl:attribute-set name="equation.number.properties">
11567 <xsl:attribute name="text-align">end</xsl:attribute>
11568 <xsl:attribute name="display-align">center</xsl:attribute>
11569 </xsl:attribute-set></programlisting>
11571 <refsection><info><title>Description</title></info>
11572 <para>Properties that apply to the fo:table-cell containing the number
11573 of an equation when it has no title. The number in an equation with a
11574 title is formatted along with the title, and this attribute-set does not apply.</para>
11578 <refentry version="5.0" xml:id="table.properties">
11580 <refentrytitle>table.properties</refentrytitle>
11581 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
11584 <refname>table.properties</refname>
11585 <refpurpose>Properties associated with the block surrounding a table</refpurpose>
11589 <programlisting xml:id="table.properties.frag">
11590 <xsl:attribute-set name="table.properties" use-attribute-sets="formal.object.properties">
11591 <xsl:attribute name="keep-together.within-column">auto</xsl:attribute>
11592 </xsl:attribute-set>
11596 <refsection><info><title>Description</title></info>
11598 <para>Block styling properties for tables. This parameter should really
11599 have been called <literal>table.block.properties</literal> or something
11600 like that, but we’re leaving it to avoid backwards-compatibility
11603 <para>See also <parameter>table.table.properties</parameter>.</para>
11608 <refentry version="5.0" xml:id="task.properties">
11610 <refentrytitle>task.properties</refentrytitle>
11611 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
11614 <refname>task.properties</refname>
11615 <refpurpose>Properties associated with a task</refpurpose>
11619 <programlisting xml:id="task.properties.frag">
11620 <xsl:attribute-set name="task.properties" use-attribute-sets="formal.object.properties">
11621 <xsl:attribute name="keep-together.within-column">auto</xsl:attribute>
11622 </xsl:attribute-set>
11626 <refsection><info><title>Description</title></info>
11628 <para>Properties to style the entire block containing a task element.</para>
11633 <refentry version="5.0" xml:id="informalfigure.properties">
11635 <refentrytitle>informalfigure.properties</refentrytitle>
11636 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
11639 <refname>informalfigure.properties</refname>
11640 <refpurpose>Properties associated with an informalfigure</refpurpose>
11644 <programlisting xml:id="informalfigure.properties.frag">
11645 <xsl:attribute-set name="informalfigure.properties" use-attribute-sets="informal.object.properties"></xsl:attribute-set>
11649 <refsection><info><title>Description</title></info>
11651 <para>The styling for informalfigures.</para>
11656 <refentry version="5.0" xml:id="informalexample.properties">
11658 <refentrytitle>informalexample.properties</refentrytitle>
11659 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
11662 <refname>informalexample.properties</refname>
11663 <refpurpose>Properties associated with an informalexample</refpurpose>
11667 <programlisting xml:id="informalexample.properties.frag">
11668 <xsl:attribute-set name="informalexample.properties" use-attribute-sets="informal.object.properties"></xsl:attribute-set>
11672 <refsection><info><title>Description</title></info>
11674 <para>The styling for informalexamples.</para>
11679 <refentry version="5.0" xml:id="informalequation.properties">
11681 <refentrytitle>informalequation.properties</refentrytitle>
11682 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
11685 <refname>informalequation.properties</refname>
11686 <refpurpose>Properties associated with an informalequation</refpurpose>
11690 <programlisting xml:id="informalequation.properties.frag">
11691 <xsl:attribute-set name="informalequation.properties" use-attribute-sets="informal.object.properties"></xsl:attribute-set>
11695 <refsection><info><title>Description</title></info>
11697 <para>The styling for informalequations.</para>
11702 <refentry version="5.0" xml:id="informaltable.properties">
11704 <refentrytitle>informaltable.properties</refentrytitle>
11705 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
11708 <refname>informaltable.properties</refname>
11709 <refpurpose>Properties associated with the block surrounding an informaltable</refpurpose>
11713 <programlisting xml:id="informaltable.properties.frag">
11714 <xsl:attribute-set name="informaltable.properties" use-attribute-sets="informal.object.properties"></xsl:attribute-set>
11718 <refsection><info><title>Description</title></info>
11720 <para>Block styling properties for informaltables. This parameter should really
11721 have been called <literal>informaltable.block.properties</literal> or something
11722 like that, but we’re leaving it to avoid backwards-compatibility
11725 <para>See also <parameter>table.table.properties</parameter>.</para>
11730 <refentry version="5.0" xml:id="procedure.properties">
11732 <refentrytitle>procedure.properties</refentrytitle>
11733 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
11736 <refname>procedure.properties</refname>
11737 <refpurpose>Properties associated with a procedure</refpurpose>
11741 <programlisting xml:id="procedure.properties.frag">
11742 <xsl:attribute-set name="procedure.properties" use-attribute-sets="formal.object.properties">
11743 <xsl:attribute name="keep-together.within-column">auto</xsl:attribute>
11744 </xsl:attribute-set>
11748 <refsection><info><title>Description</title></info>
11750 <para>The styling for procedures.</para>
11755 <refentry version="5.0" xml:id="root.properties">
11757 <refentrytitle>root.properties</refentrytitle>
11758 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
11761 <refname>root.properties</refname>
11762 <refpurpose>The properties of the fo:root element</refpurpose>
11766 <programlisting xml:id="root.properties.frag">
11767 <xsl:attribute-set name="root.properties">
11768 <xsl:attribute name="font-family">
11769 <xsl:value-of select="$body.fontset"></xsl:value-of>
11770 </xsl:attribute>
11771 <xsl:attribute name="font-size">
11772 <xsl:value-of select="$body.font.size"></xsl:value-of>
11773 </xsl:attribute>
11774 <xsl:attribute name="text-align">
11775 <xsl:value-of select="$alignment"></xsl:value-of>
11776 </xsl:attribute>
11777 <xsl:attribute name="line-height">
11778 <xsl:value-of select="$line-height"></xsl:value-of>
11779 </xsl:attribute>
11780 <xsl:attribute name="font-selection-strategy">character-by-character</xsl:attribute>
11781 <xsl:attribute name="line-height-shift-adjustment">disregard-shifts</xsl:attribute>
11782 <xsl:attribute name="writing-mode">
11783 <xsl:value-of select="$direction.mode"></xsl:value-of>
11784 </xsl:attribute>
11785 </xsl:attribute-set>
11789 <refsection><info><title>Description</title></info>
11791 <para>This property set is used on the <tag>fo:root</tag> element of
11792 an FO file. It defines a set of default, global parameters.</para>
11797 <refentry version="5.0" xml:id="qanda.title.properties">
11799 <refentrytitle>qanda.title.properties</refentrytitle>
11800 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
11803 <refname>qanda.title.properties</refname>
11804 <refpurpose>Properties for qanda set titles</refpurpose>
11808 <programlisting xml:id="qanda.title.properties.frag">
11809 <xsl:attribute-set name="qanda.title.properties">
11810 <xsl:attribute name="font-family">
11811 <xsl:value-of select="$title.fontset"></xsl:value-of>
11812 </xsl:attribute>
11813 <xsl:attribute name="font-weight">bold</xsl:attribute>
11814 <!-- font size is calculated dynamically by qanda.heading template -->
11815 <xsl:attribute name="keep-with-next.within-column">always</xsl:attribute>
11816 <xsl:attribute name="space-before.minimum">0.8em</xsl:attribute>
11817 <xsl:attribute name="space-before.optimum">1.0em</xsl:attribute>
11818 <xsl:attribute name="space-before.maximum">1.2em</xsl:attribute>
11819 </xsl:attribute-set>
11823 <refsection><info><title>Description</title></info>
11825 <para>The properties common to all qanda set titles.</para>
11830 <refentry version="5.0" xml:id="qanda.title.level1.properties">
11832 <refentrytitle>qanda.title.level1.properties</refentrytitle>
11833 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
11836 <refname>qanda.title.level1.properties</refname>
11837 <refpurpose>Properties for level-1 qanda set titles</refpurpose>
11841 <programlisting xml:id="qanda.title.level1.properties.frag">
11842 <xsl:attribute-set name="qanda.title.level1.properties">
11843 <xsl:attribute name="font-size">
11844 <xsl:value-of select="$body.font.master * 2.0736"></xsl:value-of>
11845 <xsl:text>pt</xsl:text>
11846 </xsl:attribute>
11847 </xsl:attribute-set>
11851 <refsection><info><title>Description</title></info>
11853 <para>The properties of level-1 qanda set titles.</para>
11858 <refentry version="5.0" xml:id="qanda.title.level2.properties">
11860 <refentrytitle>qanda.title.level2.properties</refentrytitle>
11861 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
11864 <refname>qanda.title.level2.properties</refname>
11865 <refpurpose>Properties for level-2 qanda set titles</refpurpose>
11869 <programlisting xml:id="qanda.title.level2.properties.frag">
11870 <xsl:attribute-set name="qanda.title.level2.properties">
11871 <xsl:attribute name="font-size">
11872 <xsl:value-of select="$body.font.master * 1.728"></xsl:value-of>
11873 <xsl:text>pt</xsl:text>
11874 </xsl:attribute>
11875 </xsl:attribute-set>
11879 <refsection><info><title>Description</title></info>
11881 <para>The properties of level-2 qanda set titles.</para>
11886 <refentry version="5.0" xml:id="qanda.title.level3.properties">
11888 <refentrytitle>qanda.title.level3.properties</refentrytitle>
11889 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
11892 <refname>qanda.title.level3.properties</refname>
11893 <refpurpose>Properties for level-3 qanda set titles</refpurpose>
11897 <programlisting xml:id="qanda.title.level3.properties.frag">
11898 <xsl:attribute-set name="qanda.title.level3.properties">
11899 <xsl:attribute name="font-size">
11900 <xsl:value-of select="$body.font.master * 1.44"></xsl:value-of>
11901 <xsl:text>pt</xsl:text>
11902 </xsl:attribute>
11903 </xsl:attribute-set>
11907 <refsection><info><title>Description</title></info>
11909 <para>The properties of level-3 qanda set titles.</para>
11914 <refentry version="5.0" xml:id="qanda.title.level4.properties">
11916 <refentrytitle>qanda.title.level4.properties</refentrytitle>
11917 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
11920 <refname>qanda.title.level4.properties</refname>
11921 <refpurpose>Properties for level-4 qanda set titles</refpurpose>
11925 <programlisting xml:id="qanda.title.level4.properties.frag">
11926 <xsl:attribute-set name="qanda.title.level4.properties">
11927 <xsl:attribute name="font-size">
11928 <xsl:value-of select="$body.font.master * 1.2"></xsl:value-of>
11929 <xsl:text>pt</xsl:text>
11930 </xsl:attribute>
11931 </xsl:attribute-set>
11935 <refsection><info><title>Description</title></info>
11937 <para>The properties of level-4 qanda set titles.</para>
11942 <refentry version="5.0" xml:id="qanda.title.level5.properties">
11944 <refentrytitle>qanda.title.level5.properties</refentrytitle>
11945 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
11948 <refname>qanda.title.level5.properties</refname>
11949 <refpurpose>Properties for level-5 qanda set titles</refpurpose>
11953 <programlisting xml:id="qanda.title.level5.properties.frag">
11954 <xsl:attribute-set name="qanda.title.level5.properties">
11955 <xsl:attribute name="font-size">
11956 <xsl:value-of select="$body.font.master"></xsl:value-of>
11957 <xsl:text>pt</xsl:text>
11958 </xsl:attribute>
11959 </xsl:attribute-set>
11963 <refsection><info><title>Description</title></info>
11965 <para>The properties of level-5 qanda set titles.</para>
11970 <refentry version="5.0" xml:id="qanda.title.level6.properties">
11972 <refentrytitle>qanda.title.level6.properties</refentrytitle>
11973 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
11976 <refname>qanda.title.level6.properties</refname>
11977 <refpurpose>Properties for level-6 qanda set titles</refpurpose>
11981 <programlisting xml:id="qanda.title.level6.properties.frag">
11982 <xsl:attribute-set name="qanda.title.level6.properties">
11983 <xsl:attribute name="font-size">
11984 <xsl:value-of select="$body.font.master"></xsl:value-of>
11985 <xsl:text>pt</xsl:text>
11986 </xsl:attribute>
11987 </xsl:attribute-set>
11991 <refsection><info><title>Description</title></info>
11993 <para>The properties of level-6 qanda set titles.
11994 This property set is actually
11995 used for all titles below level 5.</para>
12000 <refentry version="5.0" xml:id="article.appendix.title.properties">
12002 <refentrytitle>article.appendix.title.properties</refentrytitle>
12003 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
12006 <refname>article.appendix.title.properties</refname>
12007 <refpurpose>Properties for appendix titles that appear in an article</refpurpose>
12011 <programlisting xml:id="article.appendix.title.properties.frag">
12012 <xsl:attribute-set name="article.appendix.title.properties" use-attribute-sets="section.title.properties section.title.level1.properties">
12013 </xsl:attribute-set>
12017 <refsection><info><title>Description</title></info>
12019 <para>The properties for the title of an appendix that
12020 appears inside an article. The default is to use
12021 the properties of sect1 titles.</para>
12026 <refentry version="5.0" xml:id="abstract.properties">
12028 <refentrytitle>abstract.properties</refentrytitle>
12029 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
12032 <refname>abstract.properties</refname>
12033 <refpurpose>Properties associated with the block surrounding an abstract</refpurpose>
12037 <programlisting xml:id="abstract.properties.frag">
12038 <xsl:attribute-set name="abstract.properties">
12039 <xsl:attribute name="start-indent">0.0in</xsl:attribute>
12040 <xsl:attribute name="end-indent">0.0in</xsl:attribute>
12041 </xsl:attribute-set>
12045 <refsection><info><title>Description</title></info>
12047 <para>Block styling properties for abstract.</para>
12049 <para>See also <parameter>abstract.title.properties</parameter>.</para>
12054 <refentry version="5.0" xml:id="abstract.title.properties">
12056 <refentrytitle>abstract.title.properties</refentrytitle>
12057 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
12060 <refname>abstract.title.properties</refname>
12061 <refpurpose>Properties for abstract titles</refpurpose>
12065 <programlisting xml:id="abstract.title.properties.frag">
12066 <xsl:attribute-set name="abstract.title.properties">
12067 <xsl:attribute name="font-family"><xsl:value-of select="$title.fontset"></xsl:value-of></xsl:attribute>
12068 <xsl:attribute name="font-weight">bold</xsl:attribute>
12069 <xsl:attribute name="keep-with-next.within-column">always</xsl:attribute>
12070 <xsl:attribute name="keep-with-next.within-column">always</xsl:attribute>
12071 <xsl:attribute name="space-before.optimum"><xsl:value-of select="concat($body.font.master, 'pt')"></xsl:value-of></xsl:attribute>
12072 <xsl:attribute name="space-before.minimum"><xsl:value-of select="concat($body.font.master, 'pt * 0.8')"></xsl:value-of></xsl:attribute>
12073 <xsl:attribute name="space-before.maximum"><xsl:value-of select="concat($body.font.master, 'pt * 1.2')"></xsl:value-of></xsl:attribute>
12074 <xsl:attribute name="hyphenate">false</xsl:attribute>
12075 <xsl:attribute name="text-align">center</xsl:attribute>
12076 </xsl:attribute-set>
12080 <refsection><info><title>Description</title></info>
12082 <para>The properties for abstract titles.</para>
12084 <para>See also <parameter>abstract.properties</parameter>.</para>
12089 <refentry version="5.0" xml:id="index.page.number.properties">
12091 <refentrytitle>index.page.number.properties</refentrytitle>
12092 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
12095 <refname>index.page.number.properties</refname>
12096 <refpurpose>Properties associated with index page numbers</refpurpose>
12100 <programlisting xml:id="index.page.number.properties.frag">
12101 <xsl:attribute-set name="index.page.number.properties">
12102 </xsl:attribute-set>
12106 <refsection><info><title>Description</title></info>
12108 <para>Properties associated with page numbers in indexes.
12109 Changing color to indicate the page number is a link is
12116 <refentry version="5.0" xml:id="revhistory.table.properties">
12118 <refentrytitle>revhistory.table.properties</refentrytitle>
12119 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
12122 <refname>revhistory.table.properties</refname>
12123 <refpurpose>The properties of table used for formatting revhistory</refpurpose>
12127 <programlisting xml:id="revhistory.table.properties.frag">
12128 <xsl:attribute-set name="revhistory.table.properties">
12129 </xsl:attribute-set>
12133 <refsection><info><title>Description</title></info>
12135 <para>This property set defines appearance of revhistory table.</para>
12140 <refentry version="5.0" xml:id="revhistory.table.cell.properties">
12142 <refentrytitle>revhistory.table.cell.properties</refentrytitle>
12143 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
12146 <refname>revhistory.table.cell.properties</refname>
12147 <refpurpose>The properties of table cells used for formatting revhistory</refpurpose>
12151 <programlisting xml:id="revhistory.table.cell.properties.frag">
12152 <xsl:attribute-set name="revhistory.table.cell.properties">
12153 </xsl:attribute-set>
12157 <refsection><info><title>Description</title></info>
12159 <para>This property set defines appearance of individual cells in revhistory table.</para>
12164 <refentry version="5.0" xml:id="revhistory.title.properties">
12166 <refentrytitle>revhistory.title.properties</refentrytitle>
12167 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
12170 <refname>revhistory.title.properties</refname>
12171 <refpurpose>The properties of revhistory title</refpurpose>
12175 <programlisting xml:id="revhistory.title.properties.frag">
12176 <xsl:attribute-set name="revhistory.title.properties">
12177 </xsl:attribute-set>
12181 <refsection><info><title>Description</title></info>
12183 <para>This property set defines appearance of revhistory title.</para>
12189 <reference xml:id="profiling"><title>Profiling</title>
12190 <partintro xml:id="profiling_partintro">
12191 <para>The following parameters can be used for attribute-based
12192 profiling of your document. For more information about profiling, see
12193 <link xmlns:xlink="http://www.w3.org/1999/xlink" role="tcg" xlink:href="Profiling.html">Profiling (conditional text)</link>.</para>
12195 <refentry version="5.0" xml:id="profile.arch">
12197 <refentrytitle>profile.arch</refentrytitle>
12198 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
12201 <refname>profile.arch</refname>
12202 <refpurpose>Target profile for <tag class="attribute">arch</tag>
12203 attribute</refpurpose>
12207 <programlisting xml:id="profile.arch.frag">
12208 <xsl:param name="profile.arch"></xsl:param>
12213 <refsection><info><title>Description</title></info>
12215 <para>The value of this parameter specifies profiles which should be
12216 included in the output. You can specify multiple profiles by
12217 separating them by semicolon. You can change separator character by
12218 <parameter>profile.separator</parameter>
12221 <para>This parameter has effect only when you are using profiling
12222 stylesheets (<filename>profile-docbook.xsl</filename>,
12223 <filename>profile-chunk.xsl</filename>, …) instead of normal
12224 ones (<filename>docbook.xsl</filename>,
12225 <filename>chunk.xsl</filename>, …).</para>
12230 <refentry version="5.0" xml:id="profile.audience">
12232 <refentrytitle>profile.audience</refentrytitle>
12233 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
12236 <refname>profile.audience</refname>
12237 <refpurpose>Target profile for <tag class="attribute">audience</tag>
12238 attribute</refpurpose>
12242 <programlisting xml:id="profile.audience.frag">
12243 <xsl:param name="profile.audience"></xsl:param>
12247 <refsection><info><title>Description</title></info>
12249 <para>Value of this parameter specifies profiles which should be
12250 included in the output. You can specify multiple profiles by
12251 separating them by semicolon. You can change separator character by
12252 <parameter>profile.separator</parameter>
12255 <para>This parameter has effect only when you are using profiling
12256 stylesheets (<filename>profile-docbook.xsl</filename>,
12257 <filename>profile-chunk.xsl</filename>, …) instead of normal
12258 ones (<filename>docbook.xsl</filename>,
12259 <filename>chunk.xsl</filename>, …).</para>
12264 <refentry version="5.0" xml:id="profile.condition">
12266 <refentrytitle>profile.condition</refentrytitle>
12267 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
12270 <refname>profile.condition</refname>
12271 <refpurpose>Target profile for <tag class="attribute">condition</tag>
12272 attribute</refpurpose>
12276 <programlisting xml:id="profile.condition.frag">
12277 <xsl:param name="profile.condition"></xsl:param>
12281 <refsection><info><title>Description</title></info>
12283 <para>The value of this parameter specifies profiles which should be
12284 included in the output. You can specify multiple profiles by
12285 separating them by semicolon. You can change separator character by
12286 <parameter>profile.separator</parameter>
12289 <para>This parameter has effect only when you are using profiling
12290 stylesheets (<filename>profile-docbook.xsl</filename>,
12291 <filename>profile-chunk.xsl</filename>, …) instead of normal
12292 ones (<filename>docbook.xsl</filename>,
12293 <filename>chunk.xsl</filename>, …).</para>
12298 <refentry version="5.0" xml:id="profile.conformance">
12300 <refentrytitle>profile.conformance</refentrytitle>
12301 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
12304 <refname>profile.conformance</refname>
12305 <refpurpose>Target profile for <tag class="attribute">conformance</tag>
12306 attribute</refpurpose>
12310 <programlisting xml:id="profile.conformance.frag">
12311 <xsl:param name="profile.conformance"></xsl:param>
12315 <refsection><info><title>Description</title></info>
12317 <para>The value of this parameter specifies profiles which should be
12318 included in the output. You can specify multiple profiles by
12319 separating them by semicolon. You can change separator character by
12320 <parameter>profile.separator</parameter>
12323 <para>This parameter has effect only when you are using profiling
12324 stylesheets (<filename>profile-docbook.xsl</filename>,
12325 <filename>profile-chunk.xsl</filename>, …) instead of normal
12326 ones (<filename>docbook.xsl</filename>,
12327 <filename>chunk.xsl</filename>, …).</para>
12332 <refentry version="5.0" xml:id="profile.lang">
12334 <refentrytitle>profile.lang</refentrytitle>
12335 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
12338 <refname>profile.lang</refname>
12339 <refpurpose>Target profile for <tag class="attribute">lang</tag>
12340 attribute</refpurpose>
12344 <programlisting xml:id="profile.lang.frag">
12345 <xsl:param name="profile.lang"></xsl:param>
12349 <refsection><info><title>Description</title></info>
12351 <para>The value of this parameter specifies profiles which should be
12352 included in the output. You can specify multiple profiles by
12353 separating them by semicolon. You can change separator character by
12354 <parameter>profile.separator</parameter>
12357 <para>This parameter has effect only when you are using profiling
12358 stylesheets (<filename>profile-docbook.xsl</filename>,
12359 <filename>profile-chunk.xsl</filename>, …) instead of normal
12360 ones (<filename>docbook.xsl</filename>,
12361 <filename>chunk.xsl</filename>, …).</para>
12366 <refentry version="5.0" xml:id="profile.os">
12368 <refentrytitle>profile.os</refentrytitle>
12369 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
12372 <refname>profile.os</refname>
12373 <refpurpose>Target profile for <tag class="attribute">os</tag>
12374 attribute</refpurpose>
12378 <programlisting xml:id="profile.os.frag">
12379 <xsl:param name="profile.os"></xsl:param>
12383 <refsection><info><title>Description</title></info>
12385 <para>The value of this parameter specifies profiles which should be
12386 included in the output. You can specify multiple profiles by
12387 separating them by semicolon. You can change separator character by
12388 <parameter>profile.separator</parameter>
12391 <para>This parameter has effect only when you are using profiling
12392 stylesheets (<filename>profile-docbook.xsl</filename>,
12393 <filename>profile-chunk.xsl</filename>, …) instead of normal
12394 ones (<filename>docbook.xsl</filename>,
12395 <filename>chunk.xsl</filename>, …).</para>
12400 <refentry version="5.0" xml:id="profile.outputformat">
12402 <refentrytitle>profile.outputformat</refentrytitle>
12403 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
12406 <refname>profile.outputformat</refname>
12407 <refpurpose>Target profile for <tag class="attribute">outputformat</tag> attribute</refpurpose>
12411 <programlisting xml:id="profile.outputformat.frag">
12412 <xsl:param name="profile.outputformat"></xsl:param>
12416 <refsection><info><title>Description</title></info>
12418 <para>The value of this parameter specifies profiles which should be
12419 included in the output. You can specify multiple profiles by
12420 separating them by semicolon. You can change separator character by
12421 <parameter>profile.separator</parameter>
12424 <para>This parameter has effect only when you are using profiling
12425 stylesheets (<filename>profile-docbook.xsl</filename>,
12426 <filename>profile-chunk.xsl</filename>, …) instead of normal
12427 ones (<filename>docbook.xsl</filename>,
12428 <filename>chunk.xsl</filename>, …).</para>
12433 <refentry version="5.0" xml:id="profile.revision">
12435 <refentrytitle>profile.revision</refentrytitle>
12436 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
12439 <refname>profile.revision</refname>
12440 <refpurpose>Target profile for <tag class="attribute">revision</tag>
12441 attribute</refpurpose>
12445 <programlisting xml:id="profile.revision.frag">
12446 <xsl:param name="profile.revision"></xsl:param>
12450 <refsection><info><title>Description</title></info>
12452 <para>The value of this parameter specifies profiles which should be
12453 included in the output. You can specify multiple profiles by
12454 separating them by semicolon. You can change separator character by
12455 <parameter>profile.separator</parameter>
12458 <para>This parameter has effect only when you are using profiling
12459 stylesheets (<filename>profile-docbook.xsl</filename>,
12460 <filename>profile-chunk.xsl</filename>, …) instead of normal
12461 ones (<filename>docbook.xsl</filename>,
12462 <filename>chunk.xsl</filename>, …).</para>
12467 <refentry version="5.0" xml:id="profile.revisionflag">
12469 <refentrytitle>profile.revisionflag</refentrytitle>
12470 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
12473 <refname>profile.revisionflag</refname>
12474 <refpurpose>Target profile for <tag class="attribute">revisionflag</tag>
12475 attribute</refpurpose>
12479 <programlisting xml:id="profile.revisionflag.frag">
12480 <xsl:param name="profile.revisionflag"></xsl:param>
12484 <refsection><info><title>Description</title></info>
12486 <para>The value of this parameter specifies profiles which should be
12487 included in the output. You can specify multiple profiles by
12488 separating them by semicolon. You can change separator character by
12489 <parameter>profile.separator</parameter>
12492 <para>This parameter has effect only when you are using profiling
12493 stylesheets (<filename>profile-docbook.xsl</filename>,
12494 <filename>profile-chunk.xsl</filename>, …) instead of normal
12495 ones (<filename>docbook.xsl</filename>,
12496 <filename>chunk.xsl</filename>, …).</para>
12501 <refentry version="5.0" xml:id="profile.role">
12503 <refentrytitle>profile.role</refentrytitle>
12504 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
12507 <refname>profile.role</refname>
12508 <refpurpose>Target profile for <tag class="attribute">role</tag>
12509 attribute</refpurpose>
12513 <programlisting xml:id="profile.role.frag">
12514 <xsl:param name="profile.role"></xsl:param>
12518 <refsection><info><title>Description</title></info>
12520 <para>The value of this parameter specifies profiles which should be
12521 included in the output. You can specify multiple profiles by
12522 separating them by semicolon. You can change separator character by
12523 <parameter>profile.separator</parameter>
12526 <para>This parameter has effect only when you are using profiling
12527 stylesheets (<filename>profile-docbook.xsl</filename>,
12528 <filename>profile-chunk.xsl</filename>, …) instead of normal
12529 ones (<filename>docbook.xsl</filename>,
12530 <filename>chunk.xsl</filename>, …).</para>
12533 <para>Note that <tag class="attribute">role</tag> is often
12534 used for other purposes than profiling. For example it is commonly
12535 used to get emphasize in bold font:</para>
12537 <programlisting><emphasis role="bold">very important</emphasis></programlisting>
12539 <para>If you are using <tag class="attribute">role</tag> for
12540 these purposes do not forget to add values like <literal>bold</literal> to
12541 value of this parameter. If you forgot you will get document with
12542 small pieces missing which are very hard to track.</para>
12544 <para>For this reason it is not recommended to use <tag class="attribute">role</tag> attribute for profiling. You should
12545 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>
12551 <refentry version="5.0" xml:id="profile.security">
12553 <refentrytitle>profile.security</refentrytitle>
12554 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
12557 <refname>profile.security</refname>
12558 <refpurpose>Target profile for <tag class="attribute">security</tag>
12559 attribute</refpurpose>
12563 <programlisting xml:id="profile.security.frag">
12564 <xsl:param name="profile.security"></xsl:param>
12568 <refsection><info><title>Description</title></info>
12570 <para>The value of this parameter specifies profiles which should be
12571 included in the output. You can specify multiple profiles by
12572 separating them by semicolon. You can change separator character by
12573 <parameter>profile.separator</parameter>
12576 <para>This parameter has effect only when you are using profiling
12577 stylesheets (<filename>profile-docbook.xsl</filename>,
12578 <filename>profile-chunk.xsl</filename>, …) instead of normal
12579 ones (<filename>docbook.xsl</filename>,
12580 <filename>chunk.xsl</filename>, …).</para>
12585 <refentry version="5.0" xml:id="profile.status">
12587 <refentrytitle>profile.status</refentrytitle>
12588 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
12591 <refname>profile.status</refname>
12592 <refpurpose>Target profile for <tag class="attribute">status</tag>
12593 attribute</refpurpose>
12597 <programlisting xml:id="profile.status.frag">
12598 <xsl:param name="profile.status"></xsl:param>
12602 <refsection><info><title>Description</title></info>
12604 <para>The value of this parameter specifies profiles which should be
12605 included in the output. You can specify multiple profiles by
12606 separating them by semicolon. You can change separator character by
12607 <parameter>profile.separator</parameter>
12610 <para>This parameter has effect only when you are using profiling
12611 stylesheets (<filename>profile-docbook.xsl</filename>,
12612 <filename>profile-chunk.xsl</filename>, …) instead of normal
12613 ones (<filename>docbook.xsl</filename>,
12614 <filename>chunk.xsl</filename>, …).</para>
12619 <refentry version="5.0" xml:id="profile.userlevel">
12621 <refentrytitle>profile.userlevel</refentrytitle>
12622 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
12625 <refname>profile.userlevel</refname>
12626 <refpurpose>Target profile for <tag class="attribute">userlevel</tag>
12627 attribute</refpurpose>
12631 <programlisting xml:id="profile.userlevel.frag">
12632 <xsl:param name="profile.userlevel"></xsl:param>
12636 <refsection><info><title>Description</title></info>
12638 <para>The value of this parameter specifies profiles which should be
12639 included in the output. You can specify multiple profiles by
12640 separating them by semicolon. You can change separator character by
12641 <parameter>profile.separator</parameter>
12644 <para>This parameter has effect only when you are using profiling
12645 stylesheets (<filename>profile-docbook.xsl</filename>,
12646 <filename>profile-chunk.xsl</filename>, …) instead of normal
12647 ones (<filename>docbook.xsl</filename>,
12648 <filename>chunk.xsl</filename>, …).</para>
12653 <refentry version="5.0" xml:id="profile.vendor">
12655 <refentrytitle>profile.vendor</refentrytitle>
12656 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
12659 <refname>profile.vendor</refname>
12660 <refpurpose>Target profile for <tag class="attribute">vendor</tag>
12661 attribute</refpurpose>
12665 <programlisting xml:id="profile.vendor.frag">
12666 <xsl:param name="profile.vendor"></xsl:param>
12670 <refsection><info><title>Description</title></info>
12672 <para>The value of this parameter specifies profiles which should be
12673 included in the output. You can specify multiple profiles by
12674 separating them by semicolon. You can change separator character by
12675 <parameter>profile.separator</parameter>
12678 <para>This parameter has effect only when you are using profiling
12679 stylesheets (<filename>profile-docbook.xsl</filename>,
12680 <filename>profile-chunk.xsl</filename>, …) instead of normal
12681 ones (<filename>docbook.xsl</filename>,
12682 <filename>chunk.xsl</filename>, …).</para>
12687 <refentry version="5.0" xml:id="profile.wordsize">
12689 <refentrytitle>profile.wordsize</refentrytitle>
12690 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
12693 <refname>profile.wordsize</refname>
12694 <refpurpose>Target profile for <tag class="attribute">wordsize</tag>
12695 attribute</refpurpose>
12699 <programlisting xml:id="profile.wordsize.frag">
12700 <xsl:param name="profile.wordsize"></xsl:param>
12704 <refsection><info><title>Description</title></info>
12706 <para>The value of this parameter specifies profiles which should be
12707 included in the output. You can specify multiple profiles by
12708 separating them by semicolon. You can change separator character by
12709 <parameter>profile.separator</parameter>
12712 <para>This parameter has effect only when you are using profiling
12713 stylesheets (<filename>profile-docbook.xsl</filename>,
12714 <filename>profile-chunk.xsl</filename>, …) instead of normal
12715 ones (<filename>docbook.xsl</filename>,
12716 <filename>chunk.xsl</filename>, …).</para>
12721 <refentry version="5.0" xml:id="profile.attribute">
12723 <refentrytitle>profile.attribute</refentrytitle>
12724 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
12727 <refname>profile.attribute</refname>
12728 <refpurpose>Name of user-specified profiling attribute</refpurpose>
12732 <programlisting xml:id="profile.attribute.frag">
12733 <xsl:param name="profile.attribute"></xsl:param>
12737 <refsection><info><title>Description</title></info>
12739 <para>This parameter is used in conjuction with
12740 <parameter>profile.value</parameter>.</para>
12742 <para>This parameter has effect only when you are using profiling
12743 stylesheets (<filename>profile-docbook.xsl</filename>,
12744 <filename>profile-chunk.xsl</filename>, …) instead of normal
12745 ones (<filename>docbook.xsl</filename>,
12746 <filename>chunk.xsl</filename>, …).</para>
12751 <refentry version="5.0" xml:id="profile.value">
12753 <refentrytitle>profile.value</refentrytitle>
12754 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
12757 <refname>profile.value</refname>
12758 <refpurpose>Target profile for user-specified attribute</refpurpose>
12762 <programlisting xml:id="profile.value.frag">
12763 <xsl:param name="profile.value"></xsl:param>
12767 <refsection><info><title>Description</title></info>
12769 <para>When you are using this parameter you must also specify name of
12770 profiling attribute with parameter
12771 <parameter>profile.attribute</parameter>.</para>
12773 <para>The value of this parameter specifies profiles which should be
12774 included in the output. You can specify multiple profiles by
12775 separating them by semicolon. You can change separator character by
12776 <parameter>profile.separator</parameter>
12779 <para>This parameter has effect only when you are using profiling
12780 stylesheets (<filename>profile-docbook.xsl</filename>,
12781 <filename>profile-chunk.xsl</filename>, …) instead of normal
12782 ones (<filename>docbook.xsl</filename>,
12783 <filename>chunk.xsl</filename>, …).</para>
12788 <refentry version="5.0" xml:id="profile.separator">
12790 <refentrytitle>profile.separator</refentrytitle>
12791 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
12794 <refname>profile.separator</refname>
12795 <refpurpose>Separator character for compound profile values</refpurpose>
12799 <programlisting xml:id="profile.separator.frag">
12800 <xsl:param name="profile.separator">;</xsl:param>
12804 <refsection><info><title>Description</title></info>
12806 <para>Separator character used for compound profile values. See <parameter>profile.arch</parameter></para>
12812 <reference xml:id="l10n"><title>Localization</title>
12813 <refentry version="5.0" xml:id="l10n.gentext.language">
12815 <refentrytitle>l10n.gentext.language</refentrytitle>
12816 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
12819 <refname>l10n.gentext.language</refname>
12820 <refpurpose>Sets the gentext language</refpurpose>
12824 <programlisting xml:id="l10n.gentext.language.frag">
12825 <xsl:param name="l10n.gentext.language"></xsl:param>
12829 <refsection><info><title>Description</title></info>
12831 <para>If this parameter is set to any value other than the empty string, its
12832 value will be used as the value for the language when generating text. Setting
12833 <parameter>l10n.gentext.language</parameter> overrides any settings within the
12834 document being formatted.</para>
12836 <para>It's much more likely that you might want to set the
12837 <parameter>l10n.gentext.default.language</parameter> parameter.</para>
12842 <refentry version="5.0" xml:id="l10n.gentext.default.language">
12844 <refentrytitle>l10n.gentext.default.language</refentrytitle>
12845 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
12848 <refname>l10n.gentext.default.language</refname>
12849 <refpurpose>Sets the default language for generated text</refpurpose>
12853 <programlisting xml:id="l10n.gentext.default.language.frag">
12854 <xsl:param name="l10n.gentext.default.language">en</xsl:param>
12858 <refsection><info><title>Description</title></info>
12860 <para>The value of the <parameter>l10n.gentext.default.language</parameter>
12861 parameter is used as the language for generated text if no setting is provided
12862 in the source document.</para>
12867 <refentry version="5.0" xml:id="l10n.gentext.use.xref.language">
12869 <refentrytitle>l10n.gentext.use.xref.language</refentrytitle>
12870 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
12873 <refname>l10n.gentext.use.xref.language</refname>
12874 <refpurpose>Use the language of target when generating cross-reference text?</refpurpose>
12878 <programlisting xml:id="l10n.gentext.use.xref.language.frag">
12879 <xsl:param name="l10n.gentext.use.xref.language" select="0"></xsl:param>
12883 <refsection><info><title>Description</title></info>
12885 <para>If non-zero, the language of the target will be used when
12886 generating cross reference text. Usually, the <quote>current</quote>
12887 language is used when generating text (that is, the language of the
12888 element that contains the cross-reference element). But setting this parameter
12889 allows the language of the element <emphasis>pointed to</emphasis> to control
12890 the generated text.</para>
12892 <para>Consider the following example:</para>
12895 <programlisting><para lang="en">See also <xref linkend="chap3"/>.</para>
12899 <para>Suppose that Chapter 3 happens to be written in German.
12900 If <parameter>l10n.gentext.use.xref.language</parameter> is non-zero, the
12901 resulting text will be something like this:</para>
12904 <para>See also Kapital 3.</para>
12907 <para>Where the more traditional rendering would be:</para>
12910 <para>See also Chapter 3.</para>
12916 <refentry version="5.0" xml:id="l10n.lang.value.rfc.compliant">
12918 <refentrytitle>l10n.lang.value.rfc.compliant</refentrytitle>
12919 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
12922 <refname>l10n.lang.value.rfc.compliant</refname>
12923 <refpurpose>Make value of lang attribute RFC compliant?</refpurpose>
12927 <programlisting xml:id="l10n.lang.value.rfc.compliant.frag">
12928 <xsl:param name="l10n.lang.value.rfc.compliant" select="1"></xsl:param>
12932 <refsection><info><title>Description</title></info>
12934 <para>If non-zero, ensure that the values for all <tag class="attribute">lang</tag> attributes in HTML output are RFC
12935 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:
12937 <blockquote><para>[RFC1766] defines and explains the language codes
12938 that must be used in HTML documents.</para>
12939 <para>Briefly, language codes consist of a primary code and a possibly
12940 empty series of subcodes:
12942 <literallayout class="monospaced">language-code = primary-code ( "-" subcode )*</literallayout>
12944 <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
12945 of Languages</link>, the EBNF for "language tag" is given as:
12947 <literallayout class="monospaced">Language-Tag = Primary-tag *( "-" Subtag )
12948 Primary-tag = 1*8ALPHA
12949 Subtag = 1*8ALPHA</literallayout>
12952 </para></footnote>.
12954 by taking any underscore characters in any <tag class="attribute">lang</tag> values found in source documents, and
12955 replacing them with hyphen characters in output HTML files. For
12956 example, <literal>zh_CN</literal> in a source document becomes
12957 <literal>zh-CN</literal> in the HTML output form that source.
12960 <para>This parameter does not cause any case change in <tag class="attribute">lang</tag> values, because RFC 1766
12961 explicitly states that all "language tags" (as it calls them) "are
12962 to be treated as case insensitive".</para>
12969 <refentry version="5.0" xml:id="writing.mode">
12971 <refentrytitle>writing.mode</refentrytitle>
12972 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
12975 <refname>writing.mode</refname>
12976 <refpurpose>Direction of text flow based on locale</refpurpose>
12980 <programlisting xml:id="writing.mode.frag">
12981 <xsl:param name="writing.mode">
12982 <xsl:call-template name="gentext">
12983 <xsl:with-param name="key">writing-mode</xsl:with-param>
12984 <xsl:with-param name="lang">
12985 <xsl:call-template name="l10n.language">
12986 <xsl:with-param name="target" select="/*[1]"></xsl:with-param>
12987 </xsl:call-template>
12988 </xsl:with-param>
12989 </xsl:call-template>
12994 <refsection><info><title>Description</title></info>
12996 <para>Sets direction of text flow and text alignment based on locale.
12997 The value is normally taken from the gentext file for the
12998 lang attribute of the document's root element, using the
12999 key name 'writing-mode' to look it up in the gentext file.
13000 But this param can also be
13001 set on the command line to override that gentext value.
13003 <para>Accepted values are:
13008 <para>Left-to-right text flow in each line, lines stack top to bottom.</para>
13014 <para>Right-to-left text flow in each line, lines stack top to bottom.</para>
13020 <para>Top-to-bottom text flow in each vertical line, lines stack right to left.
13021 Supported by only a few XSL-FO processors. Not supported in HTML output.</para>
13027 <para>Shorthand for lr-tb.</para>
13033 <para>Shorthand for rl-tb.</para>
13039 <para>Shorthand for tb-rl.</para>
13049 <reference xml:id="ebnf"><title>EBNF</title>
13050 <refentry version="5.0" xml:id="ebnf.assignment">
13052 <refentrytitle>ebnf.assignment</refentrytitle>
13053 <refmiscinfo class="other" otherclass="datatype">rtf</refmiscinfo>
13056 <refname>ebnf.assignment</refname>
13057 <refpurpose>The EBNF production assignment operator</refpurpose>
13061 <programlisting xml:id="ebnf.assignment.frag">
13063 <xsl:param name="ebnf.assignment">
13064 <fo:inline font-family="{$monospace.font.family}">
13065 <xsl:text>::=</xsl:text>
13071 <refsection><info><title>Description</title></info>
13073 <para>The <parameter>ebnf.assignment</parameter> parameter determines what
13074 text is used to show <quote>assignment</quote> in <tag>production</tag>s
13075 in <tag>productionset</tag>s.</para>
13077 <para>While <quote><literal>::=</literal></quote> is common, so are several
13078 other operators.</para>
13083 <refentry version="5.0" xml:id="ebnf.statement.terminator">
13085 <refentrytitle>ebnf.statement.terminator</refentrytitle>
13086 <refmiscinfo class="other" otherclass="datatype">rtf</refmiscinfo>
13089 <refname>ebnf.statement.terminator</refname>
13090 <refpurpose>Punctuation that ends an EBNF statement.</refpurpose>
13094 <programlisting xml:id="ebnf.statement.terminator.frag">
13096 <xsl:param name="ebnf.statement.terminator"></xsl:param>
13100 <refsection><info><title>Description</title></info>
13102 <para>The <parameter>ebnf.statement.terminator</parameter> parameter determines what
13103 text is used to terminate each <tag>production</tag>
13104 in <tag>productionset</tag>.</para>
13106 <para>Some notations end each statement with a period.</para>
13112 <reference xml:id="prepress"><title>Prepress</title>
13113 <refentry version="5.0" xml:id="crop.marks">
13115 <refentrytitle>crop.marks</refentrytitle>
13116 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
13119 <refname>crop.marks</refname>
13120 <refpurpose>Output crop marks?</refpurpose>
13124 <programlisting xml:id="crop.marks.frag">
13125 <xsl:param name="crop.marks" select="0"></xsl:param>
13129 <refsection><info><title>Description</title></info>
13131 <para>If non-zero, crop marks will be added to each page. Currently this
13132 works only with XEP if you have <parameter>xep.extensions</parameter> set.</para>
13137 <refentry version="5.0" xml:id="crop.mark.width">
13139 <refentrytitle>crop.mark.width</refentrytitle>
13140 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
13143 <refname>crop.mark.width</refname>
13144 <refpurpose>Width of crop marks.</refpurpose>
13148 <programlisting xml:id="crop.mark.width.frag">
13149 <xsl:param name="crop.mark.width">0.5pt</xsl:param>
13153 <refsection><info><title>Description</title></info>
13155 <para>Width of crop marks. Crop marks are controlled by
13156 <parameter>crop.marks</parameter> parameter.</para>
13161 <refentry version="5.0" xml:id="crop.mark.offset">
13163 <refentrytitle>crop.mark.offset</refentrytitle>
13164 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
13167 <refname>crop.mark.offset</refname>
13168 <refpurpose>Length of crop marks.</refpurpose>
13172 <programlisting xml:id="crop.mark.offset.frag">
13173 <xsl:param name="crop.mark.offset">24pt</xsl:param>
13177 <refsection><info><title>Description</title></info>
13179 <para>Length of crop marks. Crop marks are controlled by
13180 <parameter>crop.marks</parameter> parameter.</para>
13185 <refentry version="5.0" xml:id="crop.mark.bleed">
13187 <refentrytitle>crop.mark.bleed</refentrytitle>
13188 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
13191 <refname>crop.mark.bleed</refname>
13192 <refpurpose>Length of invisible part of crop marks.</refpurpose>
13196 <programlisting xml:id="crop.mark.bleed.frag">
13197 <xsl:param name="crop.mark.bleed">6pt</xsl:param>
13201 <refsection><info><title>Description</title></info>
13203 <para>Length of invisible part of crop marks. Crop marks are controlled by
13204 <parameter>crop.marks</parameter> parameter.</para>
13210 <reference xml:id="publishers"><title>DocBook Publishers</title>
13211 <refentry version="5.0" xml:id="publishers.properties">
13213 <refentrytitle>publishers.properties</refentrytitle>
13214 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
13217 <refname>publishers.properties</refname>
13218 <refpurpose>Properties shared with the DocBook Publishers
13219 elements drama, poetry, and dialogue. </refpurpose>
13223 <programlisting xml:id="publishers.properties.frag">
13224 <xsl:attribute-set name="publishers.properties">
13225 <xsl:attribute name="space-before">1em</xsl:attribute>
13226 <xsl:attribute name="space-after">1em</xsl:attribute>
13227 <xsl:attribute name="keep-together.within-column">auto</xsl:attribute>
13228 </xsl:attribute-set>
13232 <refsection><info><title>Description</title></info>
13234 <para>This <literal>attribute set</literal> is used for common
13235 properties shared by the DocBook Publishers elements
13236 <tag>dialogue</tag>,
13237 <tag>drama</tag>, and <tag>poetry</tag>.
13238 It is imported into each of the individual
13239 attribute sets for those elements.
13245 <refentry version="5.0" xml:id="dialogue.properties">
13247 <refentrytitle>dialogue.properties</refentrytitle>
13248 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
13251 <refname>dialogue.properties</refname>
13252 <refpurpose>Properties applied to the DocBook Publishers dialogue element</refpurpose>
13256 <programlisting xml:id="dialogue.properties.frag">
13257 <xsl:attribute-set name="dialogue.properties" use-attribute-sets="publishers.properties"></xsl:attribute-set>
13261 <refsection><info><title>Description</title></info>
13263 <para>This <literal>attribute set</literal> is applied to the output
13264 block for the DocBook Publishers <tag>dialogue</tag> element.
13265 By default, it imports the attributes defined in the
13266 <tag>publishers.properties</tag> attribute-set.
13272 <refentry version="5.0" xml:id="drama.properties">
13274 <refentrytitle>drama.properties</refentrytitle>
13275 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
13278 <refname>drama.properties</refname>
13279 <refpurpose>Properties applied to the DocBook Publishers drama element</refpurpose>
13283 <programlisting xml:id="drama.properties.frag">
13284 <xsl:attribute-set name="drama.properties" use-attribute-sets="publishers.properties"></xsl:attribute-set>
13288 <refsection><info><title>Description</title></info>
13290 <para>This <literal>attribute set</literal> is applied to the output
13291 block for the DocBook Publishers <tag>drama</tag> element.
13292 By default, it imports the attributes defined in the
13293 <tag>publishers.properties</tag> attribute-set.
13299 <refentry version="5.0" xml:id="poetry.properties">
13301 <refentrytitle>poetry.properties</refentrytitle>
13302 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
13305 <refname>poetry.properties</refname>
13306 <refpurpose>Properties applied to the DocBook Publishers drama element</refpurpose>
13310 <programlisting xml:id="poetry.properties.frag">
13311 <xsl:attribute-set name="poetry.properties" use-attribute-sets="publishers.properties"></xsl:attribute-set>
13315 <refsection><info><title>Description</title></info>
13317 <para>This <literal>attribute set</literal> is applied to the output
13318 block for the DocBook Publishers <tag>poetry</tag> element.
13319 By default, it imports the attributes defined in the
13320 <tag>publishers.properties</tag> attribute-set.
13326 <refentry version="5.0" xml:id="line.properties">
13328 <refentrytitle>line.properties</refentrytitle>
13329 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
13332 <refname>line.properties</refname>
13333 <refpurpose>Properties applied to the DocBook Publishers
13334 line element. </refpurpose>
13338 <programlisting xml:id="line.properties.frag">
13339 <xsl:attribute-set name="line.properties"></xsl:attribute-set>
13343 <refsection><info><title>Description</title></info>
13345 <para>This <literal>attribute set</literal> is applied
13346 to the <tag>block</tag> that contains the output of a
13347 <tag>line</tag> element from DocBook Publishers.
13353 <refentry version="5.0" xml:id="linegroup.properties">
13355 <refentrytitle>linegroup.properties</refentrytitle>
13356 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
13359 <refname>linegroup.properties</refname>
13360 <refpurpose>Properties applied to the DocBook Publishers
13361 linegroup element</refpurpose>
13365 <programlisting xml:id="linegroup.properties.frag">
13366 <xsl:attribute-set name="linegroup.properties">
13367 <xsl:attribute name="provisional-distance-between-starts">20%</xsl:attribute>
13368 <xsl:attribute name="provisional-label-separation">.3em</xsl:attribute>
13369 <xsl:attribute name="space-before">.5em</xsl:attribute>
13370 </xsl:attribute-set>
13374 <refsection><info><title>Description</title></info>
13376 <para>This <literal>attribute set</literal> is applied
13377 to the <tag>list-block</tag> that contains the output of a
13378 <tag>linegroup</tag> element from DocBook Publishers.
13384 <refentry version="5.0" xml:id="speaker.properties">
13386 <refentrytitle>speaker.properties</refentrytitle>
13387 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
13390 <refname>speaker.properties</refname>
13391 <refpurpose>Properties applied to the DocBook Publishers
13392 speaker element</refpurpose>
13396 <programlisting xml:id="speaker.properties.frag">
13397 <xsl:attribute-set name="speaker.properties"></xsl:attribute-set>
13401 <refsection><info><title>Description</title></info>
13403 <para>This <literal>attribute set</literal> is applied
13404 to the <tag>block</tag> that contains the output of a
13405 <tag>speaker</tag> element from DocBook Publishers.
13411 <refentry version="5.0" xml:id="stagedir.properties">
13413 <refentrytitle>stagedir.properties</refentrytitle>
13414 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
13417 <refname>stagedir.properties</refname>
13418 <refpurpose>To add properties to the outer block of stage direction.</refpurpose>
13422 <programlisting xml:id="stagedir.properties.frag">
13423 <xsl:attribute-set name="stagedir.properties">
13424 <xsl:attribute name="font-weight">bold</xsl:attribute>
13425 <xsl:attribute name="font-style">italic</xsl:attribute>
13426 <xsl:attribute name="space-before">1em</xsl:attribute>
13427 <xsl:attribute name="space-after">1em</xsl:attribute>
13428 </xsl:attribute-set>
13432 <refsection><info><title>Description</title></info>
13434 <para>These properties are added to the outer block containing the
13436 Use this attribute-set to set the space above and below,
13437 and any indent for the whole stagedir.</para>
13442 <refentry version="5.0" xml:id="inlinestagedir.properties">
13444 <refentrytitle>inlinestagedir.properties</refentrytitle>
13445 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
13448 <refname>inlinestagedir.properties</refname>
13449 <refpurpose>Properties applied to the DocBook Publishers
13450 inlinestagedir element. </refpurpose>
13454 <programlisting xml:id="inlinestagedir.properties.frag">
13455 <xsl:attribute-set name="inlinestagedir.properties">
13456 <xsl:attribute name="font-weight">bold</xsl:attribute>
13457 <xsl:attribute name="font-style">italic</xsl:attribute>
13458 </xsl:attribute-set>
13462 <refsection><info><title>Description</title></info>
13464 <para>This <literal>attribute set</literal> is applied
13465 to the <tag>fo:inline</tag> that contains the output of a
13466 <tag>inlinestagedir</tag> element from DocBook Publishers.
13469 <para>The XSL template that matches on <tag>inlinestagedir</tag>
13470 also adds square brackets around the text.</para>
13477 <appendix xml:id="stylesheet"><title>The Stylesheet</title>
13479 <para>The <filename>param.xsl</filename> stylesheet is just a wrapper
13480 around all these parameters.</para>
13482 <programlisting xml:id="top">
13483 <xsl:stylesheet exclude-result-prefixes="src" version="1.0">
13485 <!-- This file is generated from param.xweb -->
13487 <!-- ********************************************************************
13488 $Id: param.xweb 9996 2015-10-01 16:35:10Z bobstayton $
13489 ********************************************************************
13491 This file is part of the XSL DocBook Stylesheet distribution.
13492 See ../README or http://docbook.sf.net/release/xsl/current/ for
13493 copyright and other information.
13495 ******************************************************************** -->
13497 <src:fragref linkend="abstract.properties.frag"></src:fragref>
13498 <src:fragref linkend="abstract.title.properties.frag"></src:fragref>
13499 <src:fragref linkend="activate.external.olinks.frag"></src:fragref>
13500 <src:fragref linkend="admon.graphics.extension.frag"></src:fragref>
13501 <src:fragref linkend="admon.graphics.frag"></src:fragref>
13502 <src:fragref linkend="admon.graphics.path.frag"></src:fragref>
13503 <src:fragref linkend="admon.textlabel.frag"></src:fragref>
13504 <src:fragref linkend="admonition.properties.frag"></src:fragref>
13505 <src:fragref linkend="admonition.title.properties.frag"></src:fragref>
13506 <src:fragref linkend="base.dir.frag"></src:fragref>
13507 <src:fragref linkend="graphical.admonition.properties.frag"></src:fragref>
13508 <src:fragref linkend="nongraphical.admonition.properties.frag"></src:fragref>
13509 <src:fragref linkend="alignment.frag"></src:fragref>
13510 <src:fragref linkend="appendix.autolabel.frag"></src:fragref>
13511 <src:fragref linkend="arbortext.extensions.frag"></src:fragref>
13512 <src:fragref linkend="article.appendix.title.properties.frag"></src:fragref>
13513 <src:fragref linkend="author.othername.in.middle.frag"></src:fragref>
13514 <src:fragref linkend="autotoc.label.separator.frag"></src:fragref>
13515 <src:fragref linkend="axf.extensions.frag"></src:fragref>
13516 <src:fragref linkend="biblioentry.item.separator.frag"></src:fragref>
13517 <src:fragref linkend="biblioentry.properties.frag"></src:fragref>
13518 <src:fragref linkend="bibliography.collection.frag"></src:fragref>
13519 <src:fragref linkend="bibliography.numbered.frag"></src:fragref>
13520 <src:fragref linkend="bibliography.style.frag"></src:fragref>
13521 <src:fragref linkend="blockquote.properties.frag"></src:fragref>
13522 <src:fragref linkend="body.font.family.frag"></src:fragref>
13523 <src:fragref linkend="body.font.master.frag"></src:fragref>
13524 <src:fragref linkend="body.font.size.frag"></src:fragref>
13525 <src:fragref linkend="body.margin.bottom.frag"></src:fragref>
13526 <src:fragref linkend="body.margin.top.frag"></src:fragref>
13527 <src:fragref linkend="body.start.indent.frag"></src:fragref>
13528 <src:fragref linkend="body.end.indent.frag"></src:fragref>
13529 <src:fragref linkend="bookmarks.collapse.frag"></src:fragref>
13530 <src:fragref linkend="bridgehead.in.toc.frag"></src:fragref>
13531 <src:fragref linkend="calloutlist.properties.frag"></src:fragref>
13532 <src:fragref linkend="callout.properties.frag"></src:fragref>
13533 <src:fragref linkend="callout.defaultcolumn.frag"></src:fragref>
13534 <src:fragref linkend="callout.graphics.extension.frag"></src:fragref>
13535 <src:fragref linkend="callout.graphics.frag"></src:fragref>
13536 <src:fragref linkend="callout.icon.size.frag"></src:fragref>
13537 <src:fragref linkend="callout.graphics.number.limit.frag"></src:fragref>
13538 <src:fragref linkend="callout.graphics.path.frag"></src:fragref>
13539 <src:fragref linkend="callout.unicode.font.frag"></src:fragref>
13540 <src:fragref linkend="callout.unicode.frag"></src:fragref>
13541 <src:fragref linkend="callout.unicode.number.limit.frag"></src:fragref>
13542 <src:fragref linkend="callout.unicode.start.character.frag"></src:fragref>
13543 <src:fragref linkend="callouts.extension.frag"></src:fragref>
13544 <src:fragref linkend="chapter.autolabel.frag"></src:fragref>
13545 <src:fragref linkend="chunk.quietly.frag"></src:fragref>
13546 <src:fragref linkend="collect.xref.targets.frag"></src:fragref>
13547 <src:fragref linkend="column.count.back.frag"></src:fragref>
13548 <src:fragref linkend="column.count.body.frag"></src:fragref>
13549 <src:fragref linkend="column.count.front.frag"></src:fragref>
13550 <src:fragref linkend="column.count.index.frag"></src:fragref>
13551 <src:fragref linkend="column.count.lot.frag"></src:fragref>
13552 <src:fragref linkend="column.count.titlepage.frag"></src:fragref>
13553 <src:fragref linkend="column.gap.back.frag"></src:fragref>
13554 <src:fragref linkend="column.gap.body.frag"></src:fragref>
13555 <src:fragref linkend="column.gap.front.frag"></src:fragref>
13556 <src:fragref linkend="column.gap.index.frag"></src:fragref>
13557 <src:fragref linkend="column.gap.lot.frag"></src:fragref>
13558 <src:fragref linkend="column.gap.titlepage.frag"></src:fragref>
13559 <src:fragref linkend="compact.list.item.spacing.frag"></src:fragref>
13560 <src:fragref linkend="component.label.includes.part.label.frag"></src:fragref>
13561 <src:fragref linkend="component.title.properties.frag"></src:fragref>
13562 <src:fragref linkend="component.titlepage.properties.frag"></src:fragref>
13563 <src:fragref linkend="crop.marks.frag"></src:fragref>
13564 <src:fragref linkend="crop.mark.width.frag"></src:fragref>
13565 <src:fragref linkend="crop.mark.offset.frag"></src:fragref>
13566 <src:fragref linkend="crop.mark.bleed.frag"></src:fragref>
13567 <src:fragref linkend="current.docid.frag"></src:fragref>
13568 <src:fragref linkend="default.float.class.frag"></src:fragref>
13569 <src:fragref linkend="default.image.width.frag"></src:fragref>
13570 <src:fragref linkend="default.table.width.frag"></src:fragref>
13571 <src:fragref linkend="default.table.frame.frag"></src:fragref>
13572 <src:fragref linkend="default.table.rules.frag"></src:fragref>
13573 <src:fragref linkend="default.units.frag"></src:fragref>
13574 <src:fragref linkend="dingbat.font.family.frag"></src:fragref>
13575 <src:fragref linkend="double.sided.frag"></src:fragref>
13576 <src:fragref linkend="draft.mode.frag"></src:fragref>
13577 <src:fragref linkend="draft.watermark.image.frag"></src:fragref>
13578 <src:fragref linkend="ebnf.assignment.frag"></src:fragref>
13579 <src:fragref linkend="ebnf.statement.terminator.frag"></src:fragref>
13580 <src:fragref linkend="email.delimiters.enabled.frag"></src:fragref>
13581 <src:fragref linkend="email.mailto.enabled.frag"></src:fragref>
13582 <src:fragref linkend="equation.properties.frag"></src:fragref>
13583 <src:fragref linkend="equation.number.properties.frag"></src:fragref>
13584 <src:fragref linkend="example.properties.frag"></src:fragref>
13585 <src:fragref linkend="exsl.node.set.available.frag"></src:fragref>
13586 <src:fragref linkend="figure.properties.frag"></src:fragref>
13587 <src:fragref linkend="firstterm.only.link.frag"></src:fragref>
13588 <src:fragref linkend="footer.content.properties.frag"></src:fragref>
13589 <src:fragref linkend="footer.rule.frag"></src:fragref>
13590 <src:fragref linkend="footer.column.widths.frag"></src:fragref>
13591 <src:fragref linkend="footer.table.height.frag"></src:fragref>
13592 <src:fragref linkend="footer.table.properties.frag"></src:fragref>
13593 <src:fragref linkend="footers.on.blank.pages.frag"></src:fragref>
13594 <src:fragref linkend="footnote.font.size.frag"></src:fragref>
13595 <src:fragref linkend="footnote.number.format.frag"></src:fragref>
13596 <src:fragref linkend="footnote.number.symbols.frag"></src:fragref>
13597 <src:fragref linkend="footnote.mark.properties.frag"></src:fragref>
13598 <src:fragref linkend="footnote.properties.frag"></src:fragref>
13599 <src:fragref linkend="footnote.sep.leader.properties.frag"></src:fragref>
13600 <src:fragref linkend="fop.extensions.frag"></src:fragref>
13601 <src:fragref linkend="fop1.extensions.frag"></src:fragref>
13602 <src:fragref linkend="force.blank.pages.frag"></src:fragref>
13603 <src:fragref linkend="formal.object.properties.frag"></src:fragref>
13604 <src:fragref linkend="formal.procedures.frag"></src:fragref>
13605 <src:fragref linkend="formal.title.placement.frag"></src:fragref>
13606 <src:fragref linkend="formal.title.properties.frag"></src:fragref>
13607 <src:fragref linkend="funcsynopsis.decoration.frag"></src:fragref>
13608 <src:fragref linkend="funcsynopsis.style.frag"></src:fragref>
13609 <src:fragref linkend="function.parens.frag"></src:fragref>
13610 <src:fragref linkend="generate.consistent.ids.frag"></src:fragref>
13611 <src:fragref linkend="generate.index.frag"></src:fragref>
13612 <src:fragref linkend="generate.section.toc.level.frag"></src:fragref>
13613 <src:fragref linkend="generate.toc.frag"></src:fragref>
13614 <src:fragref linkend="glossary.as.blocks.frag"></src:fragref>
13615 <src:fragref linkend="glossary.collection.frag"></src:fragref>
13616 <src:fragref linkend="glossary.sort.frag"></src:fragref>
13617 <src:fragref linkend="glossentry.show.acronym.frag"></src:fragref>
13618 <src:fragref linkend="glosslist.as.blocks.frag"></src:fragref>
13619 <src:fragref linkend="glossterm.auto.link.frag"></src:fragref>
13620 <src:fragref linkend="glossterm.separation.frag"></src:fragref>
13621 <src:fragref linkend="glossterm.width.frag"></src:fragref>
13622 <src:fragref linkend="glossentry.list.item.properties.frag"></src:fragref>
13623 <src:fragref linkend="glossterm.list.properties.frag"></src:fragref>
13624 <src:fragref linkend="glossterm.block.properties.frag"></src:fragref>
13625 <src:fragref linkend="glossdef.list.properties.frag"></src:fragref>
13626 <src:fragref linkend="glossdef.block.properties.frag"></src:fragref>
13627 <src:fragref linkend="graphic.default.extension.frag"></src:fragref>
13628 <src:fragref linkend="header.content.properties.frag"></src:fragref>
13629 <src:fragref linkend="header.rule.frag"></src:fragref>
13630 <src:fragref linkend="header.column.widths.frag"></src:fragref>
13631 <src:fragref linkend="header.table.height.frag"></src:fragref>
13632 <src:fragref linkend="header.table.properties.frag"></src:fragref>
13633 <src:fragref linkend="headers.on.blank.pages.frag"></src:fragref>
13634 <src:fragref linkend="highlight.default.language.frag"></src:fragref>
13635 <src:fragref linkend="highlight.source.frag"></src:fragref>
13636 <src:fragref linkend="highlight.xslthl.config.frag"></src:fragref>
13637 <src:fragref linkend="hyphenate.frag"></src:fragref>
13638 <src:fragref linkend="hyphenate.verbatim.frag"></src:fragref>
13639 <src:fragref linkend="hyphenate.verbatim.characters.frag"></src:fragref>
13640 <src:fragref linkend="ignore.image.scaling.frag"></src:fragref>
13641 <src:fragref linkend="img.src.path.frag"></src:fragref>
13642 <src:fragref linkend="index.method.frag"></src:fragref>
13643 <src:fragref linkend="index.on.role.frag"></src:fragref>
13644 <src:fragref linkend="index.on.type.frag"></src:fragref>
13645 <src:fragref linkend="index.page.number.properties.frag"></src:fragref>
13646 <src:fragref linkend="informalequation.properties.frag"></src:fragref>
13647 <src:fragref linkend="informalexample.properties.frag"></src:fragref>
13648 <src:fragref linkend="informalfigure.properties.frag"></src:fragref>
13649 <src:fragref linkend="informal.object.properties.frag"></src:fragref>
13650 <src:fragref linkend="informaltable.properties.frag"></src:fragref>
13651 <src:fragref linkend="index.preferred.page.properties.frag"></src:fragref>
13652 <src:fragref linkend="index.div.title.properties.frag"></src:fragref>
13653 <src:fragref linkend="index.entry.properties.frag"></src:fragref>
13654 <src:fragref linkend="index.number.separator.frag"></src:fragref>
13655 <src:fragref linkend="index.range.separator.frag"></src:fragref>
13656 <src:fragref linkend="index.term.separator.frag"></src:fragref>
13657 <src:fragref linkend="insert.link.page.number.frag"></src:fragref>
13658 <src:fragref linkend="insert.xref.page.number.frag"></src:fragref>
13659 <src:fragref linkend="insert.xref.page.number.para.frag"></src:fragref>
13660 <src:fragref linkend="itemizedlist.properties.frag"></src:fragref>
13661 <src:fragref linkend="itemizedlist.label.properties.frag"></src:fragref>
13662 <src:fragref linkend="itemizedlist.label.width.frag"></src:fragref>
13663 <src:fragref linkend="keep.relative.image.uris.frag"></src:fragref>
13664 <src:fragref linkend="l10n.gentext.default.language.frag"></src:fragref>
13665 <src:fragref linkend="l10n.gentext.language.frag"></src:fragref>
13666 <src:fragref linkend="l10n.gentext.use.xref.language.frag"></src:fragref>
13667 <src:fragref linkend="l10n.lang.value.rfc.compliant.frag"></src:fragref>
13668 <src:fragref linkend="label.from.part.frag"></src:fragref>
13669 <src:fragref linkend="line-height.frag"></src:fragref>
13670 <src:fragref linkend="linenumbering.everyNth.frag"></src:fragref>
13671 <src:fragref linkend="linenumbering.extension.frag"></src:fragref>
13672 <src:fragref linkend="linenumbering.separator.frag"></src:fragref>
13673 <src:fragref linkend="linenumbering.width.frag"></src:fragref>
13674 <src:fragref linkend="list.block.properties.frag"></src:fragref>
13675 <src:fragref linkend="list.block.spacing.frag"></src:fragref>
13676 <src:fragref linkend="list.item.spacing.frag"></src:fragref>
13677 <src:fragref linkend="make.index.markup.frag"></src:fragref>
13678 <src:fragref linkend="make.single.year.ranges.frag"></src:fragref>
13679 <src:fragref linkend="make.year.ranges.frag"></src:fragref>
13680 <src:fragref linkend="margin.note.properties.frag"></src:fragref>
13681 <src:fragref linkend="margin.note.title.properties.frag"></src:fragref>
13682 <src:fragref linkend="margin.note.float.type.frag"></src:fragref>
13683 <src:fragref linkend="margin.note.width.frag"></src:fragref>
13684 <src:fragref linkend="marker.section.level.frag"></src:fragref>
13685 <src:fragref linkend="menuchoice.menu.separator.frag"></src:fragref>
13686 <src:fragref linkend="menuchoice.separator.frag"></src:fragref>
13687 <src:fragref linkend="monospace.font.family.frag"></src:fragref>
13688 <src:fragref linkend="monospace.properties.frag"></src:fragref>
13689 <src:fragref linkend="monospace.verbatim.properties.frag"></src:fragref>
13690 <src:fragref linkend="monospace.verbatim.font.width.frag"></src:fragref>
13691 <src:fragref linkend="nominal.table.width.frag"></src:fragref>
13692 <src:fragref linkend="normal.para.spacing.frag"></src:fragref>
13693 <src:fragref linkend="olink.doctitle.frag"></src:fragref>
13694 <src:fragref linkend="olink.base.uri.frag"></src:fragref>
13695 <src:fragref linkend="olink.debug.frag"></src:fragref>
13696 <src:fragref linkend="olink.properties.frag"></src:fragref>
13697 <src:fragref linkend="olink.lang.fallback.sequence.frag"></src:fragref>
13698 <src:fragref linkend="orderedlist.properties.frag"></src:fragref>
13699 <src:fragref linkend="orderedlist.label.properties.frag"></src:fragref>
13700 <src:fragref linkend="orderedlist.label.width.frag"></src:fragref>
13701 <src:fragref linkend="prefer.internal.olink.frag"></src:fragref>
13702 <src:fragref linkend="insert.olink.page.number.frag"></src:fragref>
13703 <src:fragref linkend="insert.olink.pdf.frag.frag"></src:fragref>
13704 <src:fragref linkend="page.height.frag"></src:fragref>
13705 <src:fragref linkend="page.height.portrait.frag"></src:fragref>
13706 <src:fragref linkend="page.margin.bottom.frag"></src:fragref>
13707 <src:fragref linkend="page.margin.inner.frag"></src:fragref>
13708 <src:fragref linkend="page.margin.outer.frag"></src:fragref>
13709 <src:fragref linkend="page.margin.top.frag"></src:fragref>
13710 <src:fragref linkend="page.orientation.frag"></src:fragref>
13711 <src:fragref linkend="page.width.frag"></src:fragref>
13712 <src:fragref linkend="page.width.portrait.frag"></src:fragref>
13713 <src:fragref linkend="paper.type.frag"></src:fragref>
13714 <src:fragref linkend="part.autolabel.frag"></src:fragref>
13715 <src:fragref linkend="passivetex.extensions.frag"></src:fragref>
13716 <src:fragref linkend="pgwide.properties.frag"></src:fragref>
13717 <src:fragref linkend="preface.autolabel.frag"></src:fragref>
13718 <src:fragref linkend="preferred.mediaobject.role.frag"></src:fragref>
13719 <src:fragref linkend="procedure.properties.frag"></src:fragref>
13720 <src:fragref linkend="process.empty.source.toc.frag"></src:fragref>
13721 <src:fragref linkend="process.source.toc.frag"></src:fragref>
13722 <src:fragref linkend="profile.arch.frag"></src:fragref>
13723 <src:fragref linkend="profile.audience.frag"></src:fragref>
13724 <src:fragref linkend="profile.attribute.frag"></src:fragref>
13725 <src:fragref linkend="profile.condition.frag"></src:fragref>
13726 <src:fragref linkend="profile.conformance.frag"></src:fragref>
13727 <src:fragref linkend="profile.lang.frag"></src:fragref>
13728 <src:fragref linkend="profile.os.frag"></src:fragref>
13729 <src:fragref linkend="profile.outputformat.frag"></src:fragref>
13730 <src:fragref linkend="profile.revision.frag"></src:fragref>
13731 <src:fragref linkend="profile.revisionflag.frag"></src:fragref>
13732 <src:fragref linkend="profile.role.frag"></src:fragref>
13733 <src:fragref linkend="profile.security.frag"></src:fragref>
13734 <src:fragref linkend="profile.separator.frag"></src:fragref>
13735 <src:fragref linkend="profile.status.frag"></src:fragref>
13736 <src:fragref linkend="profile.userlevel.frag"></src:fragref>
13737 <src:fragref linkend="profile.value.frag"></src:fragref>
13738 <src:fragref linkend="profile.vendor.frag"></src:fragref>
13739 <src:fragref linkend="profile.wordsize.frag"></src:fragref>
13740 <src:fragref linkend="punct.honorific.frag"></src:fragref>
13741 <src:fragref linkend="qanda.defaultlabel.frag"></src:fragref>
13742 <src:fragref linkend="qanda.in.toc.frag"></src:fragref>
13743 <src:fragref linkend="qanda.nested.in.toc.frag"></src:fragref>
13744 <src:fragref linkend="qanda.inherit.numeration.frag"></src:fragref>
13745 <src:fragref linkend="qandadiv.autolabel.frag"></src:fragref>
13746 <src:fragref linkend="qanda.title.level1.properties.frag"></src:fragref>
13747 <src:fragref linkend="qanda.title.level2.properties.frag"></src:fragref>
13748 <src:fragref linkend="qanda.title.level3.properties.frag"></src:fragref>
13749 <src:fragref linkend="qanda.title.level4.properties.frag"></src:fragref>
13750 <src:fragref linkend="qanda.title.level5.properties.frag"></src:fragref>
13751 <src:fragref linkend="qanda.title.level6.properties.frag"></src:fragref>
13752 <src:fragref linkend="qanda.title.properties.frag"></src:fragref>
13753 <src:fragref linkend="refentry.generate.name.frag"></src:fragref>
13754 <src:fragref linkend="refentry.generate.title.frag"></src:fragref>
13755 <src:fragref linkend="refentry.pagebreak.frag"></src:fragref>
13756 <src:fragref linkend="refentry.title.properties.frag"></src:fragref>
13757 <src:fragref linkend="refentry.xref.manvolnum.frag"></src:fragref>
13758 <src:fragref linkend="reference.autolabel.frag"></src:fragref>
13759 <src:fragref linkend="refclass.suppress.frag"></src:fragref>
13760 <src:fragref linkend="region.after.extent.frag"></src:fragref>
13761 <src:fragref linkend="region.before.extent.frag"></src:fragref>
13762 <src:fragref linkend="revhistory.table.properties.frag"></src:fragref>
13763 <src:fragref linkend="revhistory.table.cell.properties.frag"></src:fragref>
13764 <src:fragref linkend="revhistory.title.properties.frag"></src:fragref>
13765 <src:fragref linkend="root.properties.frag"></src:fragref>
13766 <src:fragref linkend="rootid.frag"></src:fragref>
13767 <src:fragref linkend="runinhead.default.title.end.punct.frag"></src:fragref>
13768 <src:fragref linkend="runinhead.title.end.punct.frag"></src:fragref>
13769 <src:fragref linkend="sans.font.family.frag"></src:fragref>
13770 <src:fragref linkend="section.autolabel.frag"></src:fragref>
13771 <src:fragref linkend="section.autolabel.max.depth.frag"></src:fragref>
13772 <src:fragref linkend="section.container.element.frag"></src:fragref>
13773 <src:fragref linkend="section.label.includes.component.label.frag"></src:fragref>
13774 <src:fragref linkend="section.title.level1.properties.frag"></src:fragref>
13775 <src:fragref linkend="section.title.level2.properties.frag"></src:fragref>
13776 <src:fragref linkend="section.title.level3.properties.frag"></src:fragref>
13777 <src:fragref linkend="section.title.level4.properties.frag"></src:fragref>
13778 <src:fragref linkend="section.title.level5.properties.frag"></src:fragref>
13779 <src:fragref linkend="section.title.level6.properties.frag"></src:fragref>
13780 <src:fragref linkend="section.title.properties.frag"></src:fragref>
13781 <src:fragref linkend="section.level1.properties.frag"></src:fragref>
13782 <src:fragref linkend="section.level2.properties.frag"></src:fragref>
13783 <src:fragref linkend="section.level3.properties.frag"></src:fragref>
13784 <src:fragref linkend="section.level4.properties.frag"></src:fragref>
13785 <src:fragref linkend="section.level5.properties.frag"></src:fragref>
13786 <src:fragref linkend="section.level6.properties.frag"></src:fragref>
13787 <src:fragref linkend="section.properties.frag"></src:fragref>
13788 <src:fragref linkend="segmentedlist.as.table.frag"></src:fragref>
13789 <src:fragref linkend="shade.verbatim.frag"></src:fragref>
13790 <src:fragref linkend="shade.verbatim.style.frag"></src:fragref>
13791 <src:fragref linkend="show.comments.frag"></src:fragref>
13792 <src:fragref linkend="sidebar.properties.frag"></src:fragref>
13793 <src:fragref linkend="sidebar.title.properties.frag"></src:fragref>
13794 <src:fragref linkend="sidebar.float.type.frag"></src:fragref>
13795 <src:fragref linkend="sidebar.float.width.frag"></src:fragref>
13796 <src:fragref linkend="simplesect.in.toc.frag"></src:fragref>
13797 <src:fragref linkend="subscript.properties.frag"></src:fragref>
13798 <src:fragref linkend="superscript.properties.frag"></src:fragref>
13799 <src:fragref linkend="symbol.font.family.frag"></src:fragref>
13800 <src:fragref linkend="table.cell.border.color.frag"></src:fragref>
13801 <src:fragref linkend="table.cell.border.style.frag"></src:fragref>
13802 <src:fragref linkend="table.cell.border.thickness.frag"></src:fragref>
13803 <src:fragref linkend="table.cell.padding.frag"></src:fragref>
13804 <src:fragref linkend="table.footnote.number.format.frag"></src:fragref>
13805 <src:fragref linkend="table.footnote.number.symbols.frag"></src:fragref>
13806 <src:fragref linkend="table.footnote.properties.frag"></src:fragref>
13807 <src:fragref linkend="table.frame.border.color.frag"></src:fragref>
13808 <src:fragref linkend="table.frame.border.style.frag"></src:fragref>
13809 <src:fragref linkend="table.frame.border.thickness.frag"></src:fragref>
13810 <src:fragref linkend="table.properties.frag"></src:fragref>
13811 <src:fragref linkend="tablecolumns.extension.frag"></src:fragref>
13812 <src:fragref linkend="table.table.properties.frag"></src:fragref>
13813 <src:fragref linkend="table.caption.properties.frag"></src:fragref>
13814 <src:fragref linkend="target.database.document.frag"></src:fragref>
13815 <src:fragref linkend="targets.filename.frag"></src:fragref>
13816 <src:fragref linkend="task.properties.frag"></src:fragref>
13817 <src:fragref linkend="textdata.default.encoding.frag"></src:fragref>
13818 <src:fragref linkend="tex.math.delims.frag"></src:fragref>
13819 <src:fragref linkend="tex.math.in.alt.frag"></src:fragref>
13820 <src:fragref linkend="textinsert.extension.frag"></src:fragref>
13821 <src:fragref linkend="title.font.family.frag"></src:fragref>
13822 <src:fragref linkend="title.margin.left.frag"></src:fragref>
13823 <src:fragref linkend="toc.indent.width.frag"></src:fragref>
13824 <src:fragref linkend="toc.line.properties.frag"></src:fragref>
13825 <src:fragref linkend="toc.leader.properties.frag"></src:fragref>
13826 <src:fragref linkend="toc.margin.properties.frag"></src:fragref>
13827 <src:fragref linkend="toc.max.depth.frag"></src:fragref>
13828 <src:fragref linkend="toc.section.depth.frag"></src:fragref>
13829 <src:fragref linkend="ulink.footnotes.frag"></src:fragref>
13830 <src:fragref linkend="ulink.hyphenate.frag"></src:fragref>
13831 <src:fragref linkend="ulink.hyphenate.chars.frag"></src:fragref>
13832 <src:fragref linkend="ulink.show.frag"></src:fragref>
13833 <src:fragref linkend="use.extensions.frag"></src:fragref>
13834 <src:fragref linkend="use.local.olink.style.frag"></src:fragref>
13835 <src:fragref linkend="use.role.as.xrefstyle.frag"></src:fragref>
13836 <src:fragref linkend="use.role.for.mediaobject.frag"></src:fragref>
13837 <src:fragref linkend="use.svg.frag"></src:fragref>
13838 <src:fragref linkend="variablelist.as.blocks.frag"></src:fragref>
13839 <src:fragref linkend="variablelist.max.termlength.frag"></src:fragref>
13840 <src:fragref linkend="variablelist.term.separator.frag"></src:fragref>
13841 <src:fragref linkend="variablelist.term.properties.frag"></src:fragref>
13842 <src:fragref linkend="variablelist.term.break.after.frag"></src:fragref>
13843 <src:fragref linkend="verbatim.properties.frag"></src:fragref>
13844 <src:fragref linkend="writing.mode.frag"></src:fragref>
13845 <src:fragref linkend="xep.extensions.frag"></src:fragref>
13846 <src:fragref linkend="xep.index.item.properties.frag"></src:fragref>
13847 <src:fragref linkend="xref.label-page.separator.frag"></src:fragref>
13848 <src:fragref linkend="xref.label-title.separator.frag"></src:fragref>
13849 <src:fragref linkend="xref.properties.frag"></src:fragref>
13850 <src:fragref linkend="xref.title-page.separator.frag"></src:fragref>
13851 <src:fragref linkend="xref.with.number.and.title.frag"></src:fragref>
13852 <src:fragref linkend="region.inner.extent.frag"></src:fragref>
13853 <src:fragref linkend="region.outer.extent.frag"></src:fragref>
13854 <src:fragref linkend="body.margin.inner.frag"></src:fragref>
13855 <src:fragref linkend="body.margin.outer.frag"></src:fragref>
13856 <src:fragref linkend="side.region.precedence.frag"></src:fragref>
13857 <src:fragref linkend="inner.region.content.properties.frag"></src:fragref>
13858 <src:fragref linkend="outer.region.content.properties.frag"></src:fragref>
13859 <src:fragref linkend="region.inner.properties.frag"></src:fragref>
13860 <src:fragref linkend="region.outer.properties.frag"></src:fragref>
13861 <src:fragref linkend="para.properties.frag"></src:fragref>
13862 <src:fragref linkend="mark.optional.procedure.steps.frag"></src:fragref>
13863 <src:fragref linkend="xsl1.1.bookmarks.frag"></src:fragref>
13864 <src:fragref linkend="show.bookmarks.frag"></src:fragref>
13865 <src:fragref linkend="autolink.index.see.frag"></src:fragref>
13866 <src:fragref linkend="publishers.properties.frag"></src:fragref>
13867 <src:fragref linkend="drama.properties.frag"></src:fragref>
13868 <src:fragref linkend="poetry.properties.frag"></src:fragref>
13869 <src:fragref linkend="stagedir.properties.frag"></src:fragref>
13870 <src:fragref linkend="linegroup.properties.frag"></src:fragref>
13871 <src:fragref linkend="speaker.properties.frag"></src:fragref>
13872 <src:fragref linkend="line.properties.frag"></src:fragref>
13873 <src:fragref linkend="inlinestagedir.properties.frag"></src:fragref>
13874 <src:fragref linkend="dialogue.properties.frag"></src:fragref>
13876 </xsl:stylesheet>