1 <?xml version="1.0" encoding="ASCII"?>
4 <title>FO Parameter Reference</title>
5 <releaseinfo role="meta">
6 $Id: param.xweb 8543 2009-12-02 06:05:24Z bobstayton $
10 <surname>Walsh</surname>
11 <firstname>Norman</firstname>
24 <holder>Norman Walsh</holder>
27 <para>This is reference documentation for all user-configurable
28 parameters in the DocBook XSL FO stylesheets (for generating
29 XSL-FO output destined for final print/PDF output).</para>
32 <reference xml:id="admons"><title>Admonitions</title>
33 <refentry version="5.0" xml:id="admon.graphics">
35 <refentrytitle>admon.graphics</refentrytitle>
36 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
39 <refname>admon.graphics</refname>
40 <refpurpose>Use graphics in admonitions?</refpurpose>
44 <programlisting xml:id="admon.graphics.frag">
45 <xsl:param name="admon.graphics" select="0"></xsl:param>
49 <refsection><info><title>Description</title></info>
51 <para>If true (non-zero), admonitions are presented in an alternate style that uses
52 a graphic. Default graphics are provided in the distribution.
58 <refentry version="5.0" xml:id="admon.graphics.extension">
60 <refentrytitle>admon.graphics.extension</refentrytitle>
61 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
64 <refname>admon.graphics.extension</refname>
65 <refpurpose>Filename extension for admonition graphics</refpurpose>
69 <programlisting xml:id="admon.graphics.extension.frag">
70 <xsl:param name="admon.graphics.extension">.png</xsl:param>
74 <refsection><info><title>Description</title></info>
76 <para>Sets the filename extension to use on admonition graphics.</para>
81 <refentry version="5.0" xml:id="admon.graphics.path">
83 <refentrytitle>admon.graphics.path</refentrytitle>
84 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
87 <refname>admon.graphics.path</refname>
88 <refpurpose>Path to admonition graphics</refpurpose>
92 <programlisting xml:id="admon.graphics.path.frag"><xsl:param name="admon.graphics.path">images/</xsl:param></programlisting>
95 <refsection><info><title>Description</title></info>
97 <para>Sets the path to the directory containing the admonition graphics
98 (caution.png, important.png etc). This location is normally relative
99 to the output html directory. See <parameter>base.dir</parameter></para>
104 <refentry version="5.0" xml:id="admon.textlabel">
106 <refentrytitle>admon.textlabel</refentrytitle>
107 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
110 <refname>admon.textlabel</refname>
111 <refpurpose>Use text label in admonitions?</refpurpose>
115 <programlisting xml:id="admon.textlabel.frag">
116 <xsl:param name="admon.textlabel" select="1"></xsl:param>
120 <refsection><info><title>Description</title></info>
122 <para>If true (non-zero), admonitions are presented with a generated
123 text label such as Note or Warning in the appropriate language.
124 If zero, such labels are turned off, but any title child
125 of the admonition element are still output.
126 The default value is 1.
132 <refentry version="5.0" xml:id="admonition.title.properties">
135 <refentrytitle>admonition.title.properties</refentrytitle>
136 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
139 <refname>admonition.title.properties</refname>
140 <refpurpose>To set the style for admonitions titles.</refpurpose>
144 <programlisting xml:id="admonition.title.properties.frag">
145 <xsl:attribute-set name="admonition.title.properties">
146 <xsl:attribute name="font-size">14pt</xsl:attribute>
147 <xsl:attribute name="font-weight">bold</xsl:attribute>
148 <xsl:attribute name="hyphenate">false</xsl:attribute>
149 <xsl:attribute name="keep-with-next.within-column">always</xsl:attribute>
150 </xsl:attribute-set>
153 <refsection><info><title>Description</title></info>
154 <para>How do you want admonitions titles styled? </para>
155 <para>Set the font-size, weight etc to the style required.</para>
160 <refentry version="5.0" xml:id="admonition.properties">
162 <refentrytitle>admonition.properties</refentrytitle>
163 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
166 <refname>admonition.properties</refname>
167 <refpurpose>To set the style for admonitions.</refpurpose>
171 <programlisting xml:id="admonition.properties.frag"><xsl:attribute-set name="admonition.properties"></xsl:attribute-set>
174 <refsection><info><title>Description</title></info>
175 <para>How do you want admonitions styled? </para>
176 <para>Set the font-size, weight, etc. to the style required</para>
181 <refentry version="5.0" xml:id="graphical.admonition.properties">
183 <refentrytitle>graphical.admonition.properties</refentrytitle>
184 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
187 <refname>graphical.admonition.properties</refname>
188 <refpurpose>To add properties to the outer block of a graphical admonition.</refpurpose>
192 <programlisting xml:id="graphical.admonition.properties.frag"><xsl:attribute-set name="graphical.admonition.properties">
193 <xsl:attribute name="space-before.optimum">1em</xsl:attribute>
194 <xsl:attribute name="space-before.minimum">0.8em</xsl:attribute>
195 <xsl:attribute name="space-before.maximum">1.2em</xsl:attribute>
196 <xsl:attribute name="space-after.optimum">1em</xsl:attribute>
197 <xsl:attribute name="space-after.minimum">0.8em</xsl:attribute>
198 <xsl:attribute name="space-after.maximum">1.2em</xsl:attribute>
199 </xsl:attribute-set>
202 <refsection><info><title>Description</title></info>
203 <para>These properties are added to the outer block containing the
204 entire graphical admonition, including its title.
205 It is used when the parameter
206 <parameter>admon.graphics</parameter> is set to nonzero.
207 Use this attribute-set to set the space above and below,
208 and any indent for the whole admonition.</para>
210 <para>In addition to these properties, a graphical admonition
211 also applies the <parameter>admonition.title.properties</parameter>
212 attribute-set to the title, and applies the
213 <parameter>admonition.properties</parameter> attribute-set
214 to the rest of the content.</para>
219 <refentry version="5.0" xml:id="nongraphical.admonition.properties">
221 <refentrytitle>nongraphical.admonition.properties</refentrytitle>
222 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
225 <refname>nongraphical.admonition.properties</refname>
226 <refpurpose>To add properties to the outer block of a nongraphical admonition.</refpurpose>
230 <programlisting xml:id="nongraphical.admonition.properties.frag"><xsl:attribute-set name="nongraphical.admonition.properties">
231 <xsl:attribute name="space-before.minimum">0.8em</xsl:attribute>
232 <xsl:attribute name="space-before.optimum">1em</xsl:attribute>
233 <xsl:attribute name="space-before.maximum">1.2em</xsl:attribute>
234 <xsl:attribute name="margin-{$direction.align.start}">0.25in</xsl:attribute>
235 <xsl:attribute name="margin-{$direction.align.end}">0.25in</xsl:attribute>
236 </xsl:attribute-set>
239 <refsection><info><title>Description</title></info>
240 <para>These properties are added to the outer block containing the
241 entire nongraphical admonition, including its title.
242 It is used when the parameter
243 <parameter>admon.graphics</parameter> is set to zero.
244 Use this attribute-set to set the space above and below,
245 and any indent for the whole admonition.</para>
247 <para>In addition to these properties, a nongraphical admonition
248 also applies the <parameter>admonition.title.properties</parameter>
249 attribute-set to the title, and the
250 <parameter>admonition.properties</parameter> attribute-set
251 to the rest of the content.</para>
257 <reference xml:id="callouts"><title>Callouts</title>
258 <refentry version="5.0" xml:id="callout.defaultcolumn">
260 <refentrytitle>callout.defaultcolumn</refentrytitle>
261 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
264 <refname>callout.defaultcolumn</refname>
265 <refpurpose>Indicates what column callouts appear in by default</refpurpose>
269 <programlisting xml:id="callout.defaultcolumn.frag">
270 <xsl:param name="callout.defaultcolumn">60</xsl:param>
274 <refsection><info><title>Description</title></info>
276 <para>If a callout does not identify a column (for example, if it uses
277 the <literal>linerange</literal> <tag class="attribute">unit</tag>),
278 it will appear in the default column.
284 <refentry version="5.0" xml:id="callout.graphics">
286 <refentrytitle>callout.graphics</refentrytitle>
287 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
290 <refname>callout.graphics</refname>
291 <refpurpose>Use graphics for callouts?</refpurpose>
295 <programlisting xml:id="callout.graphics.frag">
296 <xsl:param name="callout.graphics" select="1"></xsl:param>
300 <refsection><info><title>Description</title></info>
302 <para>If non-zero, callouts are presented with graphics (e.g., reverse-video
303 circled numbers instead of "(1)", "(2)", etc.).
304 Default graphics are provided in the distribution.
310 <refentry version="5.0" xml:id="callout.graphics.extension">
312 <refentrytitle>callout.graphics.extension</refentrytitle>
313 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
316 <refname>callout.graphics.extension</refname>
317 <refpurpose>Filename extension for callout graphics</refpurpose>
321 <programlisting xml:id="callout.graphics.extension.frag">
323 <xsl:param name="callout.graphics.extension">.svg</xsl:param>
327 <refsection><info><title>Description</title></info>
328 <para>Sets the filename extension to use on callout graphics. </para>
331 <para>The Docbook XSL distribution provides callout graphics in the following formats:</para>
332 <listitem><para>SVG (extension: <filename class="extension">.svg</filename>)</para></listitem>
333 <listitem><para>PNG (extension: <filename class="extension">.png</filename>)</para></listitem>
334 <listitem><para>GIF (extension: <filename class="extension">.gif</filename>)</para></listitem>
339 <refentry version="5.0" xml:id="callout.graphics.number.limit">
341 <refentrytitle>callout.graphics.number.limit</refentrytitle>
342 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
345 <refname>callout.graphics.number.limit</refname>
346 <refpurpose>Number of the largest callout graphic</refpurpose>
350 <programlisting xml:id="callout.graphics.number.limit.frag">
352 <xsl:param name="callout.graphics.number.limit">30</xsl:param>
356 <refsection><info><title>Description</title></info>
358 <para>If <parameter>callout.graphics</parameter> is non-zero, graphics
359 are used to represent callout numbers instead of plain text. The value
360 of <parameter>callout.graphics.number.limit</parameter> is the largest
361 number for which a graphic exists. If the callout number exceeds this
362 limit, the default presentation "(plain text instead of a graphic)"
369 <refentry version="5.0" xml:id="callout.graphics.path">
371 <refentrytitle>callout.graphics.path</refentrytitle>
372 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
375 <refname>callout.graphics.path</refname>
376 <refpurpose>Path to callout graphics</refpurpose>
380 <programlisting xml:id="callout.graphics.path.frag">
381 <xsl:param name="callout.graphics.path">images/callouts/</xsl:param>
385 <refsection><info><title>Description</title></info>
387 <para>Sets the path to the directory holding the callout graphics. his
388 location is normally relative to the output html directory. see
389 base.dir. Always terminate the directory with / since the graphic file
390 is appended to this string, hence needs the separator.
396 <refentry version="5.0" xml:id="callout.icon.size">
398 <refentrytitle>callout.icon.size</refentrytitle>
399 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
402 <refname>callout.icon.size</refname>
403 <refpurpose>Specifies the size of callout marker icons</refpurpose>
407 <programlisting xml:id="callout.icon.size.frag">
408 <xsl:param name="callout.icon.size">7pt</xsl:param>
412 <refsection><info><title>Description</title></info>
414 <para>Specifies the size of the callout marker icons.
415 The default size is 7 points.</para>
420 <refentry version="5.0" xml:id="callout.unicode">
422 <refentrytitle>callout.unicode</refentrytitle>
423 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
426 <refname>callout.unicode</refname>
427 <refpurpose>Use Unicode characters rather than images for callouts.</refpurpose>
431 <programlisting xml:id="callout.unicode.frag"><xsl:param name="callout.unicode" select="0"></xsl:param></programlisting>
434 <refsection><info><title>Description</title></info>
436 <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.
442 <refentry version="5.0" xml:id="callout.unicode.font">
444 <refentrytitle>callout.unicode.font</refentrytitle>
445 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
448 <refname>callout.unicode.font</refname>
449 <refpurpose>Specify a font for Unicode glyphs</refpurpose>
453 <programlisting xml:id="callout.unicode.font.frag">
454 <xsl:param name="callout.unicode.font">ZapfDingbats</xsl:param>
458 <refsection><info><title>Description</title></info>
460 <para>The name of the font to specify around Unicode callout glyphs.
461 If set to the empty string, no font change will occur.
467 <refentry version="5.0" xml:id="callout.unicode.number.limit">
469 <refentrytitle>callout.unicode.number.limit</refentrytitle>
470 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
473 <refname>callout.unicode.number.limit</refname>
474 <refpurpose>Number of the largest unicode callout character</refpurpose>
478 <programlisting xml:id="callout.unicode.number.limit.frag">
479 <xsl:param name="callout.unicode.number.limit">10</xsl:param>
483 <refsection><info><title>Description</title></info>
485 <para>If <parameter>callout.unicode</parameter>
486 is non-zero, unicode characters are used to represent
487 callout numbers. The value of
488 <parameter>callout.unicode.number.limit</parameter>
490 the largest number for which a unicode character exists. If the callout number
491 exceeds this limit, the default presentation "(nnn)" will always
498 <refentry version="5.0" xml:id="callout.unicode.start.character">
500 <refentrytitle>callout.unicode.start.character</refentrytitle>
501 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
504 <refname>callout.unicode.start.character</refname>
505 <refpurpose>First Unicode character to use, decimal value.</refpurpose>
509 <programlisting xml:id="callout.unicode.start.character.frag">
510 <xsl:param name="callout.unicode.start.character">10102</xsl:param>
514 <refsection><info><title>Description</title></info>
516 <para>If <parameter>callout.graphics</parameter> is zero and <parameter>callout.unicode</parameter>
517 is non-zero, unicode characters are used to represent
518 callout numbers. The value of
519 <parameter>callout.unicode.start.character</parameter>
520 is the decimal unicode value used for callout number one. Currently,
521 only 10102 is supported in the stylesheets for this parameter.
527 <refentry version="5.0" xml:id="callouts.extension">
529 <refentrytitle>callouts.extension</refentrytitle>
530 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
533 <refname>callouts.extension</refname>
534 <refpurpose>Enable the callout extension</refpurpose>
538 <programlisting xml:id="callouts.extension.frag">
539 <xsl:param name="callouts.extension" select="1"></xsl:param>
543 <refsection><info><title>Description</title></info>
545 <para>The callouts extension processes <tag>areaset</tag>
546 elements in <tag>programlistingco</tag> and other text-based
554 <reference xml:id="toc_index"><title>ToC/LoT/Index Generation</title>
555 <refentry version="5.0" xml:id="autotoc.label.separator">
557 <refentrytitle>autotoc.label.separator</refentrytitle>
558 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
561 <refname>autotoc.label.separator</refname>
562 <refpurpose>Separator between labels and titles in the ToC</refpurpose>
566 <programlisting xml:id="autotoc.label.separator.frag">
567 <xsl:param name="autotoc.label.separator">. </xsl:param>
571 <refsection><info><title>Description</title></info>
573 <para>String used to separate labels and titles in a table of contents.</para>
578 <refentry version="5.0" xml:id="process.empty.source.toc">
580 <refentrytitle>process.empty.source.toc</refentrytitle>
581 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
584 <refname>process.empty.source.toc</refname>
585 <refpurpose>Generate automated TOC if <tag>toc</tag> element occurs in a source document?</refpurpose>
589 <programlisting xml:id="process.empty.source.toc.frag"><xsl:param name="process.empty.source.toc" select="0"></xsl:param></programlisting>
592 <refsection><info><title>Description</title></info>
594 <para>Specifies that if an empty <tag>toc</tag> element is found in a
595 source document, an automated TOC is generated at this point in the
598 <para>Depending on what the value of the
599 <parameter>generate.toc</parameter> parameter is, setting this
600 parameter to <literal>1</literal> could result in generation of
601 duplicate automated TOCs. So the
602 <parameter>process.empty.source.toc</parameter> is primarily useful
603 as an "override": by placing an empty <tag>toc</tag> in your
604 document and setting this parameter to <literal>1</literal>, you can
605 force a TOC to be generated even if <tag>generate.toc</tag>
613 <refentry version="5.0" xml:id="process.source.toc">
615 <refentrytitle>process.source.toc</refentrytitle>
616 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
619 <refname>process.source.toc</refname>
620 <refpurpose>Process a non-empty <tag>toc</tag> element if it occurs in a source document?</refpurpose>
624 <programlisting xml:id="process.source.toc.frag"><xsl:param name="process.source.toc" select="0"></xsl:param></programlisting>
627 <refsection><info><title>Description</title></info>
629 <para>Specifies that the contents of a non-empty "hard-coded"
630 <tag>toc</tag> element in a source document are processed to
631 generate a TOC in output.
633 <para>This parameter has no effect on automated generation of
634 TOCs. An automated TOC may still be generated along with the
635 "hard-coded" TOC. To suppress automated TOC generation, adjust the
636 value of the <parameter>generate.toc</parameter> paramameter.</para>
638 <para>The <tag>process.source.toc</tag> parameter also has
639 no effect if the <tag>toc</tag> element is empty; handling
640 for empty <tag>toc</tag> is controlled by the
641 <parameter>process.empty.source.toc</parameter> parameter.</para>
648 <refentry version="5.0" xml:id="generate.toc">
650 <refentrytitle>generate.toc</refentrytitle>
651 <refmiscinfo class="other" otherclass="datatype">table</refmiscinfo>
654 <refname>generate.toc</refname>
655 <refpurpose>Control generation of ToCs and LoTs</refpurpose>
659 <programlisting xml:id="generate.toc.frag">
661 <xsl:param name="generate.toc">
665 book toc,title,figure,table,example,equation
681 <refsection><info><title>Description</title></info>
683 <para>This parameter has a structured value. It is a table of space-delimited
684 path/value pairs. Each path identifies some element in the source document
685 using a restricted subset of XPath (only the implicit child axis, no wildcards,
686 no predicates). Paths can be either relative or absolute.</para>
688 <para>When processing a particular element, the stylesheets consult this table to
689 determine if a ToC (or LoT(s)) should be generated.</para>
691 <para>For example, consider the entry:</para>
693 <screen>book toc,figure</screen>
695 <para>This indicates that whenever a <tag>book</tag> is formatted, a
696 Table Of Contents and a List of Figures should be generated. Similarly,</para>
698 <screen>/chapter toc</screen>
700 <para>indicates that whenever a document <emphasis>that has a root
701 of</emphasis> <tag>chapter</tag> is formatted, a Table of
702 Contents should be generated. The entry <literal>chapter</literal> would match
703 all chapters, but <literal>/chapter</literal> matches only <tag>chapter</tag>
704 document elements.</para>
706 <para>Generally, the longest match wins. So, for example, if you want to distinguish
707 articles in books from articles in parts, you could use these two entries:</para>
709 <screen>book/article toc,figure
710 part/article toc</screen>
712 <para>Note that an article in a part can never match a <literal>book/article</literal>,
713 so if you want nothing to be generated for articles in parts, you can simply leave
714 that rule out.</para>
716 <para>If you want to leave the rule in, to make it explicit that you're turning
717 something off, use the value <quote>nop</quote>. For example, the following
718 entry disables ToCs and LoTs for articles:</para>
720 <screen>article nop</screen>
722 <para>Do not simply leave the word <quote>article</quote> in the file
723 without a matching value. That'd be just begging the silly little
724 path/value parser to get confused.</para>
726 <para>Section ToCs are further controlled by the
727 <parameter>generate.section.toc.level</parameter> parameter.
728 For a given section level to have a ToC, it must have both an entry in
729 <parameter>generate.toc</parameter> and be within the range enabled by
730 <parameter>generate.section.toc.level</parameter>.</para>
734 <refentry version="5.0" xml:id="generate.index">
736 <refentrytitle>generate.index</refentrytitle>
737 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
740 <refname>generate.index</refname>
741 <refpurpose>Do you want an index?</refpurpose>
745 <programlisting xml:id="generate.index.frag"><xsl:param name="generate.index" select="1"></xsl:param></programlisting>
748 <refsection><info><title>Description</title></info>
750 <para>Specify if an index should be generated. </para>
755 <refentry version="5.0" xml:id="make.index.markup">
757 <refentrytitle>make.index.markup</refentrytitle>
758 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
761 <refname>make.index.markup</refname>
762 <refpurpose>Generate XML index markup in the index?</refpurpose>
766 <programlisting xml:id="make.index.markup.frag">
767 <xsl:param name="make.index.markup" select="0"></xsl:param>
771 <refsection><info><title>Description</title></info>
773 <para>This parameter enables a very neat trick for getting properly
774 merged, collated back-of-the-book indexes. G. Ken Holman suggested
775 this trick at Extreme Markup Languages 2002 and I'm indebted to him
778 <para>Jeni Tennison's excellent code in
779 <filename>autoidx.xsl</filename> does a great job of merging and
780 sorting <tag>indexterm</tag>s in the document and building a
781 back-of-the-book index. However, there's one thing that it cannot
782 reasonably be expected to do: merge page numbers into ranges. (I would
783 not have thought that it could collate and suppress duplicate page
784 numbers, but in fact it appears to manage that task somehow.)</para>
786 <para>Ken's trick is to produce a document in which the index at the
787 back of the book is <quote>displayed</quote> in XML. Because the index
788 is generated by the FO processor, all of the page numbers have been resolved.
789 It's a bit hard to explain, but what it boils down to is that instead of having
790 an index at the back of the book that looks like this:</para>
793 <formalpara><info><title>A</title></info>
794 <para>ap1, 1, 2, 3</para>
798 <para>you get one that looks like this:</para>
801 <programlisting><indexdiv>A</indexdiv>
803 <primaryie>ap1</primaryie>,
804 <phrase role="pageno">1</phrase>,
805 <phrase role="pageno">2</phrase>,
806 <phrase role="pageno">3</phrase>
807 </indexentry></programlisting>
810 <para>After building a PDF file with this sort of odd-looking index, you can
811 extract the text from the PDF file and the result is a proper index expressed in
814 <para>Now you have data that's amenable to processing and a simple Perl script
815 (such as <filename>fo/pdf2index</filename>) can
816 merge page ranges and generate a proper index.</para>
818 <para>Finally, reformat your original document using this literal index instead of
819 an automatically generated one and <quote>bingo</quote>!</para>
824 <refentry version="5.0" xml:id="index.method">
826 <refentrytitle>index.method</refentrytitle>
827 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
828 <refmiscinfo class="other" otherclass="value">basic</refmiscinfo>
829 <refmiscinfo class="other" otherclass="value">kosek</refmiscinfo>
830 <refmiscinfo class="other" otherclass="value">kimber</refmiscinfo>
833 <refname>index.method</refname>
834 <refpurpose>Select method used to group index entries in an index</refpurpose>
838 <programlisting xml:id="index.method.frag">
839 <xsl:param name="index.method">basic</xsl:param>
843 <refsection><info><title>Description</title></info>
845 <para>This parameter lets you select which method to use for sorting and grouping
846 index entries in an index.
847 Indexes in Latin-based languages that have accented characters typically
848 sort together accented words and unaccented words.
849 Thus <quote>Á</quote> (U+00C1 LATIN CAPITAL LETTER A WITH ACUTE) would sort together
850 with <quote>A</quote> (U+0041 LATIN CAPITAL LETTER A), so both would appear in the <quote>A</quote>
851 section of the index.
852 Languages using other alphabets (such as Russian, which is written in the Cyrillic alphabet)
853 and languages using ideographic chararacters (such as Japanese)
854 require grouping specific to the languages and alphabets.
857 <para>The default indexing method is limited.
858 It can group accented characters in Latin-based languages only.
859 It cannot handle non-Latin alphabets or ideographic languages.
860 The other indexing methods require extensions of one type or
861 another, and do not work with
862 all XSLT processors, which is why they are not used by default.</para>
864 <para>The three choices for indexing method are:</para>
867 <term><literal>basic</literal></term>
870 (default) Sort and groups words based only on the Latin alphabet.
871 Words with accented Latin letters will group and sort with
872 their respective primary letter, but
873 words in non-Latin alphabets will be
874 put in the <quote>Symbols</quote> section of the index.
879 <term><literal>kosek</literal></term>
882 This method sorts and groups words based on letter groups configured in
883 the DocBook locale file for the given language.
884 See, for example, the French locale file <filename>common/fr.xml</filename>.
885 This method requires that the XSLT processor
886 supports the EXSLT extensions (most do).
887 It also requires support for using
888 user-defined functions in xsl:key (xsltproc does not).
890 <para>This method is suitable for any language for which you can
891 list all the individual characters that should appear
892 in each letter group in an index.
893 It is probably not practical to use it for ideographic languages
894 such as Chinese that have hundreds or thousands of characters.
897 <para>To use the kosek method, you must:</para>
901 <para>Use a processor that supports its extensions, such as
902 Saxon 6 or Xalan (xsltproc and Saxon 8 do not).
906 <para>Set the index.method parameter's value to <quote>kosek</quote>.
910 <para>Import the appropriate index extensions stylesheet module
911 <filename>fo/autoidx-kosek.xsl</filename> or
912 <filename>html/autoidx-kosek.xsl</filename> into your
921 <term><literal>kimber</literal></term>
924 This method uses extensions to the Saxon processor to implement
925 sophisticated indexing processes. It uses its own
926 configuration file, which can include information for any number of
927 languages. Each language's configuration can group
928 words using one of two processes. In the
929 enumerated process similar to that used in the kosek method,
930 you indicate the groupings character-by-character.
931 In the between-key process, you specify the
932 break-points in the sort order that should start a new group.
933 The latter configuration is useful for ideographic languages
934 such as Chinese, Japanese, and Korean.
935 You can also define your own collation algorithms and how you
936 want mixed Latin-alphabet words sorted.</para>
939 <para>For a whitepaper describing the extensions, see:
940 <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>.
944 <para>To download the extension library, see
945 <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>.
950 <para>To use the kimber method, you must:</para>
954 <para>Use Saxon (version 6 or 8) as your XSLT processor.
958 <para>Install and configure the Innodata Isogen library, using
959 the documentation that comes with it.
963 <para>Set the index.method parameter's value to <quote>kimber</quote>.
967 <para>Import the appropriate index extensions stylesheet module
968 <filename>fo/autoidx-kimber.xsl</filename> or
969 <filename>html/autoidx-kimber.xsl</filename> into your
982 <refentry version="5.0" xml:id="index.on.type">
984 <refentrytitle>index.on.type</refentrytitle>
985 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
988 <refname>index.on.type</refname>
989 <refpurpose>Select indexterms based on <tag class="attribute">type</tag>
990 attribute value</refpurpose>
994 <programlisting xml:id="index.on.type.frag">
995 <xsl:param name="index.on.type" select="0"></xsl:param>
999 <refsection><info><title>Description</title></info>
1003 then an <tag>index</tag> element that has a
1004 <tag class="attribute">type</tag> attribute
1005 value will contain only those <tag>indexterm</tag>
1006 elements with a matching <tag class="attribute">type</tag> attribute value.
1007 If an <tag>index</tag> has no <tag class="attribute">type</tag>
1008 attribute or it is blank, then the index will contain
1009 all <tag>indexterm</tag>s in the current scope.
1013 If <literal>index.on.type</literal> is zero, then the
1014 <tag class="attribute">type</tag> attribute has no effect
1015 on selecting indexterms for an index.
1018 <para>For those using DocBook version 4.2 or earlier,
1019 the <tag class="attribute">type</tag> attribute is not available
1020 for index terms. However, you can achieve the same
1021 effect by using the <tag class="attribute">role</tag> attribute
1022 in the same manner on <tag>indexterm</tag>
1023 and <tag>index</tag>, and setting the stylesheet parameter
1024 <parameter>index.on.role</parameter> to a nonzero value.
1030 <refentry version="5.0" xml:id="index.on.role">
1032 <refentrytitle>index.on.role</refentrytitle>
1033 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
1036 <refname>index.on.role</refname>
1037 <refpurpose>Select indexterms based on <tag class="attribute">role</tag> value</refpurpose>
1041 <programlisting xml:id="index.on.role.frag">
1042 <xsl:param name="index.on.role" select="0"></xsl:param>
1046 <refsection><info><title>Description</title></info>
1050 then an <tag>index</tag> element that has a
1051 <tag class="attribute">role</tag> attribute
1052 value will contain only those <tag>indexterm</tag>
1053 elements with a matching role value.
1054 If an <tag>index</tag> has no <tag class="attribute">role</tag>
1055 attribute or it is blank, then the index will contain
1056 all <tag>indexterm</tag>s in the current scope.
1059 If <literal>index.on.role</literal> is zero, then the
1060 <tag class="attribute">role</tag> attribute has no effect
1061 on selecting indexterms for an index.
1064 <para>If you are using DocBook version 4.3 or later, you should
1065 use the <tag class="attribute">type</tag> attribute instead of <tag class="attribute">role</tag>
1066 on <tag>indexterm</tag> and <tag>index</tag>,
1067 and set the <parameter>index.on.type</parameter> to a nonzero
1074 <refentry version="5.0" xml:id="index.preferred.page.properties">
1076 <refentrytitle>index.preferred.page.properties</refentrytitle>
1077 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
1080 <refname>index.preferred.page.properties</refname>
1081 <refpurpose>Properties used to emphasize page number references for
1082 significant index terms</refpurpose>
1086 <programlisting xml:id="index.preferred.page.properties.frag">
1087 <xsl:attribute-set name="index.preferred.page.properties">
1088 <xsl:attribute name="font-weight">bold</xsl:attribute>
1089 </xsl:attribute-set>
1093 <refsection><info><title>Description</title></info>
1095 <para>Properties used to emphasize page number references for
1096 significant index terms (<tag class="attribute">significance</tag>=<tag class="attvalue">preferred</tag>). Currently works only with
1102 <refentry version="5.0" xml:id="index.entry.properties">
1104 <refentrytitle>index.entry.properties</refentrytitle>
1105 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
1108 <refname>index.entry.properties</refname>
1109 <refpurpose>Properties applied to the formatted entries
1110 in an index</refpurpose>
1114 <programlisting xml:id="index.entry.properties.frag">
1115 <xsl:attribute-set name="index.entry.properties">
1116 <xsl:attribute name="start-indent">0pt</xsl:attribute>
1117 </xsl:attribute-set>
1121 <refsection><info><title>Description</title></info>
1123 <para>This attribute set is applied to the block containing
1124 the entries in a letter division in an index. It can be used to set the
1125 font-size, font-family, and other inheritable properties that will be
1126 applied to all index entries.</para>
1131 <refentry version="5.0" xml:id="index.div.title.properties">
1133 <refentrytitle>index.div.title.properties</refentrytitle>
1134 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
1137 <refname>index.div.title.properties</refname>
1138 <refpurpose>Properties associated with the letter headings in an
1143 <programlisting xml:id="index.div.title.properties.frag">
1144 <xsl:attribute-set name="index.div.title.properties">
1145 <xsl:attribute name="margin-{$direction.align.start}">0pt</xsl:attribute>
1146 <xsl:attribute name="font-size">14.4pt</xsl:attribute>
1147 <xsl:attribute name="font-family"><xsl:value-of select="$title.fontset"></xsl:value-of></xsl:attribute>
1148 <xsl:attribute name="font-weight">bold</xsl:attribute>
1149 <xsl:attribute name="keep-with-next.within-column">always</xsl:attribute>
1150 <xsl:attribute name="space-before.optimum"><xsl:value-of select="concat($body.font.master,'pt')"></xsl:value-of></xsl:attribute>
1151 <xsl:attribute name="space-before.minimum"><xsl:value-of select="concat($body.font.master,'pt * 0.8')"></xsl:value-of></xsl:attribute>
1152 <xsl:attribute name="space-before.maximum"><xsl:value-of select="concat($body.font.master,'pt * 1.2')"></xsl:value-of></xsl:attribute>
1153 <xsl:attribute name="start-indent">0pt</xsl:attribute>
1154 </xsl:attribute-set>
1158 <refsection><info><title>Description</title></info>
1160 <para>This attribute set is used on the letter headings that separate
1161 the divisions in an index.</para>
1166 <refentry version="5.0" xml:id="index.number.separator">
1168 <refentrytitle>index.number.separator</refentrytitle>
1169 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
1172 <refname>index.number.separator</refname>
1173 <refpurpose>Override for punctuation separating page numbers in index</refpurpose>
1177 <programlisting xml:id="index.number.separator.frag">
1178 <xsl:param name="index.number.separator"></xsl:param>
1182 <refsection><info><title>Description</title></info>
1184 <para>This parameter permits you to override the text to insert between
1185 page references in a formatted index entry. Typically
1186 that would be a comma and a space.
1189 <para>Because this text may be locale dependent,
1190 this parameter's value is normally taken from a gentext
1191 template named 'number-separator' in the
1192 context 'index' in the stylesheet
1193 locale file for the language
1194 of the current document.
1195 This parameter can be used to override the gentext string,
1196 and would typically be used on the command line.
1197 This parameter would apply to all languages.
1200 <para>So this text string can be customized in two ways.
1201 You can reset the default gentext string using
1202 the <parameter>local.l10n.xml</parameter> parameter, or you can
1203 override the gentext with the content of this parameter.
1204 The content can be a simple string, or it can be
1205 something more complex such as a call-template.
1208 <para>In HTML index output, section title references are used instead of
1209 page number references. This punctuation appears between
1210 such section titles in an HTML index.
1216 <refentry version="5.0" xml:id="index.range.separator">
1218 <refentrytitle>index.range.separator</refentrytitle>
1219 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
1222 <refname>index.range.separator</refname>
1223 <refpurpose>Override for punctuation separating the two numbers
1224 in a page range in index</refpurpose>
1228 <programlisting xml:id="index.range.separator.frag">
1229 <xsl:param name="index.range.separator"></xsl:param>
1233 <refsection><info><title>Description</title></info>
1235 <para>This parameter permits you
1236 to override the text to insert between
1237 the two numbers of a page range in an index.
1238 This parameter is only used by those XSL-FO processors
1239 that support an extension for generating such page ranges
1240 (such as XEP).</para>
1242 <para>Because this text may be locale dependent,
1243 this parameter's value is normally taken from a gentext
1244 template named 'range-separator' in the
1245 context 'index' in the stylesheet
1246 locale file for the language
1247 of the current document.
1248 This parameter can be used to override the gentext string,
1249 and would typically be used on the command line.
1250 This parameter would apply to all languages.
1253 <para>So this text string can be customized in two ways.
1254 You can reset the default gentext string using
1255 the <parameter>local.l10n.xml</parameter> parameter, or you can
1256 override the gentext with the content of this parameter.
1257 The content can be a simple string, or it can be
1258 something more complex such as a call-template.
1261 <para>In HTML index output, section title references are used instead of
1262 page number references. So there are no page ranges
1263 and this parameter has no effect.
1269 <refentry version="5.0" xml:id="index.term.separator">
1271 <refentrytitle>index.term.separator</refentrytitle>
1272 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
1275 <refname>index.term.separator</refname>
1276 <refpurpose>Override for punctuation separating an index term
1277 from its list of page references in an index</refpurpose>
1281 <programlisting xml:id="index.term.separator.frag">
1282 <xsl:param name="index.term.separator"></xsl:param>
1286 <refsection><info><title>Description</title></info>
1288 <para>This parameter permits you to override
1289 the text to insert between
1290 the end of an index term and its list of page references.
1291 Typically that might be a comma and a space.
1294 <para>Because this text may be locale dependent,
1295 this parameter's value is normally taken from a gentext
1296 template named 'term-separator' in the
1297 context 'index' in the stylesheet
1298 locale file for the language
1299 of the current document.
1300 This parameter can be used to override the gentext string,
1301 and would typically be used on the command line.
1302 This parameter would apply to all languages.
1305 <para>So this text string can be customized in two ways.
1306 You can reset the default gentext string using
1307 the <parameter>local.l10n.xml</parameter> parameter, or you can
1308 fill in the content for this normally empty
1310 The content can be a simple string, or it can be
1311 something more complex such as a call-template.
1312 For fo output, it could be an <tag>fo:leader</tag>
1313 element to provide space of a specific length, or a dot leader.
1319 <refentry version="5.0" xml:id="xep.index.item.properties">
1321 <refentrytitle>xep.index.item.properties</refentrytitle>
1322 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
1325 <refname>xep.index.item.properties</refname>
1326 <refpurpose>Properties associated with XEP index-items</refpurpose>
1330 <programlisting xml:id="xep.index.item.properties.frag">
1331 <xsl:attribute-set name="xep.index.item.properties" use-attribute-sets="index.page.number.properties">
1332 <xsl:attribute name="merge-subsequent-page-numbers">true</xsl:attribute>
1333 <xsl:attribute name="link-back">true</xsl:attribute>
1334 </xsl:attribute-set>
1338 <refsection><info><title>Description</title></info>
1340 <para>Properties associated with XEP index-items, which generate
1341 page numbers in an index processed by XEP. For more info see
1342 the XEP documentation section "Indexes" in
1343 <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>
1345 <para>This attribute-set also adds by default any properties from the
1346 <tag class="attribute">index.page.number.properties</tag>
1347 attribute-set.</para>
1351 <refentry version="5.0" xml:id="toc.section.depth">
1353 <refentrytitle>toc.section.depth</refentrytitle>
1354 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
1357 <refname>toc.section.depth</refname>
1358 <refpurpose>How deep should recursive <tag>section</tag>s appear
1359 in the TOC?</refpurpose>
1363 <programlisting xml:id="toc.section.depth.frag"><xsl:param name="toc.section.depth">2</xsl:param></programlisting>
1366 <refsection><info><title>Description</title></info>
1368 <para>Specifies the depth to which recursive sections should appear in the
1375 <refentry version="5.0" xml:id="toc.max.depth">
1377 <refentrytitle>toc.max.depth</refentrytitle>
1378 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
1381 <refname>toc.max.depth</refname>
1382 <refpurpose>How many levels should be created for each TOC?</refpurpose>
1386 <programlisting xml:id="toc.max.depth.frag"><xsl:param name="toc.max.depth">8</xsl:param></programlisting>
1389 <refsection><info><title>Description</title></info>
1391 <para>Specifies the maximal depth of TOC on all levels.</para>
1396 <refentry version="5.0" xml:id="toc.indent.width">
1398 <refentrytitle>toc.indent.width</refentrytitle>
1399 <refmiscinfo class="other" otherclass="datatype">float</refmiscinfo>
1402 <refname>toc.indent.width</refname>
1403 <refpurpose>Amount of indentation for TOC entries</refpurpose>
1407 <programlisting xml:id="toc.indent.width.frag">
1408 <xsl:param name="toc.indent.width">24</xsl:param>
1409 <!-- inconsistant point specification? -->
1413 <refsection><info><title>Description</title></info>
1415 <para>Specifies, in points, the distance by which each level of the
1416 TOC is indented from its parent.</para>
1418 <para>This value is expressed in points, without
1419 a unit (in other words, it is a bare number). Using a bare number allows the stylesheet
1420 to perform calculations that would otherwise have to be performed by the FO processor
1421 because not all processors support expressions.</para>
1426 <refentry version="5.0" xml:id="toc.line.properties">
1428 <refentrytitle>toc.line.properties</refentrytitle>
1429 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
1432 <refname>toc.line.properties</refname>
1433 <refpurpose>Properties for lines in ToCs and LoTs</refpurpose>
1437 <programlisting xml:id="toc.line.properties.frag">
1438 <xsl:attribute-set name="toc.line.properties">
1439 <xsl:attribute name="text-align-last">justify</xsl:attribute>
1440 <xsl:attribute name="text-align">start</xsl:attribute>
1441 <xsl:attribute name="end-indent"><xsl:value-of select="concat($toc.indent.width, 'pt')"></xsl:value-of></xsl:attribute>
1442 <xsl:attribute name="last-line-end-indent"><xsl:value-of select="concat('-', $toc.indent.width, 'pt')"></xsl:value-of></xsl:attribute>
1443 </xsl:attribute-set>
1447 <refsection><info><title>Description</title></info>
1449 <para>Properties which are applied to every line in ToC (or LoT). You can
1450 modify them in order to change appearance of all, or some lines. For
1451 example, in order to make lines for chapters bold, specify the
1452 following in your customization layer:</para>
1454 <programlisting><xsl:attribute-set name="toc.line.properties">
1455 <xsl:attribute name="font-weight">
1457 <xsl:when test="self::chapter">bold</xsl:when>
1458 <xsl:otherwise>normal</xsl:otherwise>
1460 </xsl:attribute>
1461 </xsl:attribute-set></programlisting>
1466 <refentry version="5.0" xml:id="toc.margin.properties">
1468 <refentrytitle>toc.margin.properties</refentrytitle>
1469 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
1472 <refname>toc.margin.properties</refname>
1473 <refpurpose>Margin properties used on Tables of Contents</refpurpose>
1477 <programlisting xml:id="toc.margin.properties.frag">
1478 <xsl:attribute-set name="toc.margin.properties">
1479 <xsl:attribute name="space-before.minimum">0.5em</xsl:attribute>
1480 <xsl:attribute name="space-before.optimum">1em</xsl:attribute>
1481 <xsl:attribute name="space-before.maximum">2em</xsl:attribute>
1482 <xsl:attribute name="space-after.minimum">0.5em</xsl:attribute>
1483 <xsl:attribute name="space-after.optimum">1em</xsl:attribute>
1484 <xsl:attribute name="space-after.maximum">2em</xsl:attribute>
1485 </xsl:attribute-set>
1489 <refsection><info><title>Description</title></info>
1490 <para>This attribute set is used on Tables of Contents. These attributes are set
1491 on the wrapper that surrounds the ToC block, not on each individual lines.</para>
1495 <refentry version="5.0" xml:id="bridgehead.in.toc">
1497 <refentrytitle>bridgehead.in.toc</refentrytitle>
1498 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
1501 <refname>bridgehead.in.toc</refname>
1502 <refpurpose>Should bridgehead elements appear in the TOC?</refpurpose>
1506 <programlisting xml:id="bridgehead.in.toc.frag"><xsl:param name="bridgehead.in.toc" select="0"></xsl:param></programlisting>
1509 <refsection><info><title>Description</title></info>
1511 <para>If non-zero, <tag>bridgehead</tag>s appear in the TOC. Note that
1512 this option is not fully supported and may be removed in a future
1513 version of the stylesheets.
1519 <refentry version="5.0" xml:id="simplesect.in.toc">
1521 <refentrytitle>simplesect.in.toc</refentrytitle>
1522 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
1525 <refname>simplesect.in.toc</refname>
1526 <refpurpose>Should <tag>simplesect</tag> elements appear in the TOC?</refpurpose>
1530 <programlisting xml:id="simplesect.in.toc.frag"><xsl:param name="simplesect.in.toc" select="0"></xsl:param></programlisting>
1533 <refsection><info><title>Description</title></info>
1535 <para>If non-zero, <tag>simplesect</tag>s will be included in the TOC.
1541 <refentry version="5.0" xml:id="generate.section.toc.level">
1543 <refentrytitle>generate.section.toc.level</refentrytitle>
1544 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
1547 <refname>generate.section.toc.level</refname>
1548 <refpurpose>Control depth of TOC generation in sections</refpurpose>
1552 <programlisting xml:id="generate.section.toc.level.frag">
1553 <xsl:param name="generate.section.toc.level" select="0"></xsl:param>
1557 <refsection><info><title>Description</title></info>
1559 <para>The <parameter>generate.section.toc.level</parameter> parameter
1560 controls the depth of <tag>section</tag> in which TOCs will be generated. Note
1561 that this is related to, but not the same as
1562 <parameter>toc.section.depth</parameter>, which controls the depth to
1563 which TOC entries will be generated in a given TOC.</para>
1564 <para>If, for example, <parameter>generate.section.toc.level</parameter>
1565 is <literal>3</literal>, TOCs will be generated in first, second, and third
1566 level sections, but not in fourth level sections.
1576 <reference xml:id="fo_ext"><title>Processor Extensions</title>
1577 <refentry version="5.0" xml:id="arbortext.extensions">
1579 <refentrytitle>arbortext.extensions</refentrytitle>
1580 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
1583 <refname>arbortext.extensions</refname>
1584 <refpurpose>Enable Arbortext extensions?</refpurpose>
1588 <programlisting xml:id="arbortext.extensions.frag"><xsl:param name="arbortext.extensions" select="0"></xsl:param></programlisting>
1591 <refsection><info><title>Description</title></info>
1594 <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://www.arbortext.com/">Arbortext</link>
1595 extensions will be used.
1597 <para>This parameter can also affect which graphics file formats
1598 are supported</para>
1603 <refentry version="5.0" xml:id="axf.extensions">
1605 <refentrytitle>axf.extensions</refentrytitle>
1606 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
1609 <refname>axf.extensions</refname>
1610 <refpurpose>Enable XSL Formatter extensions?</refpurpose>
1614 <programlisting xml:id="axf.extensions.frag">
1615 <xsl:param name="axf.extensions" select="0"></xsl:param>
1619 <refsection><info><title>Description</title></info>
1622 <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://www.antennahouse.com/">XSL Formatter</link>
1623 extensions will be used. XSL Formatter extensions consists of PDF bookmarks,
1624 document information and better index processing.</para>
1626 <para>This parameter can also affect which graphics file formats
1627 are supported</para>
1632 <refentry version="5.0" xml:id="fop.extensions">
1634 <refentrytitle>fop.extensions</refentrytitle>
1635 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
1638 <refname>fop.extensions</refname>
1639 <refpurpose>Enable extensions for FOP version 0.20.5 and earlier</refpurpose>
1643 <programlisting xml:id="fop.extensions.frag"><xsl:param name="fop.extensions" select="0"></xsl:param></programlisting>
1646 <refsection><info><title>Description</title></info>
1648 <para>If non-zero, extensions intended for
1649 <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://xml.apache.org/fop/">FOP</link>
1650 version 0.20.5 and earlier will be used.
1651 At present, this consists of PDF bookmarks.
1654 <para>This parameter can also affect which graphics file formats
1655 are supported.</para>
1657 <para>If you are using a version of FOP beyond
1658 version 0.20.5, then use the <parameter>fop1.extensions</parameter> parameter
1664 <refentry version="5.0" xml:id="fop1.extensions">
1666 <refentrytitle>fop1.extensions</refentrytitle>
1667 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
1670 <refname>fop1.extensions</refname>
1671 <refpurpose>Enable extensions for FOP version 0.90 and later</refpurpose>
1675 <programlisting xml:id="fop1.extensions.frag"><xsl:param name="fop1.extensions" select="0"></xsl:param></programlisting>
1678 <refsection><info><title>Description</title></info>
1680 <para>If non-zero, extensions for
1681 <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://xml.apache.org/fop/">FOP</link>
1682 version 0.90 and later will be used.
1685 <para>This parameter can also affect which graphics file formats
1686 are supported.</para>
1688 <para>The original <parameter>fop.extensions</parameter> parameter
1689 should still be used for FOP version 0.20.5 and earlier.
1694 <refentry version="5.0" xml:id="passivetex.extensions">
1696 <refentrytitle>passivetex.extensions</refentrytitle>
1697 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
1700 <refname>passivetex.extensions</refname>
1701 <refpurpose>Enable PassiveTeX extensions?</refpurpose>
1705 <programlisting xml:id="passivetex.extensions.frag"><xsl:param name="passivetex.extensions" select="0"></xsl:param></programlisting>
1708 <refsection><info><title>Description</title></info>
1711 <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://www.tei-c.org.uk/Software/passivetex/">PassiveTeX</link>
1712 extensions will be used. At present, this consists of PDF bookmarks
1713 and sorted index terms.
1716 <para>This parameter can also affect which graphics file formats
1717 are supported</para>
1720 <para>PassiveTeX is incomplete and development has ceased. In most cases,
1721 another XSL-FO engine is probably a better choice.</para>
1727 <refentry version="5.0" xml:id="tex.math.in.alt">
1729 <refentrytitle>tex.math.in.alt</refentrytitle>
1730 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
1731 <refmiscinfo class="other" otherclass="value">plain</refmiscinfo>
1732 <refmiscinfo class="other" otherclass="value">latex</refmiscinfo>
1735 <refname>tex.math.in.alt</refname>
1736 <refpurpose>TeX notation used for equations</refpurpose>
1740 <programlisting xml:id="tex.math.in.alt.frag">
1741 <xsl:param name="tex.math.in.alt"></xsl:param>
1745 <refsection><info><title>Description</title></info>
1747 <para>If you want type math directly in TeX notation in equations,
1748 this parameter specifies notation used. Currently are supported two
1749 values -- <literal>plain</literal> and <literal>latex</literal>. Empty
1750 value means that you are not using TeX math at all.</para>
1752 <para>Preferred way for including TeX alternative of math is inside of
1753 <tag>textobject</tag> element. Eg.:</para>
1755 <programlisting><inlineequation>
1756 <inlinemediaobject>
1758 <imagedata fileref="eq1.gif"/>
1759 </imageobject>
1760 <textobject><phrase>E=mc squared</phrase></textobject>
1761 <textobject role="tex"><phrase>E=mc^2</phrase></textobject>
1762 </inlinemediaobject>
1763 </inlineequation></programlisting>
1765 <para>If you are using <tag>graphic</tag> element, you can
1766 store TeX inside <tag>alt</tag> element:</para>
1768 <programlisting><inlineequation>
1769 <alt role="tex">a^2+b^2=c^2</alt>
1770 <graphic fileref="a2b2c2.gif"/>
1771 </inlineequation></programlisting>
1773 <para>If you want use this feature, you should process your FO with
1774 PassiveTeX, which only supports TeX math notation. When calling
1775 stylsheet, don't forget to specify also
1776 passivetex.extensions=1.</para>
1778 <para>If you want equations in HTML, just process generated file
1779 <filename>tex-math-equations.tex</filename> by TeX or LaTeX. Then run
1780 dvi2bitmap program on result DVI file. You will get images for
1781 equations in your document.</para>
1784 <para>This feature is useful for print/PDF output only if you
1785 use the obsolete and now unsupported PassiveTeX XSL-FO
1791 <refsection><info><title>Related Parameters</title></info>
1792 <para><parameter>tex.math.delims</parameter>,
1793 <parameter>passivetex.extensions</parameter>,
1794 <parameter>tex.math.file</parameter></para>
1799 <refentry version="5.0" xml:id="tex.math.delims">
1801 <refentrytitle>tex.math.delims</refentrytitle>
1802 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
1805 <refname>tex.math.delims</refname>
1806 <refpurpose>Should equations output for processing by TeX be
1807 surrounded by math mode delimiters?</refpurpose>
1811 <programlisting xml:id="tex.math.delims.frag">
1812 <xsl:param name="tex.math.delims" select="1"></xsl:param>
1816 <refsection><info><title>Description</title></info>
1818 <para>For compatibility with DSSSL based DBTeXMath from Allin Cottrell
1819 you should set this parameter to 0.</para>
1822 <para>This feature is useful for print/PDF output only if you
1823 use the obsolete and now unsupported PassiveTeX XSL-FO
1828 <refsection><info><title>Related Parameters</title></info>
1829 <para><parameter>tex.math.in.alt</parameter>,
1830 <parameter>passivetex.extensions</parameter></para>
1833 <refsection><info><title>See Also</title></info>
1834 <para>You can also use the <tag class="xmlpi">dbtex delims</tag> processing
1835 instruction to control whether delimiters are output.</para>
1841 <refentry version="5.0" xml:id="xep.extensions">
1843 <refentrytitle>xep.extensions</refentrytitle>
1844 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
1847 <refname>xep.extensions</refname>
1848 <refpurpose>Enable XEP extensions?</refpurpose>
1852 <programlisting xml:id="xep.extensions.frag"><xsl:param name="xep.extensions" select="0"></xsl:param></programlisting>
1855 <refsection><info><title>Description</title></info>
1858 <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://www.renderx.com/">XEP</link>
1859 extensions will be used. XEP extensions consists of PDF bookmarks,
1860 document information and better index processing.
1863 <para>This parameter can also affect which graphics file formats
1864 are supported</para>
1869 <reference xml:id="dbk_ext"><title>Stylesheet Extensions</title>
1870 <refentry version="5.0" xml:id="linenumbering.everyNth">
1872 <refentrytitle>linenumbering.everyNth</refentrytitle>
1873 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
1876 <refname>linenumbering.everyNth</refname>
1877 <refpurpose>Indicate which lines should be numbered</refpurpose>
1881 <programlisting xml:id="linenumbering.everyNth.frag">
1882 <xsl:param name="linenumbering.everyNth">5</xsl:param>
1886 <refsection><info><title>Description</title></info>
1888 <para>If line numbering is enabled, everyNth line will be
1889 numbered. Note that numbering is one based, not zero based.
1895 <refentry version="5.0" xml:id="linenumbering.extension">
1897 <refentrytitle>linenumbering.extension</refentrytitle>
1898 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
1901 <refname>linenumbering.extension</refname>
1902 <refpurpose>Enable the line numbering extension</refpurpose>
1906 <programlisting xml:id="linenumbering.extension.frag">
1907 <xsl:param name="linenumbering.extension" select="1"></xsl:param>
1911 <refsection><info><title>Description</title></info>
1913 <para>If non-zero, verbatim environments (<tag>address</tag>, <tag>literallayout</tag>,
1914 <tag>programlisting</tag>, <tag>screen</tag>, <tag>synopsis</tag>) that specify line numbering will
1921 <refentry version="5.0" xml:id="linenumbering.separator">
1923 <refentrytitle>linenumbering.separator</refentrytitle>
1924 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
1927 <refname>linenumbering.separator</refname>
1928 <refpurpose>Specify a separator between line numbers and lines</refpurpose>
1932 <programlisting xml:id="linenumbering.separator.frag">
1933 <xsl:param name="linenumbering.separator"><xsl:text> </xsl:text></xsl:param>
1937 <refsection><info><title>Description</title></info>
1939 <para>The separator is inserted between line numbers and lines in the
1940 verbatim environment. The default value is a single white space.
1941 Note the interaction with <parameter>linenumbering.width</parameter>
1947 <refentry version="5.0" xml:id="linenumbering.width">
1949 <refentrytitle>linenumbering.width</refentrytitle>
1950 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
1953 <refname>linenumbering.width</refname>
1954 <refpurpose>Indicates the width of line numbers</refpurpose>
1958 <programlisting xml:id="linenumbering.width.frag">
1959 <xsl:param name="linenumbering.width">3</xsl:param>
1963 <refsection><info><title>Description</title></info>
1965 <para>If line numbering is enabled, line numbers will appear right
1966 justified in a field "width" characters wide.
1972 <refentry version="5.0" xml:id="tablecolumns.extension">
1974 <refentrytitle>tablecolumns.extension</refentrytitle>
1975 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
1978 <refname>tablecolumns.extension</refname>
1979 <refpurpose>Enable the table columns extension function</refpurpose>
1983 <programlisting xml:id="tablecolumns.extension.frag">
1984 <xsl:param name="tablecolumns.extension" select="1"></xsl:param>
1988 <refsection><info><title>Description</title></info>
1990 <para>The table columns extension function adjusts the widths of table
1991 columns in the HTML result to more accurately reflect the specifications
1998 <refentry version="5.0" xml:id="textinsert.extension">
2000 <refentrytitle>textinsert.extension</refentrytitle>
2001 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
2004 <refname>textinsert.extension</refname>
2005 <refpurpose>Enables the textinsert extension element</refpurpose>
2008 <programlisting xml:id="textinsert.extension.frag">
2009 <xsl:param name="textinsert.extension" select="1"></xsl:param>
2012 <refsection><info><title>Description</title></info>
2013 <para>The textinsert extension element inserts the contents of
2014 a file into the result tree (as text).</para>
2016 <para>To use the textinsert extension element, you must use
2017 either Saxon or Xalan as your XSLT processor (it doesn’t
2018 work with xsltproc), along with either the DocBook Saxon
2019 extensions or DocBook Xalan extensions (for more
2020 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
2021 the <parameter>use.extensions</parameter> and
2022 <parameter>textinsert.extension</parameter> parameters to
2023 <literal>1</literal>.</para>
2024 <para>As an alternative to using the textinsert element,
2025 consider using an Xinclude element with the
2026 <literal>parse="text"</literal> attribute and value
2027 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>
2030 <refsection><info><title>See Also</title></info>
2031 <para>You can also use the <tag class="xmlpi">dbhtml-include href</tag> processing
2032 instruction to insert external files — both files containing
2033 plain text and files with markup content (including HTML
2036 <refsection><info><title>More information</title></info>
2037 <para>For how-to documentation on inserting contents of
2038 external code files and other text files into output, see
2039 <link xmlns:xlink="http://www.w3.org/1999/xlink" role="tcg" xlink:href="ExternalCode.html">External code files</link>.</para>
2040 <para>For guidelines on inserting contents of
2041 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>
2045 <refentry version="5.0" xml:id="textdata.default.encoding">
2047 <refentrytitle>textdata.default.encoding</refentrytitle>
2048 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
2051 <refname>textdata.default.encoding</refname>
2052 <refpurpose>Default encoding of external text files which are included
2053 using textdata element</refpurpose>
2057 <programlisting xml:id="textdata.default.encoding.frag">
2058 <xsl:param name="textdata.default.encoding"></xsl:param>
2062 <refsection><info><title>Description</title></info>
2064 <para>Specifies the encoding of any external text files included using
2065 <tag>textdata</tag> element. This value is used only when you do
2066 not specify encoding by the appropriate attribute
2067 directly on textdata. An empty string is interpreted as the system
2068 default encoding.</para>
2073 <refentry version="5.0" xml:id="use.extensions">
2075 <refentrytitle>use.extensions</refentrytitle>
2076 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
2079 <refname>use.extensions</refname>
2080 <refpurpose>Enable extensions</refpurpose>
2084 <programlisting xml:id="use.extensions.frag">
2085 <xsl:param name="use.extensions" select="0"></xsl:param>
2089 <refsection><info><title>Description</title></info>
2091 <para>If non-zero, extensions may be used. Each extension is
2092 further controlled by its own parameter. But if
2093 <parameter>use.extensions</parameter> is zero, no extensions will
2101 <reference xml:id="labels"><title>Automatic labelling</title>
2102 <refentry version="5.0" xml:id="appendix.autolabel">
2104 <refentrytitle>appendix.autolabel</refentrytitle>
2105 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
2106 <refmiscinfo class="other" otherclass="value">0<alt>none</alt></refmiscinfo>
2107 <refmiscinfo class="other" otherclass="value">1<alt>1,2,3...</alt></refmiscinfo>
2108 <refmiscinfo class="other" otherclass="value">A<alt>A,B,C...</alt></refmiscinfo>
2109 <refmiscinfo class="other" otherclass="value">a<alt>a,b,c...</alt></refmiscinfo>
2110 <refmiscinfo class="other" otherclass="value">i<alt>i,ii,iii...</alt></refmiscinfo>
2111 <refmiscinfo class="other" otherclass="value">I<alt>I,II,III...</alt></refmiscinfo>
2114 <refname>appendix.autolabel</refname>
2115 <refpurpose>Specifies the labeling format for Appendix titles</refpurpose>
2119 <programlisting xml:id="appendix.autolabel.frag">
2120 <xsl:param name="appendix.autolabel">A</xsl:param>
2124 <refsection><info><title>Description</title></info>
2126 <para>If non-zero, then appendices will be numbered using the
2127 parameter value as the number format if the value matches one of the
2133 <term>1 or arabic</term>
2135 <para>Arabic numeration (1, 2, 3 ...).</para>
2139 <term>A or upperalpha</term>
2141 <para>Uppercase letter numeration (A, B, C ...).</para>
2145 <term>a or loweralpha</term>
2147 <para>Lowercase letter numeration (a, b, c ...).</para>
2151 <term>I or upperroman</term>
2153 <para>Uppercase roman numeration (I, II, III ...).</para>
2157 <term>i or lowerroman</term>
2159 <para>Lowercase roman letter numeration (i, ii, iii ...).</para>
2164 <para>Any nonzero value other than the above will generate
2165 the default number format (upperalpha).
2171 <refentry version="5.0" xml:id="chapter.autolabel">
2173 <refentrytitle>chapter.autolabel</refentrytitle>
2174 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
2175 <refmiscinfo class="other" otherclass="value">0<alt>none</alt></refmiscinfo>
2176 <refmiscinfo class="other" otherclass="value">1<alt>1,2,3...</alt></refmiscinfo>
2177 <refmiscinfo class="other" otherclass="value">A<alt>A,B,C...</alt></refmiscinfo>
2178 <refmiscinfo class="other" otherclass="value">a<alt>a,b,c...</alt></refmiscinfo>
2179 <refmiscinfo class="other" otherclass="value">i<alt>i,ii,iii...</alt></refmiscinfo>
2180 <refmiscinfo class="other" otherclass="value">I<alt>I,II,III...</alt></refmiscinfo>
2183 <refname>chapter.autolabel</refname>
2184 <refpurpose>Specifies the labeling format for Chapter titles</refpurpose>
2188 <programlisting xml:id="chapter.autolabel.frag">
2189 <xsl:param name="chapter.autolabel" select="1"></xsl:param></programlisting>
2192 <refsection><info><title>Description</title></info>
2194 <para>If non-zero, then chapters will be numbered using the parameter
2195 value as the number format if the value matches one of the following:
2200 <term>1 or arabic</term>
2202 <para>Arabic numeration (1, 2, 3 ...).</para>
2206 <term>A or upperalpha</term>
2208 <para>Uppercase letter numeration (A, B, C ...).</para>
2212 <term>a or loweralpha</term>
2214 <para>Lowercase letter numeration (a, b, c ...).</para>
2218 <term>I or upperroman</term>
2220 <para>Uppercase roman numeration (I, II, III ...).</para>
2224 <term>i or lowerroman</term>
2226 <para>Lowercase roman letter numeration (i, ii, iii ...).</para>
2231 <para>Any nonzero value other than the above will generate
2232 the default number format (arabic).
2238 <refentry version="5.0" xml:id="part.autolabel">
2240 <refentrytitle>part.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>part.autolabel</refname>
2251 <refpurpose>Specifies the labeling format for Part titles</refpurpose>
2255 <programlisting xml:id="part.autolabel.frag">
2256 <xsl:param name="part.autolabel">I</xsl:param>
2260 <refsection><info><title>Description</title></info>
2262 <para>If non-zero, then parts will be numbered using the parameter
2263 value as the number format if the value matches one of the following:
2268 <term>1 or arabic</term>
2270 <para>Arabic numeration (1, 2, 3 ...).</para>
2274 <term>A or upperalpha</term>
2276 <para>Uppercase letter numeration (A, B, C ...).</para>
2280 <term>a or loweralpha</term>
2282 <para>Lowercase letter numeration (a, b, c ...).</para>
2286 <term>I or upperroman</term>
2288 <para>Uppercase roman numeration (I, II, III ...).</para>
2292 <term>i or lowerroman</term>
2294 <para>Lowercase roman letter numeration (i, ii, iii ...).</para>
2299 <para>Any nonzero value other than the above will generate
2300 the default number format (upperroman).
2307 <refentry version="5.0" xml:id="reference.autolabel">
2309 <refentrytitle>reference.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>reference.autolabel</refname>
2320 <refpurpose>Specifies the labeling format for Reference titles</refpurpose>
2323 <programlisting xml:id="reference.autolabel.frag">
2324 <xsl:param name="reference.autolabel">I</xsl:param>
2327 <refsection><info><title>Description</title></info>
2328 <para>If non-zero, references will be numbered using the parameter
2329 value as the number format if the value matches one of the
2334 <term>1 or arabic</term>
2336 <para>Arabic numeration (1, 2, 3 ...).</para>
2340 <term>A or upperalpha</term>
2342 <para>Uppercase letter numeration (A, B, C ...).</para>
2346 <term>a or loweralpha</term>
2348 <para>Lowercase letter numeration (a, b, c ...).</para>
2352 <term>I or upperroman</term>
2354 <para>Uppercase roman numeration (I, II, III ...).</para>
2358 <term>i or lowerroman</term>
2360 <para>Lowercase roman letter numeration (i, ii, iii ...).</para>
2364 <para>Any non-zero value other than the above will generate
2365 the default number format (upperroman).
2370 <refentry version="5.0" xml:id="preface.autolabel">
2372 <refentrytitle>preface.autolabel</refentrytitle>
2373 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
2374 <refmiscinfo class="other" otherclass="value">0<alt>none</alt></refmiscinfo>
2375 <refmiscinfo class="other" otherclass="value">1<alt>1,2,3...</alt></refmiscinfo>
2376 <refmiscinfo class="other" otherclass="value">A<alt>A,B,C...</alt></refmiscinfo>
2377 <refmiscinfo class="other" otherclass="value">a<alt>a,b,c...</alt></refmiscinfo>
2378 <refmiscinfo class="other" otherclass="value">i<alt>i,ii,iii...</alt></refmiscinfo>
2379 <refmiscinfo class="other" otherclass="value">I<alt>I,II,III...</alt></refmiscinfo>
2382 <refname>preface.autolabel</refname>
2383 <refpurpose>Specifices the labeling format for Preface titles</refpurpose>
2387 <programlisting xml:id="preface.autolabel.frag"><xsl:param name="preface.autolabel" select="0"></xsl:param></programlisting>
2390 <refsection><info><title>Description</title></info>
2392 <para>If non-zero then prefaces will be numbered using the parameter
2393 value as the number format if the value matches one of the following:
2398 <term>1 or arabic</term>
2400 <para>Arabic numeration (1, 2, 3 ...).</para>
2404 <term>A or upperalpha</term>
2406 <para>Uppercase letter numeration (A, B, C ...).</para>
2410 <term>a or loweralpha</term>
2412 <para>Lowercase letter numeration (a, b, c ...).</para>
2416 <term>I or upperroman</term>
2418 <para>Uppercase roman numeration (I, II, III ...).</para>
2422 <term>i or lowerroman</term>
2424 <para>Lowercase roman letter numeration (i, ii, iii ...).</para>
2429 <para>Any nonzero value other than the above will generate
2430 the default number format (arabic).
2437 <refentry version="5.0" xml:id="section.autolabel">
2439 <refentrytitle>section.autolabel</refentrytitle>
2440 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
2443 <refname>section.autolabel</refname>
2444 <refpurpose>Are sections enumerated?</refpurpose>
2448 <programlisting xml:id="section.autolabel.frag"><xsl:param name="section.autolabel" select="0"></xsl:param></programlisting>
2451 <refsection><info><title>Description</title></info>
2453 <para>If true (non-zero), unlabeled sections will be enumerated.
2459 <refentry version="5.0" xml:id="section.autolabel.max.depth">
2461 <refentrytitle>section.autolabel.max.depth</refentrytitle>
2462 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
2465 <refname>section.autolabel.max.depth</refname>
2466 <refpurpose>The deepest level of sections that are numbered.</refpurpose>
2470 <programlisting xml:id="section.autolabel.max.depth.frag">
2471 <xsl:param name="section.autolabel.max.depth">8</xsl:param>
2475 <refsection><info><title>Description</title></info>
2477 <para>When section numbering is turned on by the
2478 <parameter>section.autolabel</parameter> parameter, then this
2479 parameter controls the depth of <tag>section</tag> nesting that is
2480 numbered. Sections nested to a level deeper than this value will not
2487 <refentry version="5.0" xml:id="section.label.includes.component.label">
2489 <refentrytitle>section.label.includes.component.label</refentrytitle>
2490 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
2493 <refname>section.label.includes.component.label</refname>
2494 <refpurpose>Do section labels include the component label?</refpurpose>
2498 <programlisting xml:id="section.label.includes.component.label.frag"><xsl:param name="section.label.includes.component.label" select="0"></xsl:param></programlisting>
2501 <refsection><info><title>Description</title></info>
2503 <para>If non-zero, section labels are prefixed with the label of the
2504 component that contains them.
2510 <refentry version="5.0" xml:id="label.from.part">
2512 <refentrytitle>label.from.part</refentrytitle>
2513 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
2516 <refname>label.from.part</refname>
2517 <refpurpose>Renumber components in each part?</refpurpose>
2521 <programlisting xml:id="label.from.part.frag">
2522 <xsl:param name="label.from.part" select="0"></xsl:param>
2526 <refsection><info><title>Description</title></info>
2528 <para>If <parameter>label.from.part</parameter> is non-zero, then
2529 numbering of components — <tag>preface</tag>,
2530 <tag>chapter</tag>, <tag>appendix</tag>, and
2531 <tag>reference</tag> (when <tag>reference</tag> occurs at the
2532 component level) — is re-started within each
2533 <tag>part</tag>.</para>
2534 <para>If <parameter>label.from.part</parameter> is zero (the
2535 default), numbering of components is <emphasis>not</emphasis>
2536 re-started within each <tag>part</tag>; instead, components are
2537 numbered sequentially throughout each <tag>book</tag>,
2538 regardless of whether or not they occur within <tag>part</tag>
2544 <refentry version="5.0" xml:id="component.label.includes.part.label">
2546 <refentrytitle>component.label.includes.part.label</refentrytitle>
2547 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
2550 <refname>component.label.includes.part.label</refname>
2551 <refpurpose>Do component labels include the part label?</refpurpose>
2555 <programlisting xml:id="component.label.includes.part.label.frag"><xsl:param name="component.label.includes.part.label" select="0"></xsl:param></programlisting>
2558 <refsection><info><title>Description</title></info>
2560 <para>If non-zero, number labels for <tag>chapter</tag>,
2561 <tag>appendix</tag>, and other component elements are prefixed with
2562 the label of the part element that contains them. So you might see
2563 Chapter II.3 instead of Chapter 3. Also, the labels for formal
2564 elements such as <tag>table</tag> and <tag>figure</tag> will include
2565 the part label. If there is no part element container, then no prefix
2569 This feature is most useful when the
2570 <parameter>label.from.part</parameter> parameter is turned on.
2571 In that case, there would be more than one <tag>chapter</tag>
2572 <quote>1</quote>, and the extra part label prefix will identify
2573 each chapter unambiguously.
2580 <reference xml:id="xslt"><title>XSLT Processing</title>
2581 <refentry version="5.0" xml:id="rootid">
2583 <refentrytitle>rootid</refentrytitle>
2584 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
2587 <refname>rootid</refname>
2588 <refpurpose>Specify the root element to format</refpurpose>
2592 <programlisting xml:id="rootid.frag">
2593 <xsl:param name="rootid"></xsl:param></programlisting>
2596 <refsection><info><title>Description</title></info>
2598 <para>If <parameter>rootid</parameter> is not empty, it must be the
2599 value of an ID that occurs in the document being formatted. The entire
2600 document will be loaded and parsed, but formatting will begin at the
2601 element identified, rather than at the root. For example, this allows
2602 you to process only <tag>chapter</tag> 4 of a <tag>book</tag>.</para>
2603 <para>Because the entire document is available to the processor, automatic
2604 numbering, cross references, and other dependencies are correctly
2611 <reference xml:id="meta"><title>Meta/*Info</title>
2612 <refentry version="5.0" xml:id="make.single.year.ranges">
2614 <refentrytitle>make.single.year.ranges</refentrytitle>
2615 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
2618 <refname>make.single.year.ranges</refname>
2619 <refpurpose>Print single-year ranges (e.g., 1998-1999)</refpurpose>
2623 <programlisting xml:id="make.single.year.ranges.frag">
2624 <xsl:param name="make.single.year.ranges" select="0"></xsl:param></programlisting>
2627 <refsection><info><title>Description</title></info>
2629 <para>If non-zero, year ranges that span a single year will be printed
2630 in range notation (1998-1999) instead of discrete notation
2631 (1998, 1999).</para>
2636 <refentry version="5.0" xml:id="make.year.ranges">
2638 <refentrytitle>make.year.ranges</refentrytitle>
2639 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
2642 <refname>make.year.ranges</refname>
2643 <refpurpose>Collate copyright years into ranges?</refpurpose>
2647 <programlisting xml:id="make.year.ranges.frag"><xsl:param name="make.year.ranges" select="0"></xsl:param></programlisting>
2650 <refsection><info><title>Description</title></info>
2652 <para>If non-zero, multiple copyright <tag>year</tag> elements will be
2653 collated into ranges.
2654 This works only if each year number is put into a separate
2655 year element. The copyright element permits multiple
2656 year elements. If a year element contains a dash or
2657 a comma, then that year element will not be merged into
2664 <refentry version="5.0" xml:id="author.othername.in.middle">
2666 <refentrytitle>author.othername.in.middle</refentrytitle>
2667 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
2670 <refname>author.othername.in.middle</refname>
2671 <refpurpose>Is <tag>othername</tag> in <tag>author</tag> a
2672 middle name?</refpurpose>
2676 <programlisting xml:id="author.othername.in.middle.frag">
2677 <xsl:param name="author.othername.in.middle" select="1"></xsl:param></programlisting>
2680 <refsection><info><title>Description</title></info>
2682 <para>If non-zero, the <tag>othername</tag> of an <tag>author</tag>
2683 appears between the <tag>firstname</tag> and
2684 <tag>surname</tag>. Otherwise, <tag>othername</tag>
2692 <reference xml:id="refentry"><title>Reference Pages</title>
2693 <refentry version="5.0" xml:id="funcsynopsis.decoration">
2695 <refentrytitle>funcsynopsis.decoration</refentrytitle>
2696 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
2699 <refname>funcsynopsis.decoration</refname>
2700 <refpurpose>Decorate elements of a <tag>funcsynopsis</tag>?</refpurpose>
2704 <programlisting xml:id="funcsynopsis.decoration.frag">
2705 <xsl:param name="funcsynopsis.decoration" select="1"></xsl:param>
2709 <refsection><info><title>Description</title></info>
2711 <para>If non-zero, elements of the <tag>funcsynopsis</tag> will be
2712 decorated (e.g. rendered as bold or italic text). The decoration is controlled by
2713 templates that can be redefined in a customization layer.
2719 <refentry version="5.0" xml:id="funcsynopsis.style">
2721 <refentrytitle>funcsynopsis.style</refentrytitle>
2722 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
2723 <refmiscinfo class="other" otherclass="value">ansi</refmiscinfo>
2724 <refmiscinfo class="other" otherclass="value">kr</refmiscinfo>
2727 <refname>funcsynopsis.style</refname>
2728 <refpurpose>What style of <tag>funcsynopsis</tag> should be generated?</refpurpose>
2732 <programlisting xml:id="funcsynopsis.style.frag"><xsl:param name="funcsynopsis.style">kr</xsl:param></programlisting>
2735 <refsection><info><title>Description</title></info>
2737 <para>If <parameter>funcsynopsis.style</parameter> is <literal>ansi</literal>,
2738 ANSI-style function synopses are generated for a
2739 <tag>funcsynopsis</tag>, otherwise K&R-style
2740 function synopses are generated.
2746 <refentry version="5.0" xml:id="function.parens">
2748 <refentrytitle>function.parens</refentrytitle>
2749 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
2752 <refname>function.parens</refname>
2753 <refpurpose>Generate parens after a function?</refpurpose>
2757 <programlisting xml:id="function.parens.frag">
2758 <xsl:param name="function.parens" select="0"></xsl:param>
2762 <refsection><info><title>Description</title></info>
2764 <para>If non-zero, the formatting of a <tag>function</tag> element
2765 will include generated parentheses.
2771 <refentry version="5.0" xml:id="refentry.generate.name">
2773 <refentrytitle>refentry.generate.name</refentrytitle>
2774 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
2777 <refname>refentry.generate.name</refname>
2778 <refpurpose>Output NAME header before <tag>refname</tag>s?</refpurpose>
2782 <programlisting xml:id="refentry.generate.name.frag">
2783 <xsl:param name="refentry.generate.name" select="1"></xsl:param>
2787 <refsection><info><title>Description</title></info>
2789 <para>If non-zero, a "NAME" section title is output before the list
2790 of <tag>refname</tag>s. This parameter and
2791 <parameter>refentry.generate.title</parameter> are mutually
2792 exclusive. This means that if you change this parameter to zero, you
2793 should set <parameter>refentry.generate.title</parameter> to non-zero unless
2794 you want get quite strange output.
2800 <refentry version="5.0" xml:id="refentry.generate.title">
2802 <refentrytitle>refentry.generate.title</refentrytitle>
2803 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
2806 <refname>refentry.generate.title</refname>
2807 <refpurpose>Output title before <tag>refname</tag>s?</refpurpose>
2811 <programlisting xml:id="refentry.generate.title.frag">
2812 <xsl:param name="refentry.generate.title" select="0"></xsl:param>
2816 <refsection><info><title>Description</title></info>
2818 <para>If non-zero, the reference page title or first name is
2819 output before the list of <tag>refname</tag>s. This parameter and
2820 <parameter>refentry.generate.name</parameter> are mutually exclusive.
2821 This means that if you change this parameter to non-zero, you
2822 should set <parameter>refentry.generate.name</parameter> to zero unless
2823 you want get quite strange output.</para>
2829 <refentry version="5.0" xml:id="refentry.pagebreak">
2831 <refentrytitle>refentry.pagebreak</refentrytitle>
2832 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
2835 <refname>refentry.pagebreak</refname>
2836 <refpurpose>Start each refentry on a new page</refpurpose>
2840 <programlisting xml:id="refentry.pagebreak.frag"><xsl:param name="refentry.pagebreak" select="1"></xsl:param></programlisting>
2843 <refsection><info><title>Description</title></info>
2845 <para>If non-zero (the default), each <tag>refentry</tag>
2846 element will start on a new page. If zero, a page
2847 break will not be generated between <tag>refentry</tag> elements.
2848 The exception is when the <tag>refentry</tag> elements are children of
2849 a <tag>part</tag> element, in which case the page breaks are always
2850 retained. That is because a <tag>part</tag> element does not generate
2851 a page-sequence for its children, so each <tag>refentry</tag> must
2852 start its own page-sequence.
2858 <refentry version="5.0" xml:id="refentry.title.properties">
2860 <refentrytitle>refentry.title.properties</refentrytitle>
2861 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
2864 <refname>refentry.title.properties</refname>
2865 <refpurpose>Title properties for a refentry title</refpurpose>
2869 <programlisting xml:id="refentry.title.properties.frag">
2870 <xsl:attribute-set name="refentry.title.properties">
2871 <xsl:attribute name="font-family">
2872 <xsl:value-of select="$title.font.family"></xsl:value-of>
2873 </xsl:attribute>
2874 <xsl:attribute name="font-size">18pt</xsl:attribute>
2875 <xsl:attribute name="font-weight">bold</xsl:attribute>
2876 <xsl:attribute name="space-after">1em</xsl:attribute>
2877 <xsl:attribute name="hyphenate">false</xsl:attribute>
2878 <xsl:attribute name="keep-with-next.within-column">always</xsl:attribute>
2879 <xsl:attribute name="space-before.minimum">0.8em</xsl:attribute>
2880 <xsl:attribute name="space-before.optimum">1.0em</xsl:attribute>
2881 <xsl:attribute name="space-before.maximum">1.2em</xsl:attribute>
2882 <xsl:attribute name="space-after.optimum">0.5em</xsl:attribute>
2883 <xsl:attribute name="space-after.minimum">0.4em</xsl:attribute>
2884 <xsl:attribute name="space-after.maximum">0.6em</xsl:attribute>
2885 <xsl:attribute name="start-indent"><xsl:value-of select="$title.margin.left"></xsl:value-of></xsl:attribute>
2886 </xsl:attribute-set>
2890 <refsection><info><title>Description</title></info>
2892 <para>Formatting properties applied to the title generated for the
2893 <tag>refnamediv</tag> part of output for
2894 <tag>refentry</tag> when the value of the
2895 <parameter>refentry.generate.title</parameter> parameter is
2896 non-zero. The font size is supplied by the appropriate <parameter>section.level<replaceable>X</replaceable>.title.properties</parameter>
2897 attribute-set, computed from the location of the
2898 <tag>refentry</tag> in the section hierarchy.</para>
2901 <para>This parameter has no effect on the the title generated for
2902 the <tag>refnamediv</tag> part of output for
2903 <tag>refentry</tag> when the value of the
2904 <parameter>refentry.generate.name</parameter> parameter is
2905 non-zero. By default, that title is formatted with the same
2906 properties as the titles for all other first-level children of
2907 <tag>refentry</tag>.</para>
2913 <refentry version="5.0" xml:id="refentry.xref.manvolnum">
2915 <refentrytitle>refentry.xref.manvolnum</refentrytitle>
2916 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
2919 <refname>refentry.xref.manvolnum</refname>
2920 <refpurpose>Output <tag>manvolnum</tag> as part of
2921 <tag>refentry</tag> cross-reference?</refpurpose>
2925 <programlisting xml:id="refentry.xref.manvolnum.frag">
2926 <xsl:param name="refentry.xref.manvolnum" select="1"></xsl:param>
2930 <refsection><info><title>Description</title></info>
2932 <para>if non-zero, the <tag>manvolnum</tag> is used when cross-referencing
2933 <tag>refentry</tag>s, either with <tag>xref</tag>
2934 or <tag>citerefentry</tag>.
2940 <refentry version="5.0" xml:id="refclass.suppress">
2942 <refentrytitle>refclass.suppress</refentrytitle>
2943 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
2946 <refname>refclass.suppress</refname>
2947 <refpurpose>Suppress display of refclass contents?</refpurpose>
2951 <programlisting xml:id="refclass.suppress.frag">
2952 <xsl:param name="refclass.suppress" select="0"></xsl:param></programlisting>
2955 <refsection><info><title>Description</title></info>
2957 <para>If the value of <parameter>refclass.suppress</parameter> is
2958 non-zero, then display of <tag>refclass</tag> contents is
2959 suppressed in output.</para>
2965 <reference xml:id="tables"><title>Tables</title>
2966 <refentry version="5.0" xml:id="default.table.width">
2968 <refentrytitle>default.table.width</refentrytitle>
2969 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
2972 <refname>default.table.width</refname>
2973 <refpurpose>The default width of tables</refpurpose>
2976 <programlisting xml:id="default.table.width.frag">
2977 <xsl:param name="default.table.width"></xsl:param>
2980 <refsection><info><title>Description</title></info>
2981 <para>If non-zero, this value will be used for the
2982 <literal>width</literal> attribute on <tag>table</tag>s that do not specify an
2983 alternate width (with the <tag class="xmlpi">dbhtml table-width</tag> or
2984 <tag class="xmlpi">dbfo table-width</tag> processing instruction).</para>
2988 <refentry version="5.0" xml:id="nominal.table.width">
2990 <refentrytitle>nominal.table.width</refentrytitle>
2991 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
2994 <refname>nominal.table.width</refname>
2995 <refpurpose>The (absolute) nominal width of tables</refpurpose>
2999 <programlisting xml:id="nominal.table.width.frag">
3000 <xsl:param name="nominal.table.width">6in</xsl:param>
3004 <refsection><info><title>Description</title></info>
3006 <para>In order to convert CALS column widths into HTML column widths, it
3007 is sometimes necessary to have an absolute table width to use for conversion
3008 of mixed absolute and relative widths. This value must be an absolute
3009 length (not a percentage).</para>
3014 <refentry version="5.0" xml:id="default.table.frame">
3016 <refentrytitle>default.table.frame</refentrytitle>
3017 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
3020 <refname>default.table.frame</refname>
3021 <refpurpose>The default framing of tables</refpurpose>
3025 <programlisting xml:id="default.table.frame.frag">
3026 <xsl:param name="default.table.frame">all</xsl:param>
3030 <refsection><info><title>Description</title></info>
3032 <para>This value will be used when there is no frame attribute on the
3038 <refentry version="5.0" xml:id="default.table.rules">
3040 <refentrytitle>default.table.rules</refentrytitle>
3041 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
3044 <refname>default.table.rules</refname>
3045 <refpurpose>The default column and row rules for tables using HTML markup</refpurpose>
3049 <programlisting xml:id="default.table.rules.frag">
3050 <xsl:param name="default.table.rules">none</xsl:param>
3054 <refsection><info><title>Description</title></info>
3056 <para>Tables using HTML markup elements can use an attribute
3057 named <tag class="attribute">rules</tag> on the <tag>table</tag> or
3058 <tag>informaltable</tag> element
3059 to specify whether column and row border rules should be
3060 displayed. This parameter lets you specify a global default
3061 style for all HTML tables that don't otherwise have
3062 that attribute.</para>
3063 <para>These are the supported values:</para>
3066 <varlistentry><term>all</term>
3068 <para>Rules will appear between all rows and columns.</para>
3072 <varlistentry><term>rows</term>
3074 <para>Rules will appear between rows only.</para>
3078 <varlistentry><term>cols</term>
3080 <para>Rules will appear between columns only.</para>
3084 <varlistentry><term>groups</term>
3086 <para>Rules will appear between row groups (thead, tfoot, tbody).
3087 No support for rules between column groups yet.
3092 <varlistentry><term>none</term>
3094 <para>No rules. This is the default value.
3101 <para>The border after the last row and the border after
3102 the last column are not affected by
3103 this setting. Those borders are controlled by
3104 the <tag class="attribute">frame</tag> attribute on the table element.
3110 <refentry version="5.0" xml:id="table.cell.padding">
3112 <refentrytitle>table.cell.padding</refentrytitle>
3113 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
3116 <refname>table.cell.padding</refname>
3117 <refpurpose>Specifies the padding of table cells</refpurpose>
3121 <programlisting xml:id="table.cell.padding.frag">
3122 <xsl:attribute-set name="table.cell.padding">
3123 <xsl:attribute name="padding-start">2pt</xsl:attribute>
3124 <xsl:attribute name="padding-end">2pt</xsl:attribute>
3125 <xsl:attribute name="padding-top">2pt</xsl:attribute>
3126 <xsl:attribute name="padding-bottom">2pt</xsl:attribute>
3127 </xsl:attribute-set>
3131 <refsection><info><title>Description</title></info>
3133 <para>Specifies the padding of table cells.</para>
3138 <refentry version="5.0" xml:id="table.frame.border.thickness">
3140 <refentrytitle>table.frame.border.thickness</refentrytitle>
3141 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
3144 <refname>table.frame.border.thickness</refname>
3145 <refpurpose>Specifies the thickness of the frame border</refpurpose>
3149 <programlisting xml:id="table.frame.border.thickness.frag">
3150 <xsl:param name="table.frame.border.thickness">0.5pt</xsl:param>
3154 <refsection><info><title>Description</title></info>
3156 <para>Specifies the thickness of the border on the table's frame.</para>
3161 <refentry version="5.0" xml:id="table.frame.border.style">
3163 <refentrytitle>table.frame.border.style</refentrytitle>
3164 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
3165 <refmiscinfo class="other" otherclass="value">none</refmiscinfo>
3166 <refmiscinfo class="other" otherclass="value">solid</refmiscinfo>
3167 <refmiscinfo class="other" otherclass="value">dotted</refmiscinfo>
3168 <refmiscinfo class="other" otherclass="value">dashed</refmiscinfo>
3169 <refmiscinfo class="other" otherclass="value">double</refmiscinfo>
3170 <refmiscinfo class="other" otherclass="value">groove</refmiscinfo>
3171 <refmiscinfo class="other" otherclass="value">ridge</refmiscinfo>
3172 <refmiscinfo class="other" otherclass="value">inset</refmiscinfo>
3173 <refmiscinfo class="other" otherclass="value">outset</refmiscinfo>
3174 <refmiscinfo class="other" otherclass="value">solid</refmiscinfo>
3177 <refname>table.frame.border.style</refname>
3178 <refpurpose>Specifies the border style of table frames</refpurpose>
3182 <programlisting xml:id="table.frame.border.style.frag">
3183 <xsl:param name="table.frame.border.style">solid</xsl:param>
3187 <refsection><info><title>Description</title></info>
3189 <para>Specifies the border style of table frames.</para>
3194 <refentry version="5.0" xml:id="table.frame.border.color">
3196 <refentrytitle>table.frame.border.color</refentrytitle>
3197 <refmiscinfo class="other" otherclass="datatype">color</refmiscinfo>
3200 <refname>table.frame.border.color</refname>
3201 <refpurpose>Specifies the border color of table frames</refpurpose>
3205 <programlisting xml:id="table.frame.border.color.frag">
3207 <xsl:param name="table.frame.border.color">black</xsl:param>
3211 <refsection><info><title>Description</title></info>
3213 <para>Specifies the border color of table frames.</para>
3218 <refentry version="5.0" xml:id="table.cell.border.thickness">
3220 <refentrytitle>table.cell.border.thickness</refentrytitle>
3221 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
3224 <refname>table.cell.border.thickness</refname>
3225 <refpurpose>Specifies the thickness of table cell borders</refpurpose>
3229 <programlisting xml:id="table.cell.border.thickness.frag">
3230 <xsl:param name="table.cell.border.thickness">0.5pt</xsl:param>
3234 <refsection><info><title>Description</title></info>
3236 <para>If non-zero, specifies the thickness of borders on table
3237 cells. The units are points. See <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://www.w3.org/TR/CSS21/box.html#border-width-properties">
3241 <para>To control properties of cell borders in HTML output, you must also turn on the
3242 <parameter>table.borders.with.css</parameter> parameter.</para>
3248 <refentry version="5.0" xml:id="table.cell.border.style">
3250 <refentrytitle>table.cell.border.style</refentrytitle>
3251 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
3252 <refmiscinfo class="other" otherclass="value">none</refmiscinfo>
3253 <refmiscinfo class="other" otherclass="value">solid</refmiscinfo>
3254 <refmiscinfo class="other" otherclass="value">dotted</refmiscinfo>
3255 <refmiscinfo class="other" otherclass="value">dashed</refmiscinfo>
3256 <refmiscinfo class="other" otherclass="value">double</refmiscinfo>
3257 <refmiscinfo class="other" otherclass="value">groove</refmiscinfo>
3258 <refmiscinfo class="other" otherclass="value">ridge</refmiscinfo>
3259 <refmiscinfo class="other" otherclass="value">inset</refmiscinfo>
3260 <refmiscinfo class="other" otherclass="value">outset</refmiscinfo>
3261 <refmiscinfo class="other" otherclass="value">solid</refmiscinfo>
3264 <refname>table.cell.border.style</refname>
3265 <refpurpose>Specifies the border style of table cells</refpurpose>
3269 <programlisting xml:id="table.cell.border.style.frag">
3270 <xsl:param name="table.cell.border.style">solid</xsl:param>
3274 <refsection><info><title>Description</title></info>
3276 <para>Specifies the border style of table cells.</para>
3279 <para>To control properties of cell borders in HTML output, you must also turn on the
3280 <parameter>table.borders.with.css</parameter> parameter.</para>
3286 <refentry version="5.0" xml:id="table.cell.border.color">
3288 <refentrytitle>table.cell.border.color</refentrytitle>
3289 <refmiscinfo class="other" otherclass="datatype">color</refmiscinfo>
3292 <refname>table.cell.border.color</refname>
3293 <refpurpose>Specifies the border color of table cells</refpurpose>
3297 <programlisting xml:id="table.cell.border.color.frag">
3299 <xsl:param name="table.cell.border.color">black</xsl:param>
3303 <refsection><info><title>Description</title></info>
3305 <para>Set the color of table cell borders. If non-zero, the value is used
3306 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
3307 <literal>color</literal> is either a keyword or a numerical RGB specification.
3308 Keywords are aqua, black, blue, fuchsia, gray, green, lime, maroon,
3309 navy, olive, orange, purple, red, silver, teal, white, and
3313 <para>To control properties of cell borders in HTML output, you must also turn on the
3314 <parameter>table.borders.with.css</parameter> parameter.</para>
3320 <refentry version="5.0" xml:id="table.table.properties">
3322 <refentrytitle>table.table.properties</refentrytitle>
3323 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
3326 <refname>table.table.properties</refname>
3327 <refpurpose>Properties associated with a table</refpurpose>
3331 <programlisting xml:id="table.table.properties.frag">
3332 <xsl:attribute-set name="table.table.properties">
3333 <xsl:attribute name="border-before-width.conditionality">retain</xsl:attribute>
3334 <xsl:attribute name="border-collapse">collapse</xsl:attribute>
3335 </xsl:attribute-set>
3339 <refsection><info><title>Description</title></info>
3341 <para>The styling for tables. This parameter should really
3342 have been called <literal>table.properties</literal>, but that parameter
3343 name was inadvertently established for the block-level properties
3344 of the table as a whole.
3347 <para>See also <parameter>table.properties</parameter>.</para>
3353 <reference xml:id="links"><title>Linking</title>
3354 <refentry version="5.0" xml:id="current.docid">
3356 <refentrytitle>current.docid</refentrytitle>
3357 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
3360 <refname>current.docid</refname>
3361 <refpurpose>targetdoc identifier for the document being
3362 processed</refpurpose>
3364 <refsynopsisdiv> <programlisting xml:id="current.docid.frag">
3365 <xsl:param name="current.docid"></xsl:param>
3368 <refsection><info><title>Description</title></info>
3370 <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
3371 the targetdoc identifier of the current document, since that
3372 identifier does not appear in the document itself. </para>
3373 <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>
3377 <refentry version="5.0" xml:id="collect.xref.targets">
3379 <refentrytitle>collect.xref.targets</refentrytitle>
3380 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
3381 <refmiscinfo class="other" otherclass="value">no</refmiscinfo>
3382 <refmiscinfo class="other" otherclass="value">yes</refmiscinfo>
3383 <refmiscinfo class="other" otherclass="value">only</refmiscinfo>
3386 <refname>collect.xref.targets</refname>
3387 <refpurpose>Controls whether cross reference data is
3388 collected</refpurpose>
3390 <refsynopsisdiv> <programlisting xml:id="collect.xref.targets.frag">
3391 <xsl:param name="collect.xref.targets">no</xsl:param>
3394 <refsection><info><title>Description</title></info>
3397 In order to resolve olinks efficiently, the stylesheets can
3398 generate an external data file containing information about
3399 all potential cross reference endpoints in a document.
3400 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.
3401 See also <parameter>targets.filename</parameter>.
3406 <refentry version="5.0" xml:id="insert.olink.page.number">
3408 <refentrytitle>insert.olink.page.number</refentrytitle>
3409 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
3410 <refmiscinfo class="other" otherclass="value">no</refmiscinfo>
3411 <refmiscinfo class="other" otherclass="value">yes</refmiscinfo>
3412 <refmiscinfo class="other" otherclass="value">maybe</refmiscinfo>
3415 <refname>insert.olink.page.number</refname>
3416 <refpurpose>Turns page numbers in olinks on and off</refpurpose>
3420 <programlisting xml:id="insert.olink.page.number.frag">
3421 <xsl:param name="insert.olink.page.number">no</xsl:param>
3425 <refsection><info><title>Description</title></info>
3427 <para>The value of this parameter determines if
3428 cross references made between documents with
3429 <tag>olink</tag> will
3430 include page number citations.
3431 In most cases this is only applicable to references in printed output.
3433 <para>The parameter has three possible values.
3438 <listitem><para>No page number references will be generated for olinks.
3443 <listitem><para>Page number references will be generated
3444 for all <tag>olink</tag> references.
3445 The style of page reference may be changed
3446 if an <tag class="attribute">xrefstyle</tag>
3452 <listitem><para>Page number references will not be generated
3453 for an <tag>olink</tag> element unless
3455 <tag class="attribute">xrefstyle</tag>
3456 attribute whose value specifies a page reference.
3460 <para>Olinks that point to targets within the same document
3461 are treated as <tag>xref</tag>s, and controlled by
3462 the <parameter>insert.xref.page.number</parameter> parameter.
3465 <para>Page number references for olinks to
3466 external documents can only be inserted if the
3467 information exists in the olink database.
3468 This means each olink target element
3469 (<tag>div</tag> or <tag>obj</tag>)
3470 must have a <tag class="attribute">page</tag> attribute
3471 whose value is its page number in the target document.
3472 The XSL stylesheets are not able to extract that information
3473 during processing because pages have not yet been created in
3474 XSLT transformation. Only the XSL-FO processor knows what
3475 page each element is placed on.
3476 Therefore some postprocessing must take place to populate
3477 page numbers in the olink database.
3485 <refentry version="5.0" xml:id="insert.olink.pdf.frag">
3487 <refentrytitle>insert.olink.pdf.frag</refentrytitle>
3488 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3491 <refname>insert.olink.pdf.frag</refname>
3492 <refpurpose>Add fragment identifiers for links into PDF files</refpurpose>
3496 <programlisting xml:id="insert.olink.pdf.frag.frag">
3497 <xsl:param name="insert.olink.pdf.frag" select="0"></xsl:param>
3501 <refsection><info><title>Description</title></info>
3503 <para>The value of this parameter determines whether
3504 the cross reference URIs to PDF documents made with
3505 <tag>olink</tag> will
3506 include fragment identifiers.
3509 <para>When forming a URI to link to a PDF document,
3510 a fragment identifier (typically a '#' followed by an
3511 id value) appended to the PDF filename can be used by
3512 the PDF viewer to open
3513 the PDF file to a location within the document instead of
3515 However, not all PDF files have id
3516 values embedded in them, and not all PDF viewers can
3517 handle fragment identifiers.
3520 <para>If <parameter>insert.olink.pdf.frag</parameter> is set
3521 to a non-zero value, then any olink targeting a
3522 PDF file will have the fragment identifier appended to the URI.
3523 The URI is formed by concatenating the value of the
3524 <parameter>olink.base.uri</parameter> parameter, the
3525 value of the <tag class="attribute">baseuri</tag>
3526 attribute from the <tag class="element">document</tag>
3527 element in the olink database with the matching
3528 <tag class="attribute">targetdoc</tag> value,
3529 and the value of the <tag class="attribute">href</tag>
3530 attribute for the targeted element in the olink database.
3531 The <tag class="attribute">href</tag> attribute
3532 contains the fragment identifier.
3535 <para>If <parameter>insert.olink.pdf.frag</parameter> is set
3536 to zero (the default value), then
3537 the <tag class="attribute">href</tag> attribute
3538 from the olink database
3539 is not appended to PDF olinks, so the fragment identifier is left off.
3540 A PDF olink is any olink for which the
3541 <tag class="attribute">baseuri</tag> attribute
3542 from the matching <tag class="element">document</tag>
3543 element in the olink database ends with '.pdf'.
3544 Any other olinks will still have the fragment identifier added.
3549 <refentry version="5.0" xml:id="olink.base.uri">
3551 <refentrytitle>olink.base.uri</refentrytitle>
3552 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
3555 <refname>olink.base.uri</refname>
3556 <refpurpose>Base URI used in olink hrefs</refpurpose>
3558 <refsynopsisdiv> <programlisting xml:id="olink.base.uri.frag">
3559 <xsl:param name="olink.base.uri"></xsl:param>
3562 <refsection><info><title>Description</title></info>
3564 <para>When cross reference data is collected for resolving olinks, it
3565 may be necessary to prepend a base URI to each target's href. This
3566 parameter lets you set that base URI when cross reference data is
3567 collected. This feature is needed when you want to link to a document
3568 that is processed without chunking. The output filename for such a
3569 document is not known to the XSL stylesheet; the only target
3570 information consists of fragment identifiers such as
3571 <literal>#idref</literal>. To enable the resolution of olinks between
3572 documents, you should pass the name of the HTML output file as the
3573 value of this parameter. Then the hrefs recorded in the cross
3574 reference data collection look like
3575 <literal>outfile.html#idref</literal>, which can be reached as links
3576 from other documents.</para>
3580 <refentry version="5.0" xml:id="olink.debug">
3582 <refentrytitle>olink.debug</refentrytitle>
3583 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3586 <refname>olink.debug</refname>
3587 <refpurpose>Turn on debugging messages for olinks</refpurpose>
3591 <programlisting xml:id="olink.debug.frag">
3592 <xsl:param name="olink.debug" select="0"></xsl:param>
3596 <refsection><info><title>Description</title></info>
3598 <para>If non-zero, then each olink will generate several
3599 messages about how it is being resolved during processing.
3600 This is useful when an olink does not resolve properly
3601 and the standard error messages are not sufficient to
3605 <para>You may need to read through the olink XSL templates
3606 to understand the context for some of the debug messages.
3612 <refentry version="5.0" xml:id="olink.doctitle">
3614 <refentrytitle>olink.doctitle</refentrytitle>
3615 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
3616 <refmiscinfo class="other" otherclass="value">no</refmiscinfo>
3617 <refmiscinfo class="other" otherclass="value">yes</refmiscinfo>
3618 <refmiscinfo class="other" otherclass="value">maybe</refmiscinfo>
3621 <refname>olink.doctitle</refname>
3622 <refpurpose>show the document title for external olinks?</refpurpose>
3625 <refsynopsisdiv> <programlisting xml:id="olink.doctitle.frag">
3626 <xsl:param name="olink.doctitle">no</xsl:param>
3629 <refsection><info><title>Description</title></info>
3631 <para>When olinks between documents are resolved, the generated text
3632 may not make it clear that the reference is to another document.
3633 It is possible for the stylesheets to append the other document's
3634 title to external olinks. For this to happen, two parameters must
3638 <para>This <parameter>olink.doctitle</parameter> parameter
3639 should be set to either <literal>yes</literal> or <literal>maybe</literal>
3640 to enable this feature.
3644 <para>And you should also set the <parameter>current.docid</parameter>
3645 parameter to the document id for the document currently
3646 being processed for output.
3652 Then if an olink's <literal>targetdoc</literal> id differs from
3653 the <literal>current.docid</literal> value, the stylesheet knows
3654 that it is a reference to another document and can
3655 append the target document's
3656 title to the generated olink text. </para>
3658 <para>The text for the target document's title is copied from the
3659 olink database from the <tag>ttl</tag> element
3660 of the top-level <tag>div</tag> for that document.
3661 If that <tag>ttl</tag> element is missing or empty,
3665 <para>The supported values for <parameter>olink.doctitle</parameter> are:
3669 <term><literal>yes</literal></term>
3672 Always insert the title to the target document if it is not
3673 the current document.
3678 <term><literal>no</literal></term>
3681 Never insert the title to the target document, even if requested
3682 in an <tag class="attribute">xrefstyle</tag> attribute.
3687 <term><literal>maybe</literal></term>
3690 Only insert the title to the target document, if requested
3691 in an <tag class="attribute">xrefstyle</tag> attribute.
3696 <para>An <tag class="attribute">xrefstyle</tag> attribute
3697 may override the global setting for individual olinks.
3698 The following values are supported in an
3699 <tag class="attribute">xrefstyle</tag>
3700 attribute using the <literal>select:</literal> syntax:
3705 <term><literal>docname</literal></term>
3708 Insert the target document name for this olink using the
3709 <literal>docname</literal> gentext template, but only
3710 if the value of <parameter>olink.doctitle</parameter>
3711 is not <literal>no</literal>.
3716 <term><literal>docnamelong</literal></term>
3719 Insert the target document name for this olink using the
3720 <literal>docnamelong</literal> gentext template, but only
3721 if the value of <parameter>olink.doctitle</parameter>
3722 is not <literal>no</literal>.
3727 <term><literal>nodocname</literal></term>
3730 Omit the target document name even if
3731 the value of <parameter>olink.doctitle</parameter>
3732 is <literal>yes</literal>.
3737 <para>Another way of inserting the target document name
3738 for a single olink is to employ an
3739 <tag class="attribute">xrefstyle</tag>
3740 attribute using the <literal>template:</literal> syntax.
3741 The <literal>%o</literal> placeholder (the letter o, not zero)
3743 will be filled in with the target document's title when it is processed.
3744 This will occur regardless of
3745 the value of <parameter>olink.doctitle</parameter>.
3747 <para>Note that prior to version 1.66 of the XSL stylesheets,
3748 the allowed values for this parameter were 0 and 1. Those
3749 values are still supported and mapped to 'no' and 'yes', respectively.
3754 <refentry version="5.0" xml:id="olink.lang.fallback.sequence">
3756 <refentrytitle>olink.lang.fallback.sequence</refentrytitle>
3757 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
3760 <refname>olink.lang.fallback.sequence</refname>
3761 <refpurpose>look up translated documents if olink not found?</refpurpose>
3764 <refsynopsisdiv> <programlisting xml:id="olink.lang.fallback.sequence.frag">
3765 <xsl:param name="olink.lang.fallback.sequence"></xsl:param>
3768 <refsection><info><title>Description</title></info>
3771 <para>This parameter defines a list of lang values
3772 to search among to resolve olinks.
3775 <para>Normally an olink tries to resolve to a document in the same
3776 language as the olink itself. The language of an olink
3777 is determined by its nearest ancestor element with a
3778 <tag class="attribute">lang</tag> attribute, otherwise the
3779 value of the <parameter>l10n.gentext.default.lang</parameter>
3783 <para>An olink database can contain target data for the same
3784 document in multiple languages. Each set of data has the
3785 same value for the <tag>targetdoc</tag> attribute in
3786 the <tag>document</tag> element in the database, but with a
3787 different <tag>lang</tag> attribute value.
3790 <para>When an olink is being resolved, the target is first
3791 sought in the document with the same language as the olink.
3792 If no match is found there, then this parameter is consulted
3793 for additional languages to try.</para>
3795 <para>The <parameter>olink.lang.fallback.sequence</parameter>
3796 must be a whitespace separated list of lang values to
3797 try. The first one with a match in the olink database is used.
3798 The default value is empty.</para>
3800 <para>For example, a document might be written in German
3801 and contain an olink with
3802 <literal>targetdoc="adminguide"</literal>.
3803 When the document is processed, the processor
3804 first looks for a target dataset in the
3805 olink database starting with:</para>
3807 <literallayout><literal><document targetdoc="adminguide" lang="de"></literal>.
3810 <para>If there is no such element, then the
3811 <parameter>olink.lang.fallback.sequence</parameter>
3812 parameter is consulted.
3813 If its value is, for example, <quote>fr en</quote>, then the processor next
3814 looks for <literal>targetdoc="adminguide" lang="fr"</literal>, and
3815 then for <literal>targetdoc="adminguide" lang="en"</literal>.
3816 If there is still no match, it looks for
3817 <literal>targetdoc="adminguide"</literal> with no
3821 <para>This parameter is useful when a set of documents is only
3822 partially translated, or is in the process of being translated.
3823 If a target of an olink has not yet been translated, then this
3824 parameter permits the processor to look for the document in
3825 other languages. This assumes the reader would rather have
3826 a link to a document in a different language than to have
3833 <refentry version="5.0" xml:id="olink.properties">
3835 <refentrytitle>olink.properties</refentrytitle>
3836 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
3839 <refname>olink.properties</refname>
3840 <refpurpose>Properties associated with the cross-reference
3841 text of an olink.</refpurpose>
3845 <programlisting xml:id="olink.properties.frag">
3846 <xsl:attribute-set name="olink.properties">
3847 <xsl:attribute name="show-destination">replace</xsl:attribute>
3848 </xsl:attribute-set>
3852 <refsection><info><title>Description</title></info>
3854 <para>This <literal>attribute set</literal> is applied to the
3855 <literal>fo:basic-link</literal> element of an olink. It is not applied to the
3856 optional page number or optional title of the external
3862 <refentry version="5.0" xml:id="prefer.internal.olink">
3864 <refentrytitle>prefer.internal.olink</refentrytitle>
3865 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
3868 <refname>prefer.internal.olink</refname>
3869 <refpurpose>Prefer a local olink reference to an external reference</refpurpose>
3873 <programlisting xml:id="prefer.internal.olink.frag">
3874 <xsl:param name="prefer.internal.olink" select="0"></xsl:param>
3878 <refsection><info><title>Description</title></info>
3880 <para>If you are re-using XML content modules in multiple documents,
3881 you may want to redirect some of your olinks. This parameter
3882 permits you to redirect an olink to the current document.
3885 <para>For example: you are writing documentation for a product,
3886 which includes 3 manuals: a little installation
3887 booklet (booklet.xml), a user
3888 guide (user.xml), and a reference manual (reference.xml).
3889 All 3 documents begin with the same introduction section (intro.xml) that
3890 contains a reference to the customization section (custom.xml) which is
3891 included in both user.xml and reference.xml documents.
3894 <para>How do you write the link to custom.xml in intro.xml
3895 so that it is interpreted correctly in all 3 documents?</para>
3897 <listitem><para>If you use xref, it will fail in user.xml.</para>
3899 <listitem><para>If you use olink (pointing to reference.xml),
3900 the reference in user.xml
3901 will point to the customization section of the reference manual, while it is
3902 actually available in user.xml.</para>
3906 <para>If you set the <parameter>prefer.internal.olink</parameter>
3907 parameter to a non-zero value, then the processor will
3908 first look in the olink database
3909 for the olink's <tag>targetptr</tag> attribute value
3910 in document matching the <parameter>current.docid</parameter>
3911 parameter value. If it isn't found there, then
3912 it tries the document in the database
3913 with the <tag>targetdoc</tag>
3914 value that matches the olink's <tag>targetdoc</tag>
3918 <para>This feature permits an olink reference to resolve to
3919 the current document if there is an element
3920 with an id matching the olink's <tag>targetptr</tag>
3921 value. The current document's olink data must be
3922 included in the target database for this to work.</para>
3925 <para>There is a potential for incorrect links if
3926 the same <tag>id</tag> attribute value is used for different
3927 content in different documents.
3928 Some of your olinks may be redirected to the current document
3929 when they shouldn't be. It is not possible to control
3930 individual olink instances.</para>
3936 <refentry version="5.0" xml:id="target.database.document">
3938 <refentrytitle>target.database.document</refentrytitle>
3939 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
3942 <refname>target.database.document</refname>
3943 <refpurpose>Name of master database file for resolving
3947 <programlisting xml:id="target.database.document.frag">
3948 <xsl:param name="target.database.document">olinkdb.xml</xsl:param>
3951 <refsection><info><title>Description</title></info>
3954 To resolve olinks between documents, the stylesheets use a master
3955 database document that identifies the target datafiles for all the
3956 documents within the scope of the olinks. This parameter value is the
3957 URI of the master document to be read during processing to resolve
3958 olinks. The default value is <filename>olinkdb.xml</filename>.</para>
3960 <para>The data structure of the file is defined in the
3961 <filename>targetdatabase.dtd</filename> DTD. The database file
3962 provides the high level elements to record the identifiers, locations,
3963 and relationships of documents. The cross reference data for
3964 individual documents is generally pulled into the database using
3965 system entity references or XIncludes. See also
3966 <parameter>targets.filename</parameter>. </para> </refsection>
3969 <refentry version="5.0" xml:id="targets.filename">
3971 <refentrytitle>targets.filename</refentrytitle>
3972 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
3975 <refname>targets.filename</refname>
3976 <refpurpose>Name of cross reference targets data file</refpurpose>
3978 <refsynopsisdiv> <programlisting xml:id="targets.filename.frag">
3979 <xsl:param name="targets.filename">target.db</xsl:param>
3982 <refsection><info><title>Description</title></info>
3985 In order to resolve olinks efficiently, the stylesheets can
3986 generate an external data file containing information about
3987 all potential cross reference endpoints in a document.
3988 This parameter lets you change the name of the generated
3989 file from the default name <filename>target.db</filename>.
3990 The name must agree with that used in the target database
3991 used to resolve olinks during processing.
3992 See also <parameter>target.database.document</parameter>.
3997 <refentry version="5.0" xml:id="use.local.olink.style">
3999 <refentrytitle>use.local.olink.style</refentrytitle>
4000 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
4003 <refname>use.local.olink.style</refname>
4004 <refpurpose>Process olinks using xref style of current
4005 document</refpurpose>
4007 <refsynopsisdiv> <programlisting xml:id="use.local.olink.style.frag">
4008 <xsl:param name="use.local.olink.style" select="0"></xsl:param> </programlisting>
4010 <refsection><info><title>Description</title></info>
4012 <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
4013 reference string is formed again from the target title, number, and
4014 element name, using the stylesheet processing the targeting document.
4015 Then olinks will match the xref style in the targeting document
4016 rather than in the target document. If both documents are processed
4017 with the same stylesheet, then the results will be the same.</para>
4022 <reference xml:id="xrefs"><title>Cross References</title>
4023 <refentry version="5.0" xml:id="insert.xref.page.number">
4025 <refentrytitle>insert.xref.page.number</refentrytitle>
4026 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
4027 <refmiscinfo class="other" otherclass="value">no</refmiscinfo>
4028 <refmiscinfo class="other" otherclass="value">yes</refmiscinfo>
4029 <refmiscinfo class="other" otherclass="value">maybe</refmiscinfo>
4032 <refname>insert.xref.page.number</refname>
4033 <refpurpose>Turns page numbers in xrefs on and off</refpurpose>
4037 <programlisting xml:id="insert.xref.page.number.frag">
4038 <xsl:param name="insert.xref.page.number">no</xsl:param>
4042 <refsection><info><title>Description</title></info>
4044 <para>The value of this parameter determines if
4045 cross references (<tag>xref</tag>s) in
4047 include page number citations.
4048 It has three possible values.
4053 <listitem><para>No page number references will be generated.
4058 <listitem><para>Page number references will be generated
4059 for all <tag>xref</tag> elements.
4060 The style of page reference may be changed
4061 if an <tag class="attribute">xrefstyle</tag>
4067 <listitem><para>Page number references will not be generated
4068 for an <tag>xref</tag> element unless
4070 <tag class="attribute">xrefstyle</tag>
4071 attribute whose value specifies a page reference.
4079 <refentry version="5.0" xml:id="xref.properties">
4081 <refentrytitle>xref.properties</refentrytitle>
4082 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
4085 <refname>xref.properties</refname>
4086 <refpurpose>Properties associated with cross-reference text</refpurpose>
4090 <programlisting xml:id="xref.properties.frag">
4091 <xsl:attribute-set name="xref.properties">
4092 </xsl:attribute-set>
4096 <refsection><info><title>Description</title></info>
4098 <para>This attribute set is used to set properties
4099 on cross reference text.</para>
4104 <refentry version="5.0" xml:id="xref.label-title.separator">
4106 <refentrytitle>xref.label-title.separator</refentrytitle>
4107 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
4110 <refname>xref.label-title.separator</refname>
4111 <refpurpose>Punctuation or space separating label from title in xref</refpurpose>
4115 <programlisting xml:id="xref.label-title.separator.frag"><xsl:param name="xref.label-title.separator">: </xsl:param></programlisting>
4118 <refsection><info><title>Description</title></info>
4121 This parameter allows you to control the punctuation of certain
4122 types of generated cross reference text.
4123 When cross reference text is generated for an
4124 <tag class="element">xref</tag> or
4125 <tag class="element">olink</tag> element
4126 using an <tag class="attribute">xrefstyle</tag> attribute
4127 that makes use of the <literal>select:</literal> feature,
4128 and the selected components include both label and title,
4129 then the value of this parameter is inserted between
4130 label and title in the output.
4136 <refentry version="5.0" xml:id="xref.label-page.separator">
4138 <refentrytitle>xref.label-page.separator</refentrytitle>
4139 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
4142 <refname>xref.label-page.separator</refname>
4143 <refpurpose>Punctuation or space separating label from page number in xref</refpurpose>
4147 <programlisting xml:id="xref.label-page.separator.frag"><xsl:param name="xref.label-page.separator"><xsl:text> </xsl:text></xsl:param></programlisting>
4150 <refsection><info><title>Description</title></info>
4153 This parameter allows you to control the punctuation of certain
4154 types of generated cross reference text.
4155 When cross reference text is generated for an
4156 <tag class="element">xref</tag> or
4157 <tag class="element">olink</tag> element
4158 using an <tag class="attribute">xrefstyle</tag> attribute
4159 that makes use of the <literal>select:</literal> feature,
4160 and the selected components include both label and page
4162 then the value of this parameter is inserted between
4163 label and page number in the output.
4164 If a title is included, then other separators are used.
4170 <refentry version="5.0" xml:id="xref.title-page.separator">
4172 <refentrytitle>xref.title-page.separator</refentrytitle>
4173 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
4176 <refname>xref.title-page.separator</refname>
4177 <refpurpose>Punctuation or space separating title from page number in xref</refpurpose>
4181 <programlisting xml:id="xref.title-page.separator.frag"><xsl:param name="xref.title-page.separator"><xsl:text> </xsl:text></xsl:param></programlisting>
4184 <refsection><info><title>Description</title></info>
4187 This parameter allows you to control the punctuation of certain
4188 types of generated cross reference text.
4189 When cross reference text is generated for an
4190 <tag class="element">xref</tag> or
4191 <tag class="element">olink</tag> element
4192 using an <tag class="attribute">xrefstyle</tag> attribute
4193 that makes use of the <literal>select:</literal> feature,
4194 and the selected components include both title and page number,
4195 then the value of this parameter is inserted between
4196 title and page number in the output.
4202 <refentry version="5.0" xml:id="insert.link.page.number">
4204 <refentrytitle>insert.link.page.number</refentrytitle>
4205 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
4206 <refmiscinfo class="other" otherclass="value">no</refmiscinfo>
4207 <refmiscinfo class="other" otherclass="value">yes</refmiscinfo>
4208 <refmiscinfo class="other" otherclass="value">maybe</refmiscinfo>
4211 <refname>insert.link.page.number</refname>
4212 <refpurpose>Turns page numbers in link elements on and off</refpurpose>
4216 <programlisting xml:id="insert.link.page.number.frag">
4217 <xsl:param name="insert.link.page.number">no</xsl:param>
4221 <refsection><info><title>Description</title></info>
4223 <para>The value of this parameter determines if
4224 cross references using the <tag>link</tag> element in
4226 include standard page number citations.
4227 It has three possible values.
4232 <listitem><para>No page number references will be generated.
4237 <listitem><para>Page number references will be generated
4238 for all <tag>link</tag> elements.
4239 The style of page reference may be changed
4240 if an <tag class="attribute">xrefstyle</tag>
4246 <listitem><para>Page number references will not be generated
4247 for a <tag>link</tag> element unless
4249 <tag class="attribute">xrefstyle</tag>
4250 attribute whose value specifies a page reference.
4255 <para>Although the <tag>xrefstyle</tag> attribute
4256 can be used to turn the page reference on or off, it cannot be
4257 used to control the formatting of the page number as it
4258 can in <tag>xref</tag>.
4259 In <tag>link</tag> it will always format with
4260 the style established by the
4261 gentext template with <literal>name="page.citation"</literal>
4262 in the <literal>l:context name="xref"</literal>.
4268 <reference xml:id="lists"><title>Lists</title>
4269 <refentry version="5.0" xml:id="compact.list.item.spacing">
4271 <refentrytitle>compact.list.item.spacing</refentrytitle>
4272 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
4275 <refname>compact.list.item.spacing</refname>
4276 <refpurpose>What space do you want between list items (when spacing="compact")?</refpurpose>
4280 <programlisting xml:id="compact.list.item.spacing.frag"><xsl:attribute-set name="compact.list.item.spacing">
4281 <xsl:attribute name="space-before.optimum">0em</xsl:attribute>
4282 <xsl:attribute name="space-before.minimum">0em</xsl:attribute>
4283 <xsl:attribute name="space-before.maximum">0.2em</xsl:attribute>
4284 </xsl:attribute-set></programlisting>
4286 <refsection><info><title>Description</title></info>
4287 <para>Specify what spacing you want between each list item when
4288 <tag class="attribute">spacing</tag> is
4289 <quote><literal>compact</literal></quote>.</para>
4293 <refentry version="5.0" xml:id="itemizedlist.properties">
4295 <refentrytitle>itemizedlist.properties</refentrytitle>
4296 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
4299 <refname>itemizedlist.properties</refname>
4300 <refpurpose>Properties that apply to each list-block generated by itemizedlist.</refpurpose>
4304 <programlisting xml:id="itemizedlist.properties.frag"><xsl:attribute-set name="itemizedlist.properties" use-attribute-sets="list.block.properties">
4305 </xsl:attribute-set></programlisting>
4307 <refsection><info><title>Description</title></info>
4308 <para>Properties that apply to each fo:list-block generated by itemizedlist.</para>
4312 <refentry version="5.0" xml:id="itemizedlist.label.properties">
4314 <refentrytitle>itemizedlist.label.properties</refentrytitle>
4315 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
4318 <refname>itemizedlist.label.properties</refname>
4319 <refpurpose>Properties that apply to each label inside itemized list.</refpurpose>
4323 <programlisting xml:id="itemizedlist.label.properties.frag"><xsl:attribute-set name="itemizedlist.label.properties">
4324 </xsl:attribute-set></programlisting>
4326 <refsection><info><title>Description</title></info>
4327 <para>Properties that apply to each label inside itemized list. E.g.:</para>
4328 <programlisting><xsl:attribute-set name="itemizedlist.label.properties">
4329 <xsl:attribute name="text-align">right</xsl:attribute>
4330 </xsl:attribute-set></programlisting>
4334 <refentry version="5.0" xml:id="itemizedlist.label.width">
4336 <refentrytitle>itemizedlist.label.width</refentrytitle>
4337 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
4340 <refname>itemizedlist.label.width</refname>
4341 <refpurpose>The default width of the label (bullet) in an itemized list.</refpurpose>
4345 <programlisting xml:id="itemizedlist.label.width.frag">
4346 <xsl:param name="itemizedlist.label.width">1.0em</xsl:param>
4350 <refsection><info><title>Description</title></info>
4351 <para>Specifies the default width of the label (usually a bullet or other
4352 symbol) in an itemized list. You can override the default value on any
4353 particular list with the “dbfo” processing instruction using the
4354 “label-width” pseudoattribute.</para>
4358 <refentry version="5.0" xml:id="list.block.properties">
4360 <refentrytitle>list.block.properties</refentrytitle>
4361 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
4364 <refname>list.block.properties</refname>
4365 <refpurpose>Properties that apply to each list-block generated by list.</refpurpose>
4369 <programlisting xml:id="list.block.properties.frag"><xsl:attribute-set name="list.block.properties">
4370 <xsl:attribute name="provisional-label-separation">0.2em</xsl:attribute>
4371 <xsl:attribute name="provisional-distance-between-starts">1.5em</xsl:attribute>
4372 </xsl:attribute-set></programlisting>
4374 <refsection><info><title>Description</title></info>
4375 <para>Properties that apply to each fo:list-block generated by itemizedlist/orderedlist.</para>
4379 <refentry version="5.0" xml:id="list.block.spacing">
4381 <refentrytitle>list.block.spacing</refentrytitle>
4382 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
4385 <refname>list.block.spacing</refname>
4386 <refpurpose>What spacing do you want before and after lists?</refpurpose>
4390 <programlisting xml:id="list.block.spacing.frag"><xsl:attribute-set name="list.block.spacing">
4391 <xsl:attribute name="space-before.optimum">1em</xsl:attribute>
4392 <xsl:attribute name="space-before.minimum">0.8em</xsl:attribute>
4393 <xsl:attribute name="space-before.maximum">1.2em</xsl:attribute>
4394 <xsl:attribute name="space-after.optimum">1em</xsl:attribute>
4395 <xsl:attribute name="space-after.minimum">0.8em</xsl:attribute>
4396 <xsl:attribute name="space-after.maximum">1.2em</xsl:attribute>
4397 </xsl:attribute-set></programlisting>
4399 <refsection><info><title>Description</title></info>
4400 <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>
4404 <refentry version="5.0" xml:id="list.item.spacing">
4406 <refentrytitle>list.item.spacing</refentrytitle>
4407 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
4410 <refname>list.item.spacing</refname>
4411 <refpurpose>What space do you want between list items?</refpurpose>
4415 <programlisting xml:id="list.item.spacing.frag"><xsl:attribute-set name="list.item.spacing">
4416 <xsl:attribute name="space-before.optimum">1em</xsl:attribute>
4417 <xsl:attribute name="space-before.minimum">0.8em</xsl:attribute>
4418 <xsl:attribute name="space-before.maximum">1.2em</xsl:attribute>
4419 </xsl:attribute-set></programlisting>
4421 <refsection><info><title>Description</title></info>
4422 <para>Specify what spacing you want between each list item.</para>
4426 <refentry version="5.0" xml:id="orderedlist.properties">
4428 <refentrytitle>orderedlist.properties</refentrytitle>
4429 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
4432 <refname>orderedlist.properties</refname>
4433 <refpurpose>Properties that apply to each list-block generated by orderedlist.</refpurpose>
4437 <programlisting xml:id="orderedlist.properties.frag"><xsl:attribute-set name="orderedlist.properties" use-attribute-sets="list.block.properties">
4438 <xsl:attribute name="provisional-distance-between-starts">2em</xsl:attribute>
4439 </xsl:attribute-set></programlisting>
4441 <refsection><info><title>Description</title></info>
4442 <para>Properties that apply to each fo:list-block generated by orderedlist.</para>
4446 <refentry version="5.0" xml:id="orderedlist.label.properties">
4448 <refentrytitle>orderedlist.label.properties</refentrytitle>
4449 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
4452 <refname>orderedlist.label.properties</refname>
4453 <refpurpose>Properties that apply to each label inside ordered list.</refpurpose>
4457 <programlisting xml:id="orderedlist.label.properties.frag"><xsl:attribute-set name="orderedlist.label.properties">
4458 </xsl:attribute-set></programlisting>
4460 <refsection><info><title>Description</title></info>
4461 <para>Properties that apply to each label inside ordered list. E.g.:</para>
4462 <programlisting><xsl:attribute-set name="orderedlist.label.properties">
4463 <xsl:attribute name="text-align">right</xsl:attribute>
4464 </xsl:attribute-set></programlisting>
4468 <refentry version="5.0" xml:id="orderedlist.label.width">
4470 <refentrytitle>orderedlist.label.width</refentrytitle>
4471 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
4474 <refname>orderedlist.label.width</refname>
4475 <refpurpose>The default width of the label (number) in an ordered list.</refpurpose>
4479 <programlisting xml:id="orderedlist.label.width.frag">
4480 <xsl:param name="orderedlist.label.width">1.2em</xsl:param>
4484 <refsection><info><title>Description</title></info>
4485 <para>Specifies the default width of the label (usually a number or
4486 sequence of numbers) in an ordered list. You can override the default
4487 value on any particular list with the “dbfo” processing instruction
4488 using the “label-width” pseudoattribute.</para>
4492 <refentry version="5.0" xml:id="variablelist.max.termlength">
4494 <refentrytitle>variablelist.max.termlength</refentrytitle>
4495 <refmiscinfo class="other" otherclass="datatype">number</refmiscinfo>
4498 <refname>variablelist.max.termlength</refname>
4499 <refpurpose>Specifies the longest term in variablelists</refpurpose>
4503 <programlisting xml:id="variablelist.max.termlength.frag">
4504 <xsl:param name="variablelist.max.termlength">24</xsl:param>
4508 <refsection><info><title>Description</title></info>
4510 <para>In variablelists, the <tag>listitem</tag>
4511 is indented to leave room for the
4512 <tag>term</tag> elements. That indent may be computed
4513 if it is not specified with a <tag class="attribute">termlength</tag>
4514 attribute on the <tag>variablelist</tag> element.
4517 The computation counts characters in the
4518 <tag>term</tag> elements in the list
4519 to find the longest term. However, some terms are very long
4520 and would produce extreme indents. This parameter lets you
4521 set a maximum character count. Any terms longer than the maximum
4522 would line wrap. The default value is 24.
4525 The character counts are converted to physical widths
4526 by multiplying by 0.50em. There will be some variability
4527 in how many actual characters fit in the space
4528 since some characters are wider than others.
4534 <refentry version="5.0" xml:id="variablelist.term.separator">
4536 <refentrytitle>variablelist.term.separator</refentrytitle>
4537 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
4540 <refname>variablelist.term.separator</refname>
4541 <refpurpose>Text to separate <tag>term</tag>s within a multi-term
4542 <tag>varlistentry</tag></refpurpose>
4546 <programlisting xml:id="variablelist.term.separator.frag">
4547 <xsl:param name="variablelist.term.separator">, </xsl:param></programlisting>
4550 <refsection><info><title>Description</title></info>
4552 <para>When a <tag>varlistentry</tag> contains multiple <tag>term</tag>
4553 elements, the string specified in the value of the
4554 <parameter>variablelist.term.separator</parameter> parameter is placed
4555 after each <tag>term</tag> except the last.</para>
4558 <para>To generate a line break between multiple <tag>term</tag>s in
4559 a <tag>varlistentry</tag>, set a non-zero value for the
4560 <parameter>variablelist.term.break.after</parameter> parameter. If
4561 you do so, you may also want to set the value of the
4562 <parameter>variablelist.term.separator</parameter> parameter to an
4563 empty string (to suppress rendering of the default comma and space
4564 after each <tag>term</tag>).</para>
4570 <refentry version="5.0" xml:id="variablelist.term.properties">
4572 <refentrytitle>variablelist.term.properties</refentrytitle>
4573 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
4576 <refname>variablelist.term.properties</refname>
4577 <refpurpose>To add properties to the term elements in a variablelist.</refpurpose>
4581 <programlisting xml:id="variablelist.term.properties.frag">
4582 <xsl:attribute-set name="variablelist.term.properties">
4583 </xsl:attribute-set>
4586 <refsection><info><title>Description</title></info>
4587 <para>These properties are added to the block containing a
4588 term in a variablelist.
4589 Use this attribute-set to set
4590 font properties or alignment, for example.</para>
4595 <refentry version="5.0" xml:id="variablelist.term.break.after">
4597 <refentrytitle>variablelist.term.break.after</refentrytitle>
4598 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
4601 <refname>variablelist.term.break.after</refname>
4602 <refpurpose>Generate line break after each <tag>term</tag> within a
4603 multi-term <tag>varlistentry</tag>?</refpurpose>
4607 <programlisting xml:id="variablelist.term.break.after.frag">
4608 <xsl:param name="variablelist.term.break.after">0</xsl:param></programlisting>
4611 <refsection><info><title>Description</title></info>
4613 <para>Set a non-zero value for the
4614 <parameter>variablelist.term.break.after</parameter> parameter to
4615 generate a line break between <tag>term</tag>s in a
4616 multi-term <tag>varlistentry</tag>.</para>
4619 <para>If you set a non-zero value for
4620 <parameter>variablelist.term.break.after</parameter>, you may also
4621 want to set the value of the
4622 <parameter>variablelist.term.separator</parameter> parameter to an
4623 empty string (to suppress rendering of the default comma and space
4624 after each <tag>term</tag>).</para>
4631 <reference xml:id="qa"><title>QAndASet</title>
4632 <refentry version="5.0" xml:id="qandadiv.autolabel">
4634 <refentrytitle>qandadiv.autolabel</refentrytitle>
4635 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
4638 <refname>qandadiv.autolabel</refname>
4639 <refpurpose>Are divisions in QAndASets enumerated?</refpurpose>
4643 <programlisting xml:id="qandadiv.autolabel.frag"><xsl:param name="qandadiv.autolabel" select="1"></xsl:param></programlisting>
4646 <refsection><info><title>Description</title></info>
4648 <para>If non-zero, unlabeled qandadivs will be enumerated.
4654 <refentry version="5.0" xml:id="qanda.inherit.numeration">
4656 <refentrytitle>qanda.inherit.numeration</refentrytitle>
4657 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
4660 <refname>qanda.inherit.numeration</refname>
4661 <refpurpose>Does enumeration of QandASet components inherit the numeration of parent elements?</refpurpose>
4665 <programlisting xml:id="qanda.inherit.numeration.frag">
4666 <xsl:param name="qanda.inherit.numeration" select="1"></xsl:param>
4670 <refsection><info><title>Description</title></info>
4672 <para>If non-zero, numbered <tag>qandadiv</tag> elements and
4673 <tag>question</tag> and <tag>answer</tag> inherit the enumeration of
4674 the ancestors of the <tag>qandaset</tag>.
4680 <refentry version="5.0" xml:id="qanda.defaultlabel">
4682 <refentrytitle>qanda.defaultlabel</refentrytitle>
4683 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
4684 <refmiscinfo class="other" otherclass="value">number</refmiscinfo>
4685 <refmiscinfo class="other" otherclass="value">qanda</refmiscinfo>
4686 <refmiscinfo class="other" otherclass="value">none</refmiscinfo>
4689 <refname>qanda.defaultlabel</refname>
4690 <refpurpose>Sets the default for defaultlabel on QandASet.</refpurpose>
4694 <programlisting xml:id="qanda.defaultlabel.frag">
4695 <xsl:param name="qanda.defaultlabel">number</xsl:param>
4699 <refsection><info><title>Description</title></info>
4701 <para>If no <literal>defaultlabel</literal> attribute is specified on
4702 a <tag>qandaset</tag>, this value is used. It is generally one of the legal
4703 values for the defaultlabel attribute (<literal>none</literal>,
4704 <literal>number</literal> or
4705 <literal>qanda</literal>), or one of the additional stylesheet-specific values
4706 (<literal>qnumber</literal> or <literal>qnumberanda</literal>).
4707 The default value is 'number'.
4709 <para>The values are rendered as follows:</para>
4711 <varlistentry><term><literal>qanda</literal></term>
4713 <para><tag>question</tag>s are labeled "Q:" and
4714 <tag>answer</tag>s are labeled "A:". </para>
4718 <varlistentry><term><literal>number</literal></term>
4720 <para>The questions are enumerated and the answers
4721 are not labeled. </para>
4725 <varlistentry><term><literal>qnumber</literal></term>
4727 <para>The questions are labeled "Q:" followed by a number, and answers are not
4729 When sections are numbered, adding a label
4730 to the number distinguishes the question numbers
4731 from the section numbers.
4732 This value is not allowed in the
4733 <tag class="attribute">defaultlabel</tag> attribute
4734 of a <tag>qandaset</tag> element.</para>
4738 <varlistentry><term><literal>qnumberanda</literal></term>
4740 <para>The questions are labeled "Q:" followed by a number, and
4741 the answers are labeled "A:".
4742 When sections are numbered, adding a label
4743 to the number distinguishes the question numbers
4744 from the section numbers.
4745 This value is not allowed in the
4746 <tag class="attribute">defaultlabel</tag> attribute
4747 of a <tag>qandaset</tag> element.</para>
4751 <varlistentry><term><literal>none</literal></term>
4753 <para>No distinguishing label precedes Questions or Answers.
4762 <refentry version="5.0" xml:id="qanda.in.toc">
4764 <refentrytitle>qanda.in.toc</refentrytitle>
4765 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
4768 <refname>qanda.in.toc</refname>
4769 <refpurpose>Should qandaentry questions appear in
4770 the document table of contents?</refpurpose>
4774 <programlisting xml:id="qanda.in.toc.frag"><xsl:param name="qanda.in.toc" select="0"></xsl:param></programlisting>
4777 <refsection><info><title>Description</title></info>
4779 <para>If true (non-zero), then the generated table of contents
4780 for a document will include <tag>qandaset</tag> titles,
4781 <tag>qandadiv</tag> titles,
4782 and <tag>question</tag> elements. The default value (zero) excludes
4785 <para>This parameter does not affect any tables of contents
4786 that may be generated inside a qandaset or qandadiv.
4792 <refentry version="5.0" xml:id="qanda.nested.in.toc">
4794 <refentrytitle>qanda.nested.in.toc</refentrytitle>
4795 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
4798 <refname>qanda.nested.in.toc</refname>
4799 <refpurpose>Should nested answer/qandaentry instances appear in TOC?</refpurpose>
4803 <programlisting xml:id="qanda.nested.in.toc.frag">
4804 <xsl:param name="qanda.nested.in.toc" select="0"></xsl:param>
4808 <refsection><info><title>Description</title></info>
4810 <para>If non-zero, instances of <tag>qandaentry</tag>
4811 that are children of <tag>answer</tag> elements are shown in
4818 <reference xml:id="biblio"><title>Bibliography</title>
4819 <refentry version="5.0" xml:id="bibliography.style">
4821 <refentrytitle>bibliography.style</refentrytitle>
4822 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
4823 <refmiscinfo class="other" otherclass="value">normal</refmiscinfo>
4824 <refmiscinfo class="other" otherclass="value">iso690</refmiscinfo>
4827 <refname>bibliography.style</refname>
4828 <refpurpose>Style used for formatting of biblioentries.</refpurpose>
4832 <programlisting xml:id="bibliography.style.frag">
4833 <xsl:param name="bibliography.style">normal</xsl:param>
4837 <refsection><info><title>Description</title></info>
4839 <para>Currently only <literal>normal</literal> and
4840 <literal>iso690</literal> styles are supported.</para>
4842 <para>In order to use ISO690 style to the full extent you might need
4843 to use additional markup described on <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://wiki.docbook.org/topic/ISO690Bibliography">the
4844 following WiKi page</link>.</para>
4849 <refentry version="5.0" xml:id="biblioentry.item.separator">
4851 <refentrytitle>biblioentry.item.separator</refentrytitle>
4852 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
4855 <refname>biblioentry.item.separator</refname>
4856 <refpurpose>Text to separate bibliography entries</refpurpose>
4860 <programlisting xml:id="biblioentry.item.separator.frag"><xsl:param name="biblioentry.item.separator">. </xsl:param></programlisting>
4863 <refsection><info><title>Description</title></info>
4865 <para>Text to separate bibliography entries
4871 <refentry version="5.0" xml:id="bibliography.collection">
4873 <refentrytitle>bibliography.collection</refentrytitle>
4874 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
4877 <refname>bibliography.collection</refname>
4878 <refpurpose>Name of the bibliography collection file</refpurpose>
4882 <programlisting xml:id="bibliography.collection.frag">
4883 <xsl:param name="bibliography.collection">http://docbook.sourceforge.net/release/bibliography/bibliography.xml</xsl:param>
4888 <refsection><info><title>Description</title></info>
4890 <para>Maintaining bibliography entries across a set of documents is tedious, time
4891 consuming, and error prone. It makes much more sense, usually, to store all of
4892 the bibliography entries in a single place and simply <quote>extract</quote>
4893 the ones you need in each document.</para>
4895 <para>That's the purpose of the
4896 <parameter>bibliography.collection</parameter> parameter. To setup a global
4897 bibliography <quote>database</quote>, follow these steps:</para>
4899 <para>First, create a stand-alone bibliography document that contains all of
4900 the documents that you wish to reference. Make sure that each bibliography
4901 entry (whether you use <tag>biblioentry</tag> or <tag>bibliomixed</tag>)
4904 <para>My global bibliography, <filename>~/bibliography.xml</filename> begins
4908 <programlisting><!DOCTYPE bibliography
4909 PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
4910 "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
4911 <bibliography><title>References</title>
4913 <bibliomixed id="xml-rec"><abbrev>XML 1.0</abbrev>Tim Bray,
4914 Jean Paoli, C. M. Sperberg-McQueen, and Eve Maler, editors.
4915 <citetitle><ulink url="http://www.w3.org/TR/REC-xml">Extensible Markup
4916 Language (XML) 1.0 Second Edition</ulink></citetitle>.
4917 World Wide Web Consortium, 2000.
4918 </bibliomixed>
4920 <bibliomixed id="xml-names"><abbrev>Namespaces</abbrev>Tim Bray,
4922 and Andrew Layman, editors.
4923 <citetitle><ulink url="http://www.w3.org/TR/REC-xml-names/">Namespaces in
4924 XML</ulink></citetitle>.
4925 World Wide Web Consortium, 1999.
4926 </bibliomixed>
4929 </bibliography>
4933 <para>When you create a bibliography in your document, simply
4934 provide <emphasis>empty</emphasis> <tag>bibliomixed</tag>
4935 entries for each document that you wish to cite. Make sure that these
4936 elements have the same ID as the corresponding <quote>real</quote>
4937 entry in your global bibliography.</para>
4939 <para>For example:</para>
4942 <programlisting><bibliography><title>Bibliography</title>
4944 <bibliomixed id="xml-rec"/>
4945 <bibliomixed id="xml-names"/>
4946 <bibliomixed id="DKnuth86">Donald E. Knuth. <citetitle>Computers and
4947 Typesetting: Volume B, TeX: The Program</citetitle>. Addison-Wesley,
4948 1986. ISBN 0-201-13437-3.
4949 </bibliomixed>
4950 <bibliomixed id="relaxng"/>
4952 </bibliography></programlisting>
4955 <para>Note that it's perfectly acceptable to mix entries from your
4956 global bibliography with <quote>normal</quote> entries. You can use
4957 <tag>xref</tag> or other elements to cross-reference your
4958 bibliography entries in exactly the same way you do now.</para>
4960 <para>Finally, when you are ready to format your document, simply set the
4961 <parameter>bibliography.collection</parameter> parameter (in either a
4962 customization layer or directly through your processor's interface) to
4963 point to your global bibliography.</para>
4965 <para>The stylesheets will format the bibliography in your document as if
4966 all of the entries referenced appeared there literally.</para>
4971 <refentry version="5.0" xml:id="bibliography.numbered">
4973 <refentrytitle>bibliography.numbered</refentrytitle>
4974 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
4977 <refname>bibliography.numbered</refname>
4978 <refpurpose>Should bibliography entries be numbered?</refpurpose>
4982 <programlisting xml:id="bibliography.numbered.frag">
4983 <xsl:param name="bibliography.numbered" select="0"></xsl:param>
4987 <refsection><info><title>Description</title></info>
4989 <para>If non-zero bibliography entries will be numbered</para>
4994 <refentry version="5.0" xml:id="biblioentry.properties">
4996 <refentrytitle>biblioentry.properties</refentrytitle>
4997 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
5000 <refname>biblioentry.properties</refname>
5001 <refpurpose>To set the style for biblioentry.</refpurpose>
5005 <programlisting xml:id="biblioentry.properties.frag"><xsl:attribute-set name="biblioentry.properties" use-attribute-sets="normal.para.spacing">
5006 <xsl:attribute name="start-indent">0.5in</xsl:attribute>
5007 <xsl:attribute name="text-indent">-0.5in</xsl:attribute>
5008 </xsl:attribute-set>
5011 <refsection><info><title>Description</title></info>
5012 <para>How do you want biblioentry styled? </para>
5013 <para>Set the font-size, weight, space-above and space-below, indents, etc. to the style required</para>
5019 <reference xml:id="glossary"><title>Glossary</title>
5020 <refentry version="5.0" xml:id="glossterm.auto.link">
5022 <refentrytitle>glossterm.auto.link</refentrytitle>
5023 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
5026 <refname>glossterm.auto.link</refname>
5027 <refpurpose>Generate links from glossterm to glossentry automatically?</refpurpose>
5031 <programlisting xml:id="glossterm.auto.link.frag">
5032 <xsl:param name="glossterm.auto.link" select="0"></xsl:param>
5036 <refsection><info><title>Description</title></info>
5038 <para>If non-zero, links from inline <tag>glossterm</tag>s to the corresponding
5039 <tag>glossentry</tag> elements in a <tag>glossary</tag> or <tag>glosslist</tag>
5040 will be automatically generated. This is useful when your glossterms are consistent
5041 and you don't want to add links manually.</para>
5043 <para>The automatic link generation feature is not used on <tag>glossterm</tag> elements
5044 that have a <tag class="attribute">linkend</tag> attribute.</para>
5049 <refentry version="5.0" xml:id="firstterm.only.link">
5051 <refentrytitle>firstterm.only.link</refentrytitle>
5052 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
5055 <refname>firstterm.only.link</refname>
5056 <refpurpose>Does automatic glossterm linking only apply to firstterms?</refpurpose>
5060 <programlisting xml:id="firstterm.only.link.frag">
5061 <xsl:param name="firstterm.only.link" select="0"></xsl:param>
5065 <refsection><info><title>Description</title></info>
5067 <para>If non-zero, only <tag>firstterm</tag>s will be automatically linked
5068 to the glossary. If glossary linking is not enabled, this parameter
5069 has no effect.</para>
5074 <refentry version="5.0" xml:id="glossary.collection">
5076 <refentrytitle>glossary.collection</refentrytitle>
5077 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
5080 <refname>glossary.collection</refname>
5081 <refpurpose>Name of the glossary collection file</refpurpose>
5085 <programlisting xml:id="glossary.collection.frag">
5086 <xsl:param name="glossary.collection"></xsl:param>
5090 <refsection><info><title>Description</title></info>
5092 <para>Glossaries maintained independently across a set of documents
5093 are likely to become inconsistent unless considerable effort is
5094 expended to keep them in sync. It makes much more sense, usually, to
5095 store all of the glossary entries in a single place and simply
5096 <quote>extract</quote> the ones you need in each document.</para>
5098 <para>That's the purpose of the
5099 <parameter>glossary.collection</parameter> parameter. To setup a global
5100 glossary <quote>database</quote>, follow these steps:</para>
5102 <refsection><info><title>Setting Up the Glossary Database</title></info>
5104 <para>First, create a stand-alone glossary document that contains all of
5105 the entries that you wish to reference. Make sure that each glossary
5106 entry has an ID.</para>
5108 <para>Here's an example glossary:</para>
5112 <?xml version="1.0" encoding="utf-8"?>
5113 <!DOCTYPE glossary
5114 PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
5115 "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
5117 <glossaryinfo>
5118 <editor><firstname>Eric</firstname><surname>Raymond</surname></editor>
5119 <title>Jargon File 4.2.3 (abridged)</title>
5120 <releaseinfo>Just some test data</releaseinfo>
5121 </glossaryinfo>
5123 <glossdiv><title>0</title>
5126 <glossterm>0</glossterm>
5128 <para>Numeric zero, as opposed to the letter `O' (the 15th letter of
5129 the English alphabet). In their unmodified forms they look a lot
5130 alike, and various kluges invented to make them visually distinct have
5131 compounded the confusion. If your zero is center-dotted and letter-O
5132 is not, or if letter-O looks almost rectangular but zero looks more
5133 like an American football stood on end (or the reverse), you're
5134 probably looking at a modern character display (though the dotted zero
5135 seems to have originated as an option on IBM 3270 controllers). If
5136 your zero is slashed but letter-O is not, you're probably looking at
5137 an old-style ASCII graphic set descended from the default typewheel on
5138 the venerable ASR-33 Teletype (Scandinavians, for whom /O is a letter,
5139 curse this arrangement). (Interestingly, the slashed zero long
5140 predates computers; Florian Cajori's monumental "A History of
5141 Mathematical Notations" notes that it was used in the twelfth and
5142 thirteenth centuries.) If letter-O has a slash across it and the zero
5143 does not, your display is tuned for a very old convention used at IBM
5144 and a few other early mainframe makers (Scandinavians curse <emphasis>this</emphasis>
5145 arrangement even more, because it means two of their letters collide).
5146 Some Burroughs/Unisys equipment displays a zero with a <emphasis>reversed</emphasis>
5147 slash. Old CDC computers rendered letter O as an unbroken oval and 0
5148 as an oval broken at upper right and lower left. And yet another
5149 convention common on early line printers left zero unornamented but
5150 added a tail or hook to the letter-O so that it resembled an inverted
5151 Q or cursive capital letter-O (this was endorsed by a draft ANSI
5152 standard for how to draw ASCII characters, but the final standard
5153 changed the distinguisher to a tick-mark in the upper-left corner).
5154 Are we sufficiently confused yet?</para>
5159 <glossterm>1TBS</glossterm>
5161 <para role="accidence">
5162 <phrase role="pronounce"></phrase>
5163 <phrase role="partsofspeach">n</phrase>
5165 <para>The "One True Brace Style"</para>
5166 <glossseealso>indent style</glossseealso>
5176 </glossary></programlisting>
5181 <refsection><info><title>Marking Up Glossary Terms</title></info>
5183 <para>That takes care of the glossary database, now you have to get the entries
5184 into your document. Unlike bibliography entries, which can be empty, creating
5185 <quote>placeholder</quote> glossary entries would be very tedious. So instead,
5186 support for <parameter>glossary.collection</parameter> relies on implicit linking.</para>
5188 <para>In your source document, simply use <tag>firstterm</tag> and
5189 <tag>glossterm</tag> to identify the terms you wish to have included
5190 in the glossary. The stylesheets assume that you will either set the
5191 <tag class="attribute">baseform</tag> attribute correctly, or that the
5192 content of the element exactly matches a term in your glossary.</para>
5194 <para>If you're using a <parameter>glossary.collection</parameter>, don't
5195 make explicit links on the terms in your document.</para>
5197 <para>So, in your document, you might write things like this:</para>
5200 <programlisting><para>This is dummy text, without any real meaning.
5201 The point is simply to reference glossary terms like <glossterm>0</glossterm>
5202 and the <firstterm baseform="1TBS">One True Brace Style (1TBS)</firstterm>.
5203 The <glossterm>1TBS</glossterm>, as you can probably imagine, is a nearly
5204 religious issue.</para></programlisting>
5207 <para>If you set the <parameter>firstterm.only.link</parameter> parameter,
5208 only the terms marked with <tag>firstterm</tag> will be links.
5209 Otherwise, all the terms will be linked.</para>
5213 <refsection><info><title>Marking Up the Glossary</title></info>
5215 <para>The glossary itself has to be identified for the stylesheets. For lack
5216 of a better choice, the <tag class="attribute">role</tag> is used.
5217 To identify the glossary as the target for automatic processing, set
5218 the role to <quote><literal>auto</literal></quote>. The title of this
5219 glossary (and any other information from the <tag>glossaryinfo</tag>
5220 that's rendered by your stylesheet) will be displayed, but the entries will
5221 come from the database.
5224 <para>Unfortunately, the glossary can't be empty, so you must put in
5225 at least one <tag>glossentry</tag>. The content of this entry
5226 is irrelevant, it will not be rendered:</para>
5229 <programlisting><glossary role="auto">
5231 <glossterm>Irrelevant</glossterm>
5233 <para>If you can see this, the document was processed incorrectly. Use
5234 the <parameter>glossary.collection</parameter> parameter.</para>
5237 </glossary></programlisting>
5240 <para>What about glossary divisions? If your glossary database has glossary
5241 divisions <emphasis>and</emphasis> your automatic glossary contains at least
5242 one <tag>glossdiv</tag>, the automic glossary will have divisions.
5243 If the <tag>glossdiv</tag> is missing from either location, no divisions
5244 will be rendered.</para>
5246 <para>Glossary entries (and divisions, if appropriate) in the glossary will
5247 occur in precisely the order they occur in your database.</para>
5251 <refsection><info><title>Formatting the Document</title></info>
5253 <para>Finally, when you are ready to format your document, simply set the
5254 <parameter>glossary.collection</parameter> parameter (in either a
5255 customization layer or directly through your processor's interface) to
5256 point to your global glossary.</para>
5258 <para>The stylesheets will format the glossary in your document as if
5259 all of the entries implicilty referenced appeared there literally.</para>
5262 <refsection><info><title>Limitations</title></info>
5264 <para>Glossary cross-references <emphasis>within the glossary</emphasis> are
5265 not supported. For example, this <emphasis>will not</emphasis> work:</para>
5268 <programlisting><glossentry>
5269 <glossterm>gloss-1</glossterm>
5270 <glossdef><para>A description that references <glossterm>gloss-2</glossterm>.</para>
5271 <glossseealso>gloss-2</glossseealso>
5273 </glossentry></programlisting>
5276 <para>If you put glossary cross-references in your glossary that way,
5277 you'll get the cryptic error: <computeroutput>Warning:
5278 glossary.collection specified, but there are 0 automatic
5279 glossaries</computeroutput>.</para>
5281 <para>Instead, you must do two things:</para>
5285 <para>Markup your glossary using <tag>glossseealso</tag>:</para>
5288 <programlisting><glossentry>
5289 <glossterm>gloss-1</glossterm>
5290 <glossdef><para>A description that references <glossterm>gloss-2</glossterm>.</para>
5291 <glossseealso>gloss-2</glossseealso>
5293 </glossentry></programlisting>
5298 <para>Make sure there is at least one <tag>glossterm</tag> reference to
5299 <glossterm>gloss-2</glossterm> <emphasis>in your document</emphasis>. The
5300 easiest way to do that is probably within a <tag>remark</tag> in your
5301 automatic glossary:</para>
5304 <programlisting><glossary role="auto">
5305 <remark>Make sure there's a reference to <glossterm>gloss-2</glossterm>.</remark>
5307 <glossterm>Irrelevant</glossterm>
5309 <para>If you can see this, the document was processed incorrectly. Use
5310 the <parameter>glossary.collection</parameter> parameter.</para>
5313 </glossary></programlisting>
5322 <refentry version="5.0" xml:id="glossary.as.blocks">
5324 <refentrytitle>glossary.as.blocks</refentrytitle>
5325 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
5328 <refname>glossary.as.blocks</refname>
5329 <refpurpose>Present glossarys using blocks instead of lists?</refpurpose>
5333 <programlisting xml:id="glossary.as.blocks.frag">
5334 <xsl:param name="glossary.as.blocks" select="0"></xsl:param>
5338 <refsection><info><title>Description</title></info>
5340 <para>If non-zero, <tag>glossary</tag>s will be formatted as
5343 <para>If you have long <tag>glossterm</tag>s, proper list
5344 markup in the FO case may produce unattractive lists. By setting this
5345 parameter, you can force the stylesheets to produce block markup
5346 instead of proper lists.</para>
5348 <para>You can override this setting with a processing instruction as the
5349 child of <tag>glossary</tag>: <tag class="xmlpi">dbfo
5350 glossary-presentation="blocks"</tag> or <tag class="xmlpi">dbfo
5351 glossary-presentation="list"</tag></para>
5356 <refentry version="5.0" xml:id="glosslist.as.blocks">
5358 <refentrytitle>glosslist.as.blocks</refentrytitle>
5359 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
5362 <refname>glosslist.as.blocks</refname>
5363 <refpurpose>Use blocks for glosslists?</refpurpose>
5367 <programlisting xml:id="glosslist.as.blocks.frag">
5368 <xsl:param name="glosslist.as.blocks" select="0"></xsl:param>
5372 <refsection><info><title>Description</title></info>
5374 <para>See <parameter>glossary.as.blocks</parameter>.</para>
5379 <refentry version="5.0" xml:id="glossentry.list.item.properties">
5381 <refentrytitle>glossentry.list.item.properties</refentrytitle>
5382 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
5385 <refname>glossentry.list.item.properties</refname>
5386 <refpurpose>To add properties to each glossentry in a list.</refpurpose>
5390 <programlisting xml:id="glossentry.list.item.properties.frag"><xsl:attribute-set name="glossentry.list.item.properties">
5391 <xsl:attribute name="space-before.optimum">1em</xsl:attribute>
5392 <xsl:attribute name="space-before.minimum">0.8em</xsl:attribute>
5393 <xsl:attribute name="space-before.maximum">1.2em</xsl:attribute>
5394 </xsl:attribute-set>
5397 <refsection><info><title>Description</title></info>
5398 <para>These properties are added to the fo:list-item containing a
5399 glossentry in a glossary when the <parameter>glossary.as.blocks</parameter> parameter
5401 Use this attribute-set to set
5402 spacing between entries, for example.</para>
5407 <refentry version="5.0" xml:id="glossterm.block.properties">
5409 <refentrytitle>glossterm.block.properties</refentrytitle>
5410 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
5413 <refname>glossterm.block.properties</refname>
5414 <refpurpose>To add properties to the block of a glossentry's glossterm.</refpurpose>
5418 <programlisting xml:id="glossterm.block.properties.frag"><xsl:attribute-set name="glossterm.block.properties">
5419 <xsl:attribute name="space-before.optimum">1em</xsl:attribute>
5420 <xsl:attribute name="space-before.minimum">0.8em</xsl:attribute>
5421 <xsl:attribute name="space-before.maximum">1.2em</xsl:attribute>
5422 <xsl:attribute name="keep-with-next.within-column">always</xsl:attribute>
5423 <xsl:attribute name="keep-together.within-column">always</xsl:attribute>
5424 </xsl:attribute-set>
5427 <refsection><info><title>Description</title></info>
5428 <para>These properties are added to the block containing a
5429 glossary term in a glossary when the <parameter>glossary.as.blocks</parameter> parameter
5431 Use this attribute-set to set the space above and below,
5433 and any indent for the glossary term.</para>
5438 <refentry version="5.0" xml:id="glossdef.block.properties">
5440 <refentrytitle>glossdef.block.properties</refentrytitle>
5441 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
5444 <refname>glossdef.block.properties</refname>
5445 <refpurpose>To add properties to the block of a glossary definition.</refpurpose>
5449 <programlisting xml:id="glossdef.block.properties.frag"><xsl:attribute-set name="glossdef.block.properties">
5450 <xsl:attribute name="margin-{$direction.align.start}">.25in</xsl:attribute>
5451 </xsl:attribute-set>
5454 <refsection><info><title>Description</title></info>
5455 <para>These properties are added to the block containing a
5456 glossary definition in a glossary when
5457 the <parameter>glossary.as.blocks</parameter> parameter
5459 Use this attribute-set to set the space above and below,
5460 any font properties,
5461 and any indent for the glossary definition.</para>
5466 <refentry version="5.0" xml:id="glossterm.list.properties">
5468 <refentrytitle>glossterm.list.properties</refentrytitle>
5469 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
5472 <refname>glossterm.list.properties</refname>
5473 <refpurpose>To add properties to the glossterm in a list.</refpurpose>
5477 <programlisting xml:id="glossterm.list.properties.frag">
5478 <xsl:attribute-set name="glossterm.list.properties">
5479 </xsl:attribute-set>
5482 <refsection><info><title>Description</title></info>
5483 <para>These properties are added to the block containing a
5484 glossary term in a glossary when the <parameter>glossary.as.blocks</parameter> parameter
5486 Use this attribute-set to set
5487 font properties, for example.</para>
5492 <refentry version="5.0" xml:id="glossdef.list.properties">
5494 <refentrytitle>glossdef.list.properties</refentrytitle>
5495 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
5498 <refname>glossdef.list.properties</refname>
5499 <refpurpose>To add properties to the glossary definition in a list.</refpurpose>
5503 <programlisting xml:id="glossdef.list.properties.frag">
5504 <xsl:attribute-set name="glossdef.list.properties">
5505 </xsl:attribute-set>
5508 <refsection><info><title>Description</title></info>
5509 <para>These properties are added to the block containing a
5510 glossary definition in a glossary when
5511 the <parameter>glossary.as.blocks</parameter> parameter
5513 Use this attribute-set to set font properties, for example.</para>
5518 <refentry version="5.0" xml:id="glossterm.width">
5520 <refentrytitle>glossterm.width</refentrytitle>
5521 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
5524 <refname>glossterm.width</refname>
5525 <refpurpose>Width of glossterm in list presentation mode</refpurpose>
5529 <programlisting xml:id="glossterm.width.frag">
5530 <xsl:param name="glossterm.width">2in</xsl:param>
5534 <refsection><info><title>Description</title></info>
5536 <para>This parameter specifies the width reserved for glossary terms when
5537 a list presentation is used.</para>
5542 <refentry version="5.0" xml:id="glossterm.separation">
5544 <refentrytitle>glossterm.separation</refentrytitle>
5545 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
5548 <refname>glossterm.separation</refname>
5549 <refpurpose>Separation between glossary terms and descriptions in list mode</refpurpose>
5553 <programlisting xml:id="glossterm.separation.frag">
5554 <xsl:param name="glossterm.separation">0.25in</xsl:param>
5558 <refsection><info><title>Description</title></info>
5560 <para>Specifies the miminum horizontal
5561 separation between glossary terms and descriptions when
5562 they are presented side-by-side using lists
5563 when the <parameter>glossary.as.blocks</parameter>
5569 <refentry version="5.0" xml:id="glossentry.show.acronym">
5571 <refentrytitle>glossentry.show.acronym</refentrytitle>
5572 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
5573 <refmiscinfo class="other" otherclass="value">no</refmiscinfo>
5574 <refmiscinfo class="other" otherclass="value">yes</refmiscinfo>
5575 <refmiscinfo class="other" otherclass="value">primary</refmiscinfo>
5578 <refname>glossentry.show.acronym</refname>
5579 <refpurpose>Display <tag>glossentry</tag> acronyms?</refpurpose>
5583 <programlisting xml:id="glossentry.show.acronym.frag">
5584 <xsl:param name="glossentry.show.acronym">no</xsl:param>
5588 <refsection><info><title>Description</title></info>
5590 <para>A setting of <quote>yes</quote> means they should be displayed;
5591 <quote>no</quote> means they shouldn't. If <quote>primary</quote> is used,
5592 then they are shown as the primary text for the entry.</para>
5595 <para>This setting controls both <tag>acronym</tag> and
5596 <tag>abbrev</tag> elements in the <tag>glossentry</tag>.</para>
5602 <refentry version="5.0" xml:id="glossary.sort">
5604 <refentrytitle>glossary.sort</refentrytitle>
5605 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
5608 <refname>glossary.sort</refname>
5609 <refpurpose>Sort glossentry elements?</refpurpose>
5613 <programlisting xml:id="glossary.sort.frag">
5614 <xsl:param name="glossary.sort" select="0"></xsl:param>
5618 <refsection><info><title>Description</title></info>
5620 <para>If non-zero, then the glossentry elements within a
5621 glossary, glossdiv, or glosslist are sorted on the glossterm, using
5622 the current lang setting. If zero (the default), then
5623 glossentry elements are not sorted and are presented
5631 <reference xml:id="misc"><title>Miscellaneous</title>
5632 <refentry version="5.0" xml:id="formal.procedures">
5634 <refentrytitle>formal.procedures</refentrytitle>
5635 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
5638 <refname>formal.procedures</refname>
5639 <refpurpose>Selects formal or informal procedures</refpurpose>
5643 <programlisting xml:id="formal.procedures.frag">
5644 <xsl:param name="formal.procedures" select="1"></xsl:param>
5648 <refsection><info><title>Description</title></info>
5650 <para>Formal procedures are numbered and always have a title.
5656 <refentry version="5.0" xml:id="formal.title.placement">
5658 <refentrytitle>formal.title.placement</refentrytitle>
5659 <refmiscinfo class="other" otherclass="datatype">table</refmiscinfo>
5662 <refname>formal.title.placement</refname>
5663 <refpurpose>Specifies where formal object titles should occur</refpurpose>
5667 <programlisting xml:id="formal.title.placement.frag">
5668 <xsl:param name="formal.title.placement">
5679 <refsection><info><title>Description</title></info>
5681 <para>Specifies where formal object titles should occur. For each formal object
5682 type (<tag>figure</tag>,
5684 <tag>equation</tag>,
5685 <tag>table</tag>, and <tag>procedure</tag>)
5686 you can specify either the keyword
5687 <quote><literal>before</literal></quote> or
5688 <quote><literal>after</literal></quote>.</para>
5693 <refentry version="5.0" xml:id="runinhead.default.title.end.punct">
5695 <refentrytitle>runinhead.default.title.end.punct</refentrytitle>
5696 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
5699 <refname>runinhead.default.title.end.punct</refname>
5700 <refpurpose>Default punctuation character on a run-in-head</refpurpose>
5704 <programlisting xml:id="runinhead.default.title.end.punct.frag"><xsl:param name="runinhead.default.title.end.punct">.</xsl:param>
5708 <refsection><info><title>Description</title></info>
5710 <para>If non-zero, For a <tag>formalpara</tag>, use the specified
5711 string as the separator between the title and following text. The period is the default value.</para>
5716 <refentry version="5.0" xml:id="runinhead.title.end.punct">
5718 <refentrytitle>runinhead.title.end.punct</refentrytitle>
5719 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
5722 <refname>runinhead.title.end.punct</refname>
5723 <refpurpose>Characters that count as punctuation on a run-in-head</refpurpose>
5727 <programlisting xml:id="runinhead.title.end.punct.frag">
5728 <xsl:param name="runinhead.title.end.punct">.!?:</xsl:param>
5732 <refsection><info><title>Description</title></info>
5734 <para>Specify which characters are to be counted as punctuation. These
5735 characters are checked for a match with the last character of the
5736 title. If no match is found, the
5737 <parameter>runinhead.default.title.end.punct</parameter> contents are
5738 inserted. This is to avoid duplicated punctuation in the output.
5744 <refentry version="5.0" xml:id="show.comments">
5746 <refentrytitle>show.comments</refentrytitle>
5747 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
5750 <refname>show.comments</refname>
5751 <refpurpose>Display <tag>remark</tag> elements?</refpurpose>
5755 <programlisting xml:id="show.comments.frag">
5756 <xsl:param name="show.comments" select="1"></xsl:param>
5760 <refsection><info><title>Description</title></info>
5762 <para>If non-zero, comments will be displayed, otherwise they
5763 are suppressed. Comments here refers to the <tag>remark</tag> element
5764 (which was called <literal>comment</literal> prior to DocBook
5765 4.0), not XML comments (<-- like this -->) which are
5772 <refentry version="5.0" xml:id="punct.honorific">
5774 <refentrytitle>punct.honorific</refentrytitle>
5775 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
5778 <refname>punct.honorific</refname>
5779 <refpurpose>Punctuation after an honorific in a personal name.</refpurpose>
5783 <programlisting xml:id="punct.honorific.frag">
5784 <xsl:param name="punct.honorific">.</xsl:param>
5788 <refsection><info><title>Description</title></info>
5790 <para>This parameter specifies the punctuation that should be added after an
5791 honorific in a personal name.</para>
5796 <refentry version="5.0" xml:id="segmentedlist.as.table">
5798 <refentrytitle>segmentedlist.as.table</refentrytitle>
5799 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
5802 <refname>segmentedlist.as.table</refname>
5803 <refpurpose>Format segmented lists as tables?</refpurpose>
5807 <programlisting xml:id="segmentedlist.as.table.frag">
5808 <xsl:param name="segmentedlist.as.table" select="0"></xsl:param>
5812 <refsection><info><title>Description</title></info>
5814 <para>If non-zero, <tag>segmentedlist</tag>s will be formatted as
5820 <refentry version="5.0" xml:id="variablelist.as.blocks">
5822 <refentrytitle>variablelist.as.blocks</refentrytitle>
5823 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
5826 <refname>variablelist.as.blocks</refname>
5827 <refpurpose>Format <tag>variablelist</tag>s lists as blocks?</refpurpose>
5831 <programlisting xml:id="variablelist.as.blocks.frag">
5832 <xsl:param name="variablelist.as.blocks" select="0"></xsl:param>
5836 <refsection><info><title>Description</title></info>
5838 <para>If non-zero, <tag>variablelist</tag>s will be formatted as
5841 <para>If you have long terms, proper list markup in the FO case may produce
5842 unattractive lists. By setting this parameter, you can force the stylesheets
5843 to produce block markup instead of proper lists.</para>
5845 <para>You can override this setting with a processing instruction as the
5846 child of <tag>variablelist</tag>: <tag class="xmlpi">dbfo
5847 list-presentation="blocks"</tag> or <tag class="xmlpi">dbfo
5848 list-presentation="list"</tag>.</para>
5850 <para>When using <literal>list-presentation="list"</literal>,
5851 you can also control the amount of space used for the <tag>term</tag>s with
5852 the <tag class="xmlpi">dbfo term-width=".25in"</tag> processing instruction,
5853 the <tag class="attribute">termlength</tag> attribute on <tag>variablelist</tag>,
5854 or allow the stylesheets to attempt to calculate the amount of space to leave based on the
5855 number of letters in the longest term.
5858 <programlisting> <variablelist>
5859 <?dbfo list-presentation="list"?>
5860 <?dbfo term-width="1.5in"?>
5861 <?dbhtml list-presentation="table"?>
5862 <?dbhtml term-width="1.5in"?>
5863 <varlistentry>
5864 <term>list</term>
5867 Formatted as a list even if variablelist.as.blocks is set to 1.
5870 </varlistentry>
5871 </variablelist></programlisting>
5878 <refentry version="5.0" xml:id="blockquote.properties">
5880 <refentrytitle>blockquote.properties</refentrytitle>
5881 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
5884 <refname>blockquote.properties</refname>
5885 <refpurpose>To set the style for block quotations.</refpurpose>
5889 <programlisting xml:id="blockquote.properties.frag">
5890 <xsl:attribute-set name="blockquote.properties">
5891 <xsl:attribute name="margin-{$direction.align.start}">0.5in</xsl:attribute>
5892 <xsl:attribute name="margin-{$direction.align.end}">0.5in</xsl:attribute>
5893 <xsl:attribute name="space-after.minimum">0.5em</xsl:attribute>
5894 <xsl:attribute name="space-after.optimum">1em</xsl:attribute>
5895 <xsl:attribute name="space-after.maximum">2em</xsl:attribute>
5896 </xsl:attribute-set>
5900 <refsection><info><title>Description</title></info>
5902 <para>The <parameter>blockquote.properties</parameter> attribute set specifies
5903 the formating properties of block quotations.</para>
5908 <refentry version="5.0" xml:id="ulink.show">
5910 <refentrytitle>ulink.show</refentrytitle>
5911 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
5914 <refname>ulink.show</refname>
5915 <refpurpose>Display URLs after <tag>ulink</tag>s?</refpurpose>
5919 <programlisting xml:id="ulink.show.frag">
5920 <xsl:param name="ulink.show" select="1"></xsl:param>
5924 <refsection><info><title>Description</title></info>
5926 <para>If non-zero, the URL of each <tag>ulink</tag> will
5927 appear after the text of the link. If the text of the link and the URL
5928 are identical, the URL is suppressed. </para>
5930 <para>See also <parameter>ulink.footnotes</parameter>.</para>
5932 <note><para>DocBook 5 does not have an <tag>ulink</tag> element. When processing
5933 DocBoook 5 documents, <parameter>ulink.show</parameter> applies to all inline
5934 elements that are marked up with <tag class="attribute">xlink:href</tag> attributes
5935 that point to external resources.</para>
5941 <refentry version="5.0" xml:id="ulink.footnotes">
5943 <refentrytitle>ulink.footnotes</refentrytitle>
5944 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
5947 <refname>ulink.footnotes</refname>
5948 <refpurpose>Generate footnotes for <tag>ulink</tag>s?</refpurpose>
5952 <programlisting xml:id="ulink.footnotes.frag">
5953 <xsl:param name="ulink.footnotes" select="0"></xsl:param>
5957 <refsection><info><title>Description</title></info>
5959 <para>If non-zero, and if <parameter>ulink.show</parameter> also is non-zero,
5960 the URL of each <tag>ulink</tag> will appear as a footnote.</para>
5962 <note><para>DocBook 5 does not have an <tag>ulink</tag> element. When processing
5963 DocBoook 5 documents, <parameter>ulink.footnotes</parameter> applies to all inline
5964 elements that are marked up with <tag class="attribute">xlink:href</tag> attributes
5965 that point to external resources.</para>
5971 <refentry version="5.0" xml:id="ulink.hyphenate">
5973 <refentrytitle>ulink.hyphenate</refentrytitle>
5974 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
5977 <refname>ulink.hyphenate</refname>
5978 <refpurpose>Allow URLs to be automatically hyphenated</refpurpose>
5982 <programlisting xml:id="ulink.hyphenate.frag">
5983 <xsl:param name="ulink.hyphenate"></xsl:param>
5987 <refsection><info><title>Description</title></info>
5989 <para>If not empty, the specified character (or more generally, content) is
5990 added to URLs after every character included in the string
5991 in the <parameter>ulink.hyphenate.chars</parameter> parameter (default
5992 is <quote>/</quote>). If the character in this parameter is a
5993 Unicode soft hyphen (0x00AD) or Unicode zero-width space (0x200B), some FO
5994 processors will be able to reasonably hyphenate long URLs.</para>
5996 <para>As of 28 Jan 2002, discretionary hyphens are more widely and correctly
5997 supported than zero-width spaces for this purpose.</para>
6002 <refentry version="5.0" xml:id="ulink.hyphenate.chars">
6004 <refentrytitle>ulink.hyphenate.chars</refentrytitle>
6005 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
6008 <refname>ulink.hyphenate.chars</refname>
6009 <refpurpose>List of characters to allow ulink URLs to be automatically hyphenated on</refpurpose>
6013 <programlisting xml:id="ulink.hyphenate.chars.frag">
6014 <xsl:param name="ulink.hyphenate.chars">/</xsl:param>
6018 <refsection><info><title>Description</title></info>
6020 <para>If the <parameter>ulink.hyphenate</parameter> is not empty, then
6021 hyphenation of ulinks is turned on, and any
6022 character contained in this parameter is treated as an allowable
6023 hyphenation point.</para>
6025 <para>The default value is <quote>/</quote>, but the parameter
6027 to contain other URL characters, as for example:</para>
6029 <xsl:param name="ulink.hyphenate.chars">:/@&?.#</xsl:param>
6035 <refentry version="5.0" xml:id="shade.verbatim">
6037 <refentrytitle>shade.verbatim</refentrytitle>
6038 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
6041 <refname>shade.verbatim</refname>
6042 <refpurpose>Should verbatim environments be shaded?</refpurpose>
6046 <programlisting xml:id="shade.verbatim.frag"><xsl:param name="shade.verbatim" select="0"></xsl:param></programlisting>
6049 <refsection><info><title>Description</title></info>
6051 <para>In the FO stylesheet, if this parameter is non-zero then the
6052 <property>shade.verbatim.style</property> properties will be applied
6053 to verbatim environments.</para>
6055 <para>In the HTML stylesheet, this parameter is now deprecated. Use
6061 <refentry version="5.0" xml:id="shade.verbatim.style">
6063 <refentrytitle>shade.verbatim.style</refentrytitle>
6064 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
6067 <refname>shade.verbatim.style</refname>
6068 <refpurpose>Properties that specify the style of shaded verbatim listings</refpurpose>
6072 <programlisting xml:id="shade.verbatim.style.frag">
6074 <xsl:attribute-set name="shade.verbatim.style">
6075 <xsl:attribute name="background-color">#E0E0E0</xsl:attribute>
6076 </xsl:attribute-set>
6080 <refsection><info><title>Description</title></info>
6082 <para>Properties that specify the style of shaded verbatim listings. The
6083 parameters specified (the border and background color) are added to
6084 the styling of the xsl-fo output. A border might be specified as "thin
6085 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>
6090 <refentry version="5.0" xml:id="hyphenate.verbatim">
6092 <refentrytitle>hyphenate.verbatim</refentrytitle>
6093 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
6096 <refname>hyphenate.verbatim</refname>
6097 <refpurpose>Should verbatim environments be hyphenated on space characters?</refpurpose>
6101 <programlisting xml:id="hyphenate.verbatim.frag"><xsl:param name="hyphenate.verbatim" select="0"></xsl:param></programlisting>
6104 <refsection><info><title>Description</title></info>
6106 <para>If the lines of program listing are too long to fit into one
6107 line it is quite common to split them at space and indicite by hook
6108 arrow that code continues on the next line. You can turn on this
6109 behaviour for <tag>programlisting</tag>,
6110 <tag>screen</tag> and <tag>synopsis</tag> elements by
6111 using this parameter.</para>
6113 <para>Note that you must also enable line wrapping for verbatim environments and
6114 select appropriate hyphenation character (e.g. hook arrow). This can
6115 be done using <parameter>monospace.verbatim.properties</parameter>
6116 attribute set:</para>
6118 <programlisting><xsl:attribute-set name="monospace.verbatim.properties"
6119 use-attribute-sets="verbatim.properties monospace.properties">
6120 <xsl:attribute name="wrap-option">wrap</xsl:attribute>
6121 <xsl:attribute name="hyphenation-character">&#x25BA;</xsl:attribute>
6122 </xsl:attribute-set></programlisting>
6124 <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
6125 selected character is available in the font you are using for verbatim
6126 environments.</para>
6131 <refentry version="5.0" xml:id="hyphenate.verbatim.characters">
6133 <refentrytitle>hyphenate.verbatim.characters</refentrytitle>
6134 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
6137 <refname>hyphenate.verbatim.characters</refname>
6138 <refpurpose>List of characters after which a line break can occur in listings</refpurpose>
6142 <programlisting xml:id="hyphenate.verbatim.characters.frag">
6143 <xsl:param name="hyphenate.verbatim.characters"></xsl:param>
6147 <refsection><info><title>Description</title></info>
6149 <para>If you enable <parameter>hyphenate.verbatim</parameter> line
6150 breaks are allowed only on space characters. If this is not enough for
6151 your document, you can specify list of additional characters after
6152 which line break is allowed in this parameter.</para>
6157 <refentry version="5.0" xml:id="use.svg">
6159 <refentrytitle>use.svg</refentrytitle>
6160 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
6163 <refname>use.svg</refname>
6164 <refpurpose>Allow SVG in the result tree?</refpurpose>
6168 <programlisting xml:id="use.svg.frag">
6169 <xsl:param name="use.svg" select="1"></xsl:param>
6173 <refsection><info><title>Description</title></info>
6175 <para>If non-zero, SVG will be considered an acceptable image format. SVG
6176 is passed through to the result tree, so correct rendering of the resulting
6177 diagram depends on the formatter (FO processor or web browser) that is used
6178 to process the output from the stylesheet.</para>
6183 <refentry version="5.0" xml:id="use.role.as.xrefstyle">
6185 <refentrytitle>use.role.as.xrefstyle</refentrytitle>
6186 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
6189 <refname>use.role.as.xrefstyle</refname>
6190 <refpurpose>Use <tag class="attribute">role</tag> attribute for
6191 <tag class="attribute">xrefstyle</tag> on <tag>xref</tag>?</refpurpose>
6195 <programlisting xml:id="use.role.as.xrefstyle.frag">
6196 <xsl:param name="use.role.as.xrefstyle" select="1"></xsl:param>
6200 <refsection><info><title>Description</title></info>
6202 <para>In DocBook documents that conform to a schema older than V4.3, this parameter allows
6203 <tag class="attribute">role</tag> to serve the purpose of specifying the cross reference style.</para>
6205 <para>If non-zero, the <tag class="attribute">role</tag> attribute on
6206 <tag>xref</tag> will be used to select the cross reference style.
6207 In DocBook V4.3, the <tag class="attribute">xrefstyle</tag> attribute was added for this purpose.
6208 If the <tag class="attribute">xrefstyle</tag> attribute is present,
6209 <tag class="attribute">role</tag> will be ignored, regardless of the setting
6210 of this parameter.</para>
6214 <refsection><info><title>Example</title></info>
6216 <para>The following small stylesheet shows how to configure the
6217 stylesheets to make use of the cross reference style:</para>
6219 <programlisting><?xml version="1.0"?>
6220 <xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
6223 <xsl:import href="../xsl/html/docbook.xsl"/>
6225 <xsl:output method="html"/>
6227 <xsl:param name="local.l10n.xml" select="document('')"/>
6228 <l:i18n xmlns:l="http://docbook.sourceforge.net/xmlns/l10n/1.0">
6229 <l:l10n xmlns:l="http://docbook.sourceforge.net/xmlns/l10n/1.0" language="en">
6230 <l:context name="xref">
6231 <l:template name="chapter" style="title" text="Chapter %n, %t"/>
6232 <l:template name="chapter" text="Chapter %n"/>
6237 </xsl:stylesheet></programlisting>
6239 <para>With this stylesheet, the cross references in the following document:</para>
6241 <programlisting><?xml version="1.0" encoding="utf-8"?>
6242 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
6243 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
6244 <book id="book"><title>Book</title>
6247 <title>Preface</title>
6249 <para>Normal: <xref linkend="ch1"/>.</para>
6250 <para>Title: <xref xrefstyle="title" linkend="ch1"/>.</para>
6254 <chapter id="ch1">
6255 <title>First Chapter</title>
6257 <para>Irrelevant.</para>
6260 </book></programlisting>
6262 <para>will appear as:</para>
6265 <para>Normal: Chapter 1.</para>
6266 <para>Title: Chapter 1, <emphasis>First Chapter</emphasis>.</para>
6272 <refentry version="5.0" xml:id="menuchoice.separator">
6274 <refentrytitle>menuchoice.separator</refentrytitle>
6275 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
6278 <refname>menuchoice.separator</refname>
6279 <refpurpose>Separator between items of a <tag>menuchoice</tag>
6280 other than <tag>guimenuitem</tag> and
6281 <tag>guisubmenu</tag></refpurpose>
6285 <programlisting xml:id="menuchoice.separator.frag">
6286 <xsl:param name="menuchoice.separator">+</xsl:param>
6290 <refsection><info><title>Description</title></info>
6292 <para>Separator used to connect items of a <tag>menuchoice</tag> other
6293 than <tag>guimenuitem</tag> and <tag>guisubmenu</tag>. The latter
6294 elements are linked with <parameter>menuchoice.menu.separator</parameter>.
6300 <refentry version="5.0" xml:id="menuchoice.menu.separator">
6302 <refentrytitle>menuchoice.menu.separator</refentrytitle>
6303 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
6306 <refname>menuchoice.menu.separator</refname>
6307 <refpurpose>Separator between items of a <tag>menuchoice</tag>
6308 with <tag>guimenuitem</tag> or
6309 <tag>guisubmenu</tag></refpurpose>
6313 <programlisting xml:id="menuchoice.menu.separator.frag">
6314 <xsl:param name="menuchoice.menu.separator"> → </xsl:param>
6318 <refsection><info><title>Description</title></info>
6320 <para>Separator used to connect items of a <tag>menuchoice</tag> with
6321 <tag>guimenuitem</tag> or <tag>guisubmenu</tag>. Other elements
6322 are linked with <parameter>menuchoice.separator</parameter>.
6324 <para>The default value is &#x2192;, which is the
6325 &rarr; (right arrow) character entity.
6326 The current FOP (0.20.5) requires setting the font-family
6329 <para>The default value also includes spaces around the arrow,
6330 which will allow a line to break. Replace the spaces with
6331 &#xA0; (nonbreaking space) if you don't want those
6338 <refentry version="5.0" xml:id="default.float.class">
6340 <refentrytitle>default.float.class</refentrytitle>
6341 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
6344 <refname>default.float.class</refname>
6345 <refpurpose>Specifies the default float class</refpurpose>
6349 <programlisting xml:id="default.float.class.frag">
6350 <xsl:param name="default.float.class">
6352 <xsl:when test="contains($stylesheet.result.type,'html')">left</xsl:when>
6353 <xsl:otherwise>before</xsl:otherwise>
6359 <refsection><info><title>Description</title></info>
6361 <para>Selects the direction in which a float should be placed. for
6362 xsl-fo this is before, for html it is left. For Western texts, the
6363 before direction is the top of the page.</para>
6368 <refentry version="5.0" xml:id="footnote.number.format">
6370 <refentrytitle>footnote.number.format</refentrytitle>
6371 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
6372 <refmiscinfo class="other" otherclass="value">1<alt>1,2,3...</alt></refmiscinfo>
6373 <refmiscinfo class="other" otherclass="value">A<alt>A,B,C...</alt></refmiscinfo>
6374 <refmiscinfo class="other" otherclass="value">a<alt>a,b,c...</alt></refmiscinfo>
6375 <refmiscinfo class="other" otherclass="value">i<alt>i,ii,iii...</alt></refmiscinfo>
6376 <refmiscinfo class="other" otherclass="value">I<alt>I,II,III...</alt></refmiscinfo>
6379 <refname>footnote.number.format</refname>
6380 <refpurpose>Identifies the format used for footnote numbers</refpurpose>
6384 <programlisting xml:id="footnote.number.format.frag">
6385 <xsl:param name="footnote.number.format">1</xsl:param>
6389 <refsection><info><title>Description</title></info>
6391 <para>The <parameter>footnote.number.format</parameter> specifies the format
6392 to use for footnote numeration (1, i, I, a, or A).</para>
6397 <refentry version="5.0" xml:id="table.footnote.number.format">
6399 <refentrytitle>table.footnote.number.format</refentrytitle>
6400 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
6401 <refmiscinfo class="other" otherclass="value">1<alt>1,2,3...</alt></refmiscinfo>
6402 <refmiscinfo class="other" otherclass="value">A<alt>A,B,C...</alt></refmiscinfo>
6403 <refmiscinfo class="other" otherclass="value">a<alt>a,b,c...</alt></refmiscinfo>
6404 <refmiscinfo class="other" otherclass="value">i<alt>i,ii,iii...</alt></refmiscinfo>
6405 <refmiscinfo class="other" otherclass="value">I<alt>I,II,III...</alt></refmiscinfo>
6408 <refname>table.footnote.number.format</refname>
6409 <refpurpose>Identifies the format used for footnote numbers in tables</refpurpose>
6413 <programlisting xml:id="table.footnote.number.format.frag">
6414 <xsl:param name="table.footnote.number.format">a</xsl:param>
6418 <refsection><info><title>Description</title></info>
6420 <para>The <parameter>table.footnote.number.format</parameter> specifies the format
6421 to use for footnote numeration (1, i, I, a, or A) in tables.</para>
6426 <refentry version="5.0" xml:id="footnote.number.symbols">
6428 <refentrytitle>footnote.number.symbols</refentrytitle>
6429 <refmiscinfo class="other" otherclass="datatype"/>
6432 <refname>footnote.number.symbols</refname>
6433 <refpurpose>Special characters to use as footnote markers</refpurpose>
6437 <programlisting xml:id="footnote.number.symbols.frag">
6438 <xsl:param name="footnote.number.symbols"></xsl:param>
6442 <refsection><info><title>Description</title></info>
6444 <para>If <parameter>footnote.number.symbols</parameter> is not the empty string,
6445 footnotes will use the characters it contains as footnote symbols. For example,
6446 <quote>*&#x2020;&#x2021;&#x25CA;&#x2720;</quote> will identify
6447 footnotes with <quote>*</quote>, <quote>†</quote>, <quote>‡</quote>,
6448 <quote>◊</quote>, and <quote>✠</quote>. If there are more footnotes
6449 than symbols, the stylesheets will fall back to numbered footnotes using
6450 <parameter>footnote.number.format</parameter>.</para>
6452 <para>The use of symbols for footnotes depends on the ability of your
6453 processor (or browser) to render the symbols you select. Not all systems are
6454 capable of displaying the full range of Unicode characters. If the quoted characters
6455 in the preceding paragraph are not displayed properly, that's a good indicator
6456 that you may have trouble using those symbols for footnotes.</para>
6461 <refentry version="5.0" xml:id="table.footnote.number.symbols">
6463 <refentrytitle>table.footnote.number.symbols</refentrytitle>
6464 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
6467 <refname>table.footnote.number.symbols</refname>
6468 <refpurpose>Special characters to use a footnote markers in tables</refpurpose>
6472 <programlisting xml:id="table.footnote.number.symbols.frag">
6473 <xsl:param name="table.footnote.number.symbols"></xsl:param>
6477 <refsection><info><title>Description</title></info>
6479 <para>If <parameter>table.footnote.number.symbols</parameter> is not the empty string,
6480 table footnotes will use the characters it contains as footnote symbols. For example,
6481 <quote>*&#x2020;&#x2021;&#x25CA;&#x2720;</quote> will identify
6482 footnotes with <quote>*</quote>, <quote>†</quote>, <quote>‡</quote>,
6483 <quote>◊</quote>, and <quote>✠</quote>. If there are more footnotes
6484 than symbols, the stylesheets will fall back to numbered footnotes using
6485 <parameter>table.footnote.number.format</parameter>.</para>
6487 <para>The use of symbols for footnotes depends on the ability of your
6488 processor (or browser) to render the symbols you select. Not all systems are
6489 capable of displaying the full range of Unicode characters. If the quoted characters
6490 in the preceding paragraph are not displayed properly, that's a good indicator
6491 that you may have trouble using those symbols for footnotes.</para>
6496 <refentry version="5.0" xml:id="footnote.properties">
6498 <refentrytitle>footnote.properties</refentrytitle>
6499 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
6502 <refname>footnote.properties</refname>
6503 <refpurpose>Properties applied to each footnote body
6508 <programlisting xml:id="footnote.properties.frag">
6509 <xsl:attribute-set name="footnote.properties">
6510 <xsl:attribute name="font-family"><xsl:value-of select="$body.fontset"></xsl:value-of></xsl:attribute>
6511 <xsl:attribute name="font-size"><xsl:value-of select="$footnote.font.size"></xsl:value-of></xsl:attribute>
6512 <xsl:attribute name="font-weight">normal</xsl:attribute>
6513 <xsl:attribute name="font-style">normal</xsl:attribute>
6514 <xsl:attribute name="text-align"><xsl:value-of select="$alignment"></xsl:value-of></xsl:attribute>
6515 <xsl:attribute name="start-indent">0pt</xsl:attribute>
6516 <xsl:attribute name="text-indent">0pt</xsl:attribute>
6517 <xsl:attribute name="hyphenate"><xsl:value-of select="$hyphenate"></xsl:value-of></xsl:attribute>
6518 <xsl:attribute name="wrap-option">wrap</xsl:attribute>
6519 <xsl:attribute name="linefeed-treatment">treat-as-space</xsl:attribute>
6520 </xsl:attribute-set>
6524 <refsection><info><title>Description</title></info>
6526 <para>This attribute set is applied to the footnote-block
6528 It can be used to set the
6529 font-size, font-family, and other inheritable properties that will be
6530 applied to all footnotes.</para>
6535 <refentry version="5.0" xml:id="table.footnote.properties">
6537 <refentrytitle>table.footnote.properties</refentrytitle>
6538 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
6541 <refname>table.footnote.properties</refname>
6542 <refpurpose>Properties applied to each table footnote body
6547 <programlisting xml:id="table.footnote.properties.frag">
6548 <xsl:attribute-set name="table.footnote.properties">
6549 <xsl:attribute name="font-family"><xsl:value-of select="$body.fontset"></xsl:value-of></xsl:attribute>
6550 <xsl:attribute name="font-size"><xsl:value-of select="$footnote.font.size"></xsl:value-of></xsl:attribute>
6551 <xsl:attribute name="font-weight">normal</xsl:attribute>
6552 <xsl:attribute name="font-style">normal</xsl:attribute>
6553 <xsl:attribute name="space-before">2pt</xsl:attribute>
6554 <xsl:attribute name="text-align"><xsl:value-of select="$alignment"></xsl:value-of></xsl:attribute>
6555 </xsl:attribute-set>
6559 <refsection><info><title>Description</title></info>
6561 <para>This attribute set is applied to the footnote-block
6562 for each table footnote.
6563 It can be used to set the
6564 font-size, font-family, and other inheritable properties that will be
6565 applied to all table footnotes.</para>
6570 <refentry version="5.0" xml:id="footnote.mark.properties">
6572 <refentrytitle>footnote.mark.properties</refentrytitle>
6573 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
6576 <refname>footnote.mark.properties</refname>
6577 <refpurpose>Properties applied to each footnote mark
6582 <programlisting xml:id="footnote.mark.properties.frag">
6583 <xsl:attribute-set name="footnote.mark.properties">
6584 <xsl:attribute name="font-family"><xsl:value-of select="$body.fontset"></xsl:value-of></xsl:attribute>
6585 <xsl:attribute name="font-size">75%</xsl:attribute>
6586 <xsl:attribute name="font-weight">normal</xsl:attribute>
6587 <xsl:attribute name="font-style">normal</xsl:attribute>
6588 </xsl:attribute-set>
6592 <refsection><info><title>Description</title></info>
6594 <para>This attribute set is applied to the footnote mark used
6596 It should contain only inline properties.
6599 <para>The property to make the mark a superscript is contained in the
6600 footnote template itself, because the current version of FOP reports
6601 an error if baseline-shift is used.
6607 <refentry version="5.0" xml:id="footnote.sep.leader.properties">
6609 <refentrytitle>footnote.sep.leader.properties</refentrytitle>
6610 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
6613 <refname>footnote.sep.leader.properties</refname>
6614 <refpurpose>Properties associated with footnote separators</refpurpose>
6618 <programlisting xml:id="footnote.sep.leader.properties.frag">
6619 <xsl:attribute-set name="footnote.sep.leader.properties">
6620 <xsl:attribute name="color">black</xsl:attribute>
6621 <xsl:attribute name="leader-pattern">rule</xsl:attribute>
6622 <xsl:attribute name="leader-length">1in</xsl:attribute>
6623 </xsl:attribute-set>
6627 <refsection><info><title>Description</title></info>
6629 <para>The styling for the rule line that separates the
6630 footnotes from the body text.
6631 These are properties applied to the fo:leader used as
6634 <para>If you want to do more than just set properties on
6635 the leader element, then you can customize the template
6636 named <literal>footnote.separator</literal> in
6637 <filename>fo/pagesetup.xsl</filename>.</para>
6642 <refentry version="5.0" xml:id="xref.with.number.and.title">
6644 <refentrytitle>xref.with.number.and.title</refentrytitle>
6645 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
6648 <refname>xref.with.number.and.title</refname>
6649 <refpurpose>Use number and title in cross references</refpurpose>
6653 <programlisting xml:id="xref.with.number.and.title.frag">
6654 <xsl:param name="xref.with.number.and.title" select="1"></xsl:param>
6658 <refsection><info><title>Description</title></info>
6660 <para>A cross reference may include the number (for example, the number of
6661 an example or figure) and the <tag>title</tag> which is a required child of some
6662 targets. This parameter inserts both the relevant number as well as
6663 the title into the link. </para>
6668 <refentry version="5.0" xml:id="superscript.properties">
6670 <refentrytitle>superscript.properties</refentrytitle>
6671 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
6674 <refname>superscript.properties</refname>
6675 <refpurpose>Properties associated with superscripts</refpurpose>
6679 <programlisting xml:id="superscript.properties.frag">
6680 <xsl:attribute-set name="superscript.properties">
6681 <xsl:attribute name="font-size">75%</xsl:attribute>
6682 </xsl:attribute-set>
6686 <refsection><info><title>Description</title></info>
6688 <para>Specifies styling properties for superscripts.</para>
6693 <refentry version="5.0" xml:id="subscript.properties">
6695 <refentrytitle>subscript.properties</refentrytitle>
6696 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
6699 <refname>subscript.properties</refname>
6700 <refpurpose>Properties associated with subscripts</refpurpose>
6704 <programlisting xml:id="subscript.properties.frag">
6705 <xsl:attribute-set name="subscript.properties">
6706 <xsl:attribute name="font-size">75%</xsl:attribute>
6707 </xsl:attribute-set>
6711 <refsection><info><title>Description</title></info>
6713 <para>Specifies styling properties for subscripts.</para>
6718 <refentry version="5.0" xml:id="pgwide.properties">
6720 <refentrytitle>pgwide.properties</refentrytitle>
6721 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
6724 <refname>pgwide.properties</refname>
6725 <refpurpose>Properties to make a figure or table page wide.
6730 <programlisting xml:id="pgwide.properties.frag">
6731 <xsl:attribute-set name="pgwide.properties">
6732 <xsl:attribute name="start-indent">0pt</xsl:attribute>
6733 </xsl:attribute-set>
6737 <refsection><info><title>Description</title></info>
6739 <para>This attribute set is used to set the properties
6740 that make a figure or table "page wide" in fo output.
6741 It comes into effect when an attribute <literal>pgwide="1"</literal>
6746 By default, it sets <parameter>start-indent</parameter>
6747 to <literal>0pt</literal>.
6748 In a stylesheet that sets the parameter
6749 <parameter>body.start.indent</parameter>
6750 to a non-zero value in order to indent body text,
6751 this attribute set can be used to outdent pgwide
6752 figures to the start margin.
6755 <para>If a document uses a multi-column page layout,
6756 then this attribute set could try setting <parameter>span</parameter>
6757 to a value of <literal>all</literal>. However, this may
6758 not work with some processors because a span property must be on an
6759 fo:block that is a direct child of fo:flow. It may work in
6760 some processors anyway.
6766 <refentry version="5.0" xml:id="highlight.source">
6768 <refentrytitle>highlight.source</refentrytitle>
6769 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
6772 <refname>highlight.source</refname>
6773 <refpurpose>Should the content of <tag>programlisting</tag>
6774 be syntactically highlighted?</refpurpose>
6778 <programlisting xml:id="highlight.source.frag">
6779 <xsl:param name="highlight.source" select="0"></xsl:param>
6783 <refsection><info><title>Description</title></info>
6785 <para>When this parameter is non-zero, the stylesheets will try to do syntax highlighting of the
6786 content of <tag>programlisting</tag> elements. You specify the language for each programlisting
6787 by using the <tag class="attribute">language</tag> attribute. The <parameter>highlight.default.language</parameter>
6788 parameter can be used to specify the language for programlistings without a <tag class="attribute">language</tag>
6789 attribute. Syntax highlighting also works for <tag>screen</tag> and <tag>synopsis</tag> elements.</para>
6791 <para>The actual highlighting work is done by the XSLTHL extension module. This is an external Java library that has to be
6792 downloaded separately (see below).</para>
6795 <para>In order to use this extension, you must</para>
6797 <listitem><para>add <filename>xslthl-2.x.x.jar</filename> to your Java classpath. The latest version is available
6798 from <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://sourceforge.net/projects/xslthl">the XSLT syntax highlighting project</link>
6799 at SourceForge.</para>
6802 <para>use a customization layer in which you import one of the following stylesheet modules:
6805 <para><filename>html/highlight.xsl</filename>
6809 <para><filename>xhtml/highlight.xsl</filename>
6813 <para><filename>xhtml-1_1/highlight.xsl</filename>
6817 <para><filename>fo/highlight.xsl</filename>
6823 <listitem><para>let either the <literal>xslthl.config</literal> Java system property or the
6824 <parameter>highlight.xslthl.config</parameter> parameter point to the configuration file for syntax
6825 highlighting (using URL syntax). DocBook XSL comes with a ready-to-use configuration file,
6826 <filename>highlighting/xslthl-config.xml</filename>.</para>
6830 <para>The extension works with Saxon 6.5.x and Xalan-J. (Saxon 8.5 or later is also supported, but since it is
6831 an XSLT 2.0 processor it is not guaranteed to work with DocBook XSL in all circumstances.)</para>
6833 <para>The following is an example of a Saxon 6 command adapted for syntax highlighting, to be used on Windows:</para>
6836 <para><command>java -cp c:/Java/saxon.jar;c:/Java/xslthl-2.0.1.jar
6837 -Dxslthl.config=file:///c:/docbook-xsl/highlighting/xslthl-config.xml com.icl.saxon.StyleSheet
6838 -o test.html test.xml myhtml.xsl</command></para>
6844 <refentry version="5.0" xml:id="highlight.xslthl.config">
6846 <refentrytitle>highlight.xslthl.config</refentrytitle>
6847 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
6850 <refname>highlight.xslthl.config</refname>
6851 <refpurpose>Location of XSLTHL configuration file</refpurpose>
6855 <programlisting xml:id="highlight.xslthl.config.frag">
6856 <xsl:param name="highlight.xslthl.config"></xsl:param>
6860 <refsection><info><title>Description</title></info>
6862 <para>This location has precedence over the corresponding Java property.</para>
6864 <para>Please note that usually you have to specify location as URL not
6865 just as a simple path on the local
6866 filesystem. E.g. <filename>file:///home/user/xslthl/my-xslthl-config.xml</filename>.</para>
6873 <refentry version="5.0" xml:id="highlight.default.language">
6875 <refentrytitle>highlight.default.language</refentrytitle>
6876 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
6879 <refname>highlight.default.language</refname>
6880 <refpurpose>Default language of programlisting</refpurpose>
6884 <programlisting xml:id="highlight.default.language.frag">
6885 <xsl:param name="highlight.default.language"></xsl:param>
6889 <refsection><info><title>Description</title></info>
6891 <para>This language is used when there is no language attribute on programlisting.</para>
6896 <refentry version="5.0" xml:id="email.delimiters.enabled">
6898 <refentrytitle>email.delimiters.enabled</refentrytitle>
6899 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
6902 <refname>email.delimiters.enabled</refname>
6903 <refpurpose>Generate delimiters around email addresses?</refpurpose>
6907 <programlisting xml:id="email.delimiters.enabled.frag">
6908 <xsl:param name="email.delimiters.enabled" select="1"></xsl:param>
6912 <refsection><info><title>Description</title></info>
6914 <para>If non-zero, delimiters
6916 <footnote><para>For delimiters, the
6917 stylesheets are currently hard-coded to output angle
6918 brackets.</para></footnote>
6920 are generated around e-mail addresses
6921 (the output of the <tag>email</tag> element).</para>
6926 <refentry version="5.0" xml:id="email.mailto.enabled">
6928 <refentrytitle>email.mailto.enabled</refentrytitle>
6929 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
6932 <refname>email.mailto.enabled</refname>
6933 <refpurpose>Generate mailto: links for email addresses?</refpurpose>
6937 <programlisting xml:id="email.mailto.enabled.frag">
6938 <xsl:param name="email.mailto.enabled" select="0"></xsl:param>
6942 <refsection><info><title>Description</title></info>
6944 <para>If non-zero the generated output for the <tag>email</tag> element
6945 will be a clickable mailto: link that brings up the default mail client
6946 on the system.</para>
6951 <refentry version="5.0" xml:id="section.container.element">
6953 <refentrytitle>section.container.element</refentrytitle>
6954 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
6955 <refmiscinfo class="other" otherclass="value">block</refmiscinfo>
6956 <refmiscinfo class="other" otherclass="value">wrapper</refmiscinfo>
6959 <refname>section.container.element</refname>
6960 <refpurpose>Select XSL-FO element name to contain sections</refpurpose>
6964 <programlisting xml:id="section.container.element.frag">
6965 <xsl:param name="section.container.element">block</xsl:param>
6969 <refsection><info><title>Description</title></info>
6971 <para>Selects the element name for outer container of
6972 each section. The choices are <literal>block</literal> (default)
6973 or <literal>wrapper</literal>.
6974 The <literal>fo:</literal> namespace prefix is added
6975 by the stylesheet to form the full element name.
6978 <para>This element receives the section <literal>id</literal>
6979 attribute and the appropriate section level attribute-set.
6982 <para>Changing this parameter to <literal>wrapper</literal>
6983 is only necessary when producing multi-column output
6984 that contains page-wide spans. Using <literal>fo:wrapper</literal>
6985 avoids the nesting of <literal>fo:block</literal>
6986 elements that prevents spans from working (the standard says
6987 a span must be on a block that is a direct child of
6988 <literal>fo:flow</literal>).
6991 <para>If set to <literal>wrapper</literal>, the
6992 section attribute-sets only support properties
6993 that are inheritable. That's because there is no
6994 block to apply them to. Properties such as
6995 font-family are inheritable, but properties such as
6999 <para>Only some XSL-FO processors need to use this parameter.
7000 The Antenna House processor, for example, will handle
7001 spans in nested blocks without changing the element name.
7002 The RenderX XEP product and FOP follow the XSL-FO standard
7003 and need to use <literal>wrapper</literal>.
7009 <refentry version="5.0" xml:id="monospace.verbatim.font.width">
7011 <refentrytitle>monospace.verbatim.font.width</refentrytitle>
7012 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
7015 <refname>monospace.verbatim.font.width</refname>
7016 <refpurpose>Width of a single monospace font character</refpurpose>
7020 <programlisting xml:id="monospace.verbatim.font.width.frag">
7021 <xsl:param name="monospace.verbatim.font.width">0.60em</xsl:param>
7025 <refsection><info><title>Description</title></info>
7027 <para>Specifies with em units the width of a single character
7028 of the monospace font. The default value is <literal>0.6em</literal>.</para>
7030 <para>This parameter is only used when a <tag>screen</tag>
7031 or <tag>programlisting</tag> element has a
7032 <tag class="attribute">width</tag> attribute, which is
7033 expressed as a plain integer to indicate the maximum character count
7035 To convert this character count to an actual maximum width
7036 measurement, the width of the font characters must be provided.
7037 Different monospace fonts have different character width,
7038 so this parameter should be adjusted to fit the
7039 monospace font being used.
7045 <refentry version="5.0" xml:id="exsl.node.set.available">
7047 <refentrytitle>exsl.node.set.available</refentrytitle>
7048 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
7051 <refname>exsl.node.set.available</refname>
7052 <refpurpose>Is the test function-available('exsl:node-set') true?</refpurpose>
7056 <programlisting xml:id="exsl.node.set.available.frag"><xsl:param name="exsl.node.set.available">
7058 <xsl:when exsl:foo="" test="function-available('exsl:node-set') or contains(system-property('xsl:vendor'), 'Apache Software Foundation')">1</xsl:when>
7059 <xsl:otherwise>0</xsl:otherwise>
7065 <refsection><info><title>Description</title></info>
7068 then the exsl:node-set() function is available to be used in
7070 If zero, then the function is not available.
7071 This param automatically detects the presence of
7072 the function and does not normally need to be set manually.</para>
7074 <para>This param was created to handle a long-standing
7075 bug in the Xalan processor that fails to detect the
7076 function even though it is available.</para>
7081 <refentry version="5.0" xml:id="bookmarks.collapse">
7083 <refentrytitle>bookmarks.collapse</refentrytitle>
7084 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
7087 <refname>bookmarks.collapse</refname>
7088 <refpurpose>Specifies the initial state of bookmarks</refpurpose>
7092 <programlisting xml:id="bookmarks.collapse.frag">
7093 <xsl:param name="bookmarks.collapse" select="1"></xsl:param>
7097 <refsection><info><title>Description</title></info>
7099 <para>If non-zero, the bookmark tree is collapsed so that only the
7100 top-level bookmarks are displayed initially. Otherwise, the whole tree
7101 of bookmarks is displayed.</para>
7103 <para>This parameter currently works with FOP 0.93 or later.</para>
7109 <reference xml:id="graphics"><title>Graphics</title>
7110 <refentry version="5.0" xml:id="graphic.default.extension">
7112 <refentrytitle>graphic.default.extension</refentrytitle>
7113 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
7116 <refname>graphic.default.extension</refname>
7117 <refpurpose>Default extension for graphic filenames</refpurpose>
7121 <programlisting xml:id="graphic.default.extension.frag"><xsl:param name="graphic.default.extension"></xsl:param></programlisting>
7124 <refsection><info><title>Description</title></info>
7126 <para>If a <tag>graphic</tag> or <tag>mediaobject</tag>
7127 includes a reference to a filename that does not include an extension,
7128 and the <tag class="attribute">format</tag> attribute is
7129 <emphasis>unspecified</emphasis>, the default extension will be used.
7135 <refentry version="5.0" xml:id="default.image.width">
7137 <refentrytitle>default.image.width</refentrytitle>
7138 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
7141 <refname>default.image.width</refname>
7142 <refpurpose>The default width of images</refpurpose>
7146 <programlisting xml:id="default.image.width.frag">
7147 <xsl:param name="default.image.width"></xsl:param>
7151 <refsection><info><title>Description</title></info>
7153 <para>If specified, this value will be used for the
7154 <tag class="attribute">width</tag> attribute on images that do not specify any
7155 <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>
7160 <refentry version="5.0" xml:id="preferred.mediaobject.role">
7162 <refentrytitle>preferred.mediaobject.role</refentrytitle>
7163 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
7166 <refname>preferred.mediaobject.role</refname>
7167 <refpurpose>Select which mediaobject to use based on
7168 this value of an object's <tag class="attribute">role</tag> attribute.
7173 <programlisting xml:id="preferred.mediaobject.role.frag">
7174 <xsl:param name="preferred.mediaobject.role"></xsl:param>
7178 <refsection><info><title>Description</title></info>
7180 <para>A mediaobject may contain several objects such as imageobjects.
7181 If the parameter <parameter>use.role.for.mediaobject</parameter> is
7182 non-zero, then the <literal>role</literal> attribute on
7183 <tag>imageobject</tag>s and other objects within a
7184 <tag>mediaobject</tag> container will be used to select which object
7185 will be used. If one of the objects has a role value that matches the
7186 <parameter>preferred.mediaobject.role</parameter> parameter, then it
7187 has first priority for selection. If more than one has such a role
7188 value, the first one is used.
7191 See the <parameter>use.role.for.mediaobject</parameter> parameter
7192 for the sequence of selection.</para>
7196 <refentry version="5.0" xml:id="use.role.for.mediaobject">
7198 <refentrytitle>use.role.for.mediaobject</refentrytitle>
7199 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
7202 <refname>use.role.for.mediaobject</refname>
7203 <refpurpose>Use <tag class="attribute">role</tag> attribute
7204 value for selecting which of several objects within a mediaobject to use.
7209 <programlisting xml:id="use.role.for.mediaobject.frag">
7210 <xsl:param name="use.role.for.mediaobject" select="1"></xsl:param>
7214 <refsection><info><title>Description</title></info>
7216 <para>If non-zero, the <tag class="attribute">role</tag> attribute on
7217 <tag>imageobject</tag>s or other objects within a <tag>mediaobject</tag> container will be used to select which object will be
7221 The order of selection when then parameter is non-zero is:
7225 <para>If the stylesheet parameter <parameter>preferred.mediaobject.role</parameter> has a value, then the object whose role equals that value is selected.</para>
7228 <para>Else if an object's role attribute has a value of
7229 <literal>html</literal> for HTML processing or
7230 <literal>fo</literal> for FO output, then the first
7231 of such objects is selected.
7235 <para>Else the first suitable object is selected.</para>
7240 <parameter>use.role.for.mediaobject</parameter>
7241 is zero, then role attributes are not considered
7242 and the first suitable object
7243 with or without a role value is used.
7248 <refentry version="5.0" xml:id="ignore.image.scaling">
7250 <refentrytitle>ignore.image.scaling</refentrytitle>
7251 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
7254 <refname>ignore.image.scaling</refname>
7255 <refpurpose>Tell the stylesheets to ignore the author's image scaling attributes</refpurpose>
7259 <programlisting xml:id="ignore.image.scaling.frag">
7260 <xsl:param name="ignore.image.scaling" select="0"></xsl:param>
7264 <refsection><info><title>Description</title></info>
7266 <para>If non-zero, the scaling attributes on graphics and media objects are
7272 <refentry version="5.0" xml:id="img.src.path">
7274 <refentrytitle>img.src.path</refentrytitle>
7275 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
7278 <refname>img.src.path</refname>
7279 <refpurpose>Path to HTML/FO image files</refpurpose>
7283 <programlisting xml:id="img.src.path.frag"><xsl:param name="img.src.path"></xsl:param></programlisting>
7286 <refsection><info><title>Description</title></info>
7288 <para>Add a path prefix to the value of the <tag class="attribute">fileref</tag>
7289 attribute of <tag>graphic</tag>, <tag>inlinegraphic</tag>, and <tag>imagedata</tag> elements. The resulting
7290 compound path is used in the output as the value of the <tag class="attribute">src</tag>
7291 attribute of <tag class="element">img</tag> (HTML) or <tag class="element">external-graphic</tag> (FO).
7295 The path given by <literal>img.src.path</literal> could be relative to the directory where the HTML/FO
7296 files are created, or it could be an absolute URI.
7297 The default value is empty.
7298 Be sure to include a trailing slash if needed.
7301 <para>This prefix is not applied to any filerefs that start
7302 with "/" or contain "//:".
7308 <refentry version="5.0" xml:id="keep.relative.image.uris">
7310 <refentrytitle>keep.relative.image.uris</refentrytitle>
7311 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
7314 <refname>keep.relative.image.uris</refname>
7315 <refpurpose>Should image URIs be resolved against xml:base?</refpurpose>
7319 <programlisting xml:id="keep.relative.image.uris.frag">
7321 <xsl:param name="keep.relative.image.uris" select="0"></xsl:param>
7325 <refsection><info><title>Description</title></info>
7327 <para>If non-zero, relative URIs (in, for example
7328 <literal>fileref</literal> attributes) will be used in the generated
7329 output. Otherwise, the URIs will be made absolute with respect to the
7332 <para>Note that the stylesheets calculate (and use) the absolute form
7333 for some purposes, this only applies to the resulting output.</para>
7339 <reference xml:id="general"><title>Pagination and General Styles</title>
7340 <partintro xml:id="margins_partintro">
7341 <section xml:id="margins_intro"><title>Understanding XSL FO Margins</title>
7343 <para>To make sense of the parameters in this section, it's useful to
7344 consider <xref linkend="fig.pagemodel"/>.</para>
7346 <figure xml:id="fig.pagemodel">
7347 <title>Page Model</title>
7348 <mediaobject xml:id="fo-pageregions-image">
7349 <imageobject role="html">
7350 <imagedata fileref="page.png"/>
7352 <imageobject role="fo">
7353 <imagedata fileref="fo/page.png"/>
7355 <textobject><phrase>Figure showing page margins</phrase></textobject>
7357 <para>This figure shows the physical page with the various FO page regions
7363 <para>First, let's consider the regions on the page.</para>
7365 <para>The white region is the physical page. Its dimensions are determined by
7366 the <parameter>page.height</parameter> and <parameter>page.width</parameter>
7369 <para>The yellow region is the region-body. The size and placement of
7370 the region body is constrained by the dimensions labelled in the
7373 <para>The pink region at the top of the page is the region-before. The
7374 darker area inside the region-before is the header text. In XSL, the default
7375 display alignment for a region is <literal>before</literal>, but the
7376 DocBook stylesheets still explicitly make it <literal>before</literal>. That's
7377 why the darker area is at the top.</para>
7379 <para>The pink region at the bottom of the page is the region-after.
7380 The darker area is the footer text. In XSL, the default display
7381 alignment for a region is <literal>before</literal>,
7382 but the DocBook stylesheets explicitly make it
7383 <literal>after</literal>. That's why the darker area is at the bottom.</para>
7385 <para>The dimensions in the figure are:</para>
7387 <orderedlist numeration="upperalpha">
7388 <listitem><para>The page-master margin-top.
7390 <listitem><para>The region-before extent.
7392 <listitem><para>The region-body margin-top.
7394 <listitem><para>The region-after extent.
7396 <listitem><para>The page-master margin-bottom.
7398 <listitem><para>The region-body margin-bottom.
7400 <listitem><para>The sum of the page-master margin-left and the
7401 region-body margin-left. In DocBook, the region-body margin-left is
7402 zero by default, so this is simply the page-master margin-left.
7404 <listitem><para>The sum of the page-master margin-right and the
7405 region-body margin-right. In DocBook, the region-body margin-right is
7406 zero by default, so this is simply the page-master margin-right.
7413 <refentry version="5.0" xml:id="page.height">
7415 <refentrytitle>page.height</refentrytitle>
7416 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
7419 <refname>page.height</refname>
7420 <refpurpose>The height of the physical page</refpurpose>
7424 <programlisting xml:id="page.height.frag"><xsl:param name="page.height">
7426 <xsl:when test="$page.orientation = 'portrait'">
7427 <xsl:value-of select="$page.height.portrait"></xsl:value-of>
7429 <xsl:otherwise>
7430 <xsl:value-of select="$page.width.portrait"></xsl:value-of>
7431 </xsl:otherwise>
7433 </xsl:param></programlisting>
7436 <refsection><info><title>Description</title></info>
7438 <para>The page height is generally calculated from the
7439 <parameter>paper.type</parameter> and
7440 <parameter>page.orientation</parameter> parameters.
7446 <refentry version="5.0" xml:id="page.height.portrait">
7448 <refentrytitle>page.height.portrait</refentrytitle>
7449 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
7452 <refname>page.height.portrait</refname>
7453 <refpurpose>Specify the physical size of the long edge of the page</refpurpose>
7457 <programlisting xml:id="page.height.portrait.frag"><xsl:param name="page.height.portrait">
7459 <xsl:when test="$paper.type = 'A4landscape'">210mm</xsl:when>
7460 <xsl:when test="$paper.type = 'USletter'">11in</xsl:when>
7461 <xsl:when test="$paper.type = 'USlandscape'">8.5in</xsl:when>
7462 <xsl:when test="$paper.type = '4A0'">2378mm</xsl:when>
7463 <xsl:when test="$paper.type = '2A0'">1682mm</xsl:when>
7464 <xsl:when test="$paper.type = 'A0'">1189mm</xsl:when>
7465 <xsl:when test="$paper.type = 'A1'">841mm</xsl:when>
7466 <xsl:when test="$paper.type = 'A2'">594mm</xsl:when>
7467 <xsl:when test="$paper.type = 'A3'">420mm</xsl:when>
7468 <xsl:when test="$paper.type = 'A4'">297mm</xsl:when>
7469 <xsl:when test="$paper.type = 'A5'">210mm</xsl:when>
7470 <xsl:when test="$paper.type = 'A6'">148mm</xsl:when>
7471 <xsl:when test="$paper.type = 'A7'">105mm</xsl:when>
7472 <xsl:when test="$paper.type = 'A8'">74mm</xsl:when>
7473 <xsl:when test="$paper.type = 'A9'">52mm</xsl:when>
7474 <xsl:when test="$paper.type = 'A10'">37mm</xsl:when>
7475 <xsl:when test="$paper.type = 'B0'">1414mm</xsl:when>
7476 <xsl:when test="$paper.type = 'B1'">1000mm</xsl:when>
7477 <xsl:when test="$paper.type = 'B2'">707mm</xsl:when>
7478 <xsl:when test="$paper.type = 'B3'">500mm</xsl:when>
7479 <xsl:when test="$paper.type = 'B4'">353mm</xsl:when>
7480 <xsl:when test="$paper.type = 'B5'">250mm</xsl:when>
7481 <xsl:when test="$paper.type = 'B6'">176mm</xsl:when>
7482 <xsl:when test="$paper.type = 'B7'">125mm</xsl:when>
7483 <xsl:when test="$paper.type = 'B8'">88mm</xsl:when>
7484 <xsl:when test="$paper.type = 'B9'">62mm</xsl:when>
7485 <xsl:when test="$paper.type = 'B10'">44mm</xsl:when>
7486 <xsl:when test="$paper.type = 'C0'">1297mm</xsl:when>
7487 <xsl:when test="$paper.type = 'C1'">917mm</xsl:when>
7488 <xsl:when test="$paper.type = 'C2'">648mm</xsl:when>
7489 <xsl:when test="$paper.type = 'C3'">458mm</xsl:when>
7490 <xsl:when test="$paper.type = 'C4'">324mm</xsl:when>
7491 <xsl:when test="$paper.type = 'C5'">229mm</xsl:when>
7492 <xsl:when test="$paper.type = 'C6'">162mm</xsl:when>
7493 <xsl:when test="$paper.type = 'C7'">114mm</xsl:when>
7494 <xsl:when test="$paper.type = 'C8'">81mm</xsl:when>
7495 <xsl:when test="$paper.type = 'C9'">57mm</xsl:when>
7496 <xsl:when test="$paper.type = 'C10'">40mm</xsl:when>
7497 <xsl:otherwise>11in</xsl:otherwise>
7499 </xsl:param></programlisting>
7502 <refsection><info><title>Description</title></info>
7504 <para>The portrait page height is the length of the long
7505 edge of the physical page.
7511 <refentry version="5.0" xml:id="page.margin.bottom">
7513 <refentrytitle>page.margin.bottom</refentrytitle>
7514 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
7517 <refname>page.margin.bottom</refname>
7518 <refpurpose>The bottom margin of the page</refpurpose>
7522 <programlisting xml:id="page.margin.bottom.frag">
7523 <xsl:param name="page.margin.bottom">0.5in</xsl:param>
7527 <refsection><info><title>Description</title></info>
7529 <para>The bottom page margin is the distance from the bottom of the region-after
7530 to the physical bottom of the page.
7536 <refentry version="5.0" xml:id="page.margin.inner">
7538 <refentrytitle>page.margin.inner</refentrytitle>
7539 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
7542 <refname>page.margin.inner</refname>
7543 <refpurpose>The inner page margin</refpurpose>
7547 <programlisting xml:id="page.margin.inner.frag"><xsl:param name="page.margin.inner">
7549 <xsl:when test="$double.sided != 0">1.25in</xsl:when>
7550 <xsl:otherwise>1in</xsl:otherwise>
7552 </xsl:param></programlisting>
7555 <refsection><info><title>Description</title></info>
7557 <para>The inner page margin is the distance from bound edge of the
7558 page to the first column of text. </para>
7560 <para>The inner page margin is the distance from bound edge of the
7561 page to the outer edge of the first column of text.</para>
7563 <para>In left-to-right text direction,
7564 this is the left margin of recto (front side) pages.
7565 For single-sided output, it is the left margin
7566 of all pages.</para>
7568 <para>In right-to-left text direction,
7569 this is the right margin of recto pages.
7570 For single-sided output, this is the
7571 right margin of all pages.</para>
7574 <para>Current versions (at least as of version 4.13)
7575 of the XEP XSL-FO processor do not
7576 correctly handle these margin settings for documents
7577 with right-to-left text direction.
7578 The workaround in that situation is to reverse
7579 the values for <parameter>page.margin.inner</parameter>
7580 and <parameter>page.margin.outer</parameter>, until
7581 this bug is fixed by RenderX. It does not affect documents
7582 with left-to-right text direction.</para>
7588 <refentry version="5.0" xml:id="page.margin.outer">
7590 <refentrytitle>page.margin.outer</refentrytitle>
7591 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
7594 <refname>page.margin.outer</refname>
7595 <refpurpose>The outer page margin</refpurpose>
7599 <programlisting xml:id="page.margin.outer.frag"><xsl:param name="page.margin.outer">
7601 <xsl:when test="$double.sided != 0">0.75in</xsl:when>
7602 <xsl:otherwise>1in</xsl:otherwise>
7604 </xsl:param></programlisting>
7607 <refsection><info><title>Description</title></info>
7609 <para>The outer page margin is the distance from non-bound edge of the
7610 page to the outer edge of the last column of text.</para>
7612 <para>In left-to-right text direction,
7613 this is the right margin of recto (front side) pages.
7614 For single-sided output, it is the right margin
7615 of all pages.</para>
7617 <para>In right-to-left text direction,
7618 this is the left margin of recto pages.
7619 For single-sided output, this is the
7620 left margin of all pages.</para>
7623 <para>Current versions (at least as of version 4.13)
7624 of the XEP XSL-FO processor do not
7625 correctly handle these margin settings for documents
7626 with right-to-left text direction.
7627 The workaround in that situation is to reverse
7628 the values for <parameter>page.margin.inner</parameter>
7629 and <parameter>page.margin.outer</parameter>, until
7630 this bug is fixed by RenderX. It does not affect documents
7631 with left-to-right text direction.</para>
7637 <refentry version="5.0" xml:id="page.margin.top">
7639 <refentrytitle>page.margin.top</refentrytitle>
7640 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
7643 <refname>page.margin.top</refname>
7644 <refpurpose>The top margin of the page</refpurpose>
7648 <programlisting xml:id="page.margin.top.frag">
7649 <xsl:param name="page.margin.top">0.5in</xsl:param>
7653 <refsection><info><title>Description</title></info>
7655 <para>The top page margin is the distance from the physical top of the
7656 page to the top of the region-before.</para>
7661 <refentry version="5.0" xml:id="page.orientation">
7663 <refentrytitle>page.orientation</refentrytitle>
7664 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
7665 <refmiscinfo class="other" otherclass="value">portrait</refmiscinfo>
7666 <refmiscinfo class="other" otherclass="value">landscape</refmiscinfo>
7669 <refname>page.orientation</refname>
7670 <refpurpose>Select the page orientation</refpurpose>
7674 <programlisting xml:id="page.orientation.frag">
7675 <xsl:param name="page.orientation">portrait</xsl:param>
7679 <refsection><info><title>Description</title></info>
7681 <para> Select one from portrait or landscape.
7682 In portrait orientation, the short edge is horizontal; in
7683 landscape orientation, it is vertical.
7689 <refentry version="5.0" xml:id="page.width">
7691 <refentrytitle>page.width</refentrytitle>
7692 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
7695 <refname>page.width</refname>
7696 <refpurpose>The width of the physical page</refpurpose>
7700 <programlisting xml:id="page.width.frag"><xsl:param name="page.width">
7702 <xsl:when test="$page.orientation = 'portrait'">
7703 <xsl:value-of select="$page.width.portrait"></xsl:value-of>
7705 <xsl:otherwise>
7706 <xsl:value-of select="$page.height.portrait"></xsl:value-of>
7707 </xsl:otherwise>
7709 </xsl:param></programlisting>
7712 <refsection><info><title>Description</title></info>
7714 <para>The page width is generally calculated from the
7715 <parameter>paper.type</parameter> and
7716 <parameter>page.orientation</parameter> parameters.</para>
7721 <refentry version="5.0" xml:id="page.width.portrait">
7723 <refentrytitle>page.width.portrait</refentrytitle>
7724 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
7727 <refname>page.width.portrait</refname>
7728 <refpurpose>Specify the physical size of the short edge of the page</refpurpose>
7732 <programlisting xml:id="page.width.portrait.frag"><xsl:param name="page.width.portrait">
7734 <xsl:when test="$paper.type = 'USletter'">8.5in</xsl:when>
7735 <xsl:when test="$paper.type = '4A0'">1682mm</xsl:when>
7736 <xsl:when test="$paper.type = '2A0'">1189mm</xsl:when>
7737 <xsl:when test="$paper.type = 'A0'">841mm</xsl:when>
7738 <xsl:when test="$paper.type = 'A1'">594mm</xsl:when>
7739 <xsl:when test="$paper.type = 'A2'">420mm</xsl:when>
7740 <xsl:when test="$paper.type = 'A3'">297mm</xsl:when>
7741 <xsl:when test="$paper.type = 'A4'">210mm</xsl:when>
7742 <xsl:when test="$paper.type = 'A5'">148mm</xsl:when>
7743 <xsl:when test="$paper.type = 'A6'">105mm</xsl:when>
7744 <xsl:when test="$paper.type = 'A7'">74mm</xsl:when>
7745 <xsl:when test="$paper.type = 'A8'">52mm</xsl:when>
7746 <xsl:when test="$paper.type = 'A9'">37mm</xsl:when>
7747 <xsl:when test="$paper.type = 'A10'">26mm</xsl:when>
7748 <xsl:when test="$paper.type = 'B0'">1000mm</xsl:when>
7749 <xsl:when test="$paper.type = 'B1'">707mm</xsl:when>
7750 <xsl:when test="$paper.type = 'B2'">500mm</xsl:when>
7751 <xsl:when test="$paper.type = 'B3'">353mm</xsl:when>
7752 <xsl:when test="$paper.type = 'B4'">250mm</xsl:when>
7753 <xsl:when test="$paper.type = 'B5'">176mm</xsl:when>
7754 <xsl:when test="$paper.type = 'B6'">125mm</xsl:when>
7755 <xsl:when test="$paper.type = 'B7'">88mm</xsl:when>
7756 <xsl:when test="$paper.type = 'B8'">62mm</xsl:when>
7757 <xsl:when test="$paper.type = 'B9'">44mm</xsl:when>
7758 <xsl:when test="$paper.type = 'B10'">31mm</xsl:when>
7759 <xsl:when test="$paper.type = 'C0'">917mm</xsl:when>
7760 <xsl:when test="$paper.type = 'C1'">648mm</xsl:when>
7761 <xsl:when test="$paper.type = 'C2'">458mm</xsl:when>
7762 <xsl:when test="$paper.type = 'C3'">324mm</xsl:when>
7763 <xsl:when test="$paper.type = 'C4'">229mm</xsl:when>
7764 <xsl:when test="$paper.type = 'C5'">162mm</xsl:when>
7765 <xsl:when test="$paper.type = 'C6'">114mm</xsl:when>
7766 <xsl:when test="$paper.type = 'C7'">81mm</xsl:when>
7767 <xsl:when test="$paper.type = 'C8'">57mm</xsl:when>
7768 <xsl:when test="$paper.type = 'C9'">40mm</xsl:when>
7769 <xsl:when test="$paper.type = 'C10'">28mm</xsl:when>
7770 <xsl:otherwise>8.5in</xsl:otherwise>
7772 </xsl:param></programlisting>
7775 <refsection><info><title>Description</title></info>
7777 <para>The portrait page width is the length of the short
7778 edge of the physical page.
7784 <refentry version="5.0" xml:id="paper.type">
7786 <refentrytitle>paper.type</refentrytitle>
7787 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
7788 <refmiscinfo class="other" otherclass="list-type">open</refmiscinfo>
7789 <refmiscinfo class="other" otherclass="list-type">open</refmiscinfo>
7790 <refmiscinfo class="other" otherclass="value">USletter<alt>8.5x11in</alt></refmiscinfo>
7791 <refmiscinfo class="other" otherclass="value">USlandscape<alt>11x8.5in</alt></refmiscinfo>
7792 <refmiscinfo class="other" otherclass="value">USlegal<alt>8.5inx14in</alt></refmiscinfo>
7793 <refmiscinfo class="other" otherclass="value">USlegallandscape<alt>14inx8.5in</alt></refmiscinfo>
7794 <refmiscinfo class="other" otherclass="value">4A0<alt>2378x1682mm</alt></refmiscinfo>
7795 <refmiscinfo class="other" otherclass="value">2A0<alt>1682x1189mm</alt></refmiscinfo>
7796 <refmiscinfo class="other" otherclass="value">A0<alt>1189x841mm</alt></refmiscinfo>
7797 <refmiscinfo class="other" otherclass="value">A1<alt>841x594mm</alt></refmiscinfo>
7798 <refmiscinfo class="other" otherclass="value">A2<alt>594x420mm</alt></refmiscinfo>
7799 <refmiscinfo class="other" otherclass="value">A3<alt>420x297mm</alt></refmiscinfo>
7800 <refmiscinfo class="other" otherclass="value">A4<alt>297x210mm</alt></refmiscinfo>
7801 <refmiscinfo class="other" otherclass="value">A5<alt>210x148mm</alt></refmiscinfo>
7802 <refmiscinfo class="other" otherclass="value">A6<alt>148x105mm</alt></refmiscinfo>
7803 <refmiscinfo class="other" otherclass="value">A7<alt>105x74mm</alt></refmiscinfo>
7804 <refmiscinfo class="other" otherclass="value">A8<alt>74x52mm</alt></refmiscinfo>
7805 <refmiscinfo class="other" otherclass="value">A9<alt>52x37mm</alt></refmiscinfo>
7806 <refmiscinfo class="other" otherclass="value">A10<alt>37x26mm</alt></refmiscinfo>
7807 <refmiscinfo class="other" otherclass="value">B0<alt>1414x1000mm</alt></refmiscinfo>
7808 <refmiscinfo class="other" otherclass="value">B1<alt>1000x707mm</alt></refmiscinfo>
7809 <refmiscinfo class="other" otherclass="value">B2<alt>707x500mm</alt></refmiscinfo>
7810 <refmiscinfo class="other" otherclass="value">B3<alt>500x353mm</alt></refmiscinfo>
7811 <refmiscinfo class="other" otherclass="value">B4<alt>353x250mm</alt></refmiscinfo>
7812 <refmiscinfo class="other" otherclass="value">B5<alt>250x176mm</alt></refmiscinfo>
7813 <refmiscinfo class="other" otherclass="value">B6<alt>176x125mm</alt></refmiscinfo>
7814 <refmiscinfo class="other" otherclass="value">B7<alt>125x88mm</alt></refmiscinfo>
7815 <refmiscinfo class="other" otherclass="value">B8<alt>88x62mm</alt></refmiscinfo>
7816 <refmiscinfo class="other" otherclass="value">B9<alt>62x44mm</alt></refmiscinfo>
7817 <refmiscinfo class="other" otherclass="value">B10<alt>44x31mm</alt></refmiscinfo>
7818 <refmiscinfo class="other" otherclass="value">C0<alt>1297x917mm</alt></refmiscinfo>
7819 <refmiscinfo class="other" otherclass="value">C1<alt>917x648mm</alt></refmiscinfo>
7820 <refmiscinfo class="other" otherclass="value">C2<alt>648x458mm</alt></refmiscinfo>
7821 <refmiscinfo class="other" otherclass="value">C3<alt>458x324mm</alt></refmiscinfo>
7822 <refmiscinfo class="other" otherclass="value">C4<alt>324x229mm</alt></refmiscinfo>
7823 <refmiscinfo class="other" otherclass="value">C5<alt>229x162mm</alt></refmiscinfo>
7824 <refmiscinfo class="other" otherclass="value">C6<alt>162x114mm</alt></refmiscinfo>
7825 <refmiscinfo class="other" otherclass="value">C7<alt>114x81mm</alt></refmiscinfo>
7826 <refmiscinfo class="other" otherclass="value">C8<alt>81x57mm</alt></refmiscinfo>
7827 <refmiscinfo class="other" otherclass="value">C9<alt>57x40mm</alt></refmiscinfo>
7828 <refmiscinfo class="other" otherclass="value">C10<alt>40x28mm</alt></refmiscinfo>
7831 <refname>paper.type</refname>
7832 <refpurpose>Select the paper type</refpurpose>
7836 <programlisting xml:id="paper.type.frag">
7837 <xsl:param name="paper.type">USletter</xsl:param>
7841 <refsection><info><title>Description</title></info>
7843 <para>The paper type is a convenient way to specify the paper size.
7844 The list of known paper sizes includes USletter and most of the A,
7845 B, and C sizes. See <parameter>page.width.portrait</parameter>, for example.
7853 <refentry version="5.0" xml:id="double.sided">
7855 <refentrytitle>double.sided</refentrytitle>
7856 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
7859 <refname>double.sided</refname>
7860 <refpurpose>Is the document to be printed double sided?</refpurpose>
7864 <programlisting xml:id="double.sided.frag">
7865 <xsl:param name="double.sided" select="0"></xsl:param>
7869 <refsection><info><title>Description</title></info>
7871 <para>Double-sided documents are printed with a slightly wider margin
7872 on the binding edge of the page.
7874 <para>FIXME: The current set of parameters does not take writing direction
7875 into account.</para>
7880 <refentry version="5.0" xml:id="body.margin.bottom">
7882 <refentrytitle>body.margin.bottom</refentrytitle>
7883 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
7886 <refname>body.margin.bottom</refname>
7887 <refpurpose>The bottom margin of the body text</refpurpose>
7891 <programlisting xml:id="body.margin.bottom.frag">
7892 <xsl:param name="body.margin.bottom">0.5in</xsl:param>
7896 <refsection><info><title>Description</title></info>
7898 <para>The body bottom margin is the distance from the last line of text
7899 in the page body to the bottom of the region-after.
7905 <refentry version="5.0" xml:id="body.margin.top">
7907 <refentrytitle>body.margin.top</refentrytitle>
7908 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
7911 <refname>body.margin.top</refname>
7912 <refpurpose>To specify the size of the top margin of a page</refpurpose>
7916 <programlisting xml:id="body.margin.top.frag">
7917 <xsl:param name="body.margin.top">0.5in</xsl:param>
7921 <refsection><info><title>Description</title></info>
7923 <para>The body top margin is the distance from the top of the
7924 region-before to the first line of text in the page body.</para>
7929 <refentry version="5.0" xml:id="body.start.indent">
7931 <refentrytitle>body.start.indent</refentrytitle>
7932 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
7935 <refname>body.start.indent</refname>
7936 <refpurpose>The start-indent for the body text</refpurpose>
7940 <programlisting xml:id="body.start.indent.frag">
7941 <xsl:param name="body.start.indent">
7943 <xsl:when test="$fop.extensions != 0">0pt</xsl:when>
7944 <xsl:when test="$passivetex.extensions != 0">0pt</xsl:when>
7945 <xsl:otherwise>4pc</xsl:otherwise>
7951 <refsection><info><title>Description</title></info>
7953 <para>This parameter provides
7954 the means of indenting the body text relative to
7956 For left-to-right text direction, it indents the left side.
7957 For right-to-left text direction, it indents the right side.
7958 It is used in place of the
7959 <parameter>title.margin.left</parameter> for
7960 all XSL-FO processors except FOP 0.25.
7961 It enables support for side floats to appear
7962 in the indented margin area.
7964 <para>This start-indent property is added to the fo:flow
7965 for certain page sequences. Which page-sequences it is
7966 applied to is determined by the template named
7967 <literal>set.flow.properties</literal>.
7968 By default, that template adds it to the flow
7969 for page-sequences using the <quote>body</quote>
7970 master-reference, as well as appendixes and prefaces.
7972 <para>If this parameter is used, section titles should have
7973 a start-indent value of 0pt if they are to be
7974 outdented relative to the body text.
7977 <para>If you are using FOP, then set this parameter to a zero
7978 width value and set the <parameter>title.margin.left</parameter>
7979 parameter to the negative value of the desired indent.
7982 <para>See also <parameter>body.end.indent</parameter> and
7983 <parameter>title.margin.left</parameter>.
7989 <refentry version="5.0" xml:id="body.end.indent">
7991 <refentrytitle>body.end.indent</refentrytitle>
7992 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
7995 <refname>body.end.indent</refname>
7996 <refpurpose>The end-indent for the body text</refpurpose>
8000 <programlisting xml:id="body.end.indent.frag">
8001 <xsl:param name="body.end.indent">0pt</xsl:param>
8005 <refsection><info><title>Description</title></info>
8007 <para>This end-indent property is added to the fo:flow
8008 for certain page sequences. Which page-sequences it is
8009 applied to is determined by the template named
8010 <literal>set.flow.properties</literal>.
8011 By default, that template adds it to the flow
8012 for page-sequences using the <quote>body</quote>
8013 master-reference, as well as appendixes and prefaces.
8016 <para>See also <parameter>body.start.indent</parameter>.
8022 <refentry version="5.0" xml:id="alignment">
8024 <refentrytitle>alignment</refentrytitle>
8025 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
8026 <refmiscinfo class="other" otherclass="list-type">open</refmiscinfo>
8027 <refmiscinfo class="other" otherclass="value">left</refmiscinfo>
8028 <refmiscinfo class="other" otherclass="value">start</refmiscinfo>
8029 <refmiscinfo class="other" otherclass="value">right</refmiscinfo>
8030 <refmiscinfo class="other" otherclass="value">end</refmiscinfo>
8031 <refmiscinfo class="other" otherclass="value">center</refmiscinfo>
8032 <refmiscinfo class="other" otherclass="value">justify</refmiscinfo>
8035 <refname>alignment</refname>
8036 <refpurpose>Specify the default text alignment</refpurpose>
8040 <programlisting xml:id="alignment.frag"><xsl:param name="alignment">justify</xsl:param></programlisting>
8043 <refsection><info><title>Description</title></info>
8045 <para>The default text alignment is used for most body text.
8047 <literal>left</literal>,
8048 <literal>right</literal>,
8049 <literal>start</literal>,
8050 <literal>end</literal>,
8051 <literal>center</literal>,
8052 <literal>justify</literal>.
8053 The default value is <literal>justify</literal>.
8059 <refentry version="5.0" xml:id="hyphenate">
8061 <refentrytitle>hyphenate</refentrytitle>
8062 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
8063 <refmiscinfo class="other" otherclass="list-type">closed</refmiscinfo>
8064 <refmiscinfo class="other" otherclass="value">true</refmiscinfo>
8065 <refmiscinfo class="other" otherclass="value">false</refmiscinfo>
8068 <refname>hyphenate</refname>
8069 <refpurpose>Specify hyphenation behavior</refpurpose>
8073 <programlisting xml:id="hyphenate.frag"><xsl:param name="hyphenate">true</xsl:param></programlisting>
8076 <refsection><info><title>Description</title></info>
8078 <para>If true, words may be hyphenated. Otherwise, they may not.
8084 <refentry version="5.0" xml:id="line-height">
8086 <refentrytitle>line-height</refentrytitle>
8087 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
8090 <refname>line-height</refname>
8091 <refpurpose>Specify the line-height property</refpurpose>
8095 <programlisting xml:id="line-height.frag">
8096 <xsl:param name="line-height">normal</xsl:param>
8100 <refsection><info><title>Description</title></info>
8102 <para>Sets the line-height property.</para>
8107 <refentry version="5.0" xml:id="column.count.back">
8109 <refentrytitle>column.count.back</refentrytitle>
8110 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
8113 <refname>column.count.back</refname>
8114 <refpurpose>Number of columns on back matter pages</refpurpose>
8118 <programlisting xml:id="column.count.back.frag">
8119 <xsl:param name="column.count.back" select="1"></xsl:param>
8123 <refsection><info><title>Description</title></info>
8125 <para>Number of columns on back matter (appendix, glossary, etc.) pages.</para>
8130 <refentry version="5.0" xml:id="column.count.body">
8132 <refentrytitle>column.count.body</refentrytitle>
8133 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
8136 <refname>column.count.body</refname>
8137 <refpurpose>Number of columns on body pages</refpurpose>
8141 <programlisting xml:id="column.count.body.frag">
8142 <xsl:param name="column.count.body" select="1"></xsl:param>
8146 <refsection><info><title>Description</title></info>
8148 <para>Number of columns on body pages.</para>
8153 <refentry version="5.0" xml:id="column.count.front">
8155 <refentrytitle>column.count.front</refentrytitle>
8156 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
8159 <refname>column.count.front</refname>
8160 <refpurpose>Number of columns on front matter pages</refpurpose>
8164 <programlisting xml:id="column.count.front.frag">
8165 <xsl:param name="column.count.front" select="1"></xsl:param>
8169 <refsection><info><title>Description</title></info>
8171 <para>Number of columns on front matter (dedication, preface, etc.) pages.</para>
8176 <refentry version="5.0" xml:id="column.count.index">
8178 <refentrytitle>column.count.index</refentrytitle>
8179 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
8182 <refname>column.count.index</refname>
8183 <refpurpose>Number of columns on index pages</refpurpose>
8187 <programlisting xml:id="column.count.index.frag">
8188 <xsl:param name="column.count.index">2</xsl:param>
8192 <refsection><info><title>Description</title></info>
8194 <para>Number of columns on index pages.</para>
8199 <refentry version="5.0" xml:id="column.count.lot">
8201 <refentrytitle>column.count.lot</refentrytitle>
8202 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
8205 <refname>column.count.lot</refname>
8206 <refpurpose>Number of columns on a 'List-of-Titles' page</refpurpose>
8210 <programlisting xml:id="column.count.lot.frag">
8211 <xsl:param name="column.count.lot" select="1"></xsl:param>
8215 <refsection><info><title>Description</title></info>
8217 <para>Number of columns on a page sequence containing the Table of Contents,
8218 List of Figures, etc.</para>
8223 <refentry version="5.0" xml:id="column.count.titlepage">
8225 <refentrytitle>column.count.titlepage</refentrytitle>
8226 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
8229 <refname>column.count.titlepage</refname>
8230 <refpurpose>Number of columns on a title page</refpurpose>
8234 <programlisting xml:id="column.count.titlepage.frag">
8235 <xsl:param name="column.count.titlepage" select="1"></xsl:param>
8239 <refsection><info><title>Description</title></info>
8241 <para>Number of columns on a title page</para>
8246 <refentry version="5.0" xml:id="column.gap.back">
8248 <refentrytitle>column.gap.back</refentrytitle>
8249 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
8252 <refname>column.gap.back</refname>
8253 <refpurpose>Gap between columns in back matter</refpurpose>
8257 <programlisting xml:id="column.gap.back.frag">
8258 <xsl:param name="column.gap.back">12pt</xsl:param>
8262 <refsection><info><title>Description</title></info>
8264 <para>Specifies the gap between columns in back matter (if
8265 <parameter>column.count.back</parameter> is greater than one).</para>
8270 <refentry version="5.0" xml:id="column.gap.body">
8272 <refentrytitle>column.gap.body</refentrytitle>
8273 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
8276 <refname>column.gap.body</refname>
8277 <refpurpose>Gap between columns in the body</refpurpose>
8281 <programlisting xml:id="column.gap.body.frag">
8282 <xsl:param name="column.gap.body">12pt</xsl:param>
8286 <refsection><info><title>Description</title></info>
8288 <para>Specifies the gap between columns in body matter (if
8289 <parameter>column.count.body</parameter> is greater than one).</para>
8294 <refentry version="5.0" xml:id="column.gap.front">
8296 <refentrytitle>column.gap.front</refentrytitle>
8297 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
8300 <refname>column.gap.front</refname>
8301 <refpurpose>Gap between columns in the front matter</refpurpose>
8305 <programlisting xml:id="column.gap.front.frag">
8306 <xsl:param name="column.gap.front">12pt</xsl:param>
8310 <refsection><info><title>Description</title></info>
8312 <para>Specifies the gap between columns in front matter (if
8313 <parameter>column.count.front</parameter> is greater than one).</para>
8318 <refentry version="5.0" xml:id="column.gap.index">
8320 <refentrytitle>column.gap.index</refentrytitle>
8321 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
8324 <refname>column.gap.index</refname>
8325 <refpurpose>Gap between columns in the index</refpurpose>
8329 <programlisting xml:id="column.gap.index.frag">
8330 <xsl:param name="column.gap.index">12pt</xsl:param>
8334 <refsection><info><title>Description</title></info>
8336 <para>Specifies the gap between columns in indexes (if
8337 <parameter>column.count.index</parameter> is greater than one).</para>
8342 <refentry version="5.0" xml:id="column.gap.lot">
8344 <refentrytitle>column.gap.lot</refentrytitle>
8345 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
8348 <refname>column.gap.lot</refname>
8349 <refpurpose>Gap between columns on a 'List-of-Titles' page</refpurpose>
8353 <programlisting xml:id="column.gap.lot.frag">
8354 <xsl:param name="column.gap.lot">12pt</xsl:param>
8358 <refsection><info><title>Description</title></info>
8360 <para>Specifies the gap between columns on 'List-of-Titles' pages (if
8361 <parameter>column.count.lot</parameter> is greater than one).</para>
8366 <refentry version="5.0" xml:id="column.gap.titlepage">
8368 <refentrytitle>column.gap.titlepage</refentrytitle>
8369 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
8372 <refname>column.gap.titlepage</refname>
8373 <refpurpose>Gap between columns on title pages</refpurpose>
8377 <programlisting xml:id="column.gap.titlepage.frag">
8378 <xsl:param name="column.gap.titlepage">12pt</xsl:param>
8382 <refsection><info><title>Description</title></info>
8384 <para>Specifies the gap between columns on title pages (if
8385 <parameter>column.count.titlepage</parameter> is greater than one).</para>
8391 <refentry version="5.0" xml:id="region.after.extent">
8393 <refentrytitle>region.after.extent</refentrytitle>
8394 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
8397 <refname>region.after.extent</refname>
8398 <refpurpose>Specifies the height of the footer.</refpurpose>
8402 <programlisting xml:id="region.after.extent.frag">
8403 <xsl:param name="region.after.extent">0.4in</xsl:param>
8407 <refsection><info><title>Description</title></info>
8409 <para>The region after extent is the height of the area where footers
8416 <refentry version="5.0" xml:id="region.before.extent">
8418 <refentrytitle>region.before.extent</refentrytitle>
8419 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
8422 <refname>region.before.extent</refname>
8423 <refpurpose>Specifies the height of the header</refpurpose>
8427 <programlisting xml:id="region.before.extent.frag">
8428 <xsl:param name="region.before.extent">0.4in</xsl:param>
8432 <refsection><info><title>Description</title></info>
8434 <para>The region before extent is the height of the area where headers
8441 <refentry version="5.0" xml:id="default.units">
8443 <refentrytitle>default.units</refentrytitle>
8444 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
8445 <refmiscinfo class="other" otherclass="value">cm</refmiscinfo>
8446 <refmiscinfo class="other" otherclass="value">mm</refmiscinfo>
8447 <refmiscinfo class="other" otherclass="value">in</refmiscinfo>
8448 <refmiscinfo class="other" otherclass="value">pt</refmiscinfo>
8449 <refmiscinfo class="other" otherclass="value">pc</refmiscinfo>
8450 <refmiscinfo class="other" otherclass="value">px</refmiscinfo>
8451 <refmiscinfo class="other" otherclass="value">em</refmiscinfo>
8454 <refname>default.units</refname>
8455 <refpurpose>Default units for an unqualified dimension</refpurpose>
8459 <programlisting xml:id="default.units.frag">
8460 <xsl:param name="default.units">pt</xsl:param>
8464 <refsection><info><title>Description</title></info>
8466 <para>If an unqualified dimension is encountered (for example, in a
8467 graphic width), the <parameter>default.units</parameter> will be used for the
8468 units. Unqualified dimensions are not allowed in XSL Formatting Objects.
8474 <refentry version="5.0" xml:id="normal.para.spacing">
8476 <refentrytitle>normal.para.spacing</refentrytitle>
8477 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
8480 <refname>normal.para.spacing</refname>
8481 <refpurpose>What space do you want between normal paragraphs</refpurpose>
8485 <programlisting xml:id="normal.para.spacing.frag"><xsl:attribute-set name="normal.para.spacing">
8486 <xsl:attribute name="space-before.optimum">1em</xsl:attribute>
8487 <xsl:attribute name="space-before.minimum">0.8em</xsl:attribute>
8488 <xsl:attribute name="space-before.maximum">1.2em</xsl:attribute>
8489 </xsl:attribute-set></programlisting>
8491 <refsection><info><title>Description</title></info>
8492 <para>Specify the spacing required between normal paragraphs</para>
8496 <refentry version="5.0" xml:id="body.font.master">
8498 <refentrytitle>body.font.master</refentrytitle>
8499 <refmiscinfo class="other" otherclass="datatype">number</refmiscinfo>
8502 <refname>body.font.master</refname>
8503 <refpurpose>Specifies the default point size for body text</refpurpose>
8507 <programlisting xml:id="body.font.master.frag">
8508 <xsl:param name="body.font.master">10</xsl:param>
8512 <refsection><info><title>Description</title></info>
8514 <para>The body font size is specified in two parameters
8515 (<parameter>body.font.master</parameter> and <parameter>body.font.size</parameter>)
8516 so that math can be performed on the font size by XSLT.
8522 <refentry version="5.0" xml:id="body.font.size">
8524 <refentrytitle>body.font.size</refentrytitle>
8525 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
8528 <refname>body.font.size</refname>
8529 <refpurpose>Specifies the default font size for body text</refpurpose>
8533 <programlisting xml:id="body.font.size.frag">
8534 <xsl:param name="body.font.size">
8535 <xsl:value-of select="$body.font.master"></xsl:value-of><xsl:text>pt</xsl:text>
8536 </xsl:param></programlisting>
8539 <refsection><info><title>Description</title></info>
8541 <para>The body font size is specified in two parameters
8542 (<parameter>body.font.master</parameter> and <parameter>body.font.size</parameter>)
8543 so that math can be performed on the font size by XSLT.
8549 <refentry version="5.0" xml:id="footnote.font.size">
8551 <refentrytitle>footnote.font.size</refentrytitle>
8552 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
8555 <refname>footnote.font.size</refname>
8556 <refpurpose>The font size for footnotes</refpurpose>
8560 <programlisting xml:id="footnote.font.size.frag"><xsl:param name="footnote.font.size">
8561 <xsl:value-of select="$body.font.master * 0.8"></xsl:value-of><xsl:text>pt</xsl:text>
8562 </xsl:param></programlisting>
8565 <refsection><info><title>Description</title></info>
8567 <para>The footnote font size is used for...footnotes!
8573 <refentry version="5.0" xml:id="title.margin.left">
8575 <refentrytitle>title.margin.left</refentrytitle>
8576 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
8579 <refname>title.margin.left</refname>
8580 <refpurpose>Adjust the left margin for titles</refpurpose>
8584 <programlisting xml:id="title.margin.left.frag">
8585 <xsl:param name="title.margin.left">
8587 <xsl:when test="$fop.extensions != 0">-4pc</xsl:when>
8588 <xsl:when test="$passivetex.extensions != 0">0pt</xsl:when>
8589 <xsl:otherwise>0pt</xsl:otherwise>
8595 <refsection><info><title>Description</title></info>
8597 <para>This parameter provides
8598 the means of adjusting the left margin for titles
8599 when the XSL-FO processor being used is
8600 an old version of FOP (0.25 and earlier).
8601 It is only useful when the <parameter>fop.extensions</parameter>
8604 <para>The left margin of the body region
8605 is calculated to include this space,
8606 and titles are outdented to the left outside
8607 the body region by this amount,
8608 effectively leaving titles at the intended left margin
8609 and the body text indented.
8610 Currently this method is only used for old FOP because
8611 it cannot properly use the <parameter>body.start.indent</parameter>
8615 The default value when the <parameter>fop.extensions</parameter>
8616 parameter is nonzero is -4pc, which means the
8617 body text is indented 4 picas relative to
8619 The default value when the <parameter>fop.extensions</parameter>
8620 parameter equals zero is 0pt, and
8621 the body indent should instead be specified
8622 using the <parameter>body.start.indent</parameter>
8626 If you set the value to zero, be sure to still include
8627 a unit indicator such as <literal>0pt</literal>, or
8628 the FO processor will report errors.
8634 <refentry version="5.0" xml:id="draft.mode">
8636 <refentrytitle>draft.mode</refentrytitle>
8637 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
8638 <refmiscinfo class="other" otherclass="value">no</refmiscinfo>
8639 <refmiscinfo class="other" otherclass="value">yes</refmiscinfo>
8640 <refmiscinfo class="other" otherclass="value">maybe</refmiscinfo>
8643 <refname>draft.mode</refname>
8644 <refpurpose>Select draft mode</refpurpose>
8648 <programlisting xml:id="draft.mode.frag">
8649 <xsl:param name="draft.mode">no</xsl:param>
8653 <refsection><info><title>Description</title></info>
8655 <para>Selects draft mode. If <parameter>draft.mode</parameter> is
8656 <quote><literal>yes</literal></quote>, the entire document will be treated
8657 as a draft. If it is <quote><literal>no</literal></quote>, the entire document
8658 will be treated as a final copy. If it is <quote><literal>maybe</literal></quote>,
8659 individual sections will be treated as draft or final independently, depending
8660 on how their <literal>status</literal> attribute is set.
8666 <refentry version="5.0" xml:id="draft.watermark.image">
8668 <refentrytitle>draft.watermark.image</refentrytitle>
8669 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
8672 <refname>draft.watermark.image</refname>
8673 <refpurpose>The URI of the image to be used for draft watermarks</refpurpose>
8677 <programlisting xml:id="draft.watermark.image.frag">
8678 <xsl:param name="draft.watermark.image">images/draft.png</xsl:param>
8682 <refsection><info><title>Description</title></info>
8684 <para>The image to be used for draft watermarks.</para>
8689 <refentry version="5.0" xml:id="headers.on.blank.pages">
8691 <refentrytitle>headers.on.blank.pages</refentrytitle>
8692 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
8695 <refname>headers.on.blank.pages</refname>
8696 <refpurpose>Put headers on blank pages?</refpurpose>
8700 <programlisting xml:id="headers.on.blank.pages.frag">
8701 <xsl:param name="headers.on.blank.pages" select="1"></xsl:param>
8705 <refsection><info><title>Description</title></info>
8707 <para>If non-zero, headers will be placed on blank pages.</para>
8712 <refentry version="5.0" xml:id="footers.on.blank.pages">
8714 <refentrytitle>footers.on.blank.pages</refentrytitle>
8715 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
8718 <refname>footers.on.blank.pages</refname>
8719 <refpurpose>Put footers on blank pages?</refpurpose>
8723 <programlisting xml:id="footers.on.blank.pages.frag">
8724 <xsl:param name="footers.on.blank.pages" select="1"></xsl:param>
8728 <refsection><info><title>Description</title></info>
8730 <para>If non-zero, footers will be placed on blank pages.</para>
8735 <refentry version="5.0" xml:id="header.rule">
8737 <refentrytitle>header.rule</refentrytitle>
8738 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
8741 <refname>header.rule</refname>
8742 <refpurpose>Rule under headers?</refpurpose>
8746 <programlisting xml:id="header.rule.frag">
8747 <xsl:param name="header.rule" select="1"></xsl:param>
8751 <refsection><info><title>Description</title></info>
8753 <para>If non-zero, a rule will be drawn below the page headers.</para>
8758 <refentry version="5.0" xml:id="footer.rule">
8760 <refentrytitle>footer.rule</refentrytitle>
8761 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
8764 <refname>footer.rule</refname>
8765 <refpurpose>Rule over footers?</refpurpose>
8769 <programlisting xml:id="footer.rule.frag">
8770 <xsl:param name="footer.rule" select="1"></xsl:param>
8774 <refsection><info><title>Description</title></info>
8776 <para>If non-zero, a rule will be drawn above the page footers.</para>
8781 <refentry version="5.0" xml:id="header.column.widths">
8783 <refentrytitle>header.column.widths</refentrytitle>
8784 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
8787 <refname>header.column.widths</refname>
8788 <refpurpose>Specify relative widths of header areas</refpurpose>
8791 <refsynopsisdiv><programlisting xml:id="header.column.widths.frag">
8792 <xsl:param name="header.column.widths">1 1 1</xsl:param>
8793 </programlisting></refsynopsisdiv>
8795 <refsection><info><title>Description</title></info>
8797 <para>Page headers in print output use a three column table
8798 to position text at the left, center, and right side of
8799 the header on the page.
8800 This parameter lets you specify the relative sizes of the
8801 three columns. The default value is
8804 <para>The parameter value must be three numbers, separated
8805 by white space. The first number represents the relative
8806 width of the inside header for
8807 double-sided output. The second number is the relative
8808 width of the center header. The third number is the
8809 relative width of the outside header for
8810 double-sided output.
8812 <para>For single-sided output, the first number is the
8813 relative width of left header for left-to-right
8814 text direction, or the right header for right-to-left
8816 The third number is the
8817 relative width of right header for left-to-right
8818 text direction, or the left header for right-to-left
8819 text direction.</para>
8821 <para>The numbers are used to specify the column widths
8822 for the table that makes up the header area.
8823 In the FO output, this looks like:
8827 <fo:table-column column-number="1"
8828 column-width="proportional-column-width(1)"/>
8832 The <literal>proportional-column-width()</literal>
8833 function computes a column width by dividing its
8834 argument by the total of the arguments for all the columns, and
8835 then multiplying the result by the width of the whole table
8836 (assuming all the column specs use the function).
8837 Its argument can be any positive integer or floating point number.
8838 Zero is an acceptable value, although some FO processors
8839 may warn about it, in which case using a very small number might
8840 be more satisfactory.
8843 <para>For example, the value "1 2 1" means the center
8844 header should have twice the width of the other areas.
8845 A value of "0 0 1" means the entire header area
8846 is reserved for the right (or outside) header text.
8847 Note that to keep the center area centered on
8848 the page, the left and right values must be
8849 the same. A specification like "1 2 3" means the
8850 center area is no longer centered on the page
8851 since the right area is three times the width of the left area.
8857 <refentry version="5.0" xml:id="footer.column.widths">
8859 <refentrytitle>footer.column.widths</refentrytitle>
8860 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
8863 <refname>footer.column.widths</refname>
8864 <refpurpose>Specify relative widths of footer areas</refpurpose>
8867 <refsynopsisdiv><programlisting xml:id="footer.column.widths.frag">
8868 <xsl:param name="footer.column.widths">1 1 1</xsl:param>
8869 </programlisting></refsynopsisdiv>
8871 <refsection><info><title>Description</title></info>
8873 <para>Page footers in print output use a three column table
8874 to position text at the left, center, and right side of
8875 the footer on the page.
8876 This parameter lets you specify the relative sizes of the
8877 three columns. The default value is
8880 <para>The parameter value must be three numbers, separated
8881 by white space. The first number represents the relative
8882 width of the inside footer for
8883 double-sided output. The second number is the relative
8884 width of the center footer. The third number is the
8885 relative width of the outside footer for
8886 double-sided output.
8888 <para>For single-sided output, the first number is the
8889 relative width of left footer for left-to-right
8890 text direction, or the right footer for right-to-left
8892 The third number is the
8893 relative width of right footer for left-to-right
8894 text direction, or the left footer for right-to-left
8895 text direction.</para>
8897 <para>The numbers are used to specify the column widths
8898 for the table that makes up the footer area.
8899 In the FO output, this looks like:
8903 <fo:table-column column-number="1"
8904 column-width="proportional-column-width(1)"/>
8908 The <literal>proportional-column-width()</literal>
8909 function computes a column width by dividing its
8910 argument by the total of the arguments for all the columns, and
8911 then multiplying the result by the width of the whole table
8912 (assuming all the column specs use the function).
8913 Its argument can be any positive integer or floating point number.
8914 Zero is an acceptable value, although some FO processors
8915 may warn about it, in which case using a very small number might
8916 be more satisfactory.
8919 <para>For example, the value "1 2 1" means the center
8920 footer should have twice the width of the other areas.
8921 A value of "0 0 1" means the entire footer area
8922 is reserved for the right (or outside) footer text.
8923 Note that to keep the center area centered on
8924 the page, the left and right values must be
8925 the same. A specification like "1 2 3" means the
8926 center area is no longer centered on the page
8927 since the right area is three times the width of the left area.
8933 <refentry version="5.0" xml:id="header.table.properties">
8935 <refentrytitle>header.table.properties</refentrytitle>
8936 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
8939 <refname>header.table.properties</refname>
8940 <refpurpose>Apply properties to the header layout table</refpurpose>
8944 <programlisting xml:id="header.table.properties.frag">
8945 <xsl:attribute-set name="header.table.properties">
8946 <xsl:attribute name="table-layout">fixed</xsl:attribute>
8947 <xsl:attribute name="width">100%</xsl:attribute>
8948 </xsl:attribute-set>
8952 <refsection><info><title>Description</title></info>
8954 <para>Properties applied to the table that lays out the page header.</para>
8959 <refentry version="5.0" xml:id="header.table.height">
8961 <refentrytitle>header.table.height</refentrytitle>
8962 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
8965 <refname>header.table.height</refname>
8966 <refpurpose>Specify the minimum height of the table containing the running page headers</refpurpose>
8969 <refsynopsisdiv><programlisting xml:id="header.table.height.frag">
8970 <xsl:param name="header.table.height">14pt</xsl:param>
8971 </programlisting></refsynopsisdiv>
8973 <refsection><info><title>Description</title></info>
8975 <para>Page headers in print output use a three column table
8976 to position text at the left, center, and right side of
8977 the header on the page.
8978 This parameter lets you specify the minimum height
8979 of the single row in the table.
8980 Since this specifies only the minimum height,
8981 the table should automatically grow to fit taller content.
8982 The default value is "14pt".</para>
8987 <refentry version="5.0" xml:id="footer.table.properties">
8989 <refentrytitle>footer.table.properties</refentrytitle>
8990 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
8993 <refname>footer.table.properties</refname>
8994 <refpurpose>Apply properties to the footer layout table</refpurpose>
8998 <programlisting xml:id="footer.table.properties.frag">
8999 <xsl:attribute-set name="footer.table.properties">
9000 <xsl:attribute name="table-layout">fixed</xsl:attribute>
9001 <xsl:attribute name="width">100%</xsl:attribute>
9002 </xsl:attribute-set>
9006 <refsection><info><title>Description</title></info>
9008 <para>Properties applied to the table that lays out the page footer.</para>
9013 <refentry version="5.0" xml:id="footer.table.height">
9015 <refentrytitle>footer.table.height</refentrytitle>
9016 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
9019 <refname>footer.table.height</refname>
9020 <refpurpose>Specify the minimum height of the table containing the running page footers</refpurpose>
9023 <refsynopsisdiv><programlisting xml:id="footer.table.height.frag">
9024 <xsl:param name="footer.table.height">14pt</xsl:param>
9025 </programlisting></refsynopsisdiv>
9027 <refsection><info><title>Description</title></info>
9029 <para>Page footers in print output use a three column table
9030 to position text at the left, center, and right side of
9031 the footer on the page.
9032 This parameter lets you specify the minimum height
9033 of the single row in the table.
9034 Since this specifies only the minimum height,
9035 the table should automatically grow to fit taller content.
9036 The default value is "14pt".</para>
9041 <refentry version="5.0" xml:id="header.content.properties">
9043 <refentrytitle>header.content.properties</refentrytitle>
9044 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
9047 <refname>header.content.properties</refname>
9048 <refpurpose>Properties of page header content</refpurpose>
9052 <programlisting xml:id="header.content.properties.frag">
9053 <xsl:attribute-set name="header.content.properties">
9054 <xsl:attribute name="font-family">
9055 <xsl:value-of select="$body.fontset"></xsl:value-of>
9056 </xsl:attribute>
9057 <xsl:attribute name="margin-left">
9058 <xsl:value-of select="$title.margin.left"></xsl:value-of>
9059 </xsl:attribute>
9060 </xsl:attribute-set>
9064 <refsection><info><title>Description</title></info>
9066 <para>Properties of page header content.</para>
9071 <refentry version="5.0" xml:id="footer.content.properties">
9073 <refentrytitle>footer.content.properties</refentrytitle>
9074 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
9077 <refname>footer.content.properties</refname>
9078 <refpurpose>Properties of page footer content</refpurpose>
9082 <programlisting xml:id="footer.content.properties.frag">
9083 <xsl:attribute-set name="footer.content.properties">
9084 <xsl:attribute name="font-family">
9085 <xsl:value-of select="$body.fontset"></xsl:value-of>
9086 </xsl:attribute>
9087 <xsl:attribute name="margin-left">
9088 <xsl:value-of select="$title.margin.left"></xsl:value-of>
9089 </xsl:attribute>
9090 </xsl:attribute-set>
9094 <refsection><info><title>Description</title></info>
9096 <para>Properties of page footer content.</para>
9101 <refentry version="5.0" xml:id="marker.section.level">
9103 <refentrytitle>marker.section.level</refentrytitle>
9104 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
9107 <refname>marker.section.level</refname>
9108 <refpurpose>Control depth of sections shown in running headers or footers</refpurpose>
9112 <programlisting xml:id="marker.section.level.frag">
9113 <xsl:param name="marker.section.level">2</xsl:param>
9117 <refsection><info><title>Description</title></info>
9119 <para>The <parameter>marker.section.level</parameter> parameter
9120 controls the depth of section levels that may be displayed
9121 in running headers and footers. For example, if the value
9122 is 2 (the default), then titles from <tag>sect1</tag> and
9123 <tag>sect2</tag> or equivalent <tag>section</tag>
9124 elements are candidates for use in running headers and
9127 <para>Each candidate title is marked in the FO output with a
9128 <tag><fo:marker marker-class-name="section.head.marker"></tag>
9131 <para>In order for such titles to appear in headers
9132 or footers, the <literal>header.content</literal>
9133 or <literal>footer.content</literal> template
9134 must be customized to retrieve the marker using
9135 an output element such as:
9138 <fo:retrieve-marker retrieve-class-name="section.head.marker"
9139 retrieve-position="first-including-carryover"
9140 retrieve-boundary="page-sequence"/>
9148 <reference xml:id="fonts"><title>Font Families</title>
9149 <refentry version="5.0" xml:id="body.font.family">
9151 <refentrytitle>body.font.family</refentrytitle>
9152 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
9153 <refmiscinfo class="other" otherclass="list-type">open</refmiscinfo>
9154 <refmiscinfo class="other" otherclass="value">serif</refmiscinfo>
9155 <refmiscinfo class="other" otherclass="value">sans-serif</refmiscinfo>
9156 <refmiscinfo class="other" otherclass="value">monospace</refmiscinfo>
9159 <refname>body.font.family</refname>
9160 <refpurpose>The default font family for body text</refpurpose>
9164 <programlisting xml:id="body.font.family.frag">
9165 <xsl:param name="body.font.family">serif</xsl:param>
9169 <refsection><info><title>Description</title></info>
9171 <para>The body font family is the default font used for text in the page body.
9177 <refentry version="5.0" xml:id="dingbat.font.family">
9179 <refentrytitle>dingbat.font.family</refentrytitle>
9180 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
9181 <refmiscinfo class="other" otherclass="list-type">open</refmiscinfo>
9182 <refmiscinfo class="other" otherclass="value">serif</refmiscinfo>
9183 <refmiscinfo class="other" otherclass="value">sans-serif</refmiscinfo>
9184 <refmiscinfo class="other" otherclass="value">monospace</refmiscinfo>
9187 <refname>dingbat.font.family</refname>
9188 <refpurpose>The font family for copyright, quotes, and other symbols</refpurpose>
9192 <programlisting xml:id="dingbat.font.family.frag">
9193 <xsl:param name="dingbat.font.family">serif</xsl:param>
9197 <refsection><info><title>Description</title></info>
9199 <para>The dingbat font family is used for dingbats. If it is defined
9200 as the empty string, no font change is effected around dingbats.
9206 <refentry version="5.0" xml:id="monospace.font.family">
9208 <refentrytitle>monospace.font.family</refentrytitle>
9209 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
9212 <refname>monospace.font.family</refname>
9213 <refpurpose>The default font family for monospace environments</refpurpose>
9217 <programlisting xml:id="monospace.font.family.frag">
9218 <xsl:param name="monospace.font.family">monospace</xsl:param>
9222 <refsection><info><title>Description</title></info>
9224 <para>The monospace font family is used for verbatim environments
9225 (program listings, screens, etc.).
9231 <refentry version="5.0" xml:id="sans.font.family">
9233 <refentrytitle>sans.font.family</refentrytitle>
9234 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
9237 <refname>sans.font.family</refname>
9238 <refpurpose>The default sans-serif font family</refpurpose>
9242 <programlisting xml:id="sans.font.family.frag">
9243 <xsl:param name="sans.font.family">sans-serif</xsl:param>
9247 <refsection><info><title>Description</title></info>
9249 <para>The default sans-serif font family. At the present, this isn't
9250 actually used by the stylesheets.
9256 <refentry version="5.0" xml:id="title.font.family">
9258 <refentrytitle>title.font.family</refentrytitle>
9259 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
9260 <refmiscinfo class="other" otherclass="list-type">open</refmiscinfo>
9261 <refmiscinfo class="other" otherclass="value">serif</refmiscinfo>
9262 <refmiscinfo class="other" otherclass="value">sans-serif</refmiscinfo>
9263 <refmiscinfo class="other" otherclass="value">monospace</refmiscinfo>
9266 <refname>title.font.family</refname>
9267 <refpurpose>The default font family for titles</refpurpose>
9271 <programlisting xml:id="title.font.family.frag">
9272 <xsl:param name="title.font.family">sans-serif</xsl:param>
9276 <refsection><info><title>Description</title></info>
9278 <para>The title font family is used for titles (chapter, section, figure,
9285 <refentry version="5.0" xml:id="symbol.font.family">
9287 <refentrytitle>symbol.font.family</refentrytitle>
9288 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
9289 <refmiscinfo class="other" otherclass="list-type">open</refmiscinfo>
9290 <refmiscinfo class="other" otherclass="value">serif</refmiscinfo>
9291 <refmiscinfo class="other" otherclass="value">sans-serif</refmiscinfo>
9292 <refmiscinfo class="other" otherclass="value">monospace</refmiscinfo>
9295 <refname>symbol.font.family</refname>
9296 <refpurpose>The font families to be searched for symbols outside
9297 of the body font</refpurpose>
9301 <programlisting xml:id="symbol.font.family.frag">
9302 <xsl:param name="symbol.font.family">Symbol,ZapfDingbats</xsl:param>
9306 <refsection><info><title>Description</title></info>
9308 <para>A typical body or title font does not contain all
9309 the character glyphs that DocBook supports. This parameter
9310 specifies additional fonts that should be searched for
9311 special characters not in the normal font.
9312 These symbol font names are automatically appended
9313 to the body or title font family name when fonts
9315 <tag class="attribute">font-family</tag>
9316 property in the FO output.
9318 <para>The symbol font names should be entered as a
9319 comma-separated list. The default value is
9320 <literal>Symbol,ZapfDingbats</literal>.
9327 <reference xml:id="propsets"><title>Property Sets</title>
9328 <refentry version="5.0" xml:id="formal.object.properties">
9330 <refentrytitle>formal.object.properties</refentrytitle>
9331 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
9334 <refname>formal.object.properties</refname>
9335 <refpurpose>Properties associated with a formal object such as a figure, or other component that has a title</refpurpose>
9339 <programlisting xml:id="formal.object.properties.frag">
9340 <xsl:attribute-set name="formal.object.properties">
9341 <xsl:attribute name="space-before.minimum">0.5em</xsl:attribute>
9342 <xsl:attribute name="space-before.optimum">1em</xsl:attribute>
9343 <xsl:attribute name="space-before.maximum">2em</xsl:attribute>
9344 <xsl:attribute name="space-after.minimum">0.5em</xsl:attribute>
9345 <xsl:attribute name="space-after.optimum">1em</xsl:attribute>
9346 <xsl:attribute name="space-after.maximum">2em</xsl:attribute>
9347 <xsl:attribute name="keep-together.within-column">always</xsl:attribute>
9348 </xsl:attribute-set>
9352 <refsection><info><title>Description</title></info>
9354 <para>The styling for formal objects in docbook. Specify the spacing
9355 before and after the object.</para>
9360 <refentry version="5.0" xml:id="formal.title.properties">
9362 <refentrytitle>formal.title.properties</refentrytitle>
9363 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
9366 <refname>formal.title.properties</refname>
9367 <refpurpose>Style the title element of formal object such as a figure.</refpurpose>
9371 <programlisting xml:id="formal.title.properties.frag">
9372 <xsl:attribute-set name="formal.title.properties" use-attribute-sets="normal.para.spacing">
9373 <xsl:attribute name="font-weight">bold</xsl:attribute>
9374 <xsl:attribute name="font-size">
9375 <xsl:value-of select="$body.font.master * 1.2"></xsl:value-of>
9376 <xsl:text>pt</xsl:text>
9377 </xsl:attribute>
9378 <xsl:attribute name="hyphenate">false</xsl:attribute>
9379 <xsl:attribute name="space-after.minimum">0.4em</xsl:attribute>
9380 <xsl:attribute name="space-after.optimum">0.6em</xsl:attribute>
9381 <xsl:attribute name="space-after.maximum">0.8em</xsl:attribute>
9382 </xsl:attribute-set>
9385 <refsection><info><title>Description</title></info>
9386 <para>Specify how the title should be styled. Specify the font size and weight of the title of the formal object.</para>
9390 <refentry version="5.0" xml:id="informal.object.properties">
9392 <refentrytitle>informal.object.properties</refentrytitle>
9393 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
9396 <refname>informal.object.properties</refname>
9397 <refpurpose>Properties associated with an informal (untitled) object, such as an informalfigure</refpurpose>
9401 <programlisting xml:id="informal.object.properties.frag"><xsl:attribute-set name="informal.object.properties">
9402 <xsl:attribute name="space-before.minimum">0.5em</xsl:attribute>
9403 <xsl:attribute name="space-before.optimum">1em</xsl:attribute>
9404 <xsl:attribute name="space-before.maximum">2em</xsl:attribute>
9405 <xsl:attribute name="space-after.minimum">0.5em</xsl:attribute>
9406 <xsl:attribute name="space-after.optimum">1em</xsl:attribute>
9407 <xsl:attribute name="space-after.maximum">2em</xsl:attribute>
9408 </xsl:attribute-set></programlisting>
9410 <refsection><info><title>Description</title></info>
9411 <para>The styling for informal objects in docbook. Specify the spacing before and after the object.</para>
9415 <refentry version="5.0" xml:id="monospace.properties">
9417 <refentrytitle>monospace.properties</refentrytitle>
9418 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
9421 <refname>monospace.properties</refname>
9422 <refpurpose>Properties of monospaced content</refpurpose>
9426 <programlisting xml:id="monospace.properties.frag">
9427 <xsl:attribute-set name="monospace.properties">
9428 <xsl:attribute name="font-family">
9429 <xsl:value-of select="$monospace.font.family"></xsl:value-of>
9430 </xsl:attribute>
9431 </xsl:attribute-set>
9435 <refsection><info><title>Description</title></info>
9437 <para>Specifies the font name for monospaced output. This property set
9438 used to set the font-size as well, but that doesn't work very well
9439 when different fonts are used (as they are in titles and paragraphs,
9440 for example).</para>
9442 <para>If you want to set the font-size in a customization layer, it's
9443 probably going to be more appropriate to set font-size-adjust, if your
9444 formatter supports it.</para>
9449 <refentry version="5.0" xml:id="verbatim.properties">
9451 <refentrytitle>verbatim.properties</refentrytitle>
9452 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
9455 <refname>verbatim.properties</refname>
9456 <refpurpose>Properties associated with verbatim text</refpurpose>
9460 <programlisting xml:id="verbatim.properties.frag">
9461 <xsl:attribute-set name="verbatim.properties">
9462 <xsl:attribute name="space-before.minimum">0.8em</xsl:attribute>
9463 <xsl:attribute name="space-before.optimum">1em</xsl:attribute>
9464 <xsl:attribute name="space-before.maximum">1.2em</xsl:attribute>
9465 <xsl:attribute name="space-after.minimum">0.8em</xsl:attribute>
9466 <xsl:attribute name="space-after.optimum">1em</xsl:attribute>
9467 <xsl:attribute name="space-after.maximum">1.2em</xsl:attribute>
9468 <xsl:attribute name="hyphenate">false</xsl:attribute>
9469 <xsl:attribute name="wrap-option">no-wrap</xsl:attribute>
9470 <xsl:attribute name="white-space-collapse">false</xsl:attribute>
9471 <xsl:attribute name="white-space-treatment">preserve</xsl:attribute>
9472 <xsl:attribute name="linefeed-treatment">preserve</xsl:attribute>
9473 <xsl:attribute name="text-align">start</xsl:attribute>
9474 </xsl:attribute-set></programlisting>
9477 <refsection><info><title>Description</title></info>
9478 <para>This attribute set is used on all verbatim environments.</para>
9483 <refentry version="5.0" xml:id="monospace.verbatim.properties">
9485 <refentrytitle>monospace.verbatim.properties</refentrytitle>
9486 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
9489 <refname>monospace.verbatim.properties</refname>
9490 <refpurpose>What font and size do you want for monospaced content?</refpurpose>
9494 <programlisting xml:id="monospace.verbatim.properties.frag">
9495 <xsl:attribute-set name="monospace.verbatim.properties" use-attribute-sets="verbatim.properties monospace.properties">
9496 <xsl:attribute name="text-align">start</xsl:attribute>
9497 <xsl:attribute name="wrap-option">no-wrap</xsl:attribute>
9498 </xsl:attribute-set>
9501 <refsection><info><title>Description</title></info>
9502 <para>Specify the font name and size you want for monospaced output</para>
9506 <refentry version="5.0" xml:id="sidebar.properties">
9508 <refentrytitle>sidebar.properties</refentrytitle>
9509 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
9512 <refname>sidebar.properties</refname>
9513 <refpurpose>Attribute set for sidebar properties</refpurpose>
9517 <programlisting xml:id="sidebar.properties.frag">
9518 <xsl:attribute-set name="sidebar.properties" use-attribute-sets="formal.object.properties">
9519 <xsl:attribute name="border-style">solid</xsl:attribute>
9520 <xsl:attribute name="border-width">1pt</xsl:attribute>
9521 <xsl:attribute name="border-color">black</xsl:attribute>
9522 <xsl:attribute name="background-color">#DDDDDD</xsl:attribute>
9523 <xsl:attribute name="padding-start">12pt</xsl:attribute>
9524 <xsl:attribute name="padding-end">12pt</xsl:attribute>
9525 <xsl:attribute name="padding-top">6pt</xsl:attribute>
9526 <xsl:attribute name="padding-bottom">6pt</xsl:attribute>
9527 <xsl:attribute name="margin-{$direction.align.start}">0pt</xsl:attribute>
9528 <xsl:attribute name="margin-{$direction.align.end}">0pt</xsl:attribute>
9530 <xsl:attribute name="margin-top">6pt</xsl:attribute>
9531 <xsl:attribute name="margin-bottom">6pt</xsl:attribute>
9533 </xsl:attribute-set>
9537 <refsection><info><title>Description</title></info>
9539 <para>The styling for sidebars.</para>
9544 <refentry version="5.0" xml:id="sidebar.title.properties">
9546 <refentrytitle>sidebar.title.properties</refentrytitle>
9547 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
9550 <refname>sidebar.title.properties</refname>
9551 <refpurpose>Attribute set for sidebar titles</refpurpose>
9555 <programlisting xml:id="sidebar.title.properties.frag">
9556 <xsl:attribute-set name="sidebar.title.properties">
9557 <xsl:attribute name="font-weight">bold</xsl:attribute>
9558 <xsl:attribute name="hyphenate">false</xsl:attribute>
9559 <xsl:attribute name="text-align">start</xsl:attribute>
9560 <xsl:attribute name="keep-with-next.within-column">always</xsl:attribute>
9561 </xsl:attribute-set>
9565 <refsection><info><title>Description</title></info>
9567 <para>The styling for sidebars titles.</para>
9572 <refentry version="5.0" xml:id="sidebar.float.type">
9574 <refentrytitle>sidebar.float.type</refentrytitle>
9575 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
9576 <refmiscinfo class="other" otherclass="value">none</refmiscinfo>
9577 <refmiscinfo class="other" otherclass="value">before</refmiscinfo>
9578 <refmiscinfo class="other" otherclass="value">left</refmiscinfo>
9579 <refmiscinfo class="other" otherclass="value">start</refmiscinfo>
9580 <refmiscinfo class="other" otherclass="value">right</refmiscinfo>
9581 <refmiscinfo class="other" otherclass="value">end</refmiscinfo>
9582 <refmiscinfo class="other" otherclass="value">inside</refmiscinfo>
9583 <refmiscinfo class="other" otherclass="value">outside</refmiscinfo>
9586 <refname>sidebar.float.type</refname>
9587 <refpurpose>Select type of float for sidebar elements</refpurpose>
9591 <programlisting xml:id="sidebar.float.type.frag">
9592 <xsl:param name="sidebar.float.type">none</xsl:param>
9596 <refsection><info><title>Description</title></info>
9598 <para>Selects the type of float for sidebar elements.
9602 <para>If <parameter>sidebar.float.type</parameter> is
9603 <quote><literal>none</literal></quote>, then
9608 <para>If <parameter>sidebar.float.type</parameter> is
9609 <quote><literal>before</literal></quote>, then
9610 the float appears at the top of the page. On some processors,
9611 that may be the next page rather than the current page.
9616 <para>If <parameter>sidebar.float.type</parameter> is
9617 <quote><literal>left</literal></quote>,
9618 then a left side float is used.
9623 <para>If <parameter>sidebar.float.type</parameter> is
9624 <quote><literal>start</literal></quote>,
9625 then when the text direction is left-to-right a left side float is used.
9626 When the text direction is right-to-left, a right side float is used.
9631 <para>If <parameter>sidebar.float.type</parameter> is
9632 <quote><literal>right</literal></quote>,
9633 then a right side float is used.
9638 <para>If <parameter>sidebar.float.type</parameter> is
9639 <quote><literal>end</literal></quote>,
9640 then when the text direction is left-to-right a right side float is used.
9641 When the text direction is right-to-left, a left side float is used.
9646 <para>If your XSL-FO processor supports floats positioned on the
9647 <quote><literal>inside</literal></quote> or
9648 <quote><literal>outside</literal></quote>
9649 of double-sided pages, then you have those two
9650 options for side floats as well.
9658 <refentry version="5.0" xml:id="sidebar.float.width">
9660 <refentrytitle>sidebar.float.width</refentrytitle>
9661 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
9664 <refname>sidebar.float.width</refname>
9665 <refpurpose>Set the default width for sidebars</refpurpose>
9669 <programlisting xml:id="sidebar.float.width.frag">
9670 <xsl:param name="sidebar.float.width">1in</xsl:param>
9674 <refsection><info><title>Description</title></info>
9676 <para>Sets the default width for sidebars when used as a side float.
9677 The width determines the degree to which the sidebar block intrudes into
9680 <para>If <parameter>sidebar.float.type</parameter> is
9681 <quote><literal>before</literal></quote> or
9682 <quote><literal>none</literal></quote>, then
9683 this parameter is ignored.
9689 <refentry version="5.0" xml:id="margin.note.properties">
9691 <refentrytitle>margin.note.properties</refentrytitle>
9692 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
9695 <refname>margin.note.properties</refname>
9696 <refpurpose>Attribute set for margin.note properties</refpurpose>
9700 <programlisting xml:id="margin.note.properties.frag">
9701 <xsl:attribute-set name="margin.note.properties">
9702 <xsl:attribute name="font-size">90%</xsl:attribute>
9703 <xsl:attribute name="text-align">start</xsl:attribute>
9704 </xsl:attribute-set>
9708 <refsection><info><title>Description</title></info>
9710 <para>The styling for margin notes.
9711 By default, margin notes are not implemented for any
9712 element. A stylesheet customization is needed to make
9713 use of this attribute-set.</para>
9715 <para>You can use a template named <quote>floater</quote>
9716 to create the customization.
9717 That template can create side floats by specifying the
9718 content and characteristics as template parameters.
9721 <para>For example:</para>
9722 <programlisting><xsl:template match="para[@role='marginnote']">
9723 <xsl:call-template name="floater">
9724 <xsl:with-param name="position">
9725 <xsl:value-of select="$margin.note.float.type"/>
9726 </xsl:with-param>
9727 <xsl:with-param name="width">
9728 <xsl:value-of select="$margin.note.width"/>
9729 </xsl:with-param>
9730 <xsl:with-param name="content">
9731 <xsl:apply-imports/>
9732 </xsl:with-param>
9733 </xsl:call-template>
9734 </xsl:template></programlisting>
9739 <refentry version="5.0" xml:id="margin.note.title.properties">
9741 <refentrytitle>margin.note.title.properties</refentrytitle>
9742 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
9745 <refname>margin.note.title.properties</refname>
9746 <refpurpose>Attribute set for margin note titles</refpurpose>
9750 <programlisting xml:id="margin.note.title.properties.frag">
9751 <xsl:attribute-set name="margin.note.title.properties">
9752 <xsl:attribute name="font-weight">bold</xsl:attribute>
9753 <xsl:attribute name="hyphenate">false</xsl:attribute>
9754 <xsl:attribute name="text-align">start</xsl:attribute>
9755 <xsl:attribute name="keep-with-next.within-column">always</xsl:attribute>
9756 </xsl:attribute-set>
9760 <refsection><info><title>Description</title></info>
9762 <para>The styling for margin note titles.</para>
9767 <refentry version="5.0" xml:id="margin.note.float.type">
9769 <refentrytitle>margin.note.float.type</refentrytitle>
9770 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
9771 <refmiscinfo class="other" otherclass="value">none</refmiscinfo>
9772 <refmiscinfo class="other" otherclass="value">before</refmiscinfo>
9773 <refmiscinfo class="other" otherclass="value">left</refmiscinfo>
9774 <refmiscinfo class="other" otherclass="value">start</refmiscinfo>
9775 <refmiscinfo class="other" otherclass="value">right</refmiscinfo>
9776 <refmiscinfo class="other" otherclass="value">end</refmiscinfo>
9777 <refmiscinfo class="other" otherclass="value">inside</refmiscinfo>
9778 <refmiscinfo class="other" otherclass="value">outside</refmiscinfo>
9781 <refname>margin.note.float.type</refname>
9782 <refpurpose>Select type of float for margin note customizations</refpurpose>
9786 <programlisting xml:id="margin.note.float.type.frag">
9787 <xsl:param name="margin.note.float.type">none</xsl:param>
9791 <refsection><info><title>Description</title></info>
9793 <para>Selects the type of float for margin notes.
9794 DocBook does not define a margin note element, so this
9795 feature must be implemented as a customization of the stylesheet.
9796 See <parameter>margin.note.properties</parameter> for
9801 <para>If <parameter>margin.note.float.type</parameter> is
9802 <quote><literal>none</literal></quote>, then
9807 <para>If <parameter>margin.note.float.type</parameter> is
9808 <quote><literal>before</literal></quote>, then
9809 the float appears at the top of the page. On some processors,
9810 that may be the next page rather than the current page.
9814 <para>If <parameter>margin.note.float.type</parameter> is
9815 <quote><literal>left</literal></quote> or
9816 <quote><literal>start</literal></quote>, then
9817 a left side float is used.
9821 <para>If <parameter>margin.note.float.type</parameter> is
9822 <quote><literal>right</literal></quote> or
9823 <quote><literal>end</literal></quote>, then
9824 a right side float is used.
9828 <para>If your XSL-FO processor supports floats positioned on the
9829 <quote><literal>inside</literal></quote> or
9830 <quote><literal>outside</literal></quote>
9831 of double-sided pages, then you have those two
9832 options for side floats as well.
9840 <refentry version="5.0" xml:id="margin.note.width">
9842 <refentrytitle>margin.note.width</refentrytitle>
9843 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
9846 <refname>margin.note.width</refname>
9847 <refpurpose>Set the default width for margin notes</refpurpose>
9851 <programlisting xml:id="margin.note.width.frag">
9852 <xsl:param name="margin.note.width">1in</xsl:param>
9856 <refsection><info><title>Description</title></info>
9858 <para>Sets the default width for margin notes when used as a side
9859 float. The width determines the degree to which the margin note block
9860 intrudes into the text area.
9862 <para>If <parameter>margin.note.float.type</parameter> is
9863 <quote><literal>before</literal></quote> or
9864 <quote><literal>none</literal></quote>, then
9865 this parameter is ignored.
9871 <refentry version="5.0" xml:id="component.title.properties">
9873 <refentrytitle>component.title.properties</refentrytitle>
9874 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
9877 <refname>component.title.properties</refname>
9878 <refpurpose>Properties for component titles</refpurpose>
9882 <programlisting xml:id="component.title.properties.frag">
9883 <xsl:attribute-set name="component.title.properties">
9884 <xsl:attribute name="keep-with-next.within-column">always</xsl:attribute>
9885 <xsl:attribute name="space-before.optimum"><xsl:value-of select="concat($body.font.master, 'pt')"></xsl:value-of></xsl:attribute>
9886 <xsl:attribute name="space-before.minimum"><xsl:value-of select="concat($body.font.master, 'pt * 0.8')"></xsl:value-of></xsl:attribute>
9887 <xsl:attribute name="space-before.maximum"><xsl:value-of select="concat($body.font.master, 'pt * 1.2')"></xsl:value-of></xsl:attribute>
9888 <xsl:attribute name="hyphenate">false</xsl:attribute>
9889 <xsl:attribute name="text-align">
9891 <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>
9892 <xsl:otherwise>start</xsl:otherwise>
9894 </xsl:attribute>
9895 <xsl:attribute name="start-indent"><xsl:value-of select="$title.margin.left"></xsl:value-of></xsl:attribute>
9896 </xsl:attribute-set>
9900 <refsection><info><title>Description</title></info>
9902 <para>The properties common to all component titles.</para>
9907 <refentry version="5.0" xml:id="component.titlepage.properties">
9909 <refentrytitle>component.titlepage.properties</refentrytitle>
9910 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
9913 <refname>component.titlepage.properties</refname>
9914 <refpurpose>Properties for component titlepages</refpurpose>
9918 <programlisting xml:id="component.titlepage.properties.frag">
9919 <xsl:attribute-set name="component.titlepage.properties">
9920 </xsl:attribute-set>
9924 <refsection><info><title>Description</title></info>
9926 <para>The properties that are applied to the outer block containing
9927 all the component title page information.
9928 Its main use is to set a <literal>span="all"</literal>
9929 property on the block that is a direct child of the flow.</para>
9931 <para>This attribute-set also applies to index titlepages. It is empty by default.</para>
9936 <refentry version="5.0" xml:id="section.title.properties">
9938 <refentrytitle>section.title.properties</refentrytitle>
9939 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
9942 <refname>section.title.properties</refname>
9943 <refpurpose>Properties for section titles</refpurpose>
9947 <programlisting xml:id="section.title.properties.frag">
9948 <xsl:attribute-set name="section.title.properties">
9949 <xsl:attribute name="font-family">
9950 <xsl:value-of select="$title.font.family"></xsl:value-of>
9951 </xsl:attribute>
9952 <xsl:attribute name="font-weight">bold</xsl:attribute>
9953 <!-- font size is calculated dynamically by section.heading template -->
9954 <xsl:attribute name="keep-with-next.within-column">always</xsl:attribute>
9955 <xsl:attribute name="space-before.minimum">0.8em</xsl:attribute>
9956 <xsl:attribute name="space-before.optimum">1.0em</xsl:attribute>
9957 <xsl:attribute name="space-before.maximum">1.2em</xsl:attribute>
9958 <xsl:attribute name="text-align">start</xsl:attribute>
9959 <xsl:attribute name="start-indent"><xsl:value-of select="$title.margin.left"></xsl:value-of></xsl:attribute>
9960 </xsl:attribute-set>
9964 <refsection><info><title>Description</title></info>
9966 <para>The properties common to all section titles.</para>
9971 <refentry version="5.0" xml:id="section.title.level1.properties">
9973 <refentrytitle>section.title.level1.properties</refentrytitle>
9974 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
9977 <refname>section.title.level1.properties</refname>
9978 <refpurpose>Properties for level-1 section titles</refpurpose>
9982 <programlisting xml:id="section.title.level1.properties.frag">
9983 <xsl:attribute-set name="section.title.level1.properties">
9984 <xsl:attribute name="font-size">
9985 <xsl:value-of select="$body.font.master * 2.0736"></xsl:value-of>
9986 <xsl:text>pt</xsl:text>
9987 </xsl:attribute>
9988 </xsl:attribute-set>
9992 <refsection><info><title>Description</title></info>
9994 <para>The properties of level-1 section titles.</para>
10000 <refentry version="5.0" xml:id="section.title.level2.properties">
10002 <refentrytitle>section.title.level2.properties</refentrytitle>
10003 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
10006 <refname>section.title.level2.properties</refname>
10007 <refpurpose>Properties for level-2 section titles</refpurpose>
10011 <programlisting xml:id="section.title.level2.properties.frag">
10012 <xsl:attribute-set name="section.title.level2.properties">
10013 <xsl:attribute name="font-size">
10014 <xsl:value-of select="$body.font.master * 1.728"></xsl:value-of>
10015 <xsl:text>pt</xsl:text>
10016 </xsl:attribute>
10017 </xsl:attribute-set>
10021 <refsection><info><title>Description</title></info>
10023 <para>The properties of level-2 section titles.</para>
10028 <refentry version="5.0" xml:id="section.title.level3.properties">
10030 <refentrytitle>section.title.level3.properties</refentrytitle>
10031 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
10034 <refname>section.title.level3.properties</refname>
10035 <refpurpose>Properties for level-3 section titles</refpurpose>
10039 <programlisting xml:id="section.title.level3.properties.frag">
10040 <xsl:attribute-set name="section.title.level3.properties">
10041 <xsl:attribute name="font-size">
10042 <xsl:value-of select="$body.font.master * 1.44"></xsl:value-of>
10043 <xsl:text>pt</xsl:text>
10044 </xsl:attribute>
10045 </xsl:attribute-set>
10049 <refsection><info><title>Description</title></info>
10051 <para>The properties of level-3 section titles.</para>
10056 <refentry version="5.0" xml:id="section.title.level4.properties">
10058 <refentrytitle>section.title.level4.properties</refentrytitle>
10059 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
10062 <refname>section.title.level4.properties</refname>
10063 <refpurpose>Properties for level-4 section titles</refpurpose>
10067 <programlisting xml:id="section.title.level4.properties.frag">
10068 <xsl:attribute-set name="section.title.level4.properties">
10069 <xsl:attribute name="font-size">
10070 <xsl:value-of select="$body.font.master * 1.2"></xsl:value-of>
10071 <xsl:text>pt</xsl:text>
10072 </xsl:attribute>
10073 </xsl:attribute-set>
10077 <refsection><info><title>Description</title></info>
10079 <para>The properties of level-4 section titles.</para>
10084 <refentry version="5.0" xml:id="section.title.level5.properties">
10086 <refentrytitle>section.title.level5.properties</refentrytitle>
10087 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
10090 <refname>section.title.level5.properties</refname>
10091 <refpurpose>Properties for level-5 section titles</refpurpose>
10095 <programlisting xml:id="section.title.level5.properties.frag">
10096 <xsl:attribute-set name="section.title.level5.properties">
10097 <xsl:attribute name="font-size">
10098 <xsl:value-of select="$body.font.master"></xsl:value-of>
10099 <xsl:text>pt</xsl:text>
10100 </xsl:attribute>
10101 </xsl:attribute-set>
10105 <refsection><info><title>Description</title></info>
10107 <para>The properties of level-5 section titles.</para>
10112 <refentry version="5.0" xml:id="section.title.level6.properties">
10114 <refentrytitle>section.title.level6.properties</refentrytitle>
10115 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
10118 <refname>section.title.level6.properties</refname>
10119 <refpurpose>Properties for level-6 section titles</refpurpose>
10123 <programlisting xml:id="section.title.level6.properties.frag">
10124 <xsl:attribute-set name="section.title.level6.properties">
10125 <xsl:attribute name="font-size">
10126 <xsl:value-of select="$body.font.master"></xsl:value-of>
10127 <xsl:text>pt</xsl:text>
10128 </xsl:attribute>
10129 </xsl:attribute-set>
10133 <refsection><info><title>Description</title></info>
10135 <para>The properties of level-6 section titles. This property set is actually
10136 used for all titles below level 5.</para>
10141 <refentry version="5.0" xml:id="section.properties">
10143 <refentrytitle>section.properties</refentrytitle>
10144 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
10147 <refname>section.properties</refname>
10148 <refpurpose>Properties for all section levels</refpurpose>
10152 <programlisting xml:id="section.properties.frag">
10153 <xsl:attribute-set name="section.properties">
10154 </xsl:attribute-set>
10158 <refsection><info><title>Description</title></info>
10160 <para>The properties that apply to the containing
10161 block of all section levels, and therefore apply to
10163 This attribute set is inherited by the
10164 more specific attribute sets such as
10165 <tag>section.level1.properties</tag>.
10166 The default is empty.
10172 <refentry version="5.0" xml:id="section.level1.properties">
10174 <refentrytitle>section.level1.properties</refentrytitle>
10175 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
10178 <refname>section.level1.properties</refname>
10179 <refpurpose>Properties for level-1 sections</refpurpose>
10183 <programlisting xml:id="section.level1.properties.frag">
10184 <xsl:attribute-set name="section.level1.properties" use-attribute-sets="section.properties">
10185 </xsl:attribute-set>
10189 <refsection><info><title>Description</title></info>
10191 <para>The properties that apply to the containing
10192 block of a level-1 section, and therefore apply to
10193 the whole section. This includes <tag>sect1</tag>
10194 elements and <tag>section</tag> elements at level 1.
10197 <para>For example, you could start each level-1 section on
10198 a new page by using:</para>
10199 <programlisting><xsl:attribute-set name="section.level1.properties">
10200 <xsl:attribute name="break-before">page</xsl:attribute>
10201 </xsl:attribute-set>
10204 <para>This attribute set inherits attributes from the
10205 general <tag>section.properties</tag> attribute set.
10211 <refentry version="5.0" xml:id="section.level2.properties">
10213 <refentrytitle>section.level2.properties</refentrytitle>
10214 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
10217 <refname>section.level2.properties</refname>
10218 <refpurpose>Properties for level-2 sections</refpurpose>
10222 <programlisting xml:id="section.level2.properties.frag">
10223 <xsl:attribute-set name="section.level2.properties" use-attribute-sets="section.properties">
10224 </xsl:attribute-set>
10228 <refsection><info><title>Description</title></info>
10230 <para>The properties that apply to the containing
10231 block of a level-2 section, and therefore apply to
10232 the whole section. This includes <tag>sect2</tag>
10233 elements and <tag>section</tag> elements at level 2.
10236 <para>For example, you could start each level-2 section on
10237 a new page by using:</para>
10238 <programlisting><xsl:attribute-set name="section.level2.properties">
10239 <xsl:attribute name="break-before">page</xsl:attribute>
10240 </xsl:attribute-set>
10243 <para>This attribute set inherits attributes from the
10244 general <tag>section.properties</tag> attribute set.
10250 <refentry version="5.0" xml:id="section.level3.properties">
10252 <refentrytitle>section.level3.properties</refentrytitle>
10253 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
10256 <refname>section.level3.properties</refname>
10257 <refpurpose>Properties for level-3 sections</refpurpose>
10261 <programlisting xml:id="section.level3.properties.frag">
10262 <xsl:attribute-set name="section.level3.properties" use-attribute-sets="section.properties">
10263 </xsl:attribute-set>
10267 <refsection><info><title>Description</title></info>
10269 <para>The properties that apply to the containing
10270 block of a level-3 section, and therefore apply to
10271 the whole section. This includes <tag>sect3</tag>
10272 elements and <tag>section</tag> elements at level 3.
10275 <para>For example, you could start each level-3 section on
10276 a new page by using:</para>
10277 <programlisting><xsl:attribute-set name="section.level3.properties">
10278 <xsl:attribute name="break-before">page</xsl:attribute>
10279 </xsl:attribute-set>
10282 <para>This attribute set inherits attributes from the
10283 general <tag>section.properties</tag> attribute set.
10289 <refentry version="5.0" xml:id="section.level4.properties">
10291 <refentrytitle>section.level4.properties</refentrytitle>
10292 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
10295 <refname>section.level4.properties</refname>
10296 <refpurpose>Properties for level-4 sections</refpurpose>
10300 <programlisting xml:id="section.level4.properties.frag">
10301 <xsl:attribute-set name="section.level4.properties" use-attribute-sets="section.properties">
10302 </xsl:attribute-set>
10306 <refsection><info><title>Description</title></info>
10308 <para>The properties that apply to the containing
10309 block of a level-4 section, and therefore apply to
10310 the whole section. This includes <tag>sect4</tag>
10311 elements and <tag>section</tag> elements at level 4.
10314 <para>For example, you could start each level-4 section on
10315 a new page by using:</para>
10316 <programlisting><xsl:attribute-set name="section.level4.properties">
10317 <xsl:attribute name="break-before">page</xsl:attribute>
10318 </xsl:attribute-set>
10321 <para>This attribute set inherits attributes from the
10322 general <tag>section.properties</tag> attribute set.
10328 <refentry version="5.0" xml:id="section.level5.properties">
10330 <refentrytitle>section.level5.properties</refentrytitle>
10331 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
10334 <refname>section.level5.properties</refname>
10335 <refpurpose>Properties for level-5 sections</refpurpose>
10339 <programlisting xml:id="section.level5.properties.frag">
10340 <xsl:attribute-set name="section.level5.properties" use-attribute-sets="section.properties">
10341 </xsl:attribute-set>
10345 <refsection><info><title>Description</title></info>
10347 <para>The properties that apply to the containing
10348 block of a level-5 section, and therefore apply to
10349 the whole section. This includes <tag>sect5</tag>
10350 elements and <tag>section</tag> elements at level 5.
10353 <para>For example, you could start each level-5 section on
10354 a new page by using:</para>
10355 <programlisting><xsl:attribute-set name="section.level5.properties">
10356 <xsl:attribute name="break-before">page</xsl:attribute>
10357 </xsl:attribute-set>
10360 <para>This attribute set inherits attributes from the
10361 general <tag>section.properties</tag> attribute set.
10367 <refentry version="5.0" xml:id="section.level6.properties">
10369 <refentrytitle>section.level6.properties</refentrytitle>
10370 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
10373 <refname>section.level6.properties</refname>
10374 <refpurpose>Properties for level-6 sections</refpurpose>
10378 <programlisting xml:id="section.level6.properties.frag">
10379 <xsl:attribute-set name="section.level6.properties" use-attribute-sets="section.properties">
10380 </xsl:attribute-set>
10384 <refsection><info><title>Description</title></info>
10386 <para>The properties that apply to the containing
10387 block of a level 6 or lower section, and therefore apply to
10388 the whole section. This includes
10389 <tag>section</tag> elements at level 6 and lower.
10392 <para>For example, you could start each level-6 section on
10393 a new page by using:</para>
10394 <programlisting><xsl:attribute-set name="section.level6.properties">
10395 <xsl:attribute name="break-before">page</xsl:attribute>
10396 </xsl:attribute-set>
10399 <para>This attribute set inherits attributes from the
10400 general <tag>section.properties</tag> attribute set.
10406 <refentry version="5.0" xml:id="figure.properties">
10408 <refentrytitle>figure.properties</refentrytitle>
10409 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
10412 <refname>figure.properties</refname>
10413 <refpurpose>Properties associated with a figure</refpurpose>
10417 <programlisting xml:id="figure.properties.frag">
10418 <xsl:attribute-set name="figure.properties" use-attribute-sets="formal.object.properties"></xsl:attribute-set>
10422 <refsection><info><title>Description</title></info>
10424 <para>The styling for figures.</para>
10429 <refentry version="5.0" xml:id="example.properties">
10431 <refentrytitle>example.properties</refentrytitle>
10432 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
10435 <refname>example.properties</refname>
10436 <refpurpose>Properties associated with a example</refpurpose>
10440 <programlisting xml:id="example.properties.frag">
10441 <xsl:attribute-set name="example.properties" use-attribute-sets="formal.object.properties"></xsl:attribute-set>
10445 <refsection><info><title>Description</title></info>
10447 <para>The styling for examples.</para>
10452 <refentry version="5.0" xml:id="equation.properties">
10454 <refentrytitle>equation.properties</refentrytitle>
10455 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
10458 <refname>equation.properties</refname>
10459 <refpurpose>Properties associated with a equation</refpurpose>
10463 <programlisting xml:id="equation.properties.frag">
10464 <xsl:attribute-set name="equation.properties" use-attribute-sets="formal.object.properties"></xsl:attribute-set>
10468 <refsection><info><title>Description</title></info>
10470 <para>The styling for equations.</para>
10475 <refentry version="5.0" xml:id="equation.number.properties">
10477 <refentrytitle>equation.number.properties</refentrytitle>
10478 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
10481 <refname>equation.number.properties</refname>
10482 <refpurpose>Properties that apply to the <tag>fo:table-cell</tag> containing the number
10483 of an <tag>equation</tag> that does not have a title.</refpurpose>
10487 <programlisting xml:id="equation.number.properties.frag"><xsl:attribute-set name="equation.number.properties">
10488 <xsl:attribute name="text-align">end</xsl:attribute>
10489 <xsl:attribute name="display-align">center</xsl:attribute>
10490 </xsl:attribute-set></programlisting>
10492 <refsection><info><title>Description</title></info>
10493 <para>Properties that apply to the fo:table-cell containing the number
10494 of an equation when it has no title. The number in an equation with a
10495 title is formatted along with the title, and this attribute-set does not apply.</para>
10499 <refentry version="5.0" xml:id="table.properties">
10501 <refentrytitle>table.properties</refentrytitle>
10502 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
10505 <refname>table.properties</refname>
10506 <refpurpose>Properties associated with the block surrounding a table</refpurpose>
10510 <programlisting xml:id="table.properties.frag">
10511 <xsl:attribute-set name="table.properties" use-attribute-sets="formal.object.properties">
10512 <xsl:attribute name="keep-together.within-column">auto</xsl:attribute>
10513 </xsl:attribute-set>
10517 <refsection><info><title>Description</title></info>
10519 <para>Block styling properties for tables. This parameter should really
10520 have been called <literal>table.block.properties</literal> or something
10521 like that, but we’re leaving it to avoid backwards-compatibility
10524 <para>See also <parameter>table.table.properties</parameter>.</para>
10529 <refentry version="5.0" xml:id="informalfigure.properties">
10531 <refentrytitle>informalfigure.properties</refentrytitle>
10532 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
10535 <refname>informalfigure.properties</refname>
10536 <refpurpose>Properties associated with an informalfigure</refpurpose>
10540 <programlisting xml:id="informalfigure.properties.frag">
10541 <xsl:attribute-set name="informalfigure.properties" use-attribute-sets="informal.object.properties"></xsl:attribute-set>
10545 <refsection><info><title>Description</title></info>
10547 <para>The styling for informalfigures.</para>
10552 <refentry version="5.0" xml:id="informalexample.properties">
10554 <refentrytitle>informalexample.properties</refentrytitle>
10555 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
10558 <refname>informalexample.properties</refname>
10559 <refpurpose>Properties associated with an informalexample</refpurpose>
10563 <programlisting xml:id="informalexample.properties.frag">
10564 <xsl:attribute-set name="informalexample.properties" use-attribute-sets="informal.object.properties"></xsl:attribute-set>
10568 <refsection><info><title>Description</title></info>
10570 <para>The styling for informalexamples.</para>
10575 <refentry version="5.0" xml:id="informalequation.properties">
10577 <refentrytitle>informalequation.properties</refentrytitle>
10578 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
10581 <refname>informalequation.properties</refname>
10582 <refpurpose>Properties associated with an informalequation</refpurpose>
10586 <programlisting xml:id="informalequation.properties.frag">
10587 <xsl:attribute-set name="informalequation.properties" use-attribute-sets="informal.object.properties"></xsl:attribute-set>
10591 <refsection><info><title>Description</title></info>
10593 <para>The styling for informalequations.</para>
10598 <refentry version="5.0" xml:id="informaltable.properties">
10600 <refentrytitle>informaltable.properties</refentrytitle>
10601 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
10604 <refname>informaltable.properties</refname>
10605 <refpurpose>Properties associated with the block surrounding an informaltable</refpurpose>
10609 <programlisting xml:id="informaltable.properties.frag">
10610 <xsl:attribute-set name="informaltable.properties" use-attribute-sets="informal.object.properties"></xsl:attribute-set>
10614 <refsection><info><title>Description</title></info>
10616 <para>Block styling properties for informaltables. This parameter should really
10617 have been called <literal>informaltable.block.properties</literal> or something
10618 like that, but we’re leaving it to avoid backwards-compatibility
10621 <para>See also <parameter>table.table.properties</parameter>.</para>
10626 <refentry version="5.0" xml:id="procedure.properties">
10628 <refentrytitle>procedure.properties</refentrytitle>
10629 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
10632 <refname>procedure.properties</refname>
10633 <refpurpose>Properties associated with a procedure</refpurpose>
10637 <programlisting xml:id="procedure.properties.frag">
10638 <xsl:attribute-set name="procedure.properties" use-attribute-sets="formal.object.properties">
10639 <xsl:attribute name="keep-together.within-column">auto</xsl:attribute>
10640 </xsl:attribute-set>
10644 <refsection><info><title>Description</title></info>
10646 <para>The styling for procedures.</para>
10651 <refentry version="5.0" xml:id="root.properties">
10653 <refentrytitle>root.properties</refentrytitle>
10654 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
10657 <refname>root.properties</refname>
10658 <refpurpose>The properties of the fo:root element</refpurpose>
10662 <programlisting xml:id="root.properties.frag">
10663 <xsl:attribute-set name="root.properties">
10664 <xsl:attribute name="font-family">
10665 <xsl:value-of select="$body.fontset"></xsl:value-of>
10666 </xsl:attribute>
10667 <xsl:attribute name="font-size">
10668 <xsl:value-of select="$body.font.size"></xsl:value-of>
10669 </xsl:attribute>
10670 <xsl:attribute name="text-align">
10671 <xsl:value-of select="$alignment"></xsl:value-of>
10672 </xsl:attribute>
10673 <xsl:attribute name="line-height">
10674 <xsl:value-of select="$line-height"></xsl:value-of>
10675 </xsl:attribute>
10676 <xsl:attribute name="font-selection-strategy">character-by-character</xsl:attribute>
10677 <xsl:attribute name="line-height-shift-adjustment">disregard-shifts</xsl:attribute>
10678 <xsl:attribute name="writing-mode">
10679 <xsl:value-of select="$direction.mode"></xsl:value-of>
10680 </xsl:attribute>
10681 </xsl:attribute-set>
10685 <refsection><info><title>Description</title></info>
10687 <para>This property set is used on the <tag>fo:root</tag> element of
10688 an FO file. It defines a set of default, global parameters.</para>
10693 <refentry version="5.0" xml:id="qanda.title.properties">
10695 <refentrytitle>qanda.title.properties</refentrytitle>
10696 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
10699 <refname>qanda.title.properties</refname>
10700 <refpurpose>Properties for qanda set titles</refpurpose>
10704 <programlisting xml:id="qanda.title.properties.frag">
10705 <xsl:attribute-set name="qanda.title.properties">
10706 <xsl:attribute name="font-family">
10707 <xsl:value-of select="$title.font.family"></xsl:value-of>
10708 </xsl:attribute>
10709 <xsl:attribute name="font-weight">bold</xsl:attribute>
10710 <!-- font size is calculated dynamically by qanda.heading template -->
10711 <xsl:attribute name="keep-with-next.within-column">always</xsl:attribute>
10712 <xsl:attribute name="space-before.minimum">0.8em</xsl:attribute>
10713 <xsl:attribute name="space-before.optimum">1.0em</xsl:attribute>
10714 <xsl:attribute name="space-before.maximum">1.2em</xsl:attribute>
10715 </xsl:attribute-set>
10719 <refsection><info><title>Description</title></info>
10721 <para>The properties common to all qanda set titles.</para>
10726 <refentry version="5.0" xml:id="qanda.title.level1.properties">
10728 <refentrytitle>qanda.title.level1.properties</refentrytitle>
10729 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
10732 <refname>qanda.title.level1.properties</refname>
10733 <refpurpose>Properties for level-1 qanda set titles</refpurpose>
10737 <programlisting xml:id="qanda.title.level1.properties.frag">
10738 <xsl:attribute-set name="qanda.title.level1.properties">
10739 <xsl:attribute name="font-size">
10740 <xsl:value-of select="$body.font.master * 2.0736"></xsl:value-of>
10741 <xsl:text>pt</xsl:text>
10742 </xsl:attribute>
10743 </xsl:attribute-set>
10747 <refsection><info><title>Description</title></info>
10749 <para>The properties of level-1 qanda set titles.</para>
10754 <refentry version="5.0" xml:id="qanda.title.level2.properties">
10756 <refentrytitle>qanda.title.level2.properties</refentrytitle>
10757 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
10760 <refname>qanda.title.level2.properties</refname>
10761 <refpurpose>Properties for level-2 qanda set titles</refpurpose>
10765 <programlisting xml:id="qanda.title.level2.properties.frag">
10766 <xsl:attribute-set name="qanda.title.level2.properties">
10767 <xsl:attribute name="font-size">
10768 <xsl:value-of select="$body.font.master * 1.728"></xsl:value-of>
10769 <xsl:text>pt</xsl:text>
10770 </xsl:attribute>
10771 </xsl:attribute-set>
10775 <refsection><info><title>Description</title></info>
10777 <para>The properties of level-2 qanda set titles.</para>
10782 <refentry version="5.0" xml:id="qanda.title.level3.properties">
10784 <refentrytitle>qanda.title.level3.properties</refentrytitle>
10785 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
10788 <refname>qanda.title.level3.properties</refname>
10789 <refpurpose>Properties for level-3 qanda set titles</refpurpose>
10793 <programlisting xml:id="qanda.title.level3.properties.frag">
10794 <xsl:attribute-set name="qanda.title.level3.properties">
10795 <xsl:attribute name="font-size">
10796 <xsl:value-of select="$body.font.master * 1.44"></xsl:value-of>
10797 <xsl:text>pt</xsl:text>
10798 </xsl:attribute>
10799 </xsl:attribute-set>
10803 <refsection><info><title>Description</title></info>
10805 <para>The properties of level-3 qanda set titles.</para>
10810 <refentry version="5.0" xml:id="qanda.title.level4.properties">
10812 <refentrytitle>qanda.title.level4.properties</refentrytitle>
10813 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
10816 <refname>qanda.title.level4.properties</refname>
10817 <refpurpose>Properties for level-4 qanda set titles</refpurpose>
10821 <programlisting xml:id="qanda.title.level4.properties.frag">
10822 <xsl:attribute-set name="qanda.title.level4.properties">
10823 <xsl:attribute name="font-size">
10824 <xsl:value-of select="$body.font.master * 1.2"></xsl:value-of>
10825 <xsl:text>pt</xsl:text>
10826 </xsl:attribute>
10827 </xsl:attribute-set>
10831 <refsection><info><title>Description</title></info>
10833 <para>The properties of level-4 qanda set titles.</para>
10838 <refentry version="5.0" xml:id="qanda.title.level5.properties">
10840 <refentrytitle>qanda.title.level5.properties</refentrytitle>
10841 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
10844 <refname>qanda.title.level5.properties</refname>
10845 <refpurpose>Properties for level-5 qanda set titles</refpurpose>
10849 <programlisting xml:id="qanda.title.level5.properties.frag">
10850 <xsl:attribute-set name="qanda.title.level5.properties">
10851 <xsl:attribute name="font-size">
10852 <xsl:value-of select="$body.font.master"></xsl:value-of>
10853 <xsl:text>pt</xsl:text>
10854 </xsl:attribute>
10855 </xsl:attribute-set>
10859 <refsection><info><title>Description</title></info>
10861 <para>The properties of level-5 qanda set titles.</para>
10866 <refentry version="5.0" xml:id="qanda.title.level6.properties">
10868 <refentrytitle>qanda.title.level6.properties</refentrytitle>
10869 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
10872 <refname>qanda.title.level6.properties</refname>
10873 <refpurpose>Properties for level-6 qanda set titles</refpurpose>
10877 <programlisting xml:id="qanda.title.level6.properties.frag">
10878 <xsl:attribute-set name="qanda.title.level6.properties">
10879 <xsl:attribute name="font-size">
10880 <xsl:value-of select="$body.font.master"></xsl:value-of>
10881 <xsl:text>pt</xsl:text>
10882 </xsl:attribute>
10883 </xsl:attribute-set>
10887 <refsection><info><title>Description</title></info>
10889 <para>The properties of level-6 qanda set titles.
10890 This property set is actually
10891 used for all titles below level 5.</para>
10896 <refentry version="5.0" xml:id="article.appendix.title.properties">
10898 <refentrytitle>article.appendix.title.properties</refentrytitle>
10899 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
10902 <refname>article.appendix.title.properties</refname>
10903 <refpurpose>Properties for appendix titles that appear in an article</refpurpose>
10907 <programlisting xml:id="article.appendix.title.properties.frag">
10908 <xsl:attribute-set name="article.appendix.title.properties" use-attribute-sets="section.title.properties section.title.level1.properties">
10909 <xsl:attribute name="margin-{$direction.align.start}">
10910 <xsl:value-of select="$title.margin.left"></xsl:value-of>
10911 </xsl:attribute>
10912 </xsl:attribute-set>
10916 <refsection><info><title>Description</title></info>
10918 <para>The properties for the title of an appendix that
10919 appears inside an article. The default is to use
10920 the properties of sect1 titles.</para>
10925 <refentry version="5.0" xml:id="abstract.properties">
10927 <refentrytitle>abstract.properties</refentrytitle>
10928 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
10931 <refname>abstract.properties</refname>
10932 <refpurpose>Properties associated with the block surrounding an abstract</refpurpose>
10936 <programlisting xml:id="abstract.properties.frag">
10937 <xsl:attribute-set name="abstract.properties">
10938 <xsl:attribute name="start-indent">0.0in</xsl:attribute>
10939 <xsl:attribute name="end-indent">0.0in</xsl:attribute>
10940 </xsl:attribute-set>
10944 <refsection><info><title>Description</title></info>
10946 <para>Block styling properties for abstract.</para>
10948 <para>See also <parameter>abstract.title.properties</parameter>.</para>
10953 <refentry version="5.0" xml:id="abstract.title.properties">
10955 <refentrytitle>abstract.title.properties</refentrytitle>
10956 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
10959 <refname>abstract.title.properties</refname>
10960 <refpurpose>Properties for abstract titles</refpurpose>
10964 <programlisting xml:id="abstract.title.properties.frag">
10965 <xsl:attribute-set name="abstract.title.properties">
10966 <xsl:attribute name="font-family"><xsl:value-of select="$title.fontset"></xsl:value-of></xsl:attribute>
10967 <xsl:attribute name="font-weight">bold</xsl:attribute>
10968 <xsl:attribute name="keep-with-next.within-column">always</xsl:attribute>
10969 <xsl:attribute name="keep-with-next.within-column">always</xsl:attribute>
10970 <xsl:attribute name="space-before.optimum"><xsl:value-of select="concat($body.font.master, 'pt')"></xsl:value-of></xsl:attribute>
10971 <xsl:attribute name="space-before.minimum"><xsl:value-of select="concat($body.font.master, 'pt * 0.8')"></xsl:value-of></xsl:attribute>
10972 <xsl:attribute name="space-before.maximum"><xsl:value-of select="concat($body.font.master, 'pt * 1.2')"></xsl:value-of></xsl:attribute>
10973 <xsl:attribute name="hyphenate">false</xsl:attribute>
10974 <xsl:attribute name="text-align">center</xsl:attribute>
10975 </xsl:attribute-set>
10979 <refsection><info><title>Description</title></info>
10981 <para>The properties for abstract titles.</para>
10983 <para>See also <parameter>abstract.properties</parameter>.</para>
10988 <refentry version="5.0" xml:id="index.page.number.properties">
10990 <refentrytitle>index.page.number.properties</refentrytitle>
10991 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
10994 <refname>index.page.number.properties</refname>
10995 <refpurpose>Properties associated with index page numbers</refpurpose>
10999 <programlisting xml:id="index.page.number.properties.frag">
11000 <xsl:attribute-set name="index.page.number.properties">
11001 </xsl:attribute-set>
11005 <refsection><info><title>Description</title></info>
11007 <para>Properties associated with page numbers in indexes.
11008 Changing color to indicate the page number is a link is
11015 <refentry version="5.0" xml:id="revhistory.table.properties">
11017 <refentrytitle>revhistory.table.properties</refentrytitle>
11018 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
11021 <refname>revhistory.table.properties</refname>
11022 <refpurpose>The properties of table used for formatting revhistory</refpurpose>
11026 <programlisting xml:id="revhistory.table.properties.frag">
11027 <xsl:attribute-set name="revhistory.table.properties">
11028 </xsl:attribute-set>
11032 <refsection><info><title>Description</title></info>
11034 <para>This property set defines appearance of revhistory table.</para>
11039 <refentry version="5.0" xml:id="revhistory.table.cell.properties">
11041 <refentrytitle>revhistory.table.cell.properties</refentrytitle>
11042 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
11045 <refname>revhistory.table.cell.properties</refname>
11046 <refpurpose>The properties of table cells used for formatting revhistory</refpurpose>
11050 <programlisting xml:id="revhistory.table.cell.properties.frag">
11051 <xsl:attribute-set name="revhistory.table.cell.properties">
11052 </xsl:attribute-set>
11056 <refsection><info><title>Description</title></info>
11058 <para>This property set defines appearance of individual cells in revhistory table.</para>
11063 <refentry version="5.0" xml:id="revhistory.title.properties">
11065 <refentrytitle>revhistory.title.properties</refentrytitle>
11066 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
11069 <refname>revhistory.title.properties</refname>
11070 <refpurpose>The properties of revhistory title</refpurpose>
11074 <programlisting xml:id="revhistory.title.properties.frag">
11075 <xsl:attribute-set name="revhistory.title.properties">
11076 </xsl:attribute-set>
11080 <refsection><info><title>Description</title></info>
11082 <para>This property set defines appearance of revhistory title.</para>
11088 <reference xml:id="profiling"><title>Profiling</title>
11089 <partintro xml:id="profiling_partintro">
11090 <para>The following parameters can be used for attribute-based
11091 profiling of your document. For more information about profiling, see
11092 <link xmlns:xlink="http://www.w3.org/1999/xlink" role="tcg" xlink:href="Profiling.html">Profiling (conditional text)</link>.</para>
11094 <refentry version="5.0" xml:id="profile.arch">
11096 <refentrytitle>profile.arch</refentrytitle>
11097 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
11100 <refname>profile.arch</refname>
11101 <refpurpose>Target profile for <tag class="attribute">arch</tag>
11102 attribute</refpurpose>
11106 <programlisting xml:id="profile.arch.frag">
11107 <xsl:param name="profile.arch"></xsl:param>
11112 <refsection><info><title>Description</title></info>
11114 <para>The value of this parameter specifies profiles which should be
11115 included in the output. You can specify multiple profiles by
11116 separating them by semicolon. You can change separator character by
11117 <parameter>profile.separator</parameter>
11120 <para>This parameter has effect only when you are using profiling
11121 stylesheets (<filename>profile-docbook.xsl</filename>,
11122 <filename>profile-chunk.xsl</filename>, …) instead of normal
11123 ones (<filename>docbook.xsl</filename>,
11124 <filename>chunk.xsl</filename>, …).</para>
11129 <refentry version="5.0" xml:id="profile.audience">
11131 <refentrytitle>profile.audience</refentrytitle>
11132 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
11135 <refname>profile.audience</refname>
11136 <refpurpose>Target profile for <tag class="attribute">audience</tag>
11137 attribute</refpurpose>
11141 <programlisting xml:id="profile.audience.frag">
11142 <xsl:param name="profile.audience"></xsl:param>
11146 <refsection><info><title>Description</title></info>
11148 <para>Value of this parameter specifies profiles which should be
11149 included in the output. You can specify multiple profiles by
11150 separating them by semicolon. You can change separator character by
11151 <parameter>profile.separator</parameter>
11154 <para>This parameter has effect only when you are using profiling
11155 stylesheets (<filename>profile-docbook.xsl</filename>,
11156 <filename>profile-chunk.xsl</filename>, …) instead of normal
11157 ones (<filename>docbook.xsl</filename>,
11158 <filename>chunk.xsl</filename>, …).</para>
11163 <refentry version="5.0" xml:id="profile.condition">
11165 <refentrytitle>profile.condition</refentrytitle>
11166 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
11169 <refname>profile.condition</refname>
11170 <refpurpose>Target profile for <tag class="attribute">condition</tag>
11171 attribute</refpurpose>
11175 <programlisting xml:id="profile.condition.frag">
11176 <xsl:param name="profile.condition"></xsl:param>
11180 <refsection><info><title>Description</title></info>
11182 <para>The value of this parameter specifies profiles which should be
11183 included in the output. You can specify multiple profiles by
11184 separating them by semicolon. You can change separator character by
11185 <parameter>profile.separator</parameter>
11188 <para>This parameter has effect only when you are using profiling
11189 stylesheets (<filename>profile-docbook.xsl</filename>,
11190 <filename>profile-chunk.xsl</filename>, …) instead of normal
11191 ones (<filename>docbook.xsl</filename>,
11192 <filename>chunk.xsl</filename>, …).</para>
11197 <refentry version="5.0" xml:id="profile.conformance">
11199 <refentrytitle>profile.conformance</refentrytitle>
11200 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
11203 <refname>profile.conformance</refname>
11204 <refpurpose>Target profile for <tag class="attribute">conformance</tag>
11205 attribute</refpurpose>
11209 <programlisting xml:id="profile.conformance.frag">
11210 <xsl:param name="profile.conformance"></xsl:param>
11214 <refsection><info><title>Description</title></info>
11216 <para>The value of this parameter specifies profiles which should be
11217 included in the output. You can specify multiple profiles by
11218 separating them by semicolon. You can change separator character by
11219 <parameter>profile.separator</parameter>
11222 <para>This parameter has effect only when you are using profiling
11223 stylesheets (<filename>profile-docbook.xsl</filename>,
11224 <filename>profile-chunk.xsl</filename>, …) instead of normal
11225 ones (<filename>docbook.xsl</filename>,
11226 <filename>chunk.xsl</filename>, …).</para>
11231 <refentry version="5.0" xml:id="profile.lang">
11233 <refentrytitle>profile.lang</refentrytitle>
11234 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
11237 <refname>profile.lang</refname>
11238 <refpurpose>Target profile for <tag class="attribute">lang</tag>
11239 attribute</refpurpose>
11243 <programlisting xml:id="profile.lang.frag">
11244 <xsl:param name="profile.lang"></xsl:param>
11248 <refsection><info><title>Description</title></info>
11250 <para>The value of this parameter specifies profiles which should be
11251 included in the output. You can specify multiple profiles by
11252 separating them by semicolon. You can change separator character by
11253 <parameter>profile.separator</parameter>
11256 <para>This parameter has effect only when you are using profiling
11257 stylesheets (<filename>profile-docbook.xsl</filename>,
11258 <filename>profile-chunk.xsl</filename>, …) instead of normal
11259 ones (<filename>docbook.xsl</filename>,
11260 <filename>chunk.xsl</filename>, …).</para>
11265 <refentry version="5.0" xml:id="profile.os">
11267 <refentrytitle>profile.os</refentrytitle>
11268 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
11271 <refname>profile.os</refname>
11272 <refpurpose>Target profile for <tag class="attribute">os</tag>
11273 attribute</refpurpose>
11277 <programlisting xml:id="profile.os.frag">
11278 <xsl:param name="profile.os"></xsl:param>
11282 <refsection><info><title>Description</title></info>
11284 <para>The value of this parameter specifies profiles which should be
11285 included in the output. You can specify multiple profiles by
11286 separating them by semicolon. You can change separator character by
11287 <parameter>profile.separator</parameter>
11290 <para>This parameter has effect only when you are using profiling
11291 stylesheets (<filename>profile-docbook.xsl</filename>,
11292 <filename>profile-chunk.xsl</filename>, …) instead of normal
11293 ones (<filename>docbook.xsl</filename>,
11294 <filename>chunk.xsl</filename>, …).</para>
11299 <refentry version="5.0" xml:id="profile.revision">
11301 <refentrytitle>profile.revision</refentrytitle>
11302 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
11305 <refname>profile.revision</refname>
11306 <refpurpose>Target profile for <tag class="attribute">revision</tag>
11307 attribute</refpurpose>
11311 <programlisting xml:id="profile.revision.frag">
11312 <xsl:param name="profile.revision"></xsl:param>
11316 <refsection><info><title>Description</title></info>
11318 <para>The value of this parameter specifies profiles which should be
11319 included in the output. You can specify multiple profiles by
11320 separating them by semicolon. You can change separator character by
11321 <parameter>profile.separator</parameter>
11324 <para>This parameter has effect only when you are using profiling
11325 stylesheets (<filename>profile-docbook.xsl</filename>,
11326 <filename>profile-chunk.xsl</filename>, …) instead of normal
11327 ones (<filename>docbook.xsl</filename>,
11328 <filename>chunk.xsl</filename>, …).</para>
11333 <refentry version="5.0" xml:id="profile.revisionflag">
11335 <refentrytitle>profile.revisionflag</refentrytitle>
11336 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
11339 <refname>profile.revisionflag</refname>
11340 <refpurpose>Target profile for <tag class="attribute">revisionflag</tag>
11341 attribute</refpurpose>
11345 <programlisting xml:id="profile.revisionflag.frag">
11346 <xsl:param name="profile.revisionflag"></xsl:param>
11350 <refsection><info><title>Description</title></info>
11352 <para>The value of this parameter specifies profiles which should be
11353 included in the output. You can specify multiple profiles by
11354 separating them by semicolon. You can change separator character by
11355 <parameter>profile.separator</parameter>
11358 <para>This parameter has effect only when you are using profiling
11359 stylesheets (<filename>profile-docbook.xsl</filename>,
11360 <filename>profile-chunk.xsl</filename>, …) instead of normal
11361 ones (<filename>docbook.xsl</filename>,
11362 <filename>chunk.xsl</filename>, …).</para>
11367 <refentry version="5.0" xml:id="profile.role">
11369 <refentrytitle>profile.role</refentrytitle>
11370 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
11373 <refname>profile.role</refname>
11374 <refpurpose>Target profile for <tag class="attribute">role</tag>
11375 attribute</refpurpose>
11379 <programlisting xml:id="profile.role.frag">
11380 <xsl:param name="profile.role"></xsl:param>
11384 <refsection><info><title>Description</title></info>
11386 <para>The value of this parameter specifies profiles which should be
11387 included in the output. You can specify multiple profiles by
11388 separating them by semicolon. You can change separator character by
11389 <parameter>profile.separator</parameter>
11392 <para>This parameter has effect only when you are using profiling
11393 stylesheets (<filename>profile-docbook.xsl</filename>,
11394 <filename>profile-chunk.xsl</filename>, …) instead of normal
11395 ones (<filename>docbook.xsl</filename>,
11396 <filename>chunk.xsl</filename>, …).</para>
11399 <para>Note that <tag class="attribute">role</tag> is often
11400 used for other purposes than profiling. For example it is commonly
11401 used to get emphasize in bold font:</para>
11403 <programlisting><emphasis role="bold">very important</emphasis></programlisting>
11405 <para>If you are using <tag class="attribute">role</tag> for
11406 these purposes do not forget to add values like <literal>bold</literal> to
11407 value of this parameter. If you forgot you will get document with
11408 small pieces missing which are very hard to track.</para>
11410 <para>For this reason it is not recommended to use <tag class="attribute">role</tag> attribute for profiling. You should
11411 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>
11417 <refentry version="5.0" xml:id="profile.security">
11419 <refentrytitle>profile.security</refentrytitle>
11420 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
11423 <refname>profile.security</refname>
11424 <refpurpose>Target profile for <tag class="attribute">security</tag>
11425 attribute</refpurpose>
11429 <programlisting xml:id="profile.security.frag">
11430 <xsl:param name="profile.security"></xsl:param>
11434 <refsection><info><title>Description</title></info>
11436 <para>The value of this parameter specifies profiles which should be
11437 included in the output. You can specify multiple profiles by
11438 separating them by semicolon. You can change separator character by
11439 <parameter>profile.separator</parameter>
11442 <para>This parameter has effect only when you are using profiling
11443 stylesheets (<filename>profile-docbook.xsl</filename>,
11444 <filename>profile-chunk.xsl</filename>, …) instead of normal
11445 ones (<filename>docbook.xsl</filename>,
11446 <filename>chunk.xsl</filename>, …).</para>
11451 <refentry version="5.0" xml:id="profile.status">
11453 <refentrytitle>profile.status</refentrytitle>
11454 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
11457 <refname>profile.status</refname>
11458 <refpurpose>Target profile for <tag class="attribute">status</tag>
11459 attribute</refpurpose>
11463 <programlisting xml:id="profile.status.frag">
11464 <xsl:param name="profile.status"></xsl:param>
11468 <refsection><info><title>Description</title></info>
11470 <para>The value of this parameter specifies profiles which should be
11471 included in the output. You can specify multiple profiles by
11472 separating them by semicolon. You can change separator character by
11473 <parameter>profile.separator</parameter>
11476 <para>This parameter has effect only when you are using profiling
11477 stylesheets (<filename>profile-docbook.xsl</filename>,
11478 <filename>profile-chunk.xsl</filename>, …) instead of normal
11479 ones (<filename>docbook.xsl</filename>,
11480 <filename>chunk.xsl</filename>, …).</para>
11485 <refentry version="5.0" xml:id="profile.userlevel">
11487 <refentrytitle>profile.userlevel</refentrytitle>
11488 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
11491 <refname>profile.userlevel</refname>
11492 <refpurpose>Target profile for <tag class="attribute">userlevel</tag>
11493 attribute</refpurpose>
11497 <programlisting xml:id="profile.userlevel.frag">
11498 <xsl:param name="profile.userlevel"></xsl:param>
11502 <refsection><info><title>Description</title></info>
11504 <para>The value of this parameter specifies profiles which should be
11505 included in the output. You can specify multiple profiles by
11506 separating them by semicolon. You can change separator character by
11507 <parameter>profile.separator</parameter>
11510 <para>This parameter has effect only when you are using profiling
11511 stylesheets (<filename>profile-docbook.xsl</filename>,
11512 <filename>profile-chunk.xsl</filename>, …) instead of normal
11513 ones (<filename>docbook.xsl</filename>,
11514 <filename>chunk.xsl</filename>, …).</para>
11519 <refentry version="5.0" xml:id="profile.vendor">
11521 <refentrytitle>profile.vendor</refentrytitle>
11522 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
11525 <refname>profile.vendor</refname>
11526 <refpurpose>Target profile for <tag class="attribute">vendor</tag>
11527 attribute</refpurpose>
11531 <programlisting xml:id="profile.vendor.frag">
11532 <xsl:param name="profile.vendor"></xsl:param>
11536 <refsection><info><title>Description</title></info>
11538 <para>The value of this parameter specifies profiles which should be
11539 included in the output. You can specify multiple profiles by
11540 separating them by semicolon. You can change separator character by
11541 <parameter>profile.separator</parameter>
11544 <para>This parameter has effect only when you are using profiling
11545 stylesheets (<filename>profile-docbook.xsl</filename>,
11546 <filename>profile-chunk.xsl</filename>, …) instead of normal
11547 ones (<filename>docbook.xsl</filename>,
11548 <filename>chunk.xsl</filename>, …).</para>
11553 <refentry version="5.0" xml:id="profile.wordsize">
11555 <refentrytitle>profile.wordsize</refentrytitle>
11556 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
11559 <refname>profile.wordsize</refname>
11560 <refpurpose>Target profile for <tag class="attribute">wordsize</tag>
11561 attribute</refpurpose>
11565 <programlisting xml:id="profile.wordsize.frag">
11566 <xsl:param name="profile.wordsize"></xsl:param>
11570 <refsection><info><title>Description</title></info>
11572 <para>The value of this parameter specifies profiles which should be
11573 included in the output. You can specify multiple profiles by
11574 separating them by semicolon. You can change separator character by
11575 <parameter>profile.separator</parameter>
11578 <para>This parameter has effect only when you are using profiling
11579 stylesheets (<filename>profile-docbook.xsl</filename>,
11580 <filename>profile-chunk.xsl</filename>, …) instead of normal
11581 ones (<filename>docbook.xsl</filename>,
11582 <filename>chunk.xsl</filename>, …).</para>
11587 <refentry version="5.0" xml:id="profile.attribute">
11589 <refentrytitle>profile.attribute</refentrytitle>
11590 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
11593 <refname>profile.attribute</refname>
11594 <refpurpose>Name of user-specified profiling attribute</refpurpose>
11598 <programlisting xml:id="profile.attribute.frag">
11599 <xsl:param name="profile.attribute"></xsl:param>
11603 <refsection><info><title>Description</title></info>
11605 <para>This parameter is used in conjuction with
11606 <parameter>profile.value</parameter>.</para>
11608 <para>This parameter has effect only when you are using profiling
11609 stylesheets (<filename>profile-docbook.xsl</filename>,
11610 <filename>profile-chunk.xsl</filename>, …) instead of normal
11611 ones (<filename>docbook.xsl</filename>,
11612 <filename>chunk.xsl</filename>, …).</para>
11617 <refentry version="5.0" xml:id="profile.value">
11619 <refentrytitle>profile.value</refentrytitle>
11620 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
11623 <refname>profile.value</refname>
11624 <refpurpose>Target profile for user-specified attribute</refpurpose>
11628 <programlisting xml:id="profile.value.frag">
11629 <xsl:param name="profile.value"></xsl:param>
11633 <refsection><info><title>Description</title></info>
11635 <para>When you are using this parameter you must also specify name of
11636 profiling attribute with parameter
11637 <parameter>profile.attribute</parameter>.</para>
11639 <para>The value of this parameter specifies profiles which should be
11640 included in the output. You can specify multiple profiles by
11641 separating them by semicolon. You can change separator character by
11642 <parameter>profile.separator</parameter>
11645 <para>This parameter has effect only when you are using profiling
11646 stylesheets (<filename>profile-docbook.xsl</filename>,
11647 <filename>profile-chunk.xsl</filename>, …) instead of normal
11648 ones (<filename>docbook.xsl</filename>,
11649 <filename>chunk.xsl</filename>, …).</para>
11654 <refentry version="5.0" xml:id="profile.separator">
11656 <refentrytitle>profile.separator</refentrytitle>
11657 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
11660 <refname>profile.separator</refname>
11661 <refpurpose>Separator character for compound profile values</refpurpose>
11665 <programlisting xml:id="profile.separator.frag">
11666 <xsl:param name="profile.separator">;</xsl:param>
11670 <refsection><info><title>Description</title></info>
11672 <para>Separator character used for compound profile values. See <parameter>profile.arch</parameter></para>
11678 <reference xml:id="l10n"><title>Localization</title>
11679 <refentry version="5.0" xml:id="l10n.gentext.language">
11681 <refentrytitle>l10n.gentext.language</refentrytitle>
11682 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
11685 <refname>l10n.gentext.language</refname>
11686 <refpurpose>Sets the gentext language</refpurpose>
11690 <programlisting xml:id="l10n.gentext.language.frag">
11691 <xsl:param name="l10n.gentext.language"></xsl:param>
11695 <refsection><info><title>Description</title></info>
11697 <para>If this parameter is set to any value other than the empty string, its
11698 value will be used as the value for the language when generating text. Setting
11699 <parameter>l10n.gentext.language</parameter> overrides any settings within the
11700 document being formatted.</para>
11702 <para>It's much more likely that you might want to set the
11703 <parameter>l10n.gentext.default.language</parameter> parameter.</para>
11708 <refentry version="5.0" xml:id="l10n.gentext.default.language">
11710 <refentrytitle>l10n.gentext.default.language</refentrytitle>
11711 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
11714 <refname>l10n.gentext.default.language</refname>
11715 <refpurpose>Sets the default language for generated text</refpurpose>
11719 <programlisting xml:id="l10n.gentext.default.language.frag">
11720 <xsl:param name="l10n.gentext.default.language">en</xsl:param>
11724 <refsection><info><title>Description</title></info>
11726 <para>The value of the <parameter>l10n.gentext.default.language</parameter>
11727 parameter is used as the language for generated text if no setting is provided
11728 in the source document.</para>
11733 <refentry version="5.0" xml:id="l10n.gentext.use.xref.language">
11735 <refentrytitle>l10n.gentext.use.xref.language</refentrytitle>
11736 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
11739 <refname>l10n.gentext.use.xref.language</refname>
11740 <refpurpose>Use the language of target when generating cross-reference text?</refpurpose>
11744 <programlisting xml:id="l10n.gentext.use.xref.language.frag">
11745 <xsl:param name="l10n.gentext.use.xref.language" select="0"></xsl:param>
11749 <refsection><info><title>Description</title></info>
11751 <para>If non-zero, the language of the target will be used when
11752 generating cross reference text. Usually, the <quote>current</quote>
11753 language is used when generating text (that is, the language of the
11754 element that contains the cross-reference element). But setting this parameter
11755 allows the language of the element <emphasis>pointed to</emphasis> to control
11756 the generated text.</para>
11758 <para>Consider the following example:</para>
11761 <programlisting><para lang="en">See also <xref linkend="chap3"/>.</para>
11765 <para>Suppose that Chapter 3 happens to be written in German.
11766 If <parameter>l10n.gentext.use.xref.language</parameter> is non-zero, the
11767 resulting text will be something like this:</para>
11770 <para>See also Kapital 3.</para>
11773 <para>Where the more traditional rendering would be:</para>
11776 <para>See also Chapter 3.</para>
11782 <refentry version="5.0" xml:id="l10n.lang.value.rfc.compliant">
11784 <refentrytitle>l10n.lang.value.rfc.compliant</refentrytitle>
11785 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
11788 <refname>l10n.lang.value.rfc.compliant</refname>
11789 <refpurpose>Make value of lang attribute RFC compliant?</refpurpose>
11793 <programlisting xml:id="l10n.lang.value.rfc.compliant.frag">
11794 <xsl:param name="l10n.lang.value.rfc.compliant" select="1"></xsl:param>
11798 <refsection><info><title>Description</title></info>
11800 <para>If non-zero, ensure that the values for all <tag class="attribute">lang</tag> attributes in HTML output are RFC
11801 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:
11803 <blockquote><para>[RFC1766] defines and explains the language codes
11804 that must be used in HTML documents.</para>
11805 <para>Briefly, language codes consist of a primary code and a possibly
11806 empty series of subcodes:
11808 <literallayout class="monospaced">language-code = primary-code ( "-" subcode )*</literallayout>
11810 <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
11811 of Languages</link>, the EBNF for "language tag" is given as:
11813 <literallayout class="monospaced">Language-Tag = Primary-tag *( "-" Subtag )
11814 Primary-tag = 1*8ALPHA
11815 Subtag = 1*8ALPHA</literallayout>
11818 </para></footnote>.
11820 by taking any underscore characters in any <tag class="attribute">lang</tag> values found in source documents, and
11821 replacing them with hyphen characters in output HTML files. For
11822 example, <literal>zh_CN</literal> in a source document becomes
11823 <literal>zh-CN</literal> in the HTML output form that source.
11826 <para>This parameter does not cause any case change in <tag class="attribute">lang</tag> values, because RFC 1766
11827 explicitly states that all "language tags" (as it calls them) "are
11828 to be treated as case insensitive".</para>
11835 <refentry version="5.0" xml:id="writing.mode">
11837 <refentrytitle>writing.mode</refentrytitle>
11838 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
11841 <refname>writing.mode</refname>
11842 <refpurpose>Direction of text flow based on locale</refpurpose>
11846 <programlisting xml:id="writing.mode.frag">
11847 <xsl:param name="writing.mode">
11848 <xsl:call-template name="gentext">
11849 <xsl:with-param name="key">writing-mode</xsl:with-param>
11850 <xsl:with-param name="lang">
11851 <xsl:call-template name="l10n.language">
11852 <xsl:with-param name="target" select="/*[1]"></xsl:with-param>
11853 </xsl:call-template>
11854 </xsl:with-param>
11855 </xsl:call-template>
11860 <refsection><info><title>Description</title></info>
11862 <para>Sets direction of text flow and text alignment based on locale.
11863 The value is normally taken from the gentext file for the
11864 lang attribute of the document's root element, using the
11865 key name 'writing-mode' to look it up in the gentext file.
11866 But the param can also be
11867 set on the command line to override that gentext value.
11869 <para>Accepted values are:
11874 <para>Left-to-right text flow in each line, lines stack top to bottom.</para>
11880 <para>Right-to-left text flow in each line, lines stack top to bottom.</para>
11886 <para>Top-to-bottom text flow in each vertical line, lines stack right to left.
11887 Supported by only a few XSL-FO processors. Not supported in HTML output.</para>
11893 <para>Shorthand for lr-tb.</para>
11899 <para>Shorthand for rl-tb.</para>
11905 <para>Shorthand for tb-rl.</para>
11915 <reference xml:id="ebnf"><title>EBNF</title>
11916 <refentry version="5.0" xml:id="ebnf.assignment">
11918 <refentrytitle>ebnf.assignment</refentrytitle>
11919 <refmiscinfo class="other" otherclass="datatype">rtf</refmiscinfo>
11922 <refname>ebnf.assignment</refname>
11923 <refpurpose>The EBNF production assignment operator</refpurpose>
11927 <programlisting xml:id="ebnf.assignment.frag">
11929 <xsl:param name="ebnf.assignment">
11930 <fo:inline font-family="{$monospace.font.family}">
11931 <xsl:text>::=</xsl:text>
11937 <refsection><info><title>Description</title></info>
11939 <para>The <parameter>ebnf.assignment</parameter> parameter determines what
11940 text is used to show <quote>assignment</quote> in <tag>production</tag>s
11941 in <tag>productionset</tag>s.</para>
11943 <para>While <quote><literal>::=</literal></quote> is common, so are several
11944 other operators.</para>
11949 <refentry version="5.0" xml:id="ebnf.statement.terminator">
11951 <refentrytitle>ebnf.statement.terminator</refentrytitle>
11952 <refmiscinfo class="other" otherclass="datatype">rtf</refmiscinfo>
11955 <refname>ebnf.statement.terminator</refname>
11956 <refpurpose>Punctuation that ends an EBNF statement.</refpurpose>
11960 <programlisting xml:id="ebnf.statement.terminator.frag">
11962 <xsl:param name="ebnf.statement.terminator"></xsl:param>
11966 <refsection><info><title>Description</title></info>
11968 <para>The <parameter>ebnf.statement.terminator</parameter> parameter determines what
11969 text is used to terminate each <tag>production</tag>
11970 in <tag>productionset</tag>.</para>
11972 <para>Some notations end each statement with a period.</para>
11978 <reference xml:id="prepress"><title>Prepress</title>
11979 <refentry version="5.0" xml:id="crop.marks">
11981 <refentrytitle>crop.marks</refentrytitle>
11982 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
11985 <refname>crop.marks</refname>
11986 <refpurpose>Output crop marks?</refpurpose>
11990 <programlisting xml:id="crop.marks.frag">
11991 <xsl:param name="crop.marks" select="0"></xsl:param>
11995 <refsection><info><title>Description</title></info>
11997 <para>If non-zero, crop marks will be added to each page. Currently this
11998 works only with XEP if you have <parameter>xep.extensions</parameter> set.</para>
12003 <refentry version="5.0" xml:id="crop.mark.width">
12005 <refentrytitle>crop.mark.width</refentrytitle>
12006 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
12009 <refname>crop.mark.width</refname>
12010 <refpurpose>Width of crop marks.</refpurpose>
12014 <programlisting xml:id="crop.mark.width.frag">
12015 <xsl:param name="crop.mark.width">0.5pt</xsl:param>
12019 <refsection><info><title>Description</title></info>
12021 <para>Width of crop marks. Crop marks are controlled by
12022 <parameter>crop.marks</parameter> parameter.</para>
12027 <refentry version="5.0" xml:id="crop.mark.offset">
12029 <refentrytitle>crop.mark.offset</refentrytitle>
12030 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
12033 <refname>crop.mark.offset</refname>
12034 <refpurpose>Length of crop marks.</refpurpose>
12038 <programlisting xml:id="crop.mark.offset.frag">
12039 <xsl:param name="crop.mark.offset">24pt</xsl:param>
12043 <refsection><info><title>Description</title></info>
12045 <para>Length of crop marks. Crop marks are controlled by
12046 <parameter>crop.marks</parameter> parameter.</para>
12051 <refentry version="5.0" xml:id="crop.mark.bleed">
12053 <refentrytitle>crop.mark.bleed</refentrytitle>
12054 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
12057 <refname>crop.mark.bleed</refname>
12058 <refpurpose>Length of invisible part of crop marks.</refpurpose>
12062 <programlisting xml:id="crop.mark.bleed.frag">
12063 <xsl:param name="crop.mark.bleed">6pt</xsl:param>
12067 <refsection><info><title>Description</title></info>
12069 <para>Length of invisible part of crop marks. Crop marks are controlled by
12070 <parameter>crop.marks</parameter> parameter.</para>
12077 <appendix xml:id="stylesheet"><title>The Stylesheet</title>
12079 <para>The <filename>param.xsl</filename> stylesheet is just a wrapper
12080 around all these parameters.</para>
12082 <programlisting xml:id="top">
12083 <xsl:stylesheet exclude-result-prefixes="src" version="1.0">
12085 <!-- This file is generated from param.xweb -->
12087 <!-- ********************************************************************
12088 $Id: param.xweb 8543 2009-12-02 06:05:24Z bobstayton $
12089 ********************************************************************
12091 This file is part of the XSL DocBook Stylesheet distribution.
12092 See ../README or http://docbook.sf.net/release/xsl/current/ for
12093 copyright and other information.
12095 ******************************************************************** -->
12097 <src:fragref linkend="abstract.properties.frag"></src:fragref>
12098 <src:fragref linkend="abstract.title.properties.frag"></src:fragref>
12099 <src:fragref linkend="admon.graphics.extension.frag"></src:fragref>
12100 <src:fragref linkend="admon.graphics.frag"></src:fragref>
12101 <src:fragref linkend="admon.graphics.path.frag"></src:fragref>
12102 <src:fragref linkend="admon.textlabel.frag"></src:fragref>
12103 <src:fragref linkend="admonition.properties.frag"></src:fragref>
12104 <src:fragref linkend="admonition.title.properties.frag"></src:fragref>
12105 <src:fragref linkend="graphical.admonition.properties.frag"></src:fragref>
12106 <src:fragref linkend="nongraphical.admonition.properties.frag"></src:fragref>
12107 <src:fragref linkend="alignment.frag"></src:fragref>
12108 <src:fragref linkend="appendix.autolabel.frag"></src:fragref>
12109 <src:fragref linkend="arbortext.extensions.frag"></src:fragref>
12110 <src:fragref linkend="article.appendix.title.properties.frag"></src:fragref>
12111 <src:fragref linkend="author.othername.in.middle.frag"></src:fragref>
12112 <src:fragref linkend="autotoc.label.separator.frag"></src:fragref>
12113 <src:fragref linkend="axf.extensions.frag"></src:fragref>
12114 <src:fragref linkend="biblioentry.item.separator.frag"></src:fragref>
12115 <src:fragref linkend="biblioentry.properties.frag"></src:fragref>
12116 <src:fragref linkend="bibliography.collection.frag"></src:fragref>
12117 <src:fragref linkend="bibliography.numbered.frag"></src:fragref>
12118 <src:fragref linkend="bibliography.style.frag"></src:fragref>
12119 <src:fragref linkend="blockquote.properties.frag"></src:fragref>
12120 <src:fragref linkend="body.font.family.frag"></src:fragref>
12121 <src:fragref linkend="body.font.master.frag"></src:fragref>
12122 <src:fragref linkend="body.font.size.frag"></src:fragref>
12123 <src:fragref linkend="body.margin.bottom.frag"></src:fragref>
12124 <src:fragref linkend="body.margin.top.frag"></src:fragref>
12125 <src:fragref linkend="body.start.indent.frag"></src:fragref>
12126 <src:fragref linkend="body.end.indent.frag"></src:fragref>
12127 <src:fragref linkend="bookmarks.collapse.frag"></src:fragref>
12128 <src:fragref linkend="bridgehead.in.toc.frag"></src:fragref>
12129 <src:fragref linkend="callout.defaultcolumn.frag"></src:fragref>
12130 <src:fragref linkend="callout.graphics.extension.frag"></src:fragref>
12131 <src:fragref linkend="callout.graphics.frag"></src:fragref>
12132 <src:fragref linkend="callout.icon.size.frag"></src:fragref>
12133 <src:fragref linkend="callout.graphics.number.limit.frag"></src:fragref>
12134 <src:fragref linkend="callout.graphics.path.frag"></src:fragref>
12135 <src:fragref linkend="callout.unicode.font.frag"></src:fragref>
12136 <src:fragref linkend="callout.unicode.frag"></src:fragref>
12137 <src:fragref linkend="callout.unicode.number.limit.frag"></src:fragref>
12138 <src:fragref linkend="callout.unicode.start.character.frag"></src:fragref>
12139 <src:fragref linkend="callouts.extension.frag"></src:fragref>
12140 <src:fragref linkend="chapter.autolabel.frag"></src:fragref>
12141 <src:fragref linkend="collect.xref.targets.frag"></src:fragref>
12142 <src:fragref linkend="column.count.back.frag"></src:fragref>
12143 <src:fragref linkend="column.count.body.frag"></src:fragref>
12144 <src:fragref linkend="column.count.front.frag"></src:fragref>
12145 <src:fragref linkend="column.count.index.frag"></src:fragref>
12146 <src:fragref linkend="column.count.lot.frag"></src:fragref>
12147 <src:fragref linkend="column.count.titlepage.frag"></src:fragref>
12148 <src:fragref linkend="column.gap.back.frag"></src:fragref>
12149 <src:fragref linkend="column.gap.body.frag"></src:fragref>
12150 <src:fragref linkend="column.gap.front.frag"></src:fragref>
12151 <src:fragref linkend="column.gap.index.frag"></src:fragref>
12152 <src:fragref linkend="column.gap.lot.frag"></src:fragref>
12153 <src:fragref linkend="column.gap.titlepage.frag"></src:fragref>
12154 <src:fragref linkend="compact.list.item.spacing.frag"></src:fragref>
12155 <src:fragref linkend="component.label.includes.part.label.frag"></src:fragref>
12156 <src:fragref linkend="component.title.properties.frag"></src:fragref>
12157 <src:fragref linkend="component.titlepage.properties.frag"></src:fragref>
12158 <src:fragref linkend="crop.marks.frag"></src:fragref>
12159 <src:fragref linkend="crop.mark.width.frag"></src:fragref>
12160 <src:fragref linkend="crop.mark.offset.frag"></src:fragref>
12161 <src:fragref linkend="crop.mark.bleed.frag"></src:fragref>
12162 <src:fragref linkend="current.docid.frag"></src:fragref>
12163 <src:fragref linkend="default.float.class.frag"></src:fragref>
12164 <src:fragref linkend="default.image.width.frag"></src:fragref>
12165 <src:fragref linkend="default.table.width.frag"></src:fragref>
12166 <src:fragref linkend="default.table.frame.frag"></src:fragref>
12167 <src:fragref linkend="default.table.rules.frag"></src:fragref>
12168 <src:fragref linkend="default.units.frag"></src:fragref>
12169 <src:fragref linkend="dingbat.font.family.frag"></src:fragref>
12170 <src:fragref linkend="double.sided.frag"></src:fragref>
12171 <src:fragref linkend="draft.mode.frag"></src:fragref>
12172 <src:fragref linkend="draft.watermark.image.frag"></src:fragref>
12173 <src:fragref linkend="ebnf.assignment.frag"></src:fragref>
12174 <src:fragref linkend="ebnf.statement.terminator.frag"></src:fragref>
12175 <src:fragref linkend="email.delimiters.enabled.frag"></src:fragref>
12176 <src:fragref linkend="email.mailto.enabled.frag"></src:fragref>
12177 <src:fragref linkend="equation.properties.frag"></src:fragref>
12178 <src:fragref linkend="equation.number.properties.frag"></src:fragref>
12179 <src:fragref linkend="example.properties.frag"></src:fragref>
12180 <src:fragref linkend="exsl.node.set.available.frag"></src:fragref>
12181 <src:fragref linkend="figure.properties.frag"></src:fragref>
12182 <src:fragref linkend="firstterm.only.link.frag"></src:fragref>
12183 <src:fragref linkend="footer.content.properties.frag"></src:fragref>
12184 <src:fragref linkend="footer.rule.frag"></src:fragref>
12185 <src:fragref linkend="footer.column.widths.frag"></src:fragref>
12186 <src:fragref linkend="footer.table.height.frag"></src:fragref>
12187 <src:fragref linkend="footer.table.properties.frag"></src:fragref>
12188 <src:fragref linkend="footers.on.blank.pages.frag"></src:fragref>
12189 <src:fragref linkend="footnote.font.size.frag"></src:fragref>
12190 <src:fragref linkend="footnote.number.format.frag"></src:fragref>
12191 <src:fragref linkend="footnote.number.symbols.frag"></src:fragref>
12192 <src:fragref linkend="footnote.mark.properties.frag"></src:fragref>
12193 <src:fragref linkend="footnote.properties.frag"></src:fragref>
12194 <src:fragref linkend="footnote.sep.leader.properties.frag"></src:fragref>
12195 <src:fragref linkend="fop.extensions.frag"></src:fragref>
12196 <src:fragref linkend="fop1.extensions.frag"></src:fragref>
12197 <src:fragref linkend="formal.object.properties.frag"></src:fragref>
12198 <src:fragref linkend="formal.procedures.frag"></src:fragref>
12199 <src:fragref linkend="formal.title.placement.frag"></src:fragref>
12200 <src:fragref linkend="formal.title.properties.frag"></src:fragref>
12201 <src:fragref linkend="funcsynopsis.decoration.frag"></src:fragref>
12202 <src:fragref linkend="funcsynopsis.style.frag"></src:fragref>
12203 <src:fragref linkend="function.parens.frag"></src:fragref>
12204 <src:fragref linkend="generate.index.frag"></src:fragref>
12205 <src:fragref linkend="generate.section.toc.level.frag"></src:fragref>
12206 <src:fragref linkend="generate.toc.frag"></src:fragref>
12207 <src:fragref linkend="glossary.as.blocks.frag"></src:fragref>
12208 <src:fragref linkend="glossary.collection.frag"></src:fragref>
12209 <src:fragref linkend="glossary.sort.frag"></src:fragref>
12210 <src:fragref linkend="glossentry.show.acronym.frag"></src:fragref>
12211 <src:fragref linkend="glosslist.as.blocks.frag"></src:fragref>
12212 <src:fragref linkend="glossterm.auto.link.frag"></src:fragref>
12213 <src:fragref linkend="glossterm.separation.frag"></src:fragref>
12214 <src:fragref linkend="glossterm.width.frag"></src:fragref>
12215 <src:fragref linkend="glossentry.list.item.properties.frag"></src:fragref>
12216 <src:fragref linkend="glossterm.list.properties.frag"></src:fragref>
12217 <src:fragref linkend="glossterm.block.properties.frag"></src:fragref>
12218 <src:fragref linkend="glossdef.list.properties.frag"></src:fragref>
12219 <src:fragref linkend="glossdef.block.properties.frag"></src:fragref>
12220 <src:fragref linkend="graphic.default.extension.frag"></src:fragref>
12221 <src:fragref linkend="header.content.properties.frag"></src:fragref>
12222 <src:fragref linkend="header.rule.frag"></src:fragref>
12223 <src:fragref linkend="header.column.widths.frag"></src:fragref>
12224 <src:fragref linkend="header.table.height.frag"></src:fragref>
12225 <src:fragref linkend="header.table.properties.frag"></src:fragref>
12226 <src:fragref linkend="headers.on.blank.pages.frag"></src:fragref>
12227 <src:fragref linkend="highlight.default.language.frag"></src:fragref>
12228 <src:fragref linkend="highlight.source.frag"></src:fragref>
12229 <src:fragref linkend="highlight.xslthl.config.frag"></src:fragref>
12230 <src:fragref linkend="hyphenate.frag"></src:fragref>
12231 <src:fragref linkend="hyphenate.verbatim.frag"></src:fragref>
12232 <src:fragref linkend="hyphenate.verbatim.characters.frag"></src:fragref>
12233 <src:fragref linkend="ignore.image.scaling.frag"></src:fragref>
12234 <src:fragref linkend="img.src.path.frag"></src:fragref>
12235 <src:fragref linkend="index.method.frag"></src:fragref>
12236 <src:fragref linkend="index.on.role.frag"></src:fragref>
12237 <src:fragref linkend="index.on.type.frag"></src:fragref>
12238 <src:fragref linkend="index.page.number.properties.frag"></src:fragref>
12239 <src:fragref linkend="informalequation.properties.frag"></src:fragref>
12240 <src:fragref linkend="informalexample.properties.frag"></src:fragref>
12241 <src:fragref linkend="informalfigure.properties.frag"></src:fragref>
12242 <src:fragref linkend="informal.object.properties.frag"></src:fragref>
12243 <src:fragref linkend="informaltable.properties.frag"></src:fragref>
12244 <src:fragref linkend="index.preferred.page.properties.frag"></src:fragref>
12245 <src:fragref linkend="index.div.title.properties.frag"></src:fragref>
12246 <src:fragref linkend="index.entry.properties.frag"></src:fragref>
12247 <src:fragref linkend="index.number.separator.frag"></src:fragref>
12248 <src:fragref linkend="index.range.separator.frag"></src:fragref>
12249 <src:fragref linkend="index.term.separator.frag"></src:fragref>
12250 <src:fragref linkend="insert.link.page.number.frag"></src:fragref>
12251 <src:fragref linkend="insert.xref.page.number.frag"></src:fragref>
12252 <src:fragref linkend="itemizedlist.properties.frag"></src:fragref>
12253 <src:fragref linkend="itemizedlist.label.properties.frag"></src:fragref>
12254 <src:fragref linkend="itemizedlist.label.width.frag"></src:fragref>
12255 <src:fragref linkend="keep.relative.image.uris.frag"></src:fragref>
12256 <src:fragref linkend="l10n.gentext.default.language.frag"></src:fragref>
12257 <src:fragref linkend="l10n.gentext.language.frag"></src:fragref>
12258 <src:fragref linkend="l10n.gentext.use.xref.language.frag"></src:fragref>
12259 <src:fragref linkend="l10n.lang.value.rfc.compliant.frag"></src:fragref>
12260 <src:fragref linkend="label.from.part.frag"></src:fragref>
12261 <src:fragref linkend="line-height.frag"></src:fragref>
12262 <src:fragref linkend="linenumbering.everyNth.frag"></src:fragref>
12263 <src:fragref linkend="linenumbering.extension.frag"></src:fragref>
12264 <src:fragref linkend="linenumbering.separator.frag"></src:fragref>
12265 <src:fragref linkend="linenumbering.width.frag"></src:fragref>
12266 <src:fragref linkend="list.block.properties.frag"></src:fragref>
12267 <src:fragref linkend="list.block.spacing.frag"></src:fragref>
12268 <src:fragref linkend="list.item.spacing.frag"></src:fragref>
12269 <src:fragref linkend="make.index.markup.frag"></src:fragref>
12270 <src:fragref linkend="make.single.year.ranges.frag"></src:fragref>
12271 <src:fragref linkend="make.year.ranges.frag"></src:fragref>
12272 <src:fragref linkend="margin.note.properties.frag"></src:fragref>
12273 <src:fragref linkend="margin.note.title.properties.frag"></src:fragref>
12274 <src:fragref linkend="margin.note.float.type.frag"></src:fragref>
12275 <src:fragref linkend="margin.note.width.frag"></src:fragref>
12276 <src:fragref linkend="marker.section.level.frag"></src:fragref>
12277 <src:fragref linkend="menuchoice.menu.separator.frag"></src:fragref>
12278 <src:fragref linkend="menuchoice.separator.frag"></src:fragref>
12279 <src:fragref linkend="monospace.font.family.frag"></src:fragref>
12280 <src:fragref linkend="monospace.properties.frag"></src:fragref>
12281 <src:fragref linkend="monospace.verbatim.properties.frag"></src:fragref>
12282 <src:fragref linkend="monospace.verbatim.font.width.frag"></src:fragref>
12283 <src:fragref linkend="nominal.table.width.frag"></src:fragref>
12284 <src:fragref linkend="normal.para.spacing.frag"></src:fragref>
12285 <src:fragref linkend="olink.doctitle.frag"></src:fragref>
12286 <src:fragref linkend="olink.base.uri.frag"></src:fragref>
12287 <src:fragref linkend="olink.debug.frag"></src:fragref>
12288 <src:fragref linkend="olink.properties.frag"></src:fragref>
12289 <src:fragref linkend="olink.lang.fallback.sequence.frag"></src:fragref>
12290 <src:fragref linkend="orderedlist.properties.frag"></src:fragref>
12291 <src:fragref linkend="orderedlist.label.properties.frag"></src:fragref>
12292 <src:fragref linkend="orderedlist.label.width.frag"></src:fragref>
12293 <src:fragref linkend="prefer.internal.olink.frag"></src:fragref>
12294 <src:fragref linkend="insert.olink.page.number.frag"></src:fragref>
12295 <src:fragref linkend="insert.olink.pdf.frag.frag"></src:fragref>
12296 <src:fragref linkend="page.height.frag"></src:fragref>
12297 <src:fragref linkend="page.height.portrait.frag"></src:fragref>
12298 <src:fragref linkend="page.margin.bottom.frag"></src:fragref>
12299 <src:fragref linkend="page.margin.inner.frag"></src:fragref>
12300 <src:fragref linkend="page.margin.outer.frag"></src:fragref>
12301 <src:fragref linkend="page.margin.top.frag"></src:fragref>
12302 <src:fragref linkend="page.orientation.frag"></src:fragref>
12303 <src:fragref linkend="page.width.frag"></src:fragref>
12304 <src:fragref linkend="page.width.portrait.frag"></src:fragref>
12305 <src:fragref linkend="paper.type.frag"></src:fragref>
12306 <src:fragref linkend="part.autolabel.frag"></src:fragref>
12307 <src:fragref linkend="passivetex.extensions.frag"></src:fragref>
12308 <src:fragref linkend="pgwide.properties.frag"></src:fragref>
12309 <src:fragref linkend="preface.autolabel.frag"></src:fragref>
12310 <src:fragref linkend="preferred.mediaobject.role.frag"></src:fragref>
12311 <src:fragref linkend="procedure.properties.frag"></src:fragref>
12312 <src:fragref linkend="process.empty.source.toc.frag"></src:fragref>
12313 <src:fragref linkend="process.source.toc.frag"></src:fragref>
12314 <src:fragref linkend="profile.arch.frag"></src:fragref>
12315 <src:fragref linkend="profile.audience.frag"></src:fragref>
12316 <src:fragref linkend="profile.attribute.frag"></src:fragref>
12317 <src:fragref linkend="profile.condition.frag"></src:fragref>
12318 <src:fragref linkend="profile.conformance.frag"></src:fragref>
12319 <src:fragref linkend="profile.lang.frag"></src:fragref>
12320 <src:fragref linkend="profile.os.frag"></src:fragref>
12321 <src:fragref linkend="profile.revision.frag"></src:fragref>
12322 <src:fragref linkend="profile.revisionflag.frag"></src:fragref>
12323 <src:fragref linkend="profile.role.frag"></src:fragref>
12324 <src:fragref linkend="profile.security.frag"></src:fragref>
12325 <src:fragref linkend="profile.separator.frag"></src:fragref>
12326 <src:fragref linkend="profile.status.frag"></src:fragref>
12327 <src:fragref linkend="profile.userlevel.frag"></src:fragref>
12328 <src:fragref linkend="profile.value.frag"></src:fragref>
12329 <src:fragref linkend="profile.vendor.frag"></src:fragref>
12330 <src:fragref linkend="profile.wordsize.frag"></src:fragref>
12331 <src:fragref linkend="punct.honorific.frag"></src:fragref>
12332 <src:fragref linkend="qanda.defaultlabel.frag"></src:fragref>
12333 <src:fragref linkend="qanda.in.toc.frag"></src:fragref>
12334 <src:fragref linkend="qanda.nested.in.toc.frag"></src:fragref>
12335 <src:fragref linkend="qanda.inherit.numeration.frag"></src:fragref>
12336 <src:fragref linkend="qandadiv.autolabel.frag"></src:fragref>
12337 <src:fragref linkend="qanda.title.level1.properties.frag"></src:fragref>
12338 <src:fragref linkend="qanda.title.level2.properties.frag"></src:fragref>
12339 <src:fragref linkend="qanda.title.level3.properties.frag"></src:fragref>
12340 <src:fragref linkend="qanda.title.level4.properties.frag"></src:fragref>
12341 <src:fragref linkend="qanda.title.level5.properties.frag"></src:fragref>
12342 <src:fragref linkend="qanda.title.level6.properties.frag"></src:fragref>
12343 <src:fragref linkend="qanda.title.properties.frag"></src:fragref>
12344 <src:fragref linkend="refentry.generate.name.frag"></src:fragref>
12345 <src:fragref linkend="refentry.generate.title.frag"></src:fragref>
12346 <src:fragref linkend="refentry.pagebreak.frag"></src:fragref>
12347 <src:fragref linkend="refentry.title.properties.frag"></src:fragref>
12348 <src:fragref linkend="refentry.xref.manvolnum.frag"></src:fragref>
12349 <src:fragref linkend="reference.autolabel.frag"></src:fragref>
12350 <src:fragref linkend="refclass.suppress.frag"></src:fragref>
12351 <src:fragref linkend="region.after.extent.frag"></src:fragref>
12352 <src:fragref linkend="region.before.extent.frag"></src:fragref>
12353 <src:fragref linkend="revhistory.table.properties.frag"></src:fragref>
12354 <src:fragref linkend="revhistory.table.cell.properties.frag"></src:fragref>
12355 <src:fragref linkend="revhistory.title.properties.frag"></src:fragref>
12356 <src:fragref linkend="root.properties.frag"></src:fragref>
12357 <src:fragref linkend="rootid.frag"></src:fragref>
12358 <src:fragref linkend="runinhead.default.title.end.punct.frag"></src:fragref>
12359 <src:fragref linkend="runinhead.title.end.punct.frag"></src:fragref>
12360 <src:fragref linkend="sans.font.family.frag"></src:fragref>
12361 <src:fragref linkend="section.autolabel.frag"></src:fragref>
12362 <src:fragref linkend="section.autolabel.max.depth.frag"></src:fragref>
12363 <src:fragref linkend="section.container.element.frag"></src:fragref>
12364 <src:fragref linkend="section.label.includes.component.label.frag"></src:fragref>
12365 <src:fragref linkend="section.title.level1.properties.frag"></src:fragref>
12366 <src:fragref linkend="section.title.level2.properties.frag"></src:fragref>
12367 <src:fragref linkend="section.title.level3.properties.frag"></src:fragref>
12368 <src:fragref linkend="section.title.level4.properties.frag"></src:fragref>
12369 <src:fragref linkend="section.title.level5.properties.frag"></src:fragref>
12370 <src:fragref linkend="section.title.level6.properties.frag"></src:fragref>
12371 <src:fragref linkend="section.title.properties.frag"></src:fragref>
12372 <src:fragref linkend="section.level1.properties.frag"></src:fragref>
12373 <src:fragref linkend="section.level2.properties.frag"></src:fragref>
12374 <src:fragref linkend="section.level3.properties.frag"></src:fragref>
12375 <src:fragref linkend="section.level4.properties.frag"></src:fragref>
12376 <src:fragref linkend="section.level5.properties.frag"></src:fragref>
12377 <src:fragref linkend="section.level6.properties.frag"></src:fragref>
12378 <src:fragref linkend="section.properties.frag"></src:fragref>
12379 <src:fragref linkend="segmentedlist.as.table.frag"></src:fragref>
12380 <src:fragref linkend="shade.verbatim.frag"></src:fragref>
12381 <src:fragref linkend="shade.verbatim.style.frag"></src:fragref>
12382 <src:fragref linkend="show.comments.frag"></src:fragref>
12383 <src:fragref linkend="sidebar.properties.frag"></src:fragref>
12384 <src:fragref linkend="sidebar.title.properties.frag"></src:fragref>
12385 <src:fragref linkend="sidebar.float.type.frag"></src:fragref>
12386 <src:fragref linkend="sidebar.float.width.frag"></src:fragref>
12387 <src:fragref linkend="simplesect.in.toc.frag"></src:fragref>
12388 <src:fragref linkend="subscript.properties.frag"></src:fragref>
12389 <src:fragref linkend="superscript.properties.frag"></src:fragref>
12390 <src:fragref linkend="symbol.font.family.frag"></src:fragref>
12391 <src:fragref linkend="table.cell.border.color.frag"></src:fragref>
12392 <src:fragref linkend="table.cell.border.style.frag"></src:fragref>
12393 <src:fragref linkend="table.cell.border.thickness.frag"></src:fragref>
12394 <src:fragref linkend="table.cell.padding.frag"></src:fragref>
12395 <src:fragref linkend="table.footnote.number.format.frag"></src:fragref>
12396 <src:fragref linkend="table.footnote.number.symbols.frag"></src:fragref>
12397 <src:fragref linkend="table.footnote.properties.frag"></src:fragref>
12398 <src:fragref linkend="table.frame.border.color.frag"></src:fragref>
12399 <src:fragref linkend="table.frame.border.style.frag"></src:fragref>
12400 <src:fragref linkend="table.frame.border.thickness.frag"></src:fragref>
12401 <src:fragref linkend="table.properties.frag"></src:fragref>
12402 <src:fragref linkend="tablecolumns.extension.frag"></src:fragref>
12403 <src:fragref linkend="table.table.properties.frag"></src:fragref>
12404 <src:fragref linkend="target.database.document.frag"></src:fragref>
12405 <src:fragref linkend="targets.filename.frag"></src:fragref>
12406 <src:fragref linkend="textdata.default.encoding.frag"></src:fragref>
12407 <src:fragref linkend="tex.math.delims.frag"></src:fragref>
12408 <src:fragref linkend="tex.math.in.alt.frag"></src:fragref>
12409 <src:fragref linkend="textinsert.extension.frag"></src:fragref>
12410 <src:fragref linkend="title.font.family.frag"></src:fragref>
12411 <src:fragref linkend="title.margin.left.frag"></src:fragref>
12412 <src:fragref linkend="toc.indent.width.frag"></src:fragref>
12413 <src:fragref linkend="toc.line.properties.frag"></src:fragref>
12414 <src:fragref linkend="toc.margin.properties.frag"></src:fragref>
12415 <src:fragref linkend="toc.max.depth.frag"></src:fragref>
12416 <src:fragref linkend="toc.section.depth.frag"></src:fragref>
12417 <src:fragref linkend="ulink.footnotes.frag"></src:fragref>
12418 <src:fragref linkend="ulink.hyphenate.frag"></src:fragref>
12419 <src:fragref linkend="ulink.hyphenate.chars.frag"></src:fragref>
12420 <src:fragref linkend="ulink.show.frag"></src:fragref>
12421 <src:fragref linkend="use.extensions.frag"></src:fragref>
12422 <src:fragref linkend="use.local.olink.style.frag"></src:fragref>
12423 <src:fragref linkend="use.role.as.xrefstyle.frag"></src:fragref>
12424 <src:fragref linkend="use.role.for.mediaobject.frag"></src:fragref>
12425 <src:fragref linkend="use.svg.frag"></src:fragref>
12426 <src:fragref linkend="variablelist.as.blocks.frag"></src:fragref>
12427 <src:fragref linkend="variablelist.max.termlength.frag"></src:fragref>
12428 <src:fragref linkend="variablelist.term.separator.frag"></src:fragref>
12429 <src:fragref linkend="variablelist.term.properties.frag"></src:fragref>
12430 <src:fragref linkend="variablelist.term.break.after.frag"></src:fragref>
12431 <src:fragref linkend="verbatim.properties.frag"></src:fragref>
12432 <src:fragref linkend="writing.mode.frag"></src:fragref>
12433 <src:fragref linkend="xep.extensions.frag"></src:fragref>
12434 <src:fragref linkend="xep.index.item.properties.frag"></src:fragref>
12435 <src:fragref linkend="xref.label-page.separator.frag"></src:fragref>
12436 <src:fragref linkend="xref.label-title.separator.frag"></src:fragref>
12437 <src:fragref linkend="xref.properties.frag"></src:fragref>
12438 <src:fragref linkend="xref.title-page.separator.frag"></src:fragref>
12439 <src:fragref linkend="xref.with.number.and.title.frag"></src:fragref>
12441 </xsl:stylesheet>